Class: Google::Apis::DfareportingV3_1::AccountUserProfile

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

Overview

AccountUserProfiles contains properties of a Campaign Manager 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



525
526
527
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 525

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) 


423
424
425
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 423

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) 


429
430
431
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 429

def active
  @active
end

#advertiser_filter ⇒ Google::Apis::DfareportingV3_1::ObjectFilter

Object Filter. Corresponds to the JSON property advertiserFilter

Returns:



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

def advertiser_filter
  @advertiser_filter
end

#campaign_filter ⇒ Google::Apis::DfareportingV3_1::ObjectFilter

Object Filter. Corresponds to the JSON property campaignFilter

Returns:



440
441
442
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 440

def campaign_filter
  @campaign_filter
end

#comments ⇒ String

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

Returns:

  • (String) 


445
446
447
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 445

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) 


451
452
453
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 451

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) 


456
457
458
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 456

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) 


462
463
464
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 462

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) 


484
485
486
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 484

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) 


491
492
493
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 491

def name
  @name
end

#site_filter ⇒ Google::Apis::DfareportingV3_1::ObjectFilter

Object Filter. Corresponds to the JSON property siteFilter

Returns:



496
497
498
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 496

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) 


502
503
504
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 502

def subaccount_id
  @subaccount_id
end

#trafficker_type ⇒ String

Trafficker type of this user profile. This is a read-only field. Corresponds to the JSON property traffickerType

Returns:

  • (String) 


507
508
509
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 507

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) 


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

def user_access_type
  @user_access_type
end

#user_role_filter ⇒ Google::Apis::DfareportingV3_1::ObjectFilter

Object Filter. Corresponds to the JSON property userRoleFilter

Returns:



518
519
520
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 518

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) 


523
524
525
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 523

def user_role_id
  @user_role_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



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

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