Class: Google::Apis::DfareportingV2_1::AccountUserProfile

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

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::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ AccountUserProfile

Returns a new instance of AccountUserProfile



515
516
517
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 515

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

Instance Attribute Details

#account_id ⇒ String

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

Returns:

  • (String) 


413
414
415
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 413

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) 


419
420
421
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 419

def active
  @active
end

#advertiser_filter ⇒ Google::Apis::DfareportingV2_1::ObjectFilter

Object Filter. Corresponds to the JSON property advertiserFilter

Returns:



425
426
427
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 425

def advertiser_filter
  @advertiser_filter
end

#campaign_filter ⇒ Google::Apis::DfareportingV2_1::ObjectFilter

Object Filter. Corresponds to the JSON property campaignFilter

Returns:



430
431
432
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 430

def campaign_filter
  @campaign_filter
end

#comments ⇒ String

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

Returns:

  • (String) 


435
436
437
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 435

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) 


441
442
443
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 441

def email
  @email
end

#id ⇒ String

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

Returns:

  • (String) 


446
447
448
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 446

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) 


452
453
454
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 452

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) 


474
475
476
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 474

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) 


481
482
483
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 481

def name
  @name
end

#site_filter ⇒ Google::Apis::DfareportingV2_1::ObjectFilter

Object Filter. Corresponds to the JSON property siteFilter

Returns:



486
487
488
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 486

def site_filter
  @site_filter
end

#subaccount_id ⇒ String

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

Returns:

  • (String) 


492
493
494
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 492

def subaccount_id
  @subaccount_id
end

#trafficker_type ⇒ String

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

Returns:

  • (String) 


497
498
499
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 497

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) 


503
504
505
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 503

def user_access_type
  @user_access_type
end

#user_role_filter ⇒ Google::Apis::DfareportingV2_1::ObjectFilter

Object Filter. Corresponds to the JSON property userRoleFilter

Returns:



508
509
510
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 508

def user_role_filter
  @user_role_filter
end

#user_role_id ⇒ String

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

Returns:

  • (String) 


513
514
515
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 513

def user_role_id
  @user_role_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 520

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