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

Constructor Details

#initialize ⇒ PartnersService

Returns a new instance of PartnersService



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

def initialize
  super('https://partners.googleapis.com/', '')
end

Instance Attribute Details

#key ⇒ String

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_user ⇒ String

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, quota_user: nil, fields: 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)
  • 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.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



818
819
820
821
822
823
824
825
826
827
828
 
# File 'generated/google/apis/partners_v2/service.rb', line 818

def create_lead(company_id, create_lead_request_object = nil, quota_user: nil, fields: 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['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.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_traffic_source_traffic_sub_id: nil, request_metadata_partners_session_id: nil, request_metadata_user_overrides_user_id: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_locale: nil, request_metadata_user_overrides_ip_address: nil, quota_user: nil, fields: 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_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_partners_session_id (String) —

    Google Partners session ID.

  • request_metadata_user_overrides_user_id (String) —

    Logged-in user ID to impersonate instead of the user's 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_locale (String) —

    Locale to use for the current request.

  • request_metadata_user_overrides_ip_address (String) —

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

  • 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.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
 
# File 'generated/google/apis/partners_v2/service.rb', line 870

def create_user_company_relation(user_id, company_relation_object = nil, request_metadata_experiment_ids: nil, request_metadata_traffic_source_traffic_sub_id: nil, request_metadata_partners_session_id: nil, request_metadata_user_overrides_user_id: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_locale: nil, request_metadata_user_overrides_ip_address: nil, quota_user: nil, fields: 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'] = request_metadata_experiment_ids unless request_metadata_experiment_ids.nil?
  command.query['requestMetadata.trafficSource.trafficSubId'] = request_metadata_traffic_source_traffic_sub_id unless request_metadata_traffic_source_traffic_sub_id.nil?
  command.query['requestMetadata.partnersSessionId'] = request_metadata_partners_session_id unless request_metadata_partners_session_id.nil?
  command.query['requestMetadata.userOverrides.userId'] = request_metadata_user_overrides_user_id unless request_metadata_user_overrides_user_id.nil?
  command.query['requestMetadata.trafficSource.trafficSourceId'] = request_metadata_traffic_source_traffic_source_id unless request_metadata_traffic_source_traffic_source_id.nil?
  command.query['requestMetadata.locale'] = request_metadata_locale unless request_metadata_locale.nil?
  command.query['requestMetadata.userOverrides.ipAddress'] = request_metadata_user_overrides_ip_address unless request_metadata_user_overrides_ip_address.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#delete_user_company_relation(user_id, request_metadata_user_overrides_user_id: nil, request_metadata_partners_session_id: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_locale: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_experiment_ids: nil, request_metadata_traffic_source_traffic_sub_id: nil, quota_user: nil, fields: 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_user_overrides_user_id (String) —

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

  • 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_locale (String) —

    Locale to use for the current request.

  • request_metadata_user_overrides_ip_address (String) —

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

  • request_metadata_experiment_ids (Array<String>, String) —

    Experiment IDs the current request belongs to.

  • 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.

  • 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.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
 
# File 'generated/google/apis/partners_v2/service.rb', line 928

def delete_user_company_relation(user_id, request_metadata_user_overrides_user_id: nil, request_metadata_partners_session_id: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_locale: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_experiment_ids: nil, request_metadata_traffic_source_traffic_sub_id: nil, quota_user: nil, fields: 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.userOverrides.userId'] = request_metadata_user_overrides_user_id unless request_metadata_user_overrides_user_id.nil?
  command.query['requestMetadata.partnersSessionId'] = request_metadata_partners_session_id unless request_metadata_partners_session_id.nil?
  command.query['requestMetadata.trafficSource.trafficSourceId'] = request_metadata_traffic_source_traffic_source_id unless request_metadata_traffic_source_traffic_source_id.nil?
  command.query['requestMetadata.locale'] = request_metadata_locale unless request_metadata_locale.nil?
  command.query['requestMetadata.userOverrides.ipAddress'] = request_metadata_user_overrides_ip_address unless request_metadata_user_overrides_ip_address.nil?
  command.query['requestMetadata.experimentIds'] = request_metadata_experiment_ids unless request_metadata_experiment_ids.nil?
  command.query['requestMetadata.trafficSource.trafficSubId'] = request_metadata_traffic_source_traffic_sub_id unless request_metadata_traffic_source_traffic_sub_id.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

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

Gets a company.

Parameters:

  • company_id (String) —

    The ID of the company to retrieve.

  • 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_user_overrides_ip_address (String) —

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

  • request_metadata_experiment_ids (Array<String>, String) —

    Experiment IDs the current request belongs to.

  • 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_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_user_id (String) —

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

  • request_metadata_partners_session_id (String) —

    Google Partners session ID.

  • view (String) —

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

  • 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.

  • request_metadata_locale (String) —

    Locale to use for the current request.

  • 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.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
 
# File 'generated/google/apis/partners_v2/service.rb', line 641

def get_company(company_id, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_experiment_ids: nil, currency_code: nil, order_by: nil, request_metadata_traffic_source_traffic_sub_id: nil, request_metadata_user_overrides_user_id: nil, request_metadata_partners_session_id: nil, view: nil, address: nil, request_metadata_locale: nil, quota_user: nil, fields: 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['requestMetadata.trafficSource.trafficSourceId'] = request_metadata_traffic_source_traffic_source_id unless request_metadata_traffic_source_traffic_source_id.nil?
  command.query['requestMetadata.userOverrides.ipAddress'] = request_metadata_user_overrides_ip_address unless request_metadata_user_overrides_ip_address.nil?
  command.query['requestMetadata.experimentIds'] = request_metadata_experiment_ids unless request_metadata_experiment_ids.nil?
  command.query['currencyCode'] = currency_code unless currency_code.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['requestMetadata.trafficSource.trafficSubId'] = request_metadata_traffic_source_traffic_sub_id unless request_metadata_traffic_source_traffic_sub_id.nil?
  command.query['requestMetadata.userOverrides.userId'] = request_metadata_user_overrides_user_id unless request_metadata_user_overrides_user_id.nil?
  command.query['requestMetadata.partnersSessionId'] = request_metadata_partners_session_id unless request_metadata_partners_session_id.nil?
  command.query['view'] = view unless view.nil?
  command.query['address'] = address unless address.nil?
  command.query['requestMetadata.locale'] = request_metadata_locale unless request_metadata_locale.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

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

Gets an Exam Token for a Partner's user to take an exam in the Exams System

Parameters:

  • exam_type (String) —

    The exam type we are requesting a token for.

  • 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_locale (String) —

    Locale to use for the current request.

  • request_metadata_user_overrides_ip_address (String) —

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

  • request_metadata_experiment_ids (Array<String>, String) —

    Experiment IDs the current request belongs to.

  • 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_partners_session_id (String) —

    Google Partners session ID.

  • request_metadata_user_overrides_user_id (String) —

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

  • 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.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'generated/google/apis/partners_v2/service.rb', line 88

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

#get_partnersstatus(request_metadata_experiment_ids: nil, request_metadata_traffic_source_traffic_sub_id: nil, request_metadata_user_overrides_user_id: nil, request_metadata_partners_session_id: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_locale: nil, request_metadata_user_overrides_ip_address: nil, quota_user: nil, fields: 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_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_user_id (String) —

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

  • 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_locale (String) —

    Locale to use for the current request.

  • request_metadata_user_overrides_ip_address (String) —

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

  • 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.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
 
# File 'generated/google/apis/partners_v2/service.rb', line 452

def get_partnersstatus(request_metadata_experiment_ids: nil, request_metadata_traffic_source_traffic_sub_id: nil, request_metadata_user_overrides_user_id: nil, request_metadata_partners_session_id: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_locale: nil, request_metadata_user_overrides_ip_address: nil, quota_user: nil, fields: 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'] = request_metadata_experiment_ids unless request_metadata_experiment_ids.nil?
  command.query['requestMetadata.trafficSource.trafficSubId'] = request_metadata_traffic_source_traffic_sub_id unless request_metadata_traffic_source_traffic_sub_id.nil?
  command.query['requestMetadata.userOverrides.userId'] = request_metadata_user_overrides_user_id unless request_metadata_user_overrides_user_id.nil?
  command.query['requestMetadata.partnersSessionId'] = request_metadata_partners_session_id unless request_metadata_partners_session_id.nil?
  command.query['requestMetadata.trafficSource.trafficSourceId'] = request_metadata_traffic_source_traffic_source_id unless request_metadata_traffic_source_traffic_source_id.nil?
  command.query['requestMetadata.locale'] = request_metadata_locale unless request_metadata_locale.nil?
  command.query['requestMetadata.userOverrides.ipAddress'] = request_metadata_user_overrides_ip_address unless request_metadata_user_overrides_ip_address.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#get_user(user_id, request_metadata_partners_session_id: nil, request_metadata_user_overrides_user_id: nil, user_view: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_locale: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_experiment_ids: nil, request_metadata_traffic_source_traffic_sub_id: nil, quota_user: nil, fields: 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_partners_session_id (String) —

    Google Partners session ID.

  • 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.

  • 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_locale (String) —

    Locale to use for the current request.

  • request_metadata_user_overrides_ip_address (String) —

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

  • request_metadata_experiment_ids (Array<String>, String) —

    Experiment IDs the current request belongs to.

  • 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.

  • 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.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
 
# File 'generated/google/apis/partners_v2/service.rb', line 986

def get_user(user_id, request_metadata_partners_session_id: nil, request_metadata_user_overrides_user_id: nil, user_view: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_locale: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_experiment_ids: nil, request_metadata_traffic_source_traffic_sub_id: nil, quota_user: nil, fields: 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.partnersSessionId'] = request_metadata_partners_session_id unless request_metadata_partners_session_id.nil?
  command.query['requestMetadata.userOverrides.userId'] = request_metadata_user_overrides_user_id unless request_metadata_user_overrides_user_id.nil?
  command.query['userView'] = user_view unless user_view.nil?
  command.query['requestMetadata.trafficSource.trafficSourceId'] = request_metadata_traffic_source_traffic_source_id unless request_metadata_traffic_source_traffic_source_id.nil?
  command.query['requestMetadata.locale'] = request_metadata_locale unless request_metadata_locale.nil?
  command.query['requestMetadata.userOverrides.ipAddress'] = request_metadata_user_overrides_ip_address unless request_metadata_user_overrides_ip_address.nil?
  command.query['requestMetadata.experimentIds'] = request_metadata_experiment_ids unless request_metadata_experiment_ids.nil?
  command.query['requestMetadata.trafficSource.trafficSubId'] = request_metadata_traffic_source_traffic_sub_id unless request_metadata_traffic_source_traffic_sub_id.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#list_analytics(page_size: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_locale: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_experiment_ids: nil, request_metadata_traffic_source_traffic_sub_id: nil, request_metadata_user_overrides_user_id: nil, request_metadata_partners_session_id: nil, page_token: nil, quota_user: nil, fields: 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.

  • 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_locale (String) —

    Locale to use for the current request.

  • request_metadata_user_overrides_ip_address (String) —

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

  • request_metadata_experiment_ids (Array<String>, String) —

    Experiment IDs the current request belongs to.

  • 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_user_id (String) —

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

  • request_metadata_partners_session_id (String) —

    Google Partners session ID.

  • 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.

  • 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.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'generated/google/apis/partners_v2/service.rb', line 397

def list_analytics(page_size: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_locale: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_experiment_ids: nil, request_metadata_traffic_source_traffic_sub_id: nil, request_metadata_user_overrides_user_id: nil, request_metadata_partners_session_id: nil, page_token: nil, quota_user: nil, fields: 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['requestMetadata.trafficSource.trafficSourceId'] = request_metadata_traffic_source_traffic_source_id unless request_metadata_traffic_source_traffic_source_id.nil?
  command.query['requestMetadata.locale'] = request_metadata_locale unless request_metadata_locale.nil?
  command.query['requestMetadata.userOverrides.ipAddress'] = request_metadata_user_overrides_ip_address unless request_metadata_user_overrides_ip_address.nil?
  command.query['requestMetadata.experimentIds'] = request_metadata_experiment_ids unless request_metadata_experiment_ids.nil?
  command.query['requestMetadata.trafficSource.trafficSubId'] = request_metadata_traffic_source_traffic_sub_id unless request_metadata_traffic_source_traffic_sub_id.nil?
  command.query['requestMetadata.userOverrides.userId'] = request_metadata_user_overrides_user_id unless request_metadata_user_overrides_user_id.nil?
  command.query['requestMetadata.partnersSessionId'] = request_metadata_partners_session_id unless request_metadata_partners_session_id.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

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

Lists companies.

Parameters:

  • max_monthly_budget_currency_code (String) —

    The 3-letter currency code defined in ISO 4217.

  • min_monthly_budget_currency_code (String) —

    The 3-letter currency code defined in ISO 4217.

  • request_metadata_user_overrides_user_id (String) —

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

  • view (String) —

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

  • request_metadata_locale (String) —

    Locale to use for the current request.

  • address (String) —

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

  • min_monthly_budget_units (String) —

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

  • 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.

  • 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.

  • max_monthly_budget_units (String) —

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

  • 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.

  • 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.

  • request_metadata_partners_session_id (String) —

    Google Partners session ID.

  • 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.

  • company_name (String) —

    Company name to search for.

  • industries (Array<String>, String) —

    List of industries the company can help with.

  • website_url (String) —

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

  • gps_motivations (Array<String>, String) —

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

  • 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").

  • page_size (Fixnum) —

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

  • request_metadata_user_overrides_ip_address (String) —

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

  • request_metadata_experiment_ids (Array<String>, String) —

    Experiment IDs the current request belongs to.

  • 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.

  • 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.

  • 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.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • 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
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
 
# File 'generated/google/apis/partners_v2/service.rb', line 763

def list_companies(max_monthly_budget_currency_code: nil, min_monthly_budget_currency_code: nil, request_metadata_user_overrides_user_id: nil, view: nil, request_metadata_locale: nil, address: nil, min_monthly_budget_units: nil, max_monthly_budget_nanos: nil, services: nil, max_monthly_budget_units: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_traffic_source_traffic_sub_id: nil, min_monthly_budget_nanos: nil, request_metadata_partners_session_id: nil, page_token: nil, company_name: nil, industries: nil, website_url: nil, gps_motivations: nil, language_codes: nil, page_size: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_experiment_ids: nil, order_by: nil, specializations: nil, quota_user: nil, fields: 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['maxMonthlyBudget.currencyCode'] = max_monthly_budget_currency_code unless max_monthly_budget_currency_code.nil?
  command.query['minMonthlyBudget.currencyCode'] = min_monthly_budget_currency_code unless min_monthly_budget_currency_code.nil?
  command.query['requestMetadata.userOverrides.userId'] = request_metadata_user_overrides_user_id unless request_metadata_user_overrides_user_id.nil?
  command.query['view'] = view unless view.nil?
  command.query['requestMetadata.locale'] = request_metadata_locale unless request_metadata_locale.nil?
  command.query['address'] = address unless address.nil?
  command.query['minMonthlyBudget.units'] = min_monthly_budget_units unless min_monthly_budget_units.nil?
  command.query['maxMonthlyBudget.nanos'] = max_monthly_budget_nanos unless max_monthly_budget_nanos.nil?
  command.query['services'] = services unless services.nil?
  command.query['maxMonthlyBudget.units'] = max_monthly_budget_units unless max_monthly_budget_units.nil?
  command.query['requestMetadata.trafficSource.trafficSourceId'] = request_metadata_traffic_source_traffic_source_id unless request_metadata_traffic_source_traffic_source_id.nil?
  command.query['requestMetadata.trafficSource.trafficSubId'] = request_metadata_traffic_source_traffic_sub_id unless request_metadata_traffic_source_traffic_sub_id.nil?
  command.query['minMonthlyBudget.nanos'] = min_monthly_budget_nanos unless min_monthly_budget_nanos.nil?
  command.query['requestMetadata.partnersSessionId'] = request_metadata_partners_session_id unless request_metadata_partners_session_id.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['companyName'] = company_name unless company_name.nil?
  command.query['industries'] = industries unless industries.nil?
  command.query['websiteUrl'] = website_url unless website_url.nil?
  command.query['gpsMotivations'] = gps_motivations unless gps_motivations.nil?
  command.query['languageCodes'] = language_codes unless language_codes.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['requestMetadata.userOverrides.ipAddress'] = request_metadata_user_overrides_ip_address unless request_metadata_user_overrides_ip_address.nil?
  command.query['requestMetadata.experimentIds'] = request_metadata_experiment_ids unless request_metadata_experiment_ids.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['specializations'] = specializations unless specializations.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#list_leads(page_size: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_locale: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_experiment_ids: nil, request_metadata_traffic_source_traffic_sub_id: nil, order_by: nil, request_metadata_user_overrides_user_id: nil, request_metadata_partners_session_id: nil, page_token: nil, quota_user: nil, fields: 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:

  • page_size (Fixnum) —

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

  • 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_locale (String) —

    Locale to use for the current request.

  • request_metadata_user_overrides_ip_address (String) —

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

  • request_metadata_experiment_ids (Array<String>, String) —

    Experiment IDs the current request belongs to.

  • 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.

  • order_by (String) —

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

  • request_metadata_user_overrides_user_id (String) —

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

  • request_metadata_partners_session_id (String) —

    Google Partners session ID.

  • 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.

  • 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.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'generated/google/apis/partners_v2/service.rb', line 153

def list_leads(page_size: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_locale: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_experiment_ids: nil, request_metadata_traffic_source_traffic_sub_id: nil, order_by: nil, request_metadata_user_overrides_user_id: nil, request_metadata_partners_session_id: nil, page_token: nil, quota_user: nil, fields: 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['pageSize'] = page_size unless page_size.nil?
  command.query['requestMetadata.trafficSource.trafficSourceId'] = request_metadata_traffic_source_traffic_source_id unless request_metadata_traffic_source_traffic_source_id.nil?
  command.query['requestMetadata.locale'] = request_metadata_locale unless request_metadata_locale.nil?
  command.query['requestMetadata.userOverrides.ipAddress'] = request_metadata_user_overrides_ip_address unless request_metadata_user_overrides_ip_address.nil?
  command.query['requestMetadata.experimentIds'] = request_metadata_experiment_ids unless request_metadata_experiment_ids.nil?
  command.query['requestMetadata.trafficSource.trafficSubId'] = request_metadata_traffic_source_traffic_sub_id unless request_metadata_traffic_source_traffic_sub_id.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['requestMetadata.userOverrides.userId'] = request_metadata_user_overrides_user_id unless request_metadata_user_overrides_user_id.nil?
  command.query['requestMetadata.partnersSessionId'] = request_metadata_partners_session_id unless request_metadata_partners_session_id.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

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

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

Parameters:

  • page_size (Fixnum) —

    Maximum number of rows to return per page.

  • 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_locale (String) —

    Locale to use for the current request.

  • request_metadata_user_overrides_ip_address (String) —

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

  • request_metadata_experiment_ids (Array<String>, String) —

    Experiment IDs the current request belongs to.

  • 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.

  • 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_user_id (String) —

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

  • request_metadata_partners_session_id (String) —

    Google Partners session ID.

  • page_token (String) —

    Token to retrieve a specific page.

  • 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.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'generated/google/apis/partners_v2/service.rb', line 272

def list_offer_histories(page_size: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_locale: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_experiment_ids: nil, entire_company: nil, order_by: nil, request_metadata_traffic_source_traffic_sub_id: nil, request_metadata_user_overrides_user_id: nil, request_metadata_partners_session_id: nil, page_token: nil, quota_user: nil, fields: 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['pageSize'] = page_size unless page_size.nil?
  command.query['requestMetadata.trafficSource.trafficSourceId'] = request_metadata_traffic_source_traffic_source_id unless request_metadata_traffic_source_traffic_source_id.nil?
  command.query['requestMetadata.locale'] = request_metadata_locale unless request_metadata_locale.nil?
  command.query['requestMetadata.userOverrides.ipAddress'] = request_metadata_user_overrides_ip_address unless request_metadata_user_overrides_ip_address.nil?
  command.query['requestMetadata.experimentIds'] = request_metadata_experiment_ids unless request_metadata_experiment_ids.nil?
  command.query['entireCompany'] = entire_company unless entire_company.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['requestMetadata.trafficSource.trafficSubId'] = request_metadata_traffic_source_traffic_sub_id unless request_metadata_traffic_source_traffic_sub_id.nil?
  command.query['requestMetadata.userOverrides.userId'] = request_metadata_user_overrides_user_id unless request_metadata_user_overrides_user_id.nil?
  command.query['requestMetadata.partnersSessionId'] = request_metadata_partners_session_id unless request_metadata_partners_session_id.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

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

Lists the Offers available for the current user

Parameters:

  • request_metadata_user_overrides_user_id (String) —

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

  • 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_locale (String) —

    Locale to use for the current request.

  • request_metadata_user_overrides_ip_address (String) —

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

  • request_metadata_experiment_ids (Array<String>, String) —

    Experiment IDs the current request belongs to.

  • 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.

  • 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.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def list_offers(request_metadata_user_overrides_user_id: nil, request_metadata_partners_session_id: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_locale: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_experiment_ids: nil, request_metadata_traffic_source_traffic_sub_id: nil, quota_user: nil, fields: 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.userOverrides.userId'] = request_metadata_user_overrides_user_id unless request_metadata_user_overrides_user_id.nil?
  command.query['requestMetadata.partnersSessionId'] = request_metadata_partners_session_id unless request_metadata_partners_session_id.nil?
  command.query['requestMetadata.trafficSource.trafficSourceId'] = request_metadata_traffic_source_traffic_source_id unless request_metadata_traffic_source_traffic_source_id.nil?
  command.query['requestMetadata.locale'] = request_metadata_locale unless request_metadata_locale.nil?
  command.query['requestMetadata.userOverrides.ipAddress'] = request_metadata_user_overrides_ip_address unless request_metadata_user_overrides_ip_address.nil?
  command.query['requestMetadata.experimentIds'] = request_metadata_experiment_ids unless request_metadata_experiment_ids.nil?
  command.query['requestMetadata.trafficSource.trafficSubId'] = request_metadata_traffic_source_traffic_sub_id unless request_metadata_traffic_source_traffic_sub_id.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

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

Lists states for current user.

Parameters:

  • request_metadata_user_overrides_user_id (String) —

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

  • 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_locale (String) —

    Locale to use for the current request.

  • request_metadata_user_overrides_ip_address (String) —

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

  • request_metadata_experiment_ids (Array<String>, String) —

    Experiment IDs the current request belongs to.

  • 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.

  • 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.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'generated/google/apis/partners_v2/service.rb', line 328

def list_user_states(request_metadata_user_overrides_user_id: nil, request_metadata_partners_session_id: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_locale: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_experiment_ids: nil, request_metadata_traffic_source_traffic_sub_id: nil, quota_user: nil, fields: 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.userOverrides.userId'] = request_metadata_user_overrides_user_id unless request_metadata_user_overrides_user_id.nil?
  command.query['requestMetadata.partnersSessionId'] = request_metadata_partners_session_id unless request_metadata_partners_session_id.nil?
  command.query['requestMetadata.trafficSource.trafficSourceId'] = request_metadata_traffic_source_traffic_source_id unless request_metadata_traffic_source_traffic_source_id.nil?
  command.query['requestMetadata.locale'] = request_metadata_locale unless request_metadata_locale.nil?
  command.query['requestMetadata.userOverrides.ipAddress'] = request_metadata_user_overrides_ip_address unless request_metadata_user_overrides_ip_address.nil?
  command.query['requestMetadata.experimentIds'] = request_metadata_experiment_ids unless request_metadata_experiment_ids.nil?
  command.query['requestMetadata.trafficSource.trafficSubId'] = request_metadata_traffic_source_traffic_sub_id unless request_metadata_traffic_source_traffic_sub_id.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#log_client_message_message(log_message_request_object = nil, quota_user: nil, fields: 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)
  • 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.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
 
# File 'generated/google/apis/partners_v2/service.rb', line 1111

def log_client_message_message(log_message_request_object = nil, quota_user: nil, fields: 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['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#log_user_event(log_user_event_request_object = nil, quota_user: nil, fields: 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)
  • 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.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
 
# File 'generated/google/apis/partners_v2/service.rb', line 1079

def log_user_event(log_user_event_request_object = nil, quota_user: nil, fields: 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['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#update_companies(company_object = nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_locale: nil, request_metadata_user_overrides_ip_address: nil, update_mask: nil, request_metadata_experiment_ids: nil, request_metadata_traffic_source_traffic_sub_id: nil, request_metadata_partners_session_id: nil, request_metadata_user_overrides_user_id: nil, quota_user: nil, fields: 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_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_locale (String) —

    Locale to use for the current request.

  • request_metadata_user_overrides_ip_address (String) —

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

  • update_mask (String) —

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

  • request_metadata_experiment_ids (Array<String>, String) —

    Experiment IDs the current request belongs to.

  • 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_partners_session_id (String) —

    Google Partners session ID.

  • request_metadata_user_overrides_user_id (String) —

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

  • 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.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
 
# File 'generated/google/apis/partners_v2/service.rb', line 569

def update_companies(company_object = nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_locale: nil, request_metadata_user_overrides_ip_address: nil, update_mask: nil, request_metadata_experiment_ids: nil, request_metadata_traffic_source_traffic_sub_id: nil, request_metadata_partners_session_id: nil, request_metadata_user_overrides_user_id: nil, quota_user: nil, fields: 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.trafficSource.trafficSourceId'] = request_metadata_traffic_source_traffic_source_id unless request_metadata_traffic_source_traffic_source_id.nil?
  command.query['requestMetadata.locale'] = request_metadata_locale unless request_metadata_locale.nil?
  command.query['requestMetadata.userOverrides.ipAddress'] = request_metadata_user_overrides_ip_address unless request_metadata_user_overrides_ip_address.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['requestMetadata.experimentIds'] = request_metadata_experiment_ids unless request_metadata_experiment_ids.nil?
  command.query['requestMetadata.trafficSource.trafficSubId'] = request_metadata_traffic_source_traffic_sub_id unless request_metadata_traffic_source_traffic_sub_id.nil?
  command.query['requestMetadata.partnersSessionId'] = request_metadata_partners_session_id unless request_metadata_partners_session_id.nil?
  command.query['requestMetadata.userOverrides.userId'] = request_metadata_user_overrides_user_id unless request_metadata_user_overrides_user_id.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#update_leads(lead_object = nil, request_metadata_partners_session_id: nil, request_metadata_user_overrides_user_id: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_locale: nil, request_metadata_user_overrides_ip_address: nil, update_mask: nil, request_metadata_experiment_ids: nil, request_metadata_traffic_source_traffic_sub_id: nil, quota_user: nil, fields: 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_partners_session_id (String) —

    Google Partners session ID.

  • request_metadata_user_overrides_user_id (String) —

    Logged-in user ID to impersonate instead of the user's 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_locale (String) —

    Locale to use for the current request.

  • request_metadata_user_overrides_ip_address (String) —

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

  • 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.

  • request_metadata_experiment_ids (Array<String>, String) —

    Experiment IDs the current request belongs to.

  • 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.

  • 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.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
 
# File 'generated/google/apis/partners_v2/service.rb', line 509

def update_leads(lead_object = nil, request_metadata_partners_session_id: nil, request_metadata_user_overrides_user_id: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_locale: nil, request_metadata_user_overrides_ip_address: nil, update_mask: nil, request_metadata_experiment_ids: nil, request_metadata_traffic_source_traffic_sub_id: nil, quota_user: nil, fields: 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.partnersSessionId'] = request_metadata_partners_session_id unless request_metadata_partners_session_id.nil?
  command.query['requestMetadata.userOverrides.userId'] = request_metadata_user_overrides_user_id unless request_metadata_user_overrides_user_id.nil?
  command.query['requestMetadata.trafficSource.trafficSourceId'] = request_metadata_traffic_source_traffic_source_id unless request_metadata_traffic_source_traffic_source_id.nil?
  command.query['requestMetadata.locale'] = request_metadata_locale unless request_metadata_locale.nil?
  command.query['requestMetadata.userOverrides.ipAddress'] = request_metadata_user_overrides_ip_address unless request_metadata_user_overrides_ip_address.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['requestMetadata.experimentIds'] = request_metadata_experiment_ids unless request_metadata_experiment_ids.nil?
  command.query['requestMetadata.trafficSource.trafficSubId'] = request_metadata_traffic_source_traffic_sub_id unless request_metadata_traffic_source_traffic_sub_id.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#update_user_profile(user_profile_object = nil, request_metadata_user_overrides_user_id: nil, request_metadata_partners_session_id: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_locale: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_experiment_ids: nil, request_metadata_traffic_source_traffic_sub_id: nil, quota_user: nil, fields: 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_user_overrides_user_id (String) —

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

  • 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_locale (String) —

    Locale to use for the current request.

  • request_metadata_user_overrides_ip_address (String) —

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

  • request_metadata_experiment_ids (Array<String>, String) —

    Experiment IDs the current request belongs to.

  • 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.

  • 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.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
 
# File 'generated/google/apis/partners_v2/service.rb', line 1042

def ( = nil, request_metadata_user_overrides_user_id: nil, request_metadata_partners_session_id: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_locale: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_experiment_ids: nil, request_metadata_traffic_source_traffic_sub_id: nil, quota_user: nil, fields: 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.userOverrides.userId'] = request_metadata_user_overrides_user_id unless request_metadata_user_overrides_user_id.nil?
  command.query['requestMetadata.partnersSessionId'] = request_metadata_partners_session_id unless request_metadata_partners_session_id.nil?
  command.query['requestMetadata.trafficSource.trafficSourceId'] = request_metadata_traffic_source_traffic_source_id unless request_metadata_traffic_source_traffic_source_id.nil?
  command.query['requestMetadata.locale'] = request_metadata_locale unless request_metadata_locale.nil?
  command.query['requestMetadata.userOverrides.ipAddress'] = request_metadata_user_overrides_ip_address unless request_metadata_user_overrides_ip_address.nil?
  command.query['requestMetadata.experimentIds'] = request_metadata_experiment_ids unless request_metadata_experiment_ids.nil?
  command.query['requestMetadata.trafficSource.trafficSubId'] = request_metadata_traffic_source_traffic_sub_id unless request_metadata_traffic_source_traffic_sub_id.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end