Class: Google::Apis::PartnersV2::PartnersService
- Inherits:
-
Core::BaseService
- Object
- Core::BaseService
- Google::Apis::PartnersV2::PartnersService
- Defined in:
- generated/google/apis/partners_v2/service.rb
Overview
Google Partners API
Lets advertisers search certified companies and create contact leads with them, and also audits the usage of clients.
Instance Attribute Summary collapse
-
#key ⇒ String
API key.
-
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.
Attributes inherited from Core::BaseService
#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path
Instance Method Summary collapse
-
#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.
-
#get_company(company_id, request_metadata_user_overrides_ip_address: nil, request_metadata_user_overrides_user_id: nil, request_metadata_locale: nil, request_metadata_partners_session_id: nil, request_metadata_experiment_ids: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_traffic_source_traffic_sub_id: nil, view: nil, order_by: nil, currency_code: nil, address: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PartnersV2::GetCompanyResponse
Gets a company.
-
#initialize ⇒ PartnersService
constructor
A new instance of PartnersService.
-
#list_companies(request_metadata_user_overrides_ip_address: nil, request_metadata_user_overrides_user_id: nil, request_metadata_locale: nil, request_metadata_partners_session_id: nil, request_metadata_experiment_ids: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_traffic_source_traffic_sub_id: nil, page_size: nil, page_token: nil, company_name: nil, view: nil, min_monthly_budget_currency_code: nil, min_monthly_budget_units: nil, min_monthly_budget_nanos: nil, max_monthly_budget_currency_code: nil, max_monthly_budget_units: nil, max_monthly_budget_nanos: nil, industries: nil, services: nil, language_codes: nil, address: nil, order_by: nil, gps_motivations: nil, website_url: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PartnersV2::ListCompaniesResponse
Lists companies.
-
#list_user_states(request_metadata_user_overrides_ip_address: nil, request_metadata_user_overrides_user_id: nil, request_metadata_locale: nil, request_metadata_partners_session_id: nil, request_metadata_experiment_ids: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_traffic_source_traffic_sub_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PartnersV2::ListUserStatesResponse
Lists states for current user.
-
#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. -
#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.
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.
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.
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.
379 380 381 382 383 384 385 386 387 388 389 |
# File 'generated/google/apis/partners_v2/service.rb', line 379 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', ) 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 |
#get_company(company_id, request_metadata_user_overrides_ip_address: nil, request_metadata_user_overrides_user_id: nil, request_metadata_locale: nil, request_metadata_partners_session_id: nil, request_metadata_experiment_ids: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_traffic_source_traffic_sub_id: nil, view: nil, order_by: nil, currency_code: nil, address: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PartnersV2::GetCompanyResponse
Gets a company.
215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
# File 'generated/google/apis/partners_v2/service.rb', line 215 def get_company(company_id, request_metadata_user_overrides_ip_address: nil, request_metadata_user_overrides_user_id: nil, request_metadata_locale: nil, request_metadata_partners_session_id: nil, request_metadata_experiment_ids: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_traffic_source_traffic_sub_id: nil, view: nil, order_by: nil, currency_code: nil, address: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2/companies/{companyId}', ) 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.userOverrides.ipAddress'] = unless .nil? command.query['requestMetadata.userOverrides.userId'] = unless .nil? command.query['requestMetadata.locale'] = unless .nil? command.query['requestMetadata.partnersSessionId'] = unless .nil? command.query['requestMetadata.experimentIds'] = unless .nil? command.query['requestMetadata.trafficSource.trafficSourceId'] = unless .nil? command.query['requestMetadata.trafficSource.trafficSubId'] = unless .nil? command.query['view'] = view unless view.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['currencyCode'] = currency_code unless currency_code.nil? command.query['address'] = address unless address.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(request_metadata_user_overrides_ip_address: nil, request_metadata_user_overrides_user_id: nil, request_metadata_locale: nil, request_metadata_partners_session_id: nil, request_metadata_experiment_ids: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_traffic_source_traffic_sub_id: nil, page_size: nil, page_token: nil, company_name: nil, view: nil, min_monthly_budget_currency_code: nil, min_monthly_budget_units: nil, min_monthly_budget_nanos: nil, max_monthly_budget_currency_code: nil, max_monthly_budget_units: nil, max_monthly_budget_nanos: nil, industries: nil, services: nil, language_codes: nil, address: nil, order_by: nil, gps_motivations: nil, website_url: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PartnersV2::ListCompaniesResponse
Lists companies.
325 326 327 328 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 |
# File 'generated/google/apis/partners_v2/service.rb', line 325 def list_companies(request_metadata_user_overrides_ip_address: nil, request_metadata_user_overrides_user_id: nil, request_metadata_locale: nil, request_metadata_partners_session_id: nil, request_metadata_experiment_ids: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_traffic_source_traffic_sub_id: nil, page_size: nil, page_token: nil, company_name: nil, view: nil, min_monthly_budget_currency_code: nil, min_monthly_budget_units: nil, min_monthly_budget_nanos: nil, max_monthly_budget_currency_code: nil, max_monthly_budget_units: nil, max_monthly_budget_nanos: nil, industries: nil, services: nil, language_codes: nil, address: nil, order_by: nil, gps_motivations: nil, website_url: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2/companies', ) command.response_representation = Google::Apis::PartnersV2::ListCompaniesResponse::Representation command.response_class = Google::Apis::PartnersV2::ListCompaniesResponse command.query['requestMetadata.userOverrides.ipAddress'] = unless .nil? command.query['requestMetadata.userOverrides.userId'] = unless .nil? command.query['requestMetadata.locale'] = unless .nil? command.query['requestMetadata.partnersSessionId'] = unless .nil? command.query['requestMetadata.experimentIds'] = unless .nil? command.query['requestMetadata.trafficSource.trafficSourceId'] = unless .nil? command.query['requestMetadata.trafficSource.trafficSubId'] = unless .nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['companyName'] = company_name unless company_name.nil? command.query['view'] = view unless view.nil? command.query['minMonthlyBudget.currencyCode'] = min_monthly_budget_currency_code unless min_monthly_budget_currency_code.nil? command.query['minMonthlyBudget.units'] = min_monthly_budget_units unless min_monthly_budget_units.nil? command.query['minMonthlyBudget.nanos'] = min_monthly_budget_nanos unless min_monthly_budget_nanos.nil? command.query['maxMonthlyBudget.currencyCode'] = max_monthly_budget_currency_code unless max_monthly_budget_currency_code.nil? command.query['maxMonthlyBudget.units'] = max_monthly_budget_units unless max_monthly_budget_units.nil? command.query['maxMonthlyBudget.nanos'] = max_monthly_budget_nanos unless max_monthly_budget_nanos.nil? command.query['industries'] = industries unless industries.nil? command.query['services'] = services unless services.nil? command.query['languageCodes'] = language_codes unless language_codes.nil? command.query['address'] = address unless address.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['gpsMotivations'] = gps_motivations unless gps_motivations.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_user_states(request_metadata_user_overrides_ip_address: nil, request_metadata_user_overrides_user_id: nil, request_metadata_locale: nil, request_metadata_partners_session_id: nil, request_metadata_experiment_ids: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_traffic_source_traffic_sub_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PartnersV2::ListUserStatesResponse
Lists states for current user.
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 |
# File 'generated/google/apis/partners_v2/service.rb', line 147 def list_user_states(request_metadata_user_overrides_ip_address: nil, request_metadata_user_overrides_user_id: nil, request_metadata_locale: nil, request_metadata_partners_session_id: nil, request_metadata_experiment_ids: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_traffic_source_traffic_sub_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2/userStates', ) command.response_representation = Google::Apis::PartnersV2::ListUserStatesResponse::Representation command.response_class = Google::Apis::PartnersV2::ListUserStatesResponse command.query['requestMetadata.userOverrides.ipAddress'] = unless .nil? command.query['requestMetadata.userOverrides.userId'] = unless .nil? command.query['requestMetadata.locale'] = unless .nil? command.query['requestMetadata.partnersSessionId'] = unless .nil? command.query['requestMetadata.experimentIds'] = unless .nil? command.query['requestMetadata.trafficSource.trafficSourceId'] = unless .nil? command.query['requestMetadata.trafficSource.trafficSubId'] = 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.
101 102 103 104 105 106 107 108 109 110 |
# File 'generated/google/apis/partners_v2/service.rb', line 101 def ( = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2/clientMessages:log', ) command.request_representation = Google::Apis::PartnersV2::LogMessageRequest::Representation command.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.
69 70 71 72 73 74 75 76 77 78 |
# File 'generated/google/apis/partners_v2/service.rb', line 69 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', ) 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 |