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



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

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

Instance Attribute Details

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



2026
2027
2028
 
# File 'generated/google/apis/partners_v2/classes.rb', line 2026

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:



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

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:



2039
2040
2041
 
# File 'generated/google/apis/partners_v2/classes.rb', line 2039

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) 


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

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:



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

def exam_status
  @exam_status
end

#id ⇒ String

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

Returns:

  • (String) 


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

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) 


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

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) 


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

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


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

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:



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

def profile
  @profile
end

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

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

Returns:



2084
2085
2086
 
# File 'generated/google/apis/partners_v2/classes.rb', line 2084

def public_profile
  @public_profile
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
 
# File 'generated/google/apis/partners_v2/classes.rb', line 2091

def update!(**args)
  @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