Class: Google::Apis::DfareportingV4::UserRole

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ UserRole

Returns a new instance of UserRole.



12983
12984
12985
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 12983

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

Instance Attribute Details

#account_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


12936
12937
12938
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 12936

def 
  @account_id
end

#default_user_role ⇒ Boolean 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) 


12943
12944
12945
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 12943

def default_user_role
  @default_user_role
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


12949
12950
12951
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 12949

def id
  @id
end

#kind ⇒ String

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

Returns:

  • (String) 


12955
12956
12957
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 12955

def kind
  @kind
end

#name ⇒ String

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) 


12964
12965
12966
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 12964

def name
  @name
end

#parent_user_role_id ⇒ Fixnum

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:

  • (Fixnum) 


12970
12971
12972
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 12970

def parent_user_role_id
  @parent_user_role_id
end

#permissions ⇒ Array<Google::Apis::DfareportingV4::UserRolePermission>

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

Returns:



12975
12976
12977
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 12975

def permissions
  @permissions
end

#subaccount_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


12981
12982
12983
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 12981

def subaccount_id
  @subaccount_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



12988
12989
12990
12991
12992
12993
12994
12995
12996
12997
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 12988

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