Class: Google::Apis::DfareportingV2_3::UserRole

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/dfareporting_v2_3/classes.rb,
generated/google/apis/dfareporting_v2_3/representations.rb,
generated/google/apis/dfareporting_v2_3/representations.rb

Overview

Contains properties of auser role, which is used to manage user access.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ UserRole

Returns a new instance of UserRole.


10661
10662
10663
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 10661

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#account_idString

Account ID of this user role. This is a read-only field that can be left blank. Corresponds to the JSON property accountId

Returns:

  • (String)

10614
10615
10616
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 10614

def 
  @account_id
end

#default_user_roleBoolean Also known as: default_user_role?

Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions. Corresponds to the JSON property defaultUserRole

Returns:

  • (Boolean)

10621
10622
10623
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 10621

def default_user_role
  @default_user_role
end

#idString

ID of this user role. This is a read-only, auto-generated field. Corresponds to the JSON property id

Returns:

  • (String)

10627
10628
10629
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 10627

def id
  @id
end

#kindString

Identifies what kind of resource this is. Value: the fixed string " dfareporting#userRole". Corresponds to the JSON property kind

Returns:

  • (String)

10633
10634
10635
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 10633

def kind
  @kind
end

#nameString

Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top- level user role, and the name must be unique among top-level user roles of the same account. Corresponds to the JSON property name

Returns:

  • (String)

10642
10643
10644
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 10642

def name
  @name
end

#parent_user_role_idString

ID of the user role that this user role is based on or copied from. This is a required field. Corresponds to the JSON property parentUserRoleId

Returns:

  • (String)

10648
10649
10650
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 10648

def parent_user_role_id
  @parent_user_role_id
end

#permissionsArray<Google::Apis::DfareportingV2_3::UserRolePermission>

List of permissions associated with this user role. Corresponds to the JSON property permissions


10653
10654
10655
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 10653

def permissions
  @permissions
end

#subaccount_idString

Subaccount ID of this user role. This is a read-only field that can be left blank. Corresponds to the JSON property subaccountId

Returns:

  • (String)

10659
10660
10661
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 10659

def subaccount_id
  @subaccount_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


10666
10667
10668
10669
10670
10671
10672
10673
10674
10675
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 10666

def update!(**args)
  @account_id = args[:account_id] if args.key?(:account_id)
  @default_user_role = args[:default_user_role] if args.key?(:default_user_role)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @name = args[:name] if args.key?(:name)
  @parent_user_role_id = args[:parent_user_role_id] if args.key?(:parent_user_role_id)
  @permissions = args[:permissions] if args.key?(:permissions)
  @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id)
end