Class: Google::Apis::PartnersV2::User

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

Overview

A resource representing a user of the Partners platform.

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

Returns a new instance of User



2104
2105
2106
 
# File 'generated/google/apis/partners_v2/classes.rb', line 2104

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

Instance Attribute Details

#afa_info_shared ⇒ Boolean Also known as: afa_info_shared?

Whether or not the user has opted to share their Academy for Ads info with Google Partners. Corresponds to the JSON property afaInfoShared

Returns:

  • (Boolean) 


2034
2035
2036
 
# File 'generated/google/apis/partners_v2/classes.rb', line 2034

def afa_info_shared
  @afa_info_shared
end

#available_adwords_manager_accounts ⇒ Array<Google::Apis::PartnersV2::AdWordsManagerAccountInfo>

This is the list of AdWords Manager Accounts the user has edit access to. If the user has edit access to multiple accounts, the user can choose the preferred account and we use this when a personal account is needed. Can be empty meaning the user has access to no accounts. Corresponds to the JSON property availableAdwordsManagerAccounts

Returns:



2044
2045
2046
 
# File 'generated/google/apis/partners_v2/classes.rb', line 2044

def available_adwords_manager_accounts
  @available_adwords_manager_accounts
end

#certification_status ⇒ Array<Google::Apis::PartnersV2::Certification>

The list of achieved certifications. These are calculated based on exam results and other requirements. Corresponds to the JSON property certificationStatus

Returns:



2051
2052
2053
 
# File 'generated/google/apis/partners_v2/classes.rb', line 2051

def certification_status
  @certification_status
end

#company ⇒ Google::Apis::PartnersV2::CompanyRelation

A CompanyRelation resource representing information about a user's affiliation and standing with a company in Partners. Corresponds to the JSON property company

Returns:



2057
2058
2059
 
# File 'generated/google/apis/partners_v2/classes.rb', line 2057

def company
  @company
end

#company_verification_email ⇒ String

The email address used by the user used for company verification. Corresponds to the JSON property companyVerificationEmail

Returns:

  • (String) 


2063
2064
2065
 
# File 'generated/google/apis/partners_v2/classes.rb', line 2063

def company_verification_email
  @company_verification_email
end

#exam_status ⇒ Array<Google::Apis::PartnersV2::ExamStatus>

The list of exams the user ever taken. For each type of exam, only one entry is listed. Corresponds to the JSON property examStatus

Returns:



2069
2070
2071
 
# File 'generated/google/apis/partners_v2/classes.rb', line 2069

def exam_status
  @exam_status
end

#id ⇒ String

The ID of the user. Corresponds to the JSON property id

Returns:

  • (String) 


2074
2075
2076
 
# File 'generated/google/apis/partners_v2/classes.rb', line 2074

def id
  @id
end

#internal_id ⇒ String

The internal user ID. Only available for a whitelisted set of api clients. Corresponds to the JSON property internalId

Returns:

  • (String) 


2080
2081
2082
 
# File 'generated/google/apis/partners_v2/classes.rb', line 2080

def internal_id
  @internal_id
end

#last_access_time ⇒ String

The most recent time the user interacted with the Partners site. Corresponds to the JSON property lastAccessTime

Returns:

  • (String) 


2086
2087
2088
 
# File 'generated/google/apis/partners_v2/classes.rb', line 2086

def last_access_time
  @last_access_time
end

#primary_emails ⇒ Array<String>

The list of emails the user has access to/can select as primary. Corresponds to the JSON property primaryEmails

Returns:

  • (Array<String>) 


2092
2093
2094
 
# File 'generated/google/apis/partners_v2/classes.rb', line 2092

def primary_emails
  @primary_emails
end

#profile ⇒ Google::Apis::PartnersV2::UserProfile

The profile information of a Partners user. Corresponds to the JSON property profile

Returns:



2097
2098
2099
 
# File 'generated/google/apis/partners_v2/classes.rb', line 2097

def profile
  @profile
end

#public_profile ⇒ Google::Apis::PartnersV2::PublicProfile

Basic information from a public profile. Corresponds to the JSON property publicProfile

Returns:



2102
2103
2104
 
# File 'generated/google/apis/partners_v2/classes.rb', line 2102

def public_profile
  @public_profile
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
 
# File 'generated/google/apis/partners_v2/classes.rb', line 2109

def update!(**args)
  @afa_info_shared = args[:afa_info_shared] if args.key?(:afa_info_shared)
  @available_adwords_manager_accounts = args[:available_adwords_manager_accounts] if args.key?(:available_adwords_manager_accounts)
  @certification_status = args[:certification_status] if args.key?(:certification_status)
  @company = args[:company] if args.key?(:company)
  @company_verification_email = args[:company_verification_email] if args.key?(:company_verification_email)
  @exam_status = args[:exam_status] if args.key?(:exam_status)
  @id = args[:id] if args.key?(:id)
  @internal_id = args[:internal_id] if args.key?(:internal_id)
  @last_access_time = args[:last_access_time] if args.key?(:last_access_time)
  @primary_emails = args[:primary_emails] if args.key?(:primary_emails)
  @profile = args[:profile] if args.key?(:profile)
  @public_profile = args[:public_profile] if args.key?(:public_profile)
end