Class: Google::Apis::PartnersV2::PartnersService

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/partners_v2/service.rb

Overview

Google Partners API

Searches certified companies and creates contact leads with them, and also audits the usage of clients.

Examples:

require 'google/apis/partners_v2'

Partners = Google::Apis::PartnersV2 # Alias the module
service = Partners::PartnersService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initializePartnersService

Returns a new instance of PartnersService


46
47
48
49
# File 'generated/google/apis/partners_v2/service.rb', line 46

def initialize
  super('https://partners.googleapis.com/', '')
  @batch_path = 'batch'
end

Instance Attribute Details

#keyString

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String)

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.


39
40
41
# File 'generated/google/apis/partners_v2/service.rb', line 39

def key
  @key
end

#quota_userString

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.


44
45
46
# File 'generated/google/apis/partners_v2/service.rb', line 44

def quota_user
  @quota_user
end

Instance Method Details

#create_lead(company_id, create_lead_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PartnersV2::CreateLeadResponse

Creates an advertiser lead for the given company ID.

Parameters:

  • company_id (String)

    The ID of the company to contact.

  • create_lead_request_object (Google::Apis::PartnersV2::CreateLeadRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


384
385
386
387
388
389
390
391
392
393
394
# File 'generated/google/apis/partners_v2/service.rb', line 384

def create_lead(company_id, create_lead_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v2/companies/{companyId}/leads', options)
  command.request_representation = Google::Apis::PartnersV2::CreateLeadRequest::Representation
  command.request_object = create_lead_request_object
  command.response_representation = Google::Apis::PartnersV2::CreateLeadResponse::Representation
  command.response_class = Google::Apis::PartnersV2::CreateLeadResponse
  command.params['companyId'] = company_id unless company_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_user_company_relation(user_id, company_relation_object = nil, request_metadata_experiment_ids: nil, request_metadata_locale: nil, request_metadata_partners_session_id: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_traffic_source_traffic_sub_id: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_user_overrides_user_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PartnersV2::CompanyRelation

Creates a user's company relation. Affiliates the user to a company.

Parameters:

  • user_id (String)

    The ID of the user. Can be set to me to mean the currently authenticated user.

  • company_relation_object (Google::Apis::PartnersV2::CompanyRelation) (defaults to: nil)
  • request_metadata_experiment_ids (Array<String>, String)

    Experiment IDs the current request belongs to.

  • request_metadata_locale (String)

    Locale to use for the current request.

  • request_metadata_partners_session_id (String)

    Google Partners session ID.

  • request_metadata_traffic_source_traffic_source_id (String)

    Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.

  • request_metadata_traffic_source_traffic_sub_id (String)

    Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.

  • request_metadata_user_overrides_ip_address (String)

    IP address to use instead of the user's geo-located IP address.

  • request_metadata_user_overrides_user_id (String)

    Logged-in user ID to impersonate instead of the user's ID.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
# File 'generated/google/apis/partners_v2/service.rb', line 705

def create_user_company_relation(user_id, company_relation_object = nil, request_metadata_experiment_ids: nil, request_metadata_locale: nil, request_metadata_partners_session_id: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_traffic_source_traffic_sub_id: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_user_overrides_user_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:put, 'v2/users/{userId}/companyRelation', options)
  command.request_representation = Google::Apis::PartnersV2::CompanyRelation::Representation
  command.request_object = company_relation_object
  command.response_representation = Google::Apis::PartnersV2::CompanyRelation::Representation
  command.response_class = Google::Apis::PartnersV2::CompanyRelation
  command.params['userId'] = user_id unless user_id.nil?
  command.query['requestMetadata.experimentIds'] =  unless .nil?
  command.query['requestMetadata.locale'] =  unless .nil?
  command.query['requestMetadata.partnersSessionId'] =  unless .nil?
  command.query['requestMetadata.trafficSource.trafficSourceId'] =  unless .nil?
  command.query['requestMetadata.trafficSource.trafficSubId'] =  unless .nil?
  command.query['requestMetadata.userOverrides.ipAddress'] =  unless .nil?
  command.query['requestMetadata.userOverrides.userId'] =  unless .nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_user_company_relation(user_id, request_metadata_experiment_ids: nil, request_metadata_locale: nil, request_metadata_partners_session_id: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_traffic_source_traffic_sub_id: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_user_overrides_user_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PartnersV2::Empty

Deletes a user's company relation. Unaffiliaites the user from a company.

Parameters:

  • user_id (String)

    The ID of the user. Can be set to me to mean the currently authenticated user.

  • request_metadata_experiment_ids (Array<String>, String)

    Experiment IDs the current request belongs to.

  • request_metadata_locale (String)

    Locale to use for the current request.

  • request_metadata_partners_session_id (String)

    Google Partners session ID.

  • request_metadata_traffic_source_traffic_source_id (String)

    Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.

  • request_metadata_traffic_source_traffic_sub_id (String)

    Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.

  • request_metadata_user_overrides_ip_address (String)

    IP address to use instead of the user's geo-located IP address.

  • request_metadata_user_overrides_user_id (String)

    Logged-in user ID to impersonate instead of the user's ID.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
# File 'generated/google/apis/partners_v2/service.rb', line 763

def delete_user_company_relation(user_id, request_metadata_experiment_ids: nil, request_metadata_locale: nil, request_metadata_partners_session_id: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_traffic_source_traffic_sub_id: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_user_overrides_user_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v2/users/{userId}/companyRelation', options)
  command.response_representation = Google::Apis::PartnersV2::Empty::Representation
  command.response_class = Google::Apis::PartnersV2::Empty
  command.params['userId'] = user_id unless user_id.nil?
  command.query['requestMetadata.experimentIds'] =  unless .nil?
  command.query['requestMetadata.locale'] =  unless .nil?
  command.query['requestMetadata.partnersSessionId'] =  unless .nil?
  command.query['requestMetadata.trafficSource.trafficSourceId'] =  unless .nil?
  command.query['requestMetadata.trafficSource.trafficSubId'] =  unless .nil?
  command.query['requestMetadata.userOverrides.ipAddress'] =  unless .nil?
  command.query['requestMetadata.userOverrides.userId'] =  unless .nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_company(company_id, address: nil, currency_code: nil, order_by: nil, request_metadata_experiment_ids: nil, request_metadata_locale: nil, request_metadata_partners_session_id: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_traffic_source_traffic_sub_id: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_user_overrides_user_id: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PartnersV2::GetCompanyResponse

Gets a company.

Parameters:

  • company_id (String)

    The ID of the company to retrieve.

  • address (String)

    The address to use for sorting the company's addresses by proximity. If not given, the geo-located address of the request is used. Used when order_by is set.

  • currency_code (String)

    If the company's budget is in a different currency code than this one, then the converted budget is converted to this currency code.

  • order_by (String)

    How to order addresses within the returned company. Currently, only address and address desc is supported which will sorted by closest to farthest in distance from given address and farthest to closest distance from given address respectively.

  • request_metadata_experiment_ids (Array<String>, String)

    Experiment IDs the current request belongs to.

  • request_metadata_locale (String)

    Locale to use for the current request.

  • request_metadata_partners_session_id (String)

    Google Partners session ID.

  • request_metadata_traffic_source_traffic_source_id (String)

    Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.

  • request_metadata_traffic_source_traffic_sub_id (String)

    Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.

  • request_metadata_user_overrides_ip_address (String)

    IP address to use instead of the user's geo-located IP address.

  • request_metadata_user_overrides_user_id (String)

    Logged-in user ID to impersonate instead of the user's ID.

  • view (String)

    The view of Company resource to be returned. This must not be COMPANY_VIEW_UNSPECIFIED.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
# File 'generated/google/apis/partners_v2/service.rb', line 207

def get_company(company_id, address: nil, currency_code: nil, order_by: nil, request_metadata_experiment_ids: nil, request_metadata_locale: nil, request_metadata_partners_session_id: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_traffic_source_traffic_sub_id: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_user_overrides_user_id: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2/companies/{companyId}', options)
  command.response_representation = Google::Apis::PartnersV2::GetCompanyResponse::Representation
  command.response_class = Google::Apis::PartnersV2::GetCompanyResponse
  command.params['companyId'] = company_id unless company_id.nil?
  command.query['address'] = address unless address.nil?
  command.query['currencyCode'] = currency_code unless currency_code.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['requestMetadata.experimentIds'] =  unless .nil?
  command.query['requestMetadata.locale'] =  unless .nil?
  command.query['requestMetadata.partnersSessionId'] =  unless .nil?
  command.query['requestMetadata.trafficSource.trafficSourceId'] =  unless .nil?
  command.query['requestMetadata.trafficSource.trafficSubId'] =  unless .nil?
  command.query['requestMetadata.userOverrides.ipAddress'] =  unless .nil?
  command.query['requestMetadata.userOverrides.userId'] =  unless .nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_partnersstatus(request_metadata_experiment_ids: nil, request_metadata_locale: nil, request_metadata_partners_session_id: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_traffic_source_traffic_sub_id: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_user_overrides_user_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PartnersV2::GetPartnersStatusResponse

Gets Partners Status of the logged in user's agency. Should only be called if the logged in user is the admin of the agency.

Parameters:

  • request_metadata_experiment_ids (Array<String>, String)

    Experiment IDs the current request belongs to.

  • request_metadata_locale (String)

    Locale to use for the current request.

  • request_metadata_partners_session_id (String)

    Google Partners session ID.

  • request_metadata_traffic_source_traffic_source_id (String)

    Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.

  • request_metadata_traffic_source_traffic_sub_id (String)

    Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.

  • request_metadata_user_overrides_ip_address (String)

    IP address to use instead of the user's geo-located IP address.

  • request_metadata_user_overrides_user_id (String)

    Logged-in user ID to impersonate instead of the user's ID.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
# File 'generated/google/apis/partners_v2/service.rb', line 932

def get_partnersstatus(request_metadata_experiment_ids: nil, request_metadata_locale: nil, request_metadata_partners_session_id: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_traffic_source_traffic_sub_id: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_user_overrides_user_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2/partnersstatus', options)
  command.response_representation = Google::Apis::PartnersV2::GetPartnersStatusResponse::Representation
  command.response_class = Google::Apis::PartnersV2::GetPartnersStatusResponse
  command.query['requestMetadata.experimentIds'] =  unless .nil?
  command.query['requestMetadata.locale'] =  unless .nil?
  command.query['requestMetadata.partnersSessionId'] =  unless .nil?
  command.query['requestMetadata.trafficSource.trafficSourceId'] =  unless .nil?
  command.query['requestMetadata.trafficSource.trafficSubId'] =  unless .nil?
  command.query['requestMetadata.userOverrides.ipAddress'] =  unless .nil?
  command.query['requestMetadata.userOverrides.userId'] =  unless .nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_user(user_id, request_metadata_experiment_ids: nil, request_metadata_locale: nil, request_metadata_partners_session_id: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_traffic_source_traffic_sub_id: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_user_overrides_user_id: nil, user_view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PartnersV2::User

Gets a user.

Parameters:

  • user_id (String)

    Identifier of the user. Can be set to me to mean the currently authenticated user.

  • request_metadata_experiment_ids (Array<String>, String)

    Experiment IDs the current request belongs to.

  • request_metadata_locale (String)

    Locale to use for the current request.

  • request_metadata_partners_session_id (String)

    Google Partners session ID.

  • request_metadata_traffic_source_traffic_source_id (String)

    Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.

  • request_metadata_traffic_source_traffic_sub_id (String)

    Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.

  • request_metadata_user_overrides_ip_address (String)

    IP address to use instead of the user's geo-located IP address.

  • request_metadata_user_overrides_user_id (String)

    Logged-in user ID to impersonate instead of the user's ID.

  • user_view (String)

    Specifies what parts of the user information to return.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
# File 'generated/google/apis/partners_v2/service.rb', line 821

def get_user(user_id, request_metadata_experiment_ids: nil, request_metadata_locale: nil, request_metadata_partners_session_id: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_traffic_source_traffic_sub_id: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_user_overrides_user_id: nil, user_view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2/users/{userId}', options)
  command.response_representation = Google::Apis::PartnersV2::User::Representation
  command.response_class = Google::Apis::PartnersV2::User
  command.params['userId'] = user_id unless user_id.nil?
  command.query['requestMetadata.experimentIds'] =  unless .nil?
  command.query['requestMetadata.locale'] =  unless .nil?
  command.query['requestMetadata.partnersSessionId'] =  unless .nil?
  command.query['requestMetadata.trafficSource.trafficSourceId'] =  unless .nil?
  command.query['requestMetadata.trafficSource.trafficSubId'] =  unless .nil?
  command.query['requestMetadata.userOverrides.ipAddress'] =  unless .nil?
  command.query['requestMetadata.userOverrides.userId'] =  unless .nil?
  command.query['userView'] = user_view unless user_view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_analytics(page_size: nil, page_token: nil, request_metadata_experiment_ids: nil, request_metadata_locale: nil, request_metadata_partners_session_id: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_traffic_source_traffic_sub_id: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_user_overrides_user_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PartnersV2::ListAnalyticsResponse

Lists analytics data for a user's associated company. Should only be called within the context of an authorized logged in user.

Parameters:

  • page_size (Fixnum)

    Requested page size. Server may return fewer analytics than requested. If unspecified or set to 0, default value is 30. Specifies the number of days in the date range when querying analytics. The page_token represents the end date of the date range and the start date is calculated using the page_size as the number of days BEFORE the end date. Must be a non-negative integer.

  • page_token (String)

    A token identifying a page of results that the server returns. Typically, this is the value of ListAnalyticsResponse.next_page_token returned from the previous call to ListAnalytics. Will be a date string in YYYY-MM-DD format representing the end date of the date range of results to return. If unspecified or set to "", default value is the current date.

  • request_metadata_experiment_ids (Array<String>, String)

    Experiment IDs the current request belongs to.

  • request_metadata_locale (String)

    Locale to use for the current request.

  • request_metadata_partners_session_id (String)

    Google Partners session ID.

  • request_metadata_traffic_source_traffic_source_id (String)

    Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.

  • request_metadata_traffic_source_traffic_sub_id (String)

    Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.

  • request_metadata_user_overrides_ip_address (String)

    IP address to use instead of the user's geo-located IP address.

  • request_metadata_user_overrides_user_id (String)

    Logged-in user ID to impersonate instead of the user's ID.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
# File 'generated/google/apis/partners_v2/service.rb', line 104

def list_analytics(page_size: nil, page_token: nil, request_metadata_experiment_ids: nil, request_metadata_locale: nil, request_metadata_partners_session_id: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_traffic_source_traffic_sub_id: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_user_overrides_user_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2/analytics', options)
  command.response_representation = Google::Apis::PartnersV2::ListAnalyticsResponse::Representation
  command.response_class = Google::Apis::PartnersV2::ListAnalyticsResponse
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['requestMetadata.experimentIds'] =  unless .nil?
  command.query['requestMetadata.locale'] =  unless .nil?
  command.query['requestMetadata.partnersSessionId'] =  unless .nil?
  command.query['requestMetadata.trafficSource.trafficSourceId'] =  unless .nil?
  command.query['requestMetadata.trafficSource.trafficSubId'] =  unless .nil?
  command.query['requestMetadata.userOverrides.ipAddress'] =  unless .nil?
  command.query['requestMetadata.userOverrides.userId'] =  unless .nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_companies(address: nil, company_name: nil, gps_motivations: nil, industries: nil, language_codes: nil, max_monthly_budget_currency_code: nil, max_monthly_budget_nanos: nil, max_monthly_budget_units: nil, min_monthly_budget_currency_code: nil, min_monthly_budget_nanos: nil, min_monthly_budget_units: nil, order_by: nil, page_size: nil, page_token: nil, request_metadata_experiment_ids: nil, request_metadata_locale: nil, request_metadata_partners_session_id: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_traffic_source_traffic_sub_id: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_user_overrides_user_id: nil, services: nil, specializations: nil, view: nil, website_url: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PartnersV2::ListCompaniesResponse

Lists companies.

Parameters:

  • address (String)

    The address to use when searching for companies. If not given, the geo-located address of the request is used.

  • company_name (String)

    Company name to search for.

  • gps_motivations (Array<String>, String)

    List of reasons for using Google Partner Search to get companies.

  • industries (Array<String>, String)

    List of industries the company can help with.

  • language_codes (Array<String>, String)

    List of language codes that company can support. Only primary language subtags are accepted as defined by BCP 47 (IETF BCP 47, "Tags for Identifying Languages").

  • max_monthly_budget_currency_code (String)

    The 3-letter currency code defined in ISO 4217.

  • max_monthly_budget_nanos (Fixnum)

    Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example $-1.75 is represented as units=-1 and nanos=-750,000,000.

  • max_monthly_budget_units (Fixnum)

    The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.

  • min_monthly_budget_currency_code (String)

    The 3-letter currency code defined in ISO 4217.

  • min_monthly_budget_nanos (Fixnum)

    Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example $-1.75 is represented as units=-1 and nanos=-750,000,000.

  • min_monthly_budget_units (Fixnum)

    The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.

  • order_by (String)

    How to order addresses within the returned companies. Currently, only address and address desc is supported which will sorted by closest to farthest in distance from given address and farthest to closest distance from given address respectively.

  • page_size (Fixnum)

    Requested page size. Server may return fewer companies than requested. If unspecified, server picks an appropriate default.

  • page_token (String)

    A token identifying a page of results that the server returns. Typically, this is the value of ListCompaniesResponse.next_page_token returned from the previous call to ListCompanies.

  • request_metadata_experiment_ids (Array<String>, String)

    Experiment IDs the current request belongs to.

  • request_metadata_locale (String)

    Locale to use for the current request.

  • request_metadata_partners_session_id (String)

    Google Partners session ID.

  • request_metadata_traffic_source_traffic_source_id (String)

    Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.

  • request_metadata_traffic_source_traffic_sub_id (String)

    Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.

  • request_metadata_user_overrides_ip_address (String)

    IP address to use instead of the user's geo-located IP address.

  • request_metadata_user_overrides_user_id (String)

    Logged-in user ID to impersonate instead of the user's ID.

  • services (Array<String>, String)

    List of services that the returned agencies should provide. If this is not empty, any returned agency must have at least one of these services, or one of the specializations in the "specializations" field.

  • specializations (Array<String>, String)

    List of specializations that the returned agencies should provide. If this is not empty, any returned agency must have at least one of these specializations, or one of the services in the "services" field.

  • view (String)

    The view of the Company resource to be returned. This must not be COMPANY_VIEW_UNSPECIFIED.

  • website_url (String)

    Website URL that will help to find a better matched company. .

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
# File 'generated/google/apis/partners_v2/service.rb', line 329

def list_companies(address: nil, company_name: nil, gps_motivations: nil, industries: nil, language_codes: nil, max_monthly_budget_currency_code: nil, max_monthly_budget_nanos: nil, max_monthly_budget_units: nil, min_monthly_budget_currency_code: nil, min_monthly_budget_nanos: nil, min_monthly_budget_units: nil, order_by: nil, page_size: nil, page_token: nil, request_metadata_experiment_ids: nil, request_metadata_locale: nil, request_metadata_partners_session_id: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_traffic_source_traffic_sub_id: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_user_overrides_user_id: nil, services: nil, specializations: nil, view: nil, website_url: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2/companies', options)
  command.response_representation = Google::Apis::PartnersV2::ListCompaniesResponse::Representation
  command.response_class = Google::Apis::PartnersV2::ListCompaniesResponse
  command.query['address'] = address unless address.nil?
  command.query['companyName'] = company_name unless company_name.nil?
  command.query['gpsMotivations'] = gps_motivations unless gps_motivations.nil?
  command.query['industries'] = industries unless industries.nil?
  command.query['languageCodes'] = language_codes unless language_codes.nil?
  command.query['maxMonthlyBudget.currencyCode'] = max_monthly_budget_currency_code unless max_monthly_budget_currency_code.nil?
  command.query['maxMonthlyBudget.nanos'] = max_monthly_budget_nanos unless max_monthly_budget_nanos.nil?
  command.query['maxMonthlyBudget.units'] = max_monthly_budget_units unless max_monthly_budget_units.nil?
  command.query['minMonthlyBudget.currencyCode'] = min_monthly_budget_currency_code unless min_monthly_budget_currency_code.nil?
  command.query['minMonthlyBudget.nanos'] = min_monthly_budget_nanos unless min_monthly_budget_nanos.nil?
  command.query['minMonthlyBudget.units'] = min_monthly_budget_units unless min_monthly_budget_units.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['requestMetadata.experimentIds'] =  unless .nil?
  command.query['requestMetadata.locale'] =  unless .nil?
  command.query['requestMetadata.partnersSessionId'] =  unless .nil?
  command.query['requestMetadata.trafficSource.trafficSourceId'] =  unless .nil?
  command.query['requestMetadata.trafficSource.trafficSubId'] =  unless .nil?
  command.query['requestMetadata.userOverrides.ipAddress'] =  unless .nil?
  command.query['requestMetadata.userOverrides.userId'] =  unless .nil?
  command.query['services'] = services unless services.nil?
  command.query['specializations'] = specializations unless specializations.nil?
  command.query['view'] = view unless view.nil?
  command.query['websiteUrl'] = website_url unless website_url.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_leads(order_by: nil, page_size: nil, page_token: nil, request_metadata_experiment_ids: nil, request_metadata_locale: nil, request_metadata_partners_session_id: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_traffic_source_traffic_sub_id: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_user_overrides_user_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PartnersV2::ListLeadsResponse

Lists advertiser leads for a user's associated company. Should only be called within the context of an authorized logged in user.

Parameters:

  • order_by (String)

    How to order Leads. Currently, only create_time and create_time desc are supported

  • page_size (Fixnum)

    Requested page size. Server may return fewer leads than requested. If unspecified, server picks an appropriate default.

  • page_token (String)

    A token identifying a page of results that the server returns. Typically, this is the value of ListLeadsResponse.next_page_token returned from the previous call to ListLeads.

  • request_metadata_experiment_ids (Array<String>, String)

    Experiment IDs the current request belongs to.

  • request_metadata_locale (String)

    Locale to use for the current request.

  • request_metadata_partners_session_id (String)

    Google Partners session ID.

  • request_metadata_traffic_source_traffic_source_id (String)

    Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.

  • request_metadata_traffic_source_traffic_sub_id (String)

    Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.

  • request_metadata_user_overrides_ip_address (String)

    IP address to use instead of the user's geo-located IP address.

  • request_metadata_user_overrides_user_id (String)

    Logged-in user ID to impersonate instead of the user's ID.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
# File 'generated/google/apis/partners_v2/service.rb', line 444

def list_leads(order_by: nil, page_size: nil, page_token: nil, request_metadata_experiment_ids: nil, request_metadata_locale: nil, request_metadata_partners_session_id: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_traffic_source_traffic_sub_id: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_user_overrides_user_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2/leads', options)
  command.response_representation = Google::Apis::PartnersV2::ListLeadsResponse::Representation
  command.response_class = Google::Apis::PartnersV2::ListLeadsResponse
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['requestMetadata.experimentIds'] =  unless .nil?
  command.query['requestMetadata.locale'] =  unless .nil?
  command.query['requestMetadata.partnersSessionId'] =  unless .nil?
  command.query['requestMetadata.trafficSource.trafficSourceId'] =  unless .nil?
  command.query['requestMetadata.trafficSource.trafficSubId'] =  unless .nil?
  command.query['requestMetadata.userOverrides.ipAddress'] =  unless .nil?
  command.query['requestMetadata.userOverrides.userId'] =  unless .nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_offer_histories(entire_company: nil, order_by: nil, page_size: nil, page_token: nil, request_metadata_experiment_ids: nil, request_metadata_locale: nil, request_metadata_partners_session_id: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_traffic_source_traffic_sub_id: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_user_overrides_user_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PartnersV2::ListOffersHistoryResponse

Lists the Historical Offers for the current user (or user's entire company)

Parameters:

  • entire_company (Boolean)

    if true, show history for the entire company. Requires user to be admin.

  • order_by (String)

    Comma-separated list of fields to order by, e.g.: "foo,bar,baz". Use "foo desc" to sort descending. List of valid field names is: name, offer_code, expiration_time, status, last_modified_time, sender_name, creation_time, country_code, offer_type.

  • page_size (Fixnum)

    Maximum number of rows to return per page.

  • page_token (String)

    Token to retrieve a specific page.

  • request_metadata_experiment_ids (Array<String>, String)

    Experiment IDs the current request belongs to.

  • request_metadata_locale (String)

    Locale to use for the current request.

  • request_metadata_partners_session_id (String)

    Google Partners session ID.

  • request_metadata_traffic_source_traffic_source_id (String)

    Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.

  • request_metadata_traffic_source_traffic_sub_id (String)

    Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.

  • request_metadata_user_overrides_ip_address (String)

    IP address to use instead of the user's geo-located IP address.

  • request_metadata_user_overrides_user_id (String)

    Logged-in user ID to impersonate instead of the user's ID.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
# File 'generated/google/apis/partners_v2/service.rb', line 563

def list_offer_histories(entire_company: nil, order_by: nil, page_size: nil, page_token: nil, request_metadata_experiment_ids: nil, request_metadata_locale: nil, request_metadata_partners_session_id: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_traffic_source_traffic_sub_id: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_user_overrides_user_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2/offers/history', options)
  command.response_representation = Google::Apis::PartnersV2::ListOffersHistoryResponse::Representation
  command.response_class = Google::Apis::PartnersV2::ListOffersHistoryResponse
  command.query['entireCompany'] = entire_company unless entire_company.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['requestMetadata.experimentIds'] =  unless .nil?
  command.query['requestMetadata.locale'] =  unless .nil?
  command.query['requestMetadata.partnersSessionId'] =  unless .nil?
  command.query['requestMetadata.trafficSource.trafficSourceId'] =  unless .nil?
  command.query['requestMetadata.trafficSource.trafficSubId'] =  unless .nil?
  command.query['requestMetadata.userOverrides.ipAddress'] =  unless .nil?
  command.query['requestMetadata.userOverrides.userId'] =  unless .nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_offers(request_metadata_experiment_ids: nil, request_metadata_locale: nil, request_metadata_partners_session_id: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_traffic_source_traffic_sub_id: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_user_overrides_user_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PartnersV2::ListOffersResponse

Lists the Offers available for the current user

Parameters:

  • request_metadata_experiment_ids (Array<String>, String)

    Experiment IDs the current request belongs to.

  • request_metadata_locale (String)

    Locale to use for the current request.

  • request_metadata_partners_session_id (String)

    Google Partners session ID.

  • request_metadata_traffic_source_traffic_source_id (String)

    Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.

  • request_metadata_traffic_source_traffic_sub_id (String)

    Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.

  • request_metadata_user_overrides_ip_address (String)

    IP address to use instead of the user's geo-located IP address.

  • request_metadata_user_overrides_user_id (String)

    Logged-in user ID to impersonate instead of the user's ID.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
# File 'generated/google/apis/partners_v2/service.rb', line 499

def list_offers(request_metadata_experiment_ids: nil, request_metadata_locale: nil, request_metadata_partners_session_id: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_traffic_source_traffic_sub_id: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_user_overrides_user_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2/offers', options)
  command.response_representation = Google::Apis::PartnersV2::ListOffersResponse::Representation
  command.response_class = Google::Apis::PartnersV2::ListOffersResponse
  command.query['requestMetadata.experimentIds'] =  unless .nil?
  command.query['requestMetadata.locale'] =  unless .nil?
  command.query['requestMetadata.partnersSessionId'] =  unless .nil?
  command.query['requestMetadata.trafficSource.trafficSourceId'] =  unless .nil?
  command.query['requestMetadata.trafficSource.trafficSubId'] =  unless .nil?
  command.query['requestMetadata.userOverrides.ipAddress'] =  unless .nil?
  command.query['requestMetadata.userOverrides.userId'] =  unless .nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_user_states(request_metadata_experiment_ids: nil, request_metadata_locale: nil, request_metadata_partners_session_id: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_traffic_source_traffic_sub_id: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_user_overrides_user_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PartnersV2::ListUserStatesResponse

Lists states for current user.

Parameters:

  • request_metadata_experiment_ids (Array<String>, String)

    Experiment IDs the current request belongs to.

  • request_metadata_locale (String)

    Locale to use for the current request.

  • request_metadata_partners_session_id (String)

    Google Partners session ID.

  • request_metadata_traffic_source_traffic_source_id (String)

    Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.

  • request_metadata_traffic_source_traffic_sub_id (String)

    Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.

  • request_metadata_user_overrides_ip_address (String)

    IP address to use instead of the user's geo-located IP address.

  • request_metadata_user_overrides_user_id (String)

    Logged-in user ID to impersonate instead of the user's ID.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
# File 'generated/google/apis/partners_v2/service.rb', line 649

def list_user_states(request_metadata_experiment_ids: nil, request_metadata_locale: nil, request_metadata_partners_session_id: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_traffic_source_traffic_sub_id: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_user_overrides_user_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2/userStates', options)
  command.response_representation = Google::Apis::PartnersV2::ListUserStatesResponse::Representation
  command.response_class = Google::Apis::PartnersV2::ListUserStatesResponse
  command.query['requestMetadata.experimentIds'] =  unless .nil?
  command.query['requestMetadata.locale'] =  unless .nil?
  command.query['requestMetadata.partnersSessionId'] =  unless .nil?
  command.query['requestMetadata.trafficSource.trafficSourceId'] =  unless .nil?
  command.query['requestMetadata.trafficSource.trafficSubId'] =  unless .nil?
  command.query['requestMetadata.userOverrides.ipAddress'] =  unless .nil?
  command.query['requestMetadata.userOverrides.userId'] =  unless .nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#log_client_message_message(log_message_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PartnersV2::LogMessageResponse

Logs a generic message from the client, such as Failed to render component, Profile page is running slow, More than 500 users have accessed this result., etc.

Parameters:

  • log_message_request_object (Google::Apis::PartnersV2::LogMessageRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


143
144
145
146
147
148
149
150
151
152
# File 'generated/google/apis/partners_v2/service.rb', line 143

def log_client_message_message(log_message_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v2/clientMessages:log', options)
  command.request_representation = Google::Apis::PartnersV2::LogMessageRequest::Representation
  command.request_object = log_message_request_object
  command.response_representation = Google::Apis::PartnersV2::LogMessageResponse::Representation
  command.response_class = Google::Apis::PartnersV2::LogMessageResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#log_user_event(log_user_event_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PartnersV2::LogUserEventResponse

Logs a user event.

Parameters:

  • log_user_event_request_object (Google::Apis::PartnersV2::LogUserEventRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


602
603
604
605
606
607
608
609
610
611
# File 'generated/google/apis/partners_v2/service.rb', line 602

def log_user_event(log_user_event_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v2/userEvents:log', options)
  command.request_representation = Google::Apis::PartnersV2::LogUserEventRequest::Representation
  command.request_object = log_user_event_request_object
  command.response_representation = Google::Apis::PartnersV2::LogUserEventResponse::Representation
  command.response_class = Google::Apis::PartnersV2::LogUserEventResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_companies(company_object = nil, request_metadata_experiment_ids: nil, request_metadata_locale: nil, request_metadata_partners_session_id: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_traffic_source_traffic_sub_id: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_user_overrides_user_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PartnersV2::Company

Update company. Should only be called within the context of an authorized logged in user.

Parameters:

  • company_object (Google::Apis::PartnersV2::Company) (defaults to: nil)
  • request_metadata_experiment_ids (Array<String>, String)

    Experiment IDs the current request belongs to.

  • request_metadata_locale (String)

    Locale to use for the current request.

  • request_metadata_partners_session_id (String)

    Google Partners session ID.

  • request_metadata_traffic_source_traffic_source_id (String)

    Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.

  • request_metadata_traffic_source_traffic_sub_id (String)

    Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.

  • request_metadata_user_overrides_ip_address (String)

    IP address to use instead of the user's geo-located IP address.

  • request_metadata_user_overrides_user_id (String)

    Logged-in user ID to impersonate instead of the user's ID.

  • update_mask (String)

    Standard field mask for the set of fields to be updated. Required with at least 1 value in FieldMask's paths.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
# File 'generated/google/apis/partners_v2/service.rb', line 989

def update_companies(company_object = nil, request_metadata_experiment_ids: nil, request_metadata_locale: nil, request_metadata_partners_session_id: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_traffic_source_traffic_sub_id: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_user_overrides_user_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'v2/companies', options)
  command.request_representation = Google::Apis::PartnersV2::Company::Representation
  command.request_object = company_object
  command.response_representation = Google::Apis::PartnersV2::Company::Representation
  command.response_class = Google::Apis::PartnersV2::Company
  command.query['requestMetadata.experimentIds'] =  unless .nil?
  command.query['requestMetadata.locale'] =  unless .nil?
  command.query['requestMetadata.partnersSessionId'] =  unless .nil?
  command.query['requestMetadata.trafficSource.trafficSourceId'] =  unless .nil?
  command.query['requestMetadata.trafficSource.trafficSubId'] =  unless .nil?
  command.query['requestMetadata.userOverrides.ipAddress'] =  unless .nil?
  command.query['requestMetadata.userOverrides.userId'] =  unless .nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_leads(lead_object = nil, request_metadata_experiment_ids: nil, request_metadata_locale: nil, request_metadata_partners_session_id: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_traffic_source_traffic_sub_id: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_user_overrides_user_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PartnersV2::Lead

Updates the specified lead.

Parameters:

  • lead_object (Google::Apis::PartnersV2::Lead) (defaults to: nil)
  • request_metadata_experiment_ids (Array<String>, String)

    Experiment IDs the current request belongs to.

  • request_metadata_locale (String)

    Locale to use for the current request.

  • request_metadata_partners_session_id (String)

    Google Partners session ID.

  • request_metadata_traffic_source_traffic_source_id (String)

    Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.

  • request_metadata_traffic_source_traffic_sub_id (String)

    Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.

  • request_metadata_user_overrides_ip_address (String)

    IP address to use instead of the user's geo-located IP address.

  • request_metadata_user_overrides_user_id (String)

    Logged-in user ID to impersonate instead of the user's ID.

  • update_mask (String)

    Standard field mask for the set of fields to be updated. Required with at least 1 value in FieldMask's paths. Only state and adwords_customer_id are currently supported.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
# File 'generated/google/apis/partners_v2/service.rb', line 1049

def update_leads(lead_object = nil, request_metadata_experiment_ids: nil, request_metadata_locale: nil, request_metadata_partners_session_id: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_traffic_source_traffic_sub_id: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_user_overrides_user_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'v2/leads', options)
  command.request_representation = Google::Apis::PartnersV2::Lead::Representation
  command.request_object = lead_object
  command.response_representation = Google::Apis::PartnersV2::Lead::Representation
  command.response_class = Google::Apis::PartnersV2::Lead
  command.query['requestMetadata.experimentIds'] =  unless .nil?
  command.query['requestMetadata.locale'] =  unless .nil?
  command.query['requestMetadata.partnersSessionId'] =  unless .nil?
  command.query['requestMetadata.trafficSource.trafficSourceId'] =  unless .nil?
  command.query['requestMetadata.trafficSource.trafficSubId'] =  unless .nil?
  command.query['requestMetadata.userOverrides.ipAddress'] =  unless .nil?
  command.query['requestMetadata.userOverrides.userId'] =  unless .nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_user_profile(user_profile_object = nil, request_metadata_experiment_ids: nil, request_metadata_locale: nil, request_metadata_partners_session_id: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_traffic_source_traffic_sub_id: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_user_overrides_user_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PartnersV2::UserProfile

Updates a user's profile. A user can only update their own profile and should only be called within the context of a logged in user.

Parameters:

  • user_profile_object (Google::Apis::PartnersV2::UserProfile) (defaults to: nil)
  • request_metadata_experiment_ids (Array<String>, String)

    Experiment IDs the current request belongs to.

  • request_metadata_locale (String)

    Locale to use for the current request.

  • request_metadata_partners_session_id (String)

    Google Partners session ID.

  • request_metadata_traffic_source_traffic_source_id (String)

    Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.

  • request_metadata_traffic_source_traffic_sub_id (String)

    Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.

  • request_metadata_user_overrides_ip_address (String)

    IP address to use instead of the user's geo-located IP address.

  • request_metadata_user_overrides_user_id (String)

    Logged-in user ID to impersonate instead of the user's ID.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
# File 'generated/google/apis/partners_v2/service.rb', line 877

def ( = nil, request_metadata_experiment_ids: nil, request_metadata_locale: nil, request_metadata_partners_session_id: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_traffic_source_traffic_sub_id: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_user_overrides_user_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'v2/users/profile', options)
  command.request_representation = Google::Apis::PartnersV2::UserProfile::Representation
  command.request_object = 
  command.response_representation = Google::Apis::PartnersV2::UserProfile::Representation
  command.response_class = Google::Apis::PartnersV2::UserProfile
  command.query['requestMetadata.experimentIds'] =  unless .nil?
  command.query['requestMetadata.locale'] =  unless .nil?
  command.query['requestMetadata.partnersSessionId'] =  unless .nil?
  command.query['requestMetadata.trafficSource.trafficSourceId'] =  unless .nil?
  command.query['requestMetadata.trafficSource.trafficSubId'] =  unless .nil?
  command.query['requestMetadata.userOverrides.ipAddress'] =  unless .nil?
  command.query['requestMetadata.userOverrides.userId'] =  unless .nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end