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



2094
2095
2096
 
# File 'generated/google/apis/partners_v2/classes.rb', line 2094

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) 


2024
2025
2026
 
# File 'generated/google/apis/partners_v2/classes.rb', line 2024

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:



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

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:



2041
2042
2043
 
# File 'generated/google/apis/partners_v2/classes.rb', line 2041

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:



2047
2048
2049
 
# File 'generated/google/apis/partners_v2/classes.rb', line 2047

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) 


2053
2054
2055
 
# File 'generated/google/apis/partners_v2/classes.rb', line 2053

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:



2059
2060
2061
 
# File 'generated/google/apis/partners_v2/classes.rb', line 2059

def exam_status
  @exam_status
end

#id ⇒ String

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

Returns:

  • (String) 


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

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) 


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

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) 


2076
2077
2078
 
# File 'generated/google/apis/partners_v2/classes.rb', line 2076

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


2082
2083
2084
 
# File 'generated/google/apis/partners_v2/classes.rb', line 2082

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:



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

def profile
  @profile
end

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

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

Returns:



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

def public_profile
  @public_profile
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
 
# File 'generated/google/apis/partners_v2/classes.rb', line 2099

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