Class: Google::Apis::DfareportingV3_4::AccountUserProfile

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


458
459
460
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 458

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

Instance Attribute Details

#account_idFixnum

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)

368
369
370
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 368

def 
  @account_id
end

#activeBoolean 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)

374
375
376
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 374

def active
  @active
end

#advertiser_filterGoogle::Apis::DfareportingV3_4::ObjectFilter

Object Filter. Corresponds to the JSON property advertiserFilter


380
381
382
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 380

def advertiser_filter
  @advertiser_filter
end

#campaign_filterGoogle::Apis::DfareportingV3_4::ObjectFilter

Object Filter. Corresponds to the JSON property campaignFilter


385
386
387
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 385

def campaign_filter
  @campaign_filter
end

#commentsString

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

Returns:

  • (String)

390
391
392
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 390

def comments
  @comments
end

#emailString

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)

396
397
398
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 396

def email
  @email
end

#idFixnum

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

Returns:

  • (Fixnum)

401
402
403
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 401

def id
  @id
end

#kindString

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

Returns:

  • (String)

407
408
409
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 407

def kind
  @kind
end

#localeString

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)

417
418
419
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 417

def locale
  @locale
end

#nameString

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)

424
425
426
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 424

def name
  @name
end

#site_filterGoogle::Apis::DfareportingV3_4::ObjectFilter

Object Filter. Corresponds to the JSON property siteFilter


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

def site_filter
  @site_filter
end

#subaccount_idFixnum

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)

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

def subaccount_id
  @subaccount_id
end

#trafficker_typeString

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

Returns:

  • (String)

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

def trafficker_type
  @trafficker_type
end

#user_access_typeString

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)

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

def user_access_type
  @user_access_type
end

#user_role_filterGoogle::Apis::DfareportingV3_4::ObjectFilter

Object Filter. Corresponds to the JSON property userRoleFilter


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

def user_role_filter
  @user_role_filter
end

#user_role_idFixnum

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

Returns:

  • (Fixnum)

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

def user_role_id
  @user_role_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 463

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