Class: Google::Apis::DfareportingV2_1::UserRole

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable
Defined in:
generated/google/apis/dfareporting_v2_1/classes.rb,
generated/google/apis/dfareporting_v2_1/representations.rb,
generated/google/apis/dfareporting_v2_1/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::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ UserRole

Returns a new instance of UserRole.


10592
10593
10594
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 10592

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)

10545
10546
10547
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 10545

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)

10552
10553
10554
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 10552

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)

10558
10559
10560
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 10558

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)

10564
10565
10566
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 10564

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)

10573
10574
10575
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 10573

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)

10579
10580
10581
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 10579

def parent_user_role_id
  @parent_user_role_id
end

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

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


10584
10585
10586
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 10584

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)

10590
10591
10592
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 10590

def subaccount_id
  @subaccount_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


10597
10598
10599
10600
10601
10602
10603
10604
10605
10606
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 10597

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