Class: Google::Apis::DfareportingV2_6::AccountUserProfile

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

Overview

AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.

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) ⇒ AccountUserProfile

Returns a new instance of AccountUserProfile



524
525
526
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 524

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

Instance Attribute Details

#account_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


422
423
424
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 422

def 
  @account_id
end

#active ⇒ Boolean Also known as: active?

Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable. Corresponds to the JSON property active

Returns:

  • (Boolean) 


428
429
430
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 428

def active
  @active
end

#advertiser_filter ⇒ Google::Apis::DfareportingV2_6::ObjectFilter

Object Filter. Corresponds to the JSON property advertiserFilter

Returns:



434
435
436
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 434

def advertiser_filter
  @advertiser_filter
end

#campaign_filter ⇒ Google::Apis::DfareportingV2_6::ObjectFilter

Object Filter. Corresponds to the JSON property campaignFilter

Returns:



439
440
441
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 439

def campaign_filter
  @campaign_filter
end

#comments ⇒ String

Comments for this user profile. Corresponds to the JSON property comments

Returns:

  • (String) 


444
445
446
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 444

def comments
  @comments
end

#email ⇒ String

Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion. Corresponds to the JSON property email

Returns:

  • (String) 


450
451
452
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 450

def email
  @email
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


455
456
457
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 455

def id
  @id
end

#kind ⇒ String

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

Returns:

  • (String) 


461
462
463
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 461

def kind
  @kind
end

#locale ⇒ String

Locale of the user profile. This is a required field. Acceptable values are:

  • "cs" (Czech)
  • "de" (German)
  • "en" (English)
  • "en-GB" (English United Kingdom)
  • "es" (Spanish)
  • "fr" (French)
  • "it" (Italian)
  • "ja" (Japanese)
  • "ko" (Korean)
  • "pl" (Polish)
  • "pt-BR" (Portuguese Brazil)
  • "ru" (Russian)
  • "sv" (Swedish)
  • "tr" (Turkish)
  • "zh-CN" (Chinese Simplified)
  • "zh-TW" (Chinese Traditional) Corresponds to the JSON property locale

Returns:

  • (String) 


483
484
485
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 483

def locale
  @locale
end

#name ⇒ String

Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;"#%,". Corresponds to the JSON property name

Returns:

  • (String) 


490
491
492
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 490

def name
  @name
end

#site_filter ⇒ Google::Apis::DfareportingV2_6::ObjectFilter

Object Filter. Corresponds to the JSON property siteFilter

Returns:



495
496
497
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 495

def site_filter
  @site_filter
end

#subaccount_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


501
502
503
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 501

def subaccount_id
  @subaccount_id
end

#trafficker_type ⇒ String

Trafficker type of this user profile. Corresponds to the JSON property traffickerType

Returns:

  • (String) 


506
507
508
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 506

def trafficker_type
  @trafficker_type
end

#user_access_type ⇒ String

User type of the user profile. This is a read-only field that can be left blank. Corresponds to the JSON property userAccessType

Returns:

  • (String) 


512
513
514
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 512

def user_access_type
  @user_access_type
end

#user_role_filter ⇒ Google::Apis::DfareportingV2_6::ObjectFilter

Object Filter. Corresponds to the JSON property userRoleFilter

Returns:



517
518
519
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 517

def user_role_filter
  @user_role_filter
end

#user_role_id ⇒ Fixnum

User role ID of the user profile. This is a required field. Corresponds to the JSON property userRoleId

Returns:

  • (Fixnum) 


522
523
524
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 522

def user_role_id
  @user_role_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 529

def update!(**args)
  @account_id = args[:account_id] if args.key?(:account_id)
  @active = args[:active] if args.key?(:active)
  @advertiser_filter = args[:advertiser_filter] if args.key?(:advertiser_filter)
  @campaign_filter = args[:campaign_filter] if args.key?(:campaign_filter)
  @comments = args[:comments] if args.key?(:comments)
  @email = args[:email] if args.key?(:email)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @locale = args[:locale] if args.key?(:locale)
  @name = args[:name] if args.key?(:name)
  @site_filter = args[:site_filter] if args.key?(:site_filter)
  @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id)
  @trafficker_type = args[:trafficker_type] if args.key?(:trafficker_type)
  @user_access_type = args[:user_access_type] if args.key?(:user_access_type)
  @user_role_filter = args[:user_role_filter] if args.key?(:user_role_filter)
  @user_role_id = args[:user_role_id] if args.key?(:user_role_id)
end