Class: Google::Apis::DfareportingV2_6::AccountUserProfile
- Inherits:
-
Object
- Object
- Google::Apis::DfareportingV2_6::AccountUserProfile
- 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
-
#account_id ⇒ String
Account ID of the user profile.
-
#active ⇒ Boolean
(also: #active?)
Whether this user profile is active.
-
#advertiser_filter ⇒ Google::Apis::DfareportingV2_6::ObjectFilter
Object Filter.
-
#campaign_filter ⇒ Google::Apis::DfareportingV2_6::ObjectFilter
Object Filter.
-
#comments ⇒ String
Comments for this user profile.
-
#email ⇒ String
Email of the user profile.
-
#id ⇒ String
ID of the user profile.
-
#kind ⇒ String
Identifies what kind of resource this is.
-
#locale ⇒ String
Locale of the user profile.
-
#name ⇒ String
Name of the user profile.
-
#site_filter ⇒ Google::Apis::DfareportingV2_6::ObjectFilter
Object Filter.
-
#subaccount_id ⇒ String
Subaccount ID of the user profile.
-
#trafficker_type ⇒ String
Trafficker type of this user profile.
-
#user_access_type ⇒ String
User type of the user profile.
-
#user_role_filter ⇒ Google::Apis::DfareportingV2_6::ObjectFilter
Object Filter.
-
#user_role_id ⇒ String
User role ID of the user profile.
Instance Method Summary collapse
-
#initialize(**args) ⇒ AccountUserProfile
constructor
A new instance of AccountUserProfile.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ AccountUserProfile
Returns a new instance of AccountUserProfile.
522 523 524 |
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 522 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
420 421 422 |
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 420 def account_id @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
426 427 428 |
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 426 def active @active end |
#advertiser_filter ⇒ Google::Apis::DfareportingV2_6::ObjectFilter
Object Filter.
Corresponds to the JSON property advertiserFilter
432 433 434 |
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 432 def advertiser_filter @advertiser_filter end |
#campaign_filter ⇒ Google::Apis::DfareportingV2_6::ObjectFilter
Object Filter.
Corresponds to the JSON property campaignFilter
437 438 439 |
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 437 def campaign_filter @campaign_filter end |
#comments ⇒ String
Comments for this user profile.
Corresponds to the JSON property comments
442 443 444 |
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 442 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
448 449 450 |
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 448 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
453 454 455 |
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 453 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
459 460 461 |
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 459 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
481 482 483 |
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 481 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
488 489 490 |
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 488 def name @name end |
#site_filter ⇒ Google::Apis::DfareportingV2_6::ObjectFilter
Object Filter.
Corresponds to the JSON property siteFilter
493 494 495 |
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 493 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
499 500 501 |
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 499 def subaccount_id @subaccount_id end |
#trafficker_type ⇒ String
Trafficker type of this user profile.
Corresponds to the JSON property traffickerType
504 505 506 |
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 504 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
510 511 512 |
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 510 def user_access_type @user_access_type end |
#user_role_filter ⇒ Google::Apis::DfareportingV2_6::ObjectFilter
Object Filter.
Corresponds to the JSON property userRoleFilter
515 516 517 |
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 515 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
520 521 522 |
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 520 def user_role_id @user_role_id end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 |
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 527 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 |