Class: Google::Apis::Searchads360V23::SA360Service

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/searchads360_v23/service.rb

Overview

Search Ads 360 Reporting API

The Search Ads 360 API allows developers to automate downloading reports from Search Ads 360.

Examples:

require 'google/apis/searchads360_v23'

Searchads360 = Google::Apis::Searchads360V23 # Alias the module
service = Searchads360::SA360Service.new

See Also:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE =
"https://searchads360.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeSA360Service

Returns a new instance of SA360Service.



48
49
50
51
52
53
# File 'lib/google/apis/searchads360_v23/service.rb', line 48

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-searchads360_v23',
        client_version: Google::Apis::Searchads360V23::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#keyString

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

Returns:

  • (String)

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



41
42
43
# File 'lib/google/apis/searchads360_v23/service.rb', line 41

def key
  @key
end

#quota_userString

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

Returns:

  • (String)

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



46
47
48
# File 'lib/google/apis/searchads360_v23/service.rb', line 46

def quota_user
  @quota_user
end

Instance Method Details

#add_customer_batch_job_operations(resource_name, google_ads_searchads360_v23_services__add_batch_job_operations_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesAddBatchJobOperationsResponse

Parameters:

  • resource_name (String)

    Required. The resource name of the batch job.

  • google_ads_searchads360_v23_services__add_batch_job_operations_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesAddBatchJobOperationsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
# File 'lib/google/apis/searchads360_v23/service.rb', line 1989

def add_customer_batch_job_operations(resource_name, google_ads_searchads360_v23_services__add_batch_job_operations_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/{+resourceName}:addOperations', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesAddBatchJobOperationsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__add_batch_job_operations_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesAddBatchJobOperationsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesAddBatchJobOperationsResponse
  command.params['resourceName'] = resource_name unless resource_name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#add_customer_offline_user_data_job_operations(resource_name, google_ads_searchads360_v23_services__add_offline_user_data_job_operations_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesAddOfflineUserDataJobOperationsResponse

Parameters:

  • resource_name (String)

    Required. The resource name of the OfflineUserDataJob.

  • google_ads_searchads360_v23_services__add_offline_user_data_job_operations_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesAddOfflineUserDataJobOperationsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
# File 'lib/google/apis/searchads360_v23/service.rb', line 4474

def add_customer_offline_user_data_job_operations(resource_name, google_ads_searchads360_v23_services__add_offline_user_data_job_operations_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/{+resourceName}:addOperations', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesAddOfflineUserDataJobOperationsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__add_offline_user_data_job_operations_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesAddOfflineUserDataJobOperationsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesAddOfflineUserDataJobOperationsResponse
  command.params['resourceName'] = resource_name unless resource_name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#append_customer_local_service_lead_conversation(customer_id, google_ads_searchads360_v23_services__append_lead_conversation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesAppendLeadConversationResponse

RPC to append Local Services Lead Conversation resources to Local Services Lead resources.

Parameters:

  • customer_id (String)

    Required. The Id of the customer which owns the leads onto which the conversations will be appended.

  • google_ads_searchads360_v23_services__append_lead_conversation_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesAppendLeadConversationRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
# File 'lib/google/apis/searchads360_v23/service.rb', line 4404

def append_customer_local_service_lead_conversation(customer_id, google_ads_searchads360_v23_services__append_lead_conversation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/localServices:appendLeadConversation', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesAppendLeadConversationRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__append_lead_conversation_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesAppendLeadConversationResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesAppendLeadConversationResponse
  command.params['customerId'] = customer_id unless customer_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

#apply_customer_incentive_incentive(customer_id, selected_incentive_id, google_ads_searchads360_v23_services__apply_incentive_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesApplyIncentiveResponse

Applies the incentive for the ads customer.

Parameters:

  • customer_id (String)

    The customer ID of the account that the incentive is being applied to.

  • selected_incentive_id (Fixnum)

    The incentive ID of this incentive. This is used to identify which incentive is selected by the user in the CYO flow.

  • google_ads_searchads360_v23_services__apply_incentive_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesApplyIncentiveRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
# File 'lib/google/apis/searchads360_v23/service.rb', line 4088

def apply_customer_incentive_incentive(customer_id, selected_incentive_id, google_ads_searchads360_v23_services__apply_incentive_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/incentives/{+selectedIncentiveId}:applyIncentive', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesApplyIncentiveRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__apply_incentive_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesApplyIncentiveResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesApplyIncentiveResponse
  command.params['customerId'] = customer_id unless customer_id.nil?
  command.params['selectedIncentiveId'] = selected_incentive_id unless selected_incentive_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

#apply_customer_recommendation(customer_id, google_ads_searchads360_v23_services__apply_recommendation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesApplyRecommendationResponse

Applies given recommendations with corresponding apply parameters. List of thrown errors: AuthenticationError AuthorizationError DatabaseError FieldError HeaderError InternalError MutateError QuotaError RecommendationError RequestError UrlFieldError

Parameters:

  • customer_id (String)

    Required. The ID of the customer with the recommendation.

  • google_ads_searchads360_v23_services__apply_recommendation_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesApplyRecommendationRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
# File 'lib/google/apis/searchads360_v23/service.rb', line 4823

def apply_customer_recommendation(customer_id, google_ads_searchads360_v23_services__apply_recommendation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/recommendations:apply', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesApplyRecommendationRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__apply_recommendation_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesApplyRecommendationResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesApplyRecommendationResponse
  command.params['customerId'] = customer_id unless customer_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

#configure_customer_campaign_lifecycle_goal_campaign_lifecycle_goals(customer_id, google_ads_searchads360_v23_services__configure_campaign_lifecycle_goals_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesConfigureCampaignLifecycleGoalsResponse

Process the given campaign lifecycle configurations. List of thrown errors: AuthenticationError AuthorizationError CampaignLifecycleGoalConfigError HeaderError InternalError QuotaError RequestError

Parameters:

  • customer_id (String)

    Required. The ID of the customer performing the upload.

  • google_ads_searchads360_v23_services__configure_campaign_lifecycle_goals_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesConfigureCampaignLifecycleGoalsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
# File 'lib/google/apis/searchads360_v23/service.rb', line 2735

def configure_customer_campaign_lifecycle_goal_campaign_lifecycle_goals(customer_id, google_ads_searchads360_v23_services__configure_campaign_lifecycle_goals_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/campaignLifecycleGoal:configureCampaignLifecycleGoals', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesConfigureCampaignLifecycleGoalsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__configure_campaign_lifecycle_goals_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesConfigureCampaignLifecycleGoalsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesConfigureCampaignLifecycleGoalsResponse
  command.params['customerId'] = customer_id unless customer_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

#configure_customer_customer_lifecycle_goal_customer_lifecycle_goals(customer_id, google_ads_searchads360_v23_services__configure_customer_lifecycle_goals_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesConfigureCustomerLifecycleGoalsResponse

Process the given customer lifecycle configurations. List of thrown errors: AuthenticationError AuthorizationError CustomerLifecycleGoalConfigError HeaderError InternalError QuotaError RequestError

Parameters:

  • customer_id (String)

    Required. The ID of the customer performing the upload.

  • google_ads_searchads360_v23_services__configure_customer_lifecycle_goals_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesConfigureCustomerLifecycleGoalsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
# File 'lib/google/apis/searchads360_v23/service.rb', line 3417

def configure_customer_customer_lifecycle_goal_customer_lifecycle_goals(customer_id, google_ads_searchads360_v23_services__configure_customer_lifecycle_goals_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/customerLifecycleGoal:configureCustomerLifecycleGoals', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesConfigureCustomerLifecycleGoalsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__configure_customer_lifecycle_goals_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesConfigureCustomerLifecycleGoalsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesConfigureCustomerLifecycleGoalsResponse
  command.params['customerId'] = customer_id unless customer_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

Parameters:

  • customer_id (String)

    Required. The ID of the customer for which the account link is created.

  • google_ads_searchads360_v23_services__create_account_link_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesCreateAccountLinkRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
# File 'lib/google/apis/searchads360_v23/service.rb', line 1140

def (customer_id,  = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/accountLinks:create', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesCreateAccountLinkRequest::Representation
  command.request_object = 
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesCreateAccountLinkResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesCreateAccountLinkResponse
  command.params['customerId'] = customer_id unless customer_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_customer_customer_client(customer_id, google_ads_searchads360_v23_services__create_customer_client_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesCreateCustomerClientResponse

Parameters:

  • customer_id (String)

    Required. The ID of the Manager under whom client customer is being created.

  • google_ads_searchads360_v23_services__create_customer_client_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesCreateCustomerClientRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



112
113
114
115
116
117
118
119
120
121
122
# File 'lib/google/apis/searchads360_v23/service.rb', line 112

def create_customer_customer_client(customer_id, google_ads_searchads360_v23_services__create_customer_client_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}:createCustomerClient', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesCreateCustomerClientRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__create_customer_client_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesCreateCustomerClientResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesCreateCustomerClientResponse
  command.params['customerId'] = customer_id unless customer_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

Creates a data link. The requesting Google Ads account name and account ID will be shared with the third party (such as YouTube creators for video links) to whom you are creating the link with. Only customers on the allow-list can create data links. List of thrown errors: AuthenticationError AuthorizationError DatabaseError DataLinkError FieldError HeaderError InternalError MutateError QuotaError RequestError

Parameters:

  • customer_id (String)

    Required. The ID of the customer for which the data link is created.

  • google_ads_searchads360_v23_services__create_data_link_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesCreateDataLinkRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
# File 'lib/google/apis/searchads360_v23/service.rb', line 3710

def create_customer_data_link(customer_id, google_ads_searchads360_v23_services__create_data_link_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/dataLinks:create', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesCreateDataLinkRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__create_data_link_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesCreateDataLinkResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesCreateDataLinkResponse
  command.params['customerId'] = customer_id unless customer_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_customer_offline_user_data_job(customer_id, google_ads_searchads360_v23_services__create_offline_user_data_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesCreateOfflineUserDataJobResponse

Parameters:

  • customer_id (String)

    Required. The ID of the customer for which to create an offline user data job.

  • google_ads_searchads360_v23_services__create_offline_user_data_job_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesCreateOfflineUserDataJobRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
# File 'lib/google/apis/searchads360_v23/service.rb', line 4510

def create_customer_offline_user_data_job(customer_id, google_ads_searchads360_v23_services__create_offline_user_data_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/offlineUserDataJobs:create', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesCreateOfflineUserDataJobRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__create_offline_user_data_job_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesCreateOfflineUserDataJobResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesCreateOfflineUserDataJobResponse
  command.params['customerId'] = customer_id unless customer_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

Parameters:

  • customer_id (String)

    Required. The ID of the customer for which the product link is created.

  • google_ads_searchads360_v23_services__create_product_link_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesCreateProductLinkRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
# File 'lib/google/apis/searchads360_v23/service.rb', line 4715

def create_customer_product_link(customer_id, google_ads_searchads360_v23_services__create_product_link_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/productLinks:create', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesCreateProductLinkRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__create_product_link_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesCreateProductLinkResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesCreateProductLinkResponse
  command.params['customerId'] = customer_id unless customer_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

Creates a product link invitation.

Parameters:

  • customer_id (String)

    Required. The ID of the customer being modified.

  • google_ads_searchads360_v23_services__create_product_link_invitation_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesCreateProductLinkInvitationRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
# File 'lib/google/apis/searchads360_v23/service.rb', line 4614

def create_customer_product_link_invitation(customer_id, google_ads_searchads360_v23_services__create_product_link_invitation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/productLinkInvitations:create', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesCreateProductLinkInvitationRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__create_product_link_invitation_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesCreateProductLinkInvitationResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesCreateProductLinkInvitationResponse
  command.params['customerId'] = customer_id unless customer_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

#dismiss_customer_recommendation(customer_id, google_ads_searchads360_v23_services__dismiss_recommendation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesDismissRecommendationResponse

Parameters:

  • customer_id (String)

    Required. The ID of the customer with the recommendation.

  • google_ads_searchads360_v23_services__dismiss_recommendation_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesDismissRecommendationRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
# File 'lib/google/apis/searchads360_v23/service.rb', line 4858

def dismiss_customer_recommendation(customer_id, google_ads_searchads360_v23_services__dismiss_recommendation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/recommendations:dismiss', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesDismissRecommendationRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__dismiss_recommendation_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesDismissRecommendationResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesDismissRecommendationResponse
  command.params['customerId'] = customer_id unless customer_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

#enable_customer_campaign_p_max_brand_guidelines(customer_id, google_ads_searchads360_v23_services__enable_p_max_brand_guidelines_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesEnablePMaxBrandGuidelinesResponse

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose campaigns are being enabled.

  • google_ads_searchads360_v23_services__enable_p_max_brand_guidelines_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesEnablePMaxBrandGuidelinesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
# File 'lib/google/apis/searchads360_v23/service.rb', line 2811

def enable_customer_campaign_p_max_brand_guidelines(customer_id, google_ads_searchads360_v23_services__enable_p_max_brand_guidelines_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/campaigns:enablePMaxBrandGuidelines', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesEnablePMaxBrandGuidelinesRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__enable_p_max_brand_guidelines_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesEnablePMaxBrandGuidelinesResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesEnablePMaxBrandGuidelinesResponse
  command.params['customerId'] = customer_id unless customer_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

#end_customer_experiment_experiment(experiment, google_ads_searchads360_v23_services__end_experiment_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleProtobufEmpty

Immediately ends an experiment, changing the experiment's scheduled end date and without waiting for end of day. End date is updated to be the time of the request. List of thrown errors: AuthenticationError AuthorizationError ExperimentError HeaderError InternalError QuotaError RequestError

Parameters:

  • experiment (String)

    Required. The resource name of the campaign experiment to end.

  • google_ads_searchads360_v23_services__end_experiment_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesEndExperimentRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
# File 'lib/google/apis/searchads360_v23/service.rb', line 3855

def end_customer_experiment_experiment(experiment, google_ads_searchads360_v23_services__end_experiment_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/{+experiment}:endExperiment', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesEndExperimentRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__end_experiment_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleProtobufEmpty
  command.params['experiment'] = experiment unless experiment.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#fetch_incentive_incentive(country_code: nil, email: nil, language_code: nil, type: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesFetchIncentiveResponse

Returns incentives for a given user.

Parameters:

  • country_code (String) (defaults to: nil)

    Optional. User's country code. If not provided, the server will default to "US" . Possible country codes: https://developers.google.com/google-ads/api/data/ codes-formats#country_codes

  • email (String) (defaults to: nil)

    Optional. Email of the user that the requested incentive is meant for. Will be used for channel partners who do NOT use OAuth to authenticate on behalf of user.

  • language_code (String) (defaults to: nil)

    Optional. User's language code. If not provided, the server will default to " en". Possible language codes: https://developers.google.com/google-ads/api/ data/codes-formats#languages

  • type (String) (defaults to: nil)

    Optional. The type of incentive to get. Defaults to ACQUISITION.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
# File 'lib/google/apis/searchads360_v23/service.rb', line 5373

def fetch_incentive_incentive(country_code: nil, email: nil, language_code: nil, type: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v23/incentives:fetchIncentive', options)
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesFetchIncentiveResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesFetchIncentiveResponse
  command.query['countryCode'] = country_code unless country_code.nil?
  command.query['email'] = email unless email.nil?
  command.query['languageCode'] = language_code unless language_code.nil?
  command.query['type'] = type unless type.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#generate_conversion_rates(google_ads_searchads360_v23_services__generate_conversion_rates_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateConversionRatesResponse

Returns a collection of conversion rate suggestions for supported plannable products. List of thrown errors: AuthenticationError AuthorizationError HeaderError InternalError QuotaError RequestError

Parameters:

  • google_ads_searchads360_v23_services__generate_conversion_rates_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateConversionRatesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
# File 'lib/google/apis/searchads360_v23/service.rb', line 5504

def generate_conversion_rates(google_ads_searchads360_v23_services__generate_conversion_rates_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23:generateConversionRates', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateConversionRatesRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__generate_conversion_rates_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateConversionRatesResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateConversionRatesResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#generate_customer_ad_group_themes(customer_id, google_ads_searchads360_v23_services__generate_ad_group_themes_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateAdGroupThemesResponse

Returns a list of suggested AdGroups and suggested modifications (text, match type) for the given keywords. List of thrown errors: AuthenticationError AuthorizationError CollectionSizeError HeaderError InternalError QuotaError RequestError

Parameters:

  • customer_id (String)

    Required. The ID of the customer.

  • google_ads_searchads360_v23_services__generate_ad_group_themes_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateAdGroupThemesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



148
149
150
151
152
153
154
155
156
157
158
# File 'lib/google/apis/searchads360_v23/service.rb', line 148

def generate_customer_ad_group_themes(customer_id, google_ads_searchads360_v23_services__generate_ad_group_themes_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}:generateAdGroupThemes', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateAdGroupThemesRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__generate_ad_group_themes_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateAdGroupThemesResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateAdGroupThemesResponse
  command.params['customerId'] = customer_id unless customer_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

#generate_customer_audience_composition_insights(customer_id, google_ads_searchads360_v23_services__generate_audience_composition_insights_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateAudienceCompositionInsightsResponse

Returns a collection of attributes that are represented in an audience of interest, with metrics that compare each attribute's share of the audience with its share of a baseline audience. List of thrown errors: AudienceInsightsError AuthenticationError AuthorizationError FieldError HeaderError InternalError QuotaError RangeError RequestError

Parameters:

  • customer_id (String)

    Required. The ID of the customer.

  • google_ads_searchads360_v23_services__generate_audience_composition_insights_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateAudienceCompositionInsightsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



186
187
188
189
190
191
192
193
194
195
196
# File 'lib/google/apis/searchads360_v23/service.rb', line 186

def generate_customer_audience_composition_insights(customer_id, google_ads_searchads360_v23_services__generate_audience_composition_insights_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}:generateAudienceCompositionInsights', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateAudienceCompositionInsightsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__generate_audience_composition_insights_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateAudienceCompositionInsightsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateAudienceCompositionInsightsResponse
  command.params['customerId'] = customer_id unless customer_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

#generate_customer_audience_definition(customer_id, google_ads_searchads360_v23_services__generate_audience_definition_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateAudienceDefinitionResponse

Returns a collection of audience attributes using generative AI based on the provided audience description. List of thrown errors: AudienceInsightsError AuthenticationError AuthorizationError FieldError HeaderError InternalError QuotaError RequestError

Parameters:

  • customer_id (String)

    Required. The ID of the customer.

  • google_ads_searchads360_v23_services__generate_audience_definition_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateAudienceDefinitionRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



222
223
224
225
226
227
228
229
230
231
232
# File 'lib/google/apis/searchads360_v23/service.rb', line 222

def generate_customer_audience_definition(customer_id, google_ads_searchads360_v23_services__generate_audience_definition_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}:generateAudienceDefinition', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateAudienceDefinitionRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__generate_audience_definition_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateAudienceDefinitionResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateAudienceDefinitionResponse
  command.params['customerId'] = customer_id unless customer_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

#generate_customer_audience_overlap_insights(customer_id, google_ads_searchads360_v23_services__generate_audience_overlap_insights_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateAudienceOverlapInsightsResponse

Returns a collection of audience attributes along with estimates of the overlap between their potential YouTube reach and that of a given input attribute. List of thrown errors: AudienceInsightsError AuthenticationError AuthorizationError FieldError HeaderError InternalError QuotaError RangeError RequestError

Parameters:

  • customer_id (String)

    Required. The ID of the customer.

  • google_ads_searchads360_v23_services__generate_audience_overlap_insights_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateAudienceOverlapInsightsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



259
260
261
262
263
264
265
266
267
268
269
# File 'lib/google/apis/searchads360_v23/service.rb', line 259

def generate_customer_audience_overlap_insights(customer_id, google_ads_searchads360_v23_services__generate_audience_overlap_insights_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}:generateAudienceOverlapInsights', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateAudienceOverlapInsightsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__generate_audience_overlap_insights_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateAudienceOverlapInsightsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateAudienceOverlapInsightsResponse
  command.params['customerId'] = customer_id unless customer_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

#generate_customer_benchmarks_metrics(customer_id, google_ads_searchads360_v23_services__generate_benchmarks_metrics_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateBenchmarksMetricsResponse

Returns YouTube advertisement metrics for the given client against industry benchmarks. List of thrown errors: AuthenticationError AuthorizationError BenchmarksError FieldError HeaderError InternalError QuotaError RangeError RequestError

Parameters:

  • customer_id (String)

    Required. The ID of the customer. Supply a client customer ID to generate metrics for the customer. A manager account customer ID will not return customer metrics since it does not have any associated direct ad campaigns.

  • google_ads_searchads360_v23_services__generate_benchmarks_metrics_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateBenchmarksMetricsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



297
298
299
300
301
302
303
304
305
306
307
# File 'lib/google/apis/searchads360_v23/service.rb', line 297

def generate_customer_benchmarks_metrics(customer_id, google_ads_searchads360_v23_services__generate_benchmarks_metrics_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}:generateBenchmarksMetrics', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateBenchmarksMetricsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__generate_benchmarks_metrics_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateBenchmarksMetricsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateBenchmarksMetricsResponse
  command.params['customerId'] = customer_id unless customer_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

#generate_customer_insights_finder_report(customer_id, google_ads_searchads360_v23_services__generate_insights_finder_report_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateInsightsFinderReportResponse

Creates a saved report that can be viewed in the Insights Finder tool. List of thrown errors: AuthenticationError AuthorizationError FieldError HeaderError InternalError QuotaError RangeError RequestError

Parameters:

  • customer_id (String)

    Required. The ID of the customer.

  • google_ads_searchads360_v23_services__generate_insights_finder_report_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateInsightsFinderReportRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



332
333
334
335
336
337
338
339
340
341
342
# File 'lib/google/apis/searchads360_v23/service.rb', line 332

def generate_customer_insights_finder_report(customer_id, google_ads_searchads360_v23_services__generate_insights_finder_report_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}:generateInsightsFinderReport', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateInsightsFinderReportRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__generate_insights_finder_report_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateInsightsFinderReportResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateInsightsFinderReportResponse
  command.params['customerId'] = customer_id unless customer_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

#generate_customer_keyword_forecast_metrics(customer_id, google_ads_searchads360_v23_services__generate_keyword_forecast_metrics_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateKeywordForecastMetricsResponse

Returns metrics (such as impressions, clicks, total cost) of a keyword forecast for the given campaign. List of thrown errors: AuthenticationError AuthorizationError CollectionSizeError HeaderError InternalError QuotaError RequestError

Parameters:

  • customer_id (String)

    The ID of the customer.

  • google_ads_searchads360_v23_services__generate_keyword_forecast_metrics_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateKeywordForecastMetricsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



368
369
370
371
372
373
374
375
376
377
378
# File 'lib/google/apis/searchads360_v23/service.rb', line 368

def generate_customer_keyword_forecast_metrics(customer_id, google_ads_searchads360_v23_services__generate_keyword_forecast_metrics_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}:generateKeywordForecastMetrics', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateKeywordForecastMetricsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__generate_keyword_forecast_metrics_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateKeywordForecastMetricsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateKeywordForecastMetricsResponse
  command.params['customerId'] = customer_id unless customer_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

#generate_customer_keyword_historical_metrics(customer_id, google_ads_searchads360_v23_services__generate_keyword_historical_metrics_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateKeywordHistoricalMetricsResponse

Returns a list of keyword historical metrics. List of thrown errors: AuthenticationError AuthorizationError CollectionSizeError HeaderError InternalError QuotaError RequestError

Parameters:

  • customer_id (String)

    The ID of the customer with the recommendation.

  • google_ads_searchads360_v23_services__generate_keyword_historical_metrics_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateKeywordHistoricalMetricsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



403
404
405
406
407
408
409
410
411
412
413
# File 'lib/google/apis/searchads360_v23/service.rb', line 403

def generate_customer_keyword_historical_metrics(customer_id, google_ads_searchads360_v23_services__generate_keyword_historical_metrics_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}:generateKeywordHistoricalMetrics', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateKeywordHistoricalMetricsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__generate_keyword_historical_metrics_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateKeywordHistoricalMetricsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateKeywordHistoricalMetricsResponse
  command.params['customerId'] = customer_id unless customer_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

#generate_customer_keyword_ideas(customer_id, google_ads_searchads360_v23_services__generate_keyword_ideas_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateKeywordIdeaResponse

Parameters:

  • customer_id (String)

    The ID of the customer with the recommendation.

  • google_ads_searchads360_v23_services__generate_keyword_ideas_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateKeywordIdeasRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



438
439
440
441
442
443
444
445
446
447
448
# File 'lib/google/apis/searchads360_v23/service.rb', line 438

def generate_customer_keyword_ideas(customer_id, google_ads_searchads360_v23_services__generate_keyword_ideas_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}:generateKeywordIdeas', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateKeywordIdeasRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__generate_keyword_ideas_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateKeywordIdeaResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateKeywordIdeaResponse
  command.params['customerId'] = customer_id unless customer_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

#generate_customer_reach_forecast(customer_id, google_ads_searchads360_v23_services__generate_reach_forecast_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateReachForecastResponse

Generates a reach forecast for a given targeting / product mix. List of thrown errors: AuthenticationError AuthorizationError FieldError HeaderError InternalError QuotaError RangeError ReachPlanError RequestError

Parameters:

  • customer_id (String)

    Required. The ID of the customer.

  • google_ads_searchads360_v23_services__generate_reach_forecast_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateReachForecastRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



474
475
476
477
478
479
480
481
482
483
484
# File 'lib/google/apis/searchads360_v23/service.rb', line 474

def generate_customer_reach_forecast(customer_id, google_ads_searchads360_v23_services__generate_reach_forecast_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}:generateReachForecast', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateReachForecastRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__generate_reach_forecast_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateReachForecastResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateReachForecastResponse
  command.params['customerId'] = customer_id unless customer_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

#generate_customer_recommendation(customer_id, google_ads_searchads360_v23_services__generate_recommendations_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateRecommendationsResponse

Generates Recommendations based off the requested recommendation_types. List of thrown errors: AuthenticationError AuthorizationError HeaderError InternalError QuotaError RecommendationError RequestError

Parameters:

  • customer_id (String)

    Required. The ID of the customer generating recommendations.

  • google_ads_searchads360_v23_services__generate_recommendations_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateRecommendationsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
# File 'lib/google/apis/searchads360_v23/service.rb', line 4893

def generate_customer_recommendation(customer_id, google_ads_searchads360_v23_services__generate_recommendations_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/recommendations:generate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateRecommendationsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__generate_recommendations_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateRecommendationsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateRecommendationsResponse
  command.params['customerId'] = customer_id unless customer_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

#generate_customer_suggested_targeting_insights(customer_id, google_ads_searchads360_v23_services__generate_suggested_targeting_insights_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateSuggestedTargetingInsightsResponse

Returns a collection of targeting insights (e.g. targetable audiences) that are relevant to the requested audience. List of thrown errors: AudienceInsightsError AuthenticationError AuthorizationError FieldError HeaderError InternalError QuotaError RangeError RequestError

Parameters:

  • customer_id (String)

    Required. The ID of the customer.

  • google_ads_searchads360_v23_services__generate_suggested_targeting_insights_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateSuggestedTargetingInsightsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



511
512
513
514
515
516
517
518
519
520
521
# File 'lib/google/apis/searchads360_v23/service.rb', line 511

def generate_customer_suggested_targeting_insights(customer_id, google_ads_searchads360_v23_services__generate_suggested_targeting_insights_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}:generateSuggestedTargetingInsights', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateSuggestedTargetingInsightsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__generate_suggested_targeting_insights_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateSuggestedTargetingInsightsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateSuggestedTargetingInsightsResponse
  command.params['customerId'] = customer_id unless customer_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

#generate_customer_targeting_suggestion_metrics(customer_id, google_ads_searchads360_v23_services__generate_targeting_suggestion_metrics_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateTargetingSuggestionMetricsResponse

Returns potential reach metrics for targetable audiences. This method helps answer questions like "How many Men aged 18+ interested in Camping can be reached on YouTube?" List of thrown errors: AudienceInsightsError AuthenticationError AuthorizationError FieldError HeaderError InternalError QuotaError RangeError RequestError

Parameters:

  • customer_id (String)

    Required. The ID of the customer.

  • google_ads_searchads360_v23_services__generate_targeting_suggestion_metrics_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateTargetingSuggestionMetricsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



548
549
550
551
552
553
554
555
556
557
558
# File 'lib/google/apis/searchads360_v23/service.rb', line 548

def generate_customer_targeting_suggestion_metrics(customer_id, google_ads_searchads360_v23_services__generate_targeting_suggestion_metrics_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}:generateTargetingSuggestionMetrics', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateTargetingSuggestionMetricsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__generate_targeting_suggestion_metrics_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateTargetingSuggestionMetricsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateTargetingSuggestionMetricsResponse
  command.params['customerId'] = customer_id unless customer_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_customer_custom_column(resource_name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ResourcesCustomColumn

Returns the requested custom column in full detail.

Parameters:

  • resource_name (String)

    Required. The resource name of the custom column to fetch.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3104
3105
3106
3107
3108
3109
3110
3111
3112
# File 'lib/google/apis/searchads360_v23/service.rb', line 3104

def get_customer_custom_column(resource_name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v23/{+resourceName}', options)
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ResourcesCustomColumn::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ResourcesCustomColumn
  command.params['resourceName'] = resource_name unless resource_name.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_customer_identity_verification(customer_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGetIdentityVerificationResponse

Returns Identity Verification information. List of thrown errors: AuthenticationError AuthorizationError HeaderError InternalError QuotaError RequestError

Parameters:

  • customer_id (String)

    Required. The ID of the customer for whom we are requesting verification information.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



583
584
585
586
587
588
589
590
591
# File 'lib/google/apis/searchads360_v23/service.rb', line 583

def get_customer_identity_verification(customer_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v23/customers/{+customerId}/getIdentityVerification', options)
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGetIdentityVerificationResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGetIdentityVerificationResponse
  command.params['customerId'] = customer_id unless customer_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_customer_smart_campaign_setting_smart_campaign_status(resource_name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGetSmartCampaignStatusResponse

Returns the status of the requested Smart campaign.

Parameters:

  • resource_name (String)

    Required. The resource name of the Smart campaign setting belonging to the Smart campaign to fetch the status of.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5152
5153
5154
5155
5156
5157
5158
5159
5160
# File 'lib/google/apis/searchads360_v23/service.rb', line 5152

def get_customer_smart_campaign_setting_smart_campaign_status(resource_name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v23/{+resourceName}:getSmartCampaignStatus', options)
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGetSmartCampaignStatusResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGetSmartCampaignStatusResponse
  command.params['resourceName'] = resource_name unless resource_name.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_search_ads360_field(resource_name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ResourcesSearchAds360Field

Returns just the requested field. List of thrown errors: AuthenticationError AuthorizationError HeaderError InternalError QuotaError RequestError

Parameters:

  • resource_name (String)

    Required. The resource name of the field to get.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5440
5441
5442
5443
5444
5445
5446
5447
5448
# File 'lib/google/apis/searchads360_v23/service.rb', line 5440

def get_search_ads360_field(resource_name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v23/{+resourceName}', options)
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ResourcesSearchAds360Field::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ResourcesSearchAds360Field
  command.params['resourceName'] = resource_name unless resource_name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#graduate_customer_experiment_experiment(experiment, google_ads_searchads360_v23_services__graduate_experiment_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleProtobufEmpty

Graduates an experiment to a full campaign. List of thrown errors: AuthenticationError AuthorizationError ExperimentError HeaderError InternalError MutateError QuotaError RequestError

Parameters:

  • experiment (String)

    Required. The experiment to be graduated.

  • google_ads_searchads360_v23_services__graduate_experiment_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGraduateExperimentRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
# File 'lib/google/apis/searchads360_v23/service.rb', line 3890

def graduate_customer_experiment_experiment(experiment, google_ads_searchads360_v23_services__graduate_experiment_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/{+experiment}:graduateExperiment', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGraduateExperimentRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__graduate_experiment_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleProtobufEmpty
  command.params['experiment'] = experiment unless experiment.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_audience_insight_insights_eligible_dates(google_ads_searchads360_v23_services__list_insights_eligible_dates_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListInsightsEligibleDatesResponse

Lists date ranges for which audience insights data can be requested. List of thrown errors: AuthenticationError AuthorizationError FieldError HeaderError InternalError QuotaError RangeError RequestError

Parameters:

  • google_ads_searchads360_v23_services__list_insights_eligible_dates_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListInsightsEligibleDatesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



76
77
78
79
80
81
82
83
84
85
# File 'lib/google/apis/searchads360_v23/service.rb', line 76

def list_audience_insight_insights_eligible_dates(google_ads_searchads360_v23_services__list_insights_eligible_dates_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/audienceInsights:listInsightsEligibleDates', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListInsightsEligibleDatesRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__list_insights_eligible_dates_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListInsightsEligibleDatesResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListInsightsEligibleDatesResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_benchmarks_available_dates(google_ads_searchads360_v23_services__list_benchmarks_available_dates_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListBenchmarksAvailableDatesResponse

Returns a date range that supports benchmarks. List of thrown errors: AuthenticationError AuthorizationError FieldError HeaderError InternalError QuotaError RequestError

Parameters:

  • google_ads_searchads360_v23_services__list_benchmarks_available_dates_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListBenchmarksAvailableDatesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
# File 'lib/google/apis/searchads360_v23/service.rb', line 5536

def list_benchmarks_available_dates(google_ads_searchads360_v23_services__list_benchmarks_available_dates_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23:listBenchmarksAvailableDates', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListBenchmarksAvailableDatesRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__list_benchmarks_available_dates_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListBenchmarksAvailableDatesResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListBenchmarksAvailableDatesResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_benchmarks_locations(google_ads_searchads360_v23_services__list_benchmarks_locations_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListBenchmarksLocationsResponse

Returns the list of locations that support benchmarks (for example, countries). List of thrown errors: AuthenticationError AuthorizationError FieldError HeaderError InternalError QuotaError RequestError

Parameters:

  • google_ads_searchads360_v23_services__list_benchmarks_locations_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListBenchmarksLocationsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
# File 'lib/google/apis/searchads360_v23/service.rb', line 5568

def list_benchmarks_locations(google_ads_searchads360_v23_services__list_benchmarks_locations_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23:listBenchmarksLocations', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListBenchmarksLocationsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__list_benchmarks_locations_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListBenchmarksLocationsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListBenchmarksLocationsResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_benchmarks_products(google_ads_searchads360_v23_services__list_benchmarks_products_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListBenchmarksProductsResponse

Returns the list of products that supports benchmarks. List of thrown errors: AuthenticationError AuthorizationError FieldError HeaderError InternalError QuotaError RequestError

Parameters:

  • google_ads_searchads360_v23_services__list_benchmarks_products_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListBenchmarksProductsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
# File 'lib/google/apis/searchads360_v23/service.rb', line 5600

def list_benchmarks_products(google_ads_searchads360_v23_services__list_benchmarks_products_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23:listBenchmarksProducts', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListBenchmarksProductsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__list_benchmarks_products_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListBenchmarksProductsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListBenchmarksProductsResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_benchmarks_sources(google_ads_searchads360_v23_services__list_benchmarks_sources_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListBenchmarksSourcesResponse

Returns the list of benchmarks sources (for example, Industry Verticals). List of thrown errors: AuthenticationError AuthorizationError FieldError HeaderError InternalError QuotaError RequestError

Parameters:

  • google_ads_searchads360_v23_services__list_benchmarks_sources_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListBenchmarksSourcesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
# File 'lib/google/apis/searchads360_v23/service.rb', line 5632

def list_benchmarks_sources(google_ads_searchads360_v23_services__list_benchmarks_sources_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23:listBenchmarksSources', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListBenchmarksSourcesRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__list_benchmarks_sources_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListBenchmarksSourcesResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListBenchmarksSourcesResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_customer_accessible_customers(fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListAccessibleCustomersResponse

Returns resource names of customers directly accessible by the user authenticating the call. List of thrown errors: AuthenticationError AuthorizationError HeaderError InternalError QuotaError RequestError

Parameters:

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



614
615
616
617
618
619
620
621
# File 'lib/google/apis/searchads360_v23/service.rb', line 614

def list_customer_accessible_customers(fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v23/customers:listAccessibleCustomers', options)
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListAccessibleCustomersResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListAccessibleCustomersResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_customer_batch_job_results(resource_name, page_size: nil, page_token: nil, response_content_type: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListBatchJobResultsResponse

Returns the results of the batch job. The job must be done. Supports standard list paging. List of thrown errors: AuthenticationError AuthorizationError BatchJobError HeaderError InternalError QuotaError RequestError

Parameters:

  • resource_name (String)

    Required. The resource name of the batch job whose results are being listed.

  • page_size (Fixnum) (defaults to: nil)
  • page_token (String) (defaults to: nil)

    Token of the page to retrieve. If not specified, the first page of results will be returned. Use the value obtained from next_page_token in the previous response in order to request the next page of results.

  • response_content_type (String) (defaults to: nil)

    The response content type setting. Determines whether the mutable resource or just the resource name should be returned.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
# File 'lib/google/apis/searchads360_v23/service.rb', line 2032

def list_customer_batch_job_results(resource_name, page_size: nil, page_token: nil, response_content_type: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v23/{+resourceName}:listResults', options)
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListBatchJobResultsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListBatchJobResultsResponse
  command.params['resourceName'] = resource_name unless resource_name.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['responseContentType'] = response_content_type unless response_content_type.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_customer_campaign_draft_async_errors(resource_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListCampaignDraftAsyncErrorsResponse

Returns all errors that occurred during CampaignDraft promote. Throws an error if called before campaign draft is promoted. Supports standard list paging. List of thrown errors: AuthenticationError AuthorizationError HeaderError InternalError QuotaError RequestError

Parameters:

  • resource_name (String)

    Required. The name of the campaign draft from which to retrieve the async errors.

  • page_size (Fixnum) (defaults to: nil)

    Number of elements to retrieve in a single page. When a page request is too large, the server may decide to further limit the number of returned resources.

  • page_token (String) (defaults to: nil)

    Token of the page to retrieve. If not specified, the first page of results will be returned. Use the value obtained from next_page_token in the previous response in order to request the next page of results.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
# File 'lib/google/apis/searchads360_v23/service.rb', line 2551

def list_customer_campaign_draft_async_errors(resource_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v23/{+resourceName}:listAsyncErrors', options)
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListCampaignDraftAsyncErrorsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListCampaignDraftAsyncErrorsResponse
  command.params['resourceName'] = resource_name unless resource_name.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.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_customer_custom_columns(customer_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListCustomColumnsResponse

Returns all the custom columns associated with the customer in full detail.

Parameters:

  • customer_id (String)

    Required. The ID of the customer to apply the CustomColumn list operation to.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3134
3135
3136
3137
3138
3139
3140
3141
3142
# File 'lib/google/apis/searchads360_v23/service.rb', line 3134

def list_customer_custom_columns(customer_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v23/customers/{+customerId}/customColumns', options)
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListCustomColumnsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListCustomColumnsResponse
  command.params['customerId'] = customer_id unless customer_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

#list_customer_experiment_experiment_async_errors(resource_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListExperimentAsyncErrorsResponse

Returns all errors that occurred during the last Experiment update (either scheduling or promotion). Supports standard list paging. List of thrown errors: AuthenticationError AuthorizationError HeaderError InternalError QuotaError RequestError

Parameters:

  • resource_name (String)

    Required. The name of the experiment from which to retrieve the async errors.

  • page_size (Fixnum) (defaults to: nil)

    Number of elements to retrieve in a single page. When a page request is too large, the server may decide to further limit the number of returned resources. The maximum page size is 1000.

  • page_token (String) (defaults to: nil)

    Token of the page to retrieve. If not specified, the first page of results will be returned. Use the value obtained from next_page_token in the previous response in order to request the next page of results.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
# File 'lib/google/apis/searchads360_v23/service.rb', line 3933

def list_customer_experiment_experiment_async_errors(resource_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v23/{+resourceName}:listExperimentAsyncErrors', options)
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListExperimentAsyncErrorsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListExperimentAsyncErrorsResponse
  command.params['resourceName'] = resource_name unless resource_name.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.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_customer_invoices(customer_id, billing_setup: nil, include_granular_level_invoice_details: nil, issue_month: nil, issue_year: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListInvoicesResponse

Returns all invoices associated with a billing setup, for a given month. List of thrown errors: AuthenticationError AuthorizationError FieldError HeaderError InternalError InvoiceError QuotaError RequestError

Parameters:

  • customer_id (String)

    Required. The ID of the customer to fetch invoices for.

  • billing_setup (String) (defaults to: nil)

    Required. The billing setup resource name of the requested invoices. customers/customer_id/billingSetups/billing_setup_id``

  • include_granular_level_invoice_details (Boolean) (defaults to: nil)

    Optional. When true, the response will include more granular level invoice details such as campaign level cost breakdown, itemized regulatory costs and adjustments. The default value is false.

  • issue_month (String) (defaults to: nil)

    Required. The issue month to retrieve invoices.

  • issue_year (String) (defaults to: nil)

    Required. The issue year to retrieve invoices, in yyyy format. Only invoices issued in 2019 or later can be retrieved.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
# File 'lib/google/apis/searchads360_v23/service.rb', line 4136

def list_customer_invoices(customer_id, billing_setup: nil, include_granular_level_invoice_details: nil, issue_month: nil, issue_year: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v23/customers/{+customerId}/invoices', options)
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListInvoicesResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListInvoicesResponse
  command.params['customerId'] = customer_id unless customer_id.nil?
  command.query['billingSetup'] = billing_setup unless billing_setup.nil?
  command.query['includeGranularLevelInvoiceDetails'] = include_granular_level_invoice_details unless include_granular_level_invoice_details.nil?
  command.query['issueMonth'] = issue_month unless issue_month.nil?
  command.query['issueYear'] = issue_year unless issue_year.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_customer_payments_accounts(customer_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListPaymentsAccountsResponse

Returns all payments accounts associated with all managers between the login customer ID and specified serving customer in the hierarchy, inclusive. List of thrown errors: AuthenticationError AuthorizationError HeaderError InternalError PaymentsAccountError QuotaError RequestError

Parameters:

  • customer_id (String)

    Required. The ID of the customer to apply the PaymentsAccount list operation to.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4583
4584
4585
4586
4587
4588
4589
4590
4591
# File 'lib/google/apis/searchads360_v23/service.rb', line 4583

def list_customer_payments_accounts(customer_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v23/customers/{+customerId}/paymentsAccounts', options)
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListPaymentsAccountsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListPaymentsAccountsResponse
  command.params['customerId'] = customer_id unless customer_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

#list_plannable_locations(google_ads_searchads360_v23_services__list_plannable_locations_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListPlannableLocationsResponse

Returns the list of plannable locations (for example, countries). List of thrown errors: AuthenticationError AuthorizationError HeaderError InternalError QuotaError RequestError

Parameters:

  • google_ads_searchads360_v23_services__list_plannable_locations_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListPlannableLocationsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
# File 'lib/google/apis/searchads360_v23/service.rb', line 5664

def list_plannable_locations(google_ads_searchads360_v23_services__list_plannable_locations_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23:listPlannableLocations', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListPlannableLocationsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__list_plannable_locations_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListPlannableLocationsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListPlannableLocationsResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_plannable_products(google_ads_searchads360_v23_services__list_plannable_products_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListPlannableProductsResponse

Returns the list of per-location plannable YouTube ad formats with allowed targeting. List of thrown errors: AuthenticationError AuthorizationError HeaderError InternalError QuotaError RequestError

Parameters:

  • google_ads_searchads360_v23_services__list_plannable_products_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListPlannableProductsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
# File 'lib/google/apis/searchads360_v23/service.rb', line 5696

def list_plannable_products(google_ads_searchads360_v23_services__list_plannable_products_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23:listPlannableProducts', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListPlannableProductsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__list_plannable_products_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListPlannableProductsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListPlannableProductsResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_plannable_user_interests(google_ads_searchads360_v23_services__list_plannable_user_interests_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListPlannableUserInterestsResponse

Returns the list of plannable user interests. A plannable user interest is one that can be targeted in a reach forecast using ReachPlanService. GenerateReachForecast. List of thrown errors: AuthenticationError AuthorizationError FieldError HeaderError InternalError ListOperationError QuotaError RequestError StringLengthError

Parameters:

  • google_ads_searchads360_v23_services__list_plannable_user_interests_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListPlannableUserInterestsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
# File 'lib/google/apis/searchads360_v23/service.rb', line 5730

def list_plannable_user_interests(google_ads_searchads360_v23_services__list_plannable_user_interests_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23:listPlannableUserInterests', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListPlannableUserInterestsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__list_plannable_user_interests_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListPlannableUserInterestsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListPlannableUserInterestsResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_plannable_user_lists(google_ads_searchads360_v23_services__list_plannable_user_lists_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListPlannableUserListsResponse

Returns the list of plannable user lists with their plannable status. User lists may not be plannable for a number of reasons, including: - They are less than 10 days old. - They have a membership lifespan that is less than 30 days - They have less than 10,000 or more than 700,000 users. List of thrown errors: AuthenticationError AuthorizationError FieldError HeaderError InternalError QuotaError RangeError ReachPlanError RequestError

Parameters:

  • google_ads_searchads360_v23_services__list_plannable_user_lists_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListPlannableUserListsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
# File 'lib/google/apis/searchads360_v23/service.rb', line 5766

def list_plannable_user_lists(google_ads_searchads360_v23_services__list_plannable_user_lists_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23:listPlannableUserLists', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListPlannableUserListsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__list_plannable_user_lists_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListPlannableUserListsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListPlannableUserListsResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

Moves a client customer to a new manager customer. This simplifies the complex request that requires two operations to move a client customer to a new manager, for example: 1. Update operation with Status INACTIVE (previous manager) and, 2. Update operation with Status ACTIVE (new manager). List of thrown errors: AuthenticationError AuthorizationError DatabaseError FieldError HeaderError InternalError MutateError QuotaError RequestError

Parameters:

  • customer_id (String)

    Required. The ID of the client customer that is being moved.

  • google_ads_searchads360_v23_services__move_manager_link_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMoveManagerLinkRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
# File 'lib/google/apis/searchads360_v23/service.rb', line 3456

def move_customer_customer_manager_link_manager_link(customer_id, google_ads_searchads360_v23_services__move_manager_link_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/customerManagerLinks:moveManagerLink', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMoveManagerLinkRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__move_manager_link_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMoveManagerLinkResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMoveManagerLinkResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer(customer_id, google_ads_searchads360_v23_services__mutate_customer_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerResponse

Parameters:

  • customer_id (String)

    Required. The ID of the customer being modified.

  • google_ads_searchads360_v23_services__mutate_customer_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



647
648
649
650
651
652
653
654
655
656
657
# File 'lib/google/apis/searchads360_v23/service.rb', line 647

def mutate_customer(customer_id, google_ads_searchads360_v23_services__mutate_customer_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_customer_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_account_budget_proposal(customer_id, google_ads_searchads360_v23_services__mutate_account_budget_proposal_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAccountBudgetProposalResponse

Parameters:

  • customer_id (String)

    Required. The ID of the customer.

  • google_ads_searchads360_v23_services__mutate_account_budget_proposal_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAccountBudgetProposalRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
# File 'lib/google/apis/searchads360_v23/service.rb', line 1104

def (customer_id,  = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/accountBudgetProposals:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAccountBudgetProposalRequest::Representation
  command.request_object = 
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAccountBudgetProposalResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAccountBudgetProposalResponse
  command.params['customerId'] = customer_id unless customer_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

Creates or removes an account link. From V5, create is not supported through AccountLinkService.MutateAccountLink. Use AccountLinkService.CreateAccountLink instead. List of thrown errors: AccountLinkError AuthenticationError AuthorizationError FieldMaskError HeaderError InternalError MutateError QuotaError RequestError

Parameters:

  • customer_id (String)

    Required. The ID of the customer being modified.

  • google_ads_searchads360_v23_services__mutate_account_link_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAccountLinkRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
# File 'lib/google/apis/searchads360_v23/service.rb', line 1177

def (customer_id,  = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/accountLinks:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAccountLinkRequest::Representation
  command.request_object = 
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAccountLinkResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAccountLinkResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_ad(customer_id, google_ads_searchads360_v23_services__mutate_ads_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdsResponse

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose ads are being modified.

  • google_ads_searchads360_v23_services__mutate_ads_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
# File 'lib/google/apis/searchads360_v23/service.rb', line 1679

def mutate_customer_ad(customer_id, google_ads_searchads360_v23_services__mutate_ads_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/ads:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_ads_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdsResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_ad_group(customer_id, google_ads_searchads360_v23_services__mutate_ad_groups_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdGroupsResponse

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose ad groups are being modified.

  • google_ads_searchads360_v23_services__mutate_ad_groups_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdGroupsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
# File 'lib/google/apis/searchads360_v23/service.rb', line 1598

def mutate_customer_ad_group(customer_id, google_ads_searchads360_v23_services__mutate_ad_groups_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/adGroups:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdGroupsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_ad_groups_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdGroupsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdGroupsResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_ad_group_ad(customer_id, google_ads_searchads360_v23_services__mutate_ad_group_ads_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdGroupAdsResponse

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose ads are being modified.

  • google_ads_searchads360_v23_services__mutate_ad_group_ads_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdGroupAdsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
# File 'lib/google/apis/searchads360_v23/service.rb', line 1259

def mutate_customer_ad_group_ad(customer_id, google_ads_searchads360_v23_services__mutate_ad_group_ads_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/adGroupAds:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdGroupAdsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_ad_group_ads_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdGroupAdsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdGroupAdsResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_ad_group_ad_label(customer_id, google_ads_searchads360_v23_services__mutate_ad_group_ad_labels_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdGroupAdLabelsResponse

Creates and removes ad group ad labels. Operation statuses are returned. List of thrown errors: AuthenticationError AuthorizationError DatabaseError HeaderError InternalError LabelError MutateError NewResourceCreationError QuotaError RequestError

Parameters:

  • customer_id (String)

    Required. ID of the customer whose ad group ad labels are being modified.

  • google_ads_searchads360_v23_services__mutate_ad_group_ad_labels_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdGroupAdLabelsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
# File 'lib/google/apis/searchads360_v23/service.rb', line 1213

def mutate_customer_ad_group_ad_label(customer_id, google_ads_searchads360_v23_services__mutate_ad_group_ad_labels_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/adGroupAdLabels:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdGroupAdLabelsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_ad_group_ad_labels_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdGroupAdLabelsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdGroupAdLabelsResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_ad_group_asset(customer_id, google_ads_searchads360_v23_services__mutate_ad_group_assets_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdGroupAssetsResponse

Creates, updates, or removes ad group assets. Operation statuses are returned. List of thrown errors: AssetLinkError AuthenticationError AuthorizationError ContextError FieldError HeaderError InternalError MutateError NotAllowlistedError QuotaError RequestError

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose ad group assets are being modified.

  • google_ads_searchads360_v23_services__mutate_ad_group_assets_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdGroupAssetsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
# File 'lib/google/apis/searchads360_v23/service.rb', line 1366

def mutate_customer_ad_group_asset(customer_id, google_ads_searchads360_v23_services__mutate_ad_group_assets_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/adGroupAssets:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdGroupAssetsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_ad_group_assets_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdGroupAssetsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdGroupAssetsResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_ad_group_asset_set(customer_id, google_ads_searchads360_v23_services__mutate_ad_group_asset_sets_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdGroupAssetSetsResponse

Creates, or removes ad group asset sets. Operation statuses are returned.

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose ad group asset sets are being modified.

  • google_ads_searchads360_v23_services__mutate_ad_group_asset_sets_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdGroupAssetSetsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
# File 'lib/google/apis/searchads360_v23/service.rb', line 1329

def mutate_customer_ad_group_asset_set(customer_id, google_ads_searchads360_v23_services__mutate_ad_group_asset_sets_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/adGroupAssetSets:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdGroupAssetSetsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_ad_group_asset_sets_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdGroupAssetSetsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdGroupAssetSetsResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_ad_group_bid_modifier(customer_id, google_ads_searchads360_v23_services__mutate_ad_group_bid_modifiers_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdGroupBidModifiersResponse

Parameters:

  • customer_id (String)

    Required. ID of the customer whose ad group bid modifiers are being modified.

  • google_ads_searchads360_v23_services__mutate_ad_group_bid_modifiers_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdGroupBidModifiersRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
# File 'lib/google/apis/searchads360_v23/service.rb', line 1406

def mutate_customer_ad_group_bid_modifier(customer_id, google_ads_searchads360_v23_services__mutate_ad_group_bid_modifiers_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/adGroupBidModifiers:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdGroupBidModifiersRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_ad_group_bid_modifiers_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdGroupBidModifiersResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdGroupBidModifiersResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_ad_group_criterion_customizer(customer_id, google_ads_searchads360_v23_services__mutate_ad_group_criterion_customizers_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdGroupCriterionCustomizersResponse

Creates, updates or removes ad group criterion customizers. Operation statuses are returned.

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose ad group criterion customizers are being modified.

  • google_ads_searchads360_v23_services__mutate_ad_group_criterion_customizers_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdGroupCriterionCustomizersRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



961
962
963
964
965
966
967
968
969
970
971
# File 'lib/google/apis/searchads360_v23/service.rb', line 961

def mutate_customer_ad_group_criterion_customizer(customer_id, google_ads_searchads360_v23_services__mutate_ad_group_criterion_customizers_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/AdGroupCriterionCustomizers:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdGroupCriterionCustomizersRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_ad_group_criterion_customizers_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdGroupCriterionCustomizersResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdGroupCriterionCustomizersResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_ad_group_criterion_label(customer_id, google_ads_searchads360_v23_services__mutate_ad_group_criterion_labels_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdGroupCriterionLabelsResponse

Creates and removes ad group criterion labels. Operation statuses are returned. List of thrown errors: AuthenticationError AuthorizationError DatabaseError FieldError HeaderError InternalError QuotaError RequestError

Parameters:

  • customer_id (String)

    Required. ID of the customer whose ad group criterion labels are being modified.

  • google_ads_searchads360_v23_services__mutate_ad_group_criterion_labels_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdGroupCriterionLabelsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
# File 'lib/google/apis/searchads360_v23/service.rb', line 1486

def mutate_customer_ad_group_criterion_label(customer_id, google_ads_searchads360_v23_services__mutate_ad_group_criterion_labels_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/adGroupCriterionLabels:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdGroupCriterionLabelsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_ad_group_criterion_labels_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdGroupCriterionLabelsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdGroupCriterionLabelsResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_ad_group_criterium(customer_id, google_ads_searchads360_v23_services__mutate_ad_group_criteria_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdGroupCriteriaResponse

Parameters:

  • customer_id (String)

    Required. ID of the customer whose criteria are being modified.

  • google_ads_searchads360_v23_services__mutate_ad_group_criteria_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdGroupCriteriaRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
# File 'lib/google/apis/searchads360_v23/service.rb', line 1449

def mutate_customer_ad_group_criterium(customer_id, google_ads_searchads360_v23_services__mutate_ad_group_criteria_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/adGroupCriteria:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdGroupCriteriaRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_ad_group_criteria_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdGroupCriteriaResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdGroupCriteriaResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_ad_group_customizer(customer_id, google_ads_searchads360_v23_services__mutate_ad_group_customizers_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdGroupCustomizersResponse

Creates, updates or removes ad group customizers. Operation statuses are returned.

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose ad group customizers are being modified.

  • google_ads_searchads360_v23_services__mutate_ad_group_customizers_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdGroupCustomizersRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
# File 'lib/google/apis/searchads360_v23/service.rb', line 1520

def mutate_customer_ad_group_customizer(customer_id, google_ads_searchads360_v23_services__mutate_ad_group_customizers_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/adGroupCustomizers:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdGroupCustomizersRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_ad_group_customizers_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdGroupCustomizersResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdGroupCustomizersResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_ad_group_label(customer_id, google_ads_searchads360_v23_services__mutate_ad_group_labels_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdGroupLabelsResponse

Creates and removes ad group labels. Operation statuses are returned. List of thrown errors: AuthenticationError AuthorizationError DatabaseError FieldError HeaderError InternalError LabelError MutateError NewResourceCreationError QuotaError RequestError

Parameters:

  • customer_id (String)

    Required. ID of the customer whose ad group labels are being modified.

  • google_ads_searchads360_v23_services__mutate_ad_group_labels_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdGroupLabelsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
# File 'lib/google/apis/searchads360_v23/service.rb', line 1556

def mutate_customer_ad_group_label(customer_id, google_ads_searchads360_v23_services__mutate_ad_group_labels_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/adGroupLabels:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdGroupLabelsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_ad_group_labels_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdGroupLabelsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdGroupLabelsResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_ad_parameter(customer_id, google_ads_searchads360_v23_services__mutate_ad_parameters_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdParametersResponse

Creates, updates, or removes ad parameters. Operation statuses are returned. List of thrown errors: AdParameterError AuthenticationError AuthorizationError ContextError DatabaseError FieldError FieldMaskError HeaderError InternalError MutateError QuotaError RequestError

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose ad parameters are being modified.

  • google_ads_searchads360_v23_services__mutate_ad_parameters_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdParametersRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
# File 'lib/google/apis/searchads360_v23/service.rb', line 1635

def mutate_customer_ad_parameter(customer_id, google_ads_searchads360_v23_services__mutate_ad_parameters_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/adParameters:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdParametersRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_ad_parameters_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdParametersResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAdParametersResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_asset(customer_id, google_ads_searchads360_v23_services__mutate_assets_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAssetsResponse

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose assets are being modified.

  • google_ads_searchads360_v23_services__mutate_assets_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAssetsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
# File 'lib/google/apis/searchads360_v23/service.rb', line 1920

def mutate_customer_asset(customer_id, google_ads_searchads360_v23_services__mutate_assets_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/assets:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAssetsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_assets_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAssetsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAssetsResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_asset_group(customer_id, google_ads_searchads360_v23_services__mutate_asset_groups_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAssetGroupsResponse

Creates, updates or removes asset groups. Operation statuses are returned.

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose asset groups are being modified.

  • google_ads_searchads360_v23_services__mutate_asset_groups_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAssetGroupsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
# File 'lib/google/apis/searchads360_v23/service.rb', line 1814

def mutate_customer_asset_group(customer_id, google_ads_searchads360_v23_services__mutate_asset_groups_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/assetGroups:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAssetGroupsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_asset_groups_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAssetGroupsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAssetGroupsResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_asset_group_asset(customer_id, google_ads_searchads360_v23_services__mutate_asset_group_assets_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAssetGroupAssetsResponse

Creates, updates or removes asset group assets. Operation statuses are returned.

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose asset group assets are being modified.

  • google_ads_searchads360_v23_services__mutate_asset_group_assets_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAssetGroupAssetsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
# File 'lib/google/apis/searchads360_v23/service.rb', line 1713

def mutate_customer_asset_group_asset(customer_id, google_ads_searchads360_v23_services__mutate_asset_group_assets_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/assetGroupAssets:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAssetGroupAssetsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_asset_group_assets_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAssetGroupAssetsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAssetGroupAssetsResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_asset_group_listing_group_filter(customer_id, google_ads_searchads360_v23_services__mutate_asset_group_listing_group_filters_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAssetGroupListingGroupFiltersResponse

Creates, updates or removes asset group listing group filters. Operation statuses are returned.

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose asset group listing group filters are being modified.

  • google_ads_searchads360_v23_services__mutate_asset_group_listing_group_filters_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAssetGroupListingGroupFiltersRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
# File 'lib/google/apis/searchads360_v23/service.rb', line 1748

def mutate_customer_asset_group_listing_group_filter(customer_id, google_ads_searchads360_v23_services__mutate_asset_group_listing_group_filters_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/assetGroupListingGroupFilters:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAssetGroupListingGroupFiltersRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_asset_group_listing_group_filters_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAssetGroupListingGroupFiltersResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAssetGroupListingGroupFiltersResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_asset_group_signal(customer_id, google_ads_searchads360_v23_services__mutate_asset_group_signals_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAssetGroupSignalsResponse

Creates or removes asset group signals. Operation statuses are returned.

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose asset group signals are being modified.

  • google_ads_searchads360_v23_services__mutate_asset_group_signals_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAssetGroupSignalsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
# File 'lib/google/apis/searchads360_v23/service.rb', line 1781

def mutate_customer_asset_group_signal(customer_id, google_ads_searchads360_v23_services__mutate_asset_group_signals_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/assetGroupSignals:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAssetGroupSignalsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_asset_group_signals_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAssetGroupSignalsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAssetGroupSignalsResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_asset_set(customer_id, google_ads_searchads360_v23_services__mutate_asset_sets_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAssetSetsResponse

Creates, updates or removes asset sets. Operation statuses are returned.

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose asset sets are being modified.

  • google_ads_searchads360_v23_services__mutate_asset_sets_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAssetSetsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
# File 'lib/google/apis/searchads360_v23/service.rb', line 1880

def mutate_customer_asset_set(customer_id, google_ads_searchads360_v23_services__mutate_asset_sets_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/assetSets:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAssetSetsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_asset_sets_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAssetSetsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAssetSetsResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_asset_set_asset(customer_id, google_ads_searchads360_v23_services__mutate_asset_set_assets_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAssetSetAssetsResponse

Creates, updates or removes asset set assets. Operation statuses are returned.

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose asset set assets are being modified.

  • google_ads_searchads360_v23_services__mutate_asset_set_assets_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAssetSetAssetsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
# File 'lib/google/apis/searchads360_v23/service.rb', line 1847

def mutate_customer_asset_set_asset(customer_id, google_ads_searchads360_v23_services__mutate_asset_set_assets_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/assetSetAssets:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAssetSetAssetsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_asset_set_assets_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAssetSetAssetsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAssetSetAssetsResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_audience(customer_id, google_ads_searchads360_v23_services__mutate_audiences_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAudiencesResponse

Creates audiences. Operation statuses are returned. List of thrown errors: AudienceError

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose audiences are being modified.

  • google_ads_searchads360_v23_services__mutate_audiences_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAudiencesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
# File 'lib/google/apis/searchads360_v23/service.rb', line 1954

def mutate_customer_audience(customer_id, google_ads_searchads360_v23_services__mutate_audiences_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/audiences:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAudiencesRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_audiences_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAudiencesResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateAudiencesResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_batch_job(customer_id, google_ads_searchads360_v23_services__mutate_batch_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateBatchJobResponse

Parameters:

  • customer_id (String)

    Required. The ID of the customer for which to create a batch job.

  • google_ads_searchads360_v23_services__mutate_batch_job_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateBatchJobRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
# File 'lib/google/apis/searchads360_v23/service.rb', line 2068

def mutate_customer_batch_job(customer_id, google_ads_searchads360_v23_services__mutate_batch_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/batchJobs:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateBatchJobRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_batch_job_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateBatchJobResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateBatchJobResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_bidding_data_exclusion(customer_id, google_ads_searchads360_v23_services__mutate_bidding_data_exclusions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateBiddingDataExclusionsResponse

Creates, updates, or removes data exclusions. Operation statuses are returned.

Parameters:

  • customer_id (String)

    Required. ID of the customer whose data exclusions are being modified.

  • google_ads_searchads360_v23_services__mutate_bidding_data_exclusions_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateBiddingDataExclusionsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
# File 'lib/google/apis/searchads360_v23/service.rb', line 2139

def mutate_customer_bidding_data_exclusion(customer_id, google_ads_searchads360_v23_services__mutate_bidding_data_exclusions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/biddingDataExclusions:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateBiddingDataExclusionsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_bidding_data_exclusions_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateBiddingDataExclusionsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateBiddingDataExclusionsResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_bidding_seasonality_adjustment(customer_id, google_ads_searchads360_v23_services__mutate_bidding_seasonality_adjustments_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateBiddingSeasonalityAdjustmentsResponse

Creates, updates, or removes seasonality adjustments. Operation statuses are returned.

Parameters:

  • customer_id (String)

    Required. ID of the customer whose seasonality adjustments are being modified.

  • google_ads_searchads360_v23_services__mutate_bidding_seasonality_adjustments_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateBiddingSeasonalityAdjustmentsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
# File 'lib/google/apis/searchads360_v23/service.rb', line 2173

def mutate_customer_bidding_seasonality_adjustment(customer_id, google_ads_searchads360_v23_services__mutate_bidding_seasonality_adjustments_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/biddingSeasonalityAdjustments:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateBiddingSeasonalityAdjustmentsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_bidding_seasonality_adjustments_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateBiddingSeasonalityAdjustmentsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateBiddingSeasonalityAdjustmentsResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_bidding_strategy(customer_id, google_ads_searchads360_v23_services__mutate_bidding_strategies_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateBiddingStrategiesResponse

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose bidding strategies are being modified.

  • google_ads_searchads360_v23_services__mutate_bidding_strategies_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateBiddingStrategiesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
# File 'lib/google/apis/searchads360_v23/service.rb', line 2213

def mutate_customer_bidding_strategy(customer_id, google_ads_searchads360_v23_services__mutate_bidding_strategies_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/biddingStrategies:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateBiddingStrategiesRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_bidding_strategies_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateBiddingStrategiesResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateBiddingStrategiesResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_billing_setup(customer_id, google_ads_searchads360_v23_services__mutate_billing_setup_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateBillingSetupResponse

Creates a billing setup, or cancels an existing billing setup. List of thrown errors: AuthenticationError AuthorizationError BillingSetupError DateError FieldError HeaderError InternalError MutateError QuotaError RequestError

Parameters:

  • customer_id (String)

    Required. Id of the customer to apply the billing setup mutate operation to.

  • google_ads_searchads360_v23_services__mutate_billing_setup_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateBillingSetupRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
# File 'lib/google/apis/searchads360_v23/service.rb', line 2249

def mutate_customer_billing_setup(customer_id, google_ads_searchads360_v23_services__mutate_billing_setup_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/billingSetups:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateBillingSetupRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_billing_setup_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateBillingSetupResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateBillingSetupResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_campaign(customer_id, google_ads_searchads360_v23_services__mutate_campaigns_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignsResponse

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose campaigns are being modified.

  • google_ads_searchads360_v23_services__mutate_campaigns_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
# File 'lib/google/apis/searchads360_v23/service.rb', line 2854

def mutate_customer_campaign(customer_id, google_ads_searchads360_v23_services__mutate_campaigns_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/campaigns:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_campaigns_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignsResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_campaign_asset(customer_id, google_ads_searchads360_v23_services__mutate_campaign_assets_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignAssetsResponse

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose campaign assets are being modified.

  • google_ads_searchads360_v23_services__mutate_campaign_assets_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignAssetsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
# File 'lib/google/apis/searchads360_v23/service.rb', line 2320

def mutate_customer_campaign_asset(customer_id, google_ads_searchads360_v23_services__mutate_campaign_assets_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/campaignAssets:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignAssetsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_campaign_assets_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignAssetsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignAssetsResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_campaign_asset_set(customer_id, google_ads_searchads360_v23_services__mutate_campaign_asset_sets_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignAssetSetsResponse

Creates, updates or removes campaign asset sets. Operation statuses are returned.

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose campaign asset sets are being modified.

  • google_ads_searchads360_v23_services__mutate_campaign_asset_sets_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignAssetSetsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
# File 'lib/google/apis/searchads360_v23/service.rb', line 2283

def mutate_customer_campaign_asset_set(customer_id, google_ads_searchads360_v23_services__mutate_campaign_asset_sets_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/campaignAssetSets:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignAssetSetsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_campaign_asset_sets_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignAssetSetsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignAssetSetsResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_campaign_bid_modifier(customer_id, google_ads_searchads360_v23_services__mutate_campaign_bid_modifiers_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignBidModifiersResponse

Parameters:

  • customer_id (String)

    Required. ID of the customer whose campaign bid modifiers are being modified.

  • google_ads_searchads360_v23_services__mutate_campaign_bid_modifiers_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignBidModifiersRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
# File 'lib/google/apis/searchads360_v23/service.rb', line 2359

def mutate_customer_campaign_bid_modifier(customer_id, google_ads_searchads360_v23_services__mutate_campaign_bid_modifiers_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/campaignBidModifiers:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignBidModifiersRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_campaign_bid_modifiers_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignBidModifiersResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignBidModifiersResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_campaign_budget(customer_id, google_ads_searchads360_v23_services__mutate_campaign_budgets_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignBudgetsResponse

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose campaign budgets are being modified.

  • google_ads_searchads360_v23_services__mutate_campaign_budgets_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignBudgetsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
# File 'lib/google/apis/searchads360_v23/service.rb', line 2398

def mutate_customer_campaign_budget(customer_id, google_ads_searchads360_v23_services__mutate_campaign_budgets_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/campaignBudgets:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignBudgetsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_campaign_budgets_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignBudgetsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignBudgetsResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_campaign_conversion_goal(customer_id, google_ads_searchads360_v23_services__mutate_campaign_conversion_goals_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignConversionGoalsResponse

Creates, updates or removes campaign conversion goals. Operation statuses are returned.

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose campaign conversion goals are being modified.

  • google_ads_searchads360_v23_services__mutate_campaign_conversion_goals_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignConversionGoalsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
# File 'lib/google/apis/searchads360_v23/service.rb', line 2433

def mutate_customer_campaign_conversion_goal(customer_id, google_ads_searchads360_v23_services__mutate_campaign_conversion_goals_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/campaignConversionGoals:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignConversionGoalsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_campaign_conversion_goals_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignConversionGoalsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignConversionGoalsResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_campaign_criterium(customer_id, google_ads_searchads360_v23_services__mutate_campaign_criteria_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignCriteriaResponse

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose criteria are being modified.

  • google_ads_searchads360_v23_services__mutate_campaign_criteria_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignCriteriaRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
# File 'lib/google/apis/searchads360_v23/service.rb', line 2474

def mutate_customer_campaign_criterium(customer_id, google_ads_searchads360_v23_services__mutate_campaign_criteria_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/campaignCriteria:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignCriteriaRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_campaign_criteria_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignCriteriaResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignCriteriaResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_campaign_customizer(customer_id, google_ads_searchads360_v23_services__mutate_campaign_customizers_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignCustomizersResponse

Creates, updates or removes campaign customizers. Operation statuses are returned.

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose campaign customizers are being modified.

  • google_ads_searchads360_v23_services__mutate_campaign_customizers_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignCustomizersRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
# File 'lib/google/apis/searchads360_v23/service.rb', line 2508

def mutate_customer_campaign_customizer(customer_id, google_ads_searchads360_v23_services__mutate_campaign_customizers_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/campaignCustomizers:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignCustomizersRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_campaign_customizers_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignCustomizersResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignCustomizersResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_campaign_draft(customer_id, google_ads_searchads360_v23_services__mutate_campaign_drafts_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignDraftsResponse

Creates, updates, or removes campaign drafts. Operation statuses are returned. List of thrown errors: AuthenticationError AuthorizationError CampaignDraftError DatabaseError FieldError HeaderError InternalError MutateError QuotaError RequestError

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose campaign drafts are being modified.

  • google_ads_searchads360_v23_services__mutate_campaign_drafts_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignDraftsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
# File 'lib/google/apis/searchads360_v23/service.rb', line 2587

def mutate_customer_campaign_draft(customer_id, google_ads_searchads360_v23_services__mutate_campaign_drafts_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/campaignDrafts:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignDraftsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_campaign_drafts_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignDraftsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignDraftsResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_campaign_goal_config(customer_id, google_ads_searchads360_v23_services__mutate_campaign_goal_configs_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignGoalConfigsResponse

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose campaign goal configs are being modified.

  • google_ads_searchads360_v23_services__mutate_campaign_goal_configs_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignGoalConfigsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
# File 'lib/google/apis/searchads360_v23/service.rb', line 998

def mutate_customer_campaign_goal_config(customer_id, google_ads_searchads360_v23_services__mutate_campaign_goal_configs_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/CampaignGoalConfigs:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignGoalConfigsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_campaign_goal_configs_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignGoalConfigsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignGoalConfigsResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_campaign_group(customer_id, google_ads_searchads360_v23_services__mutate_campaign_groups_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignGroupsResponse

Creates, updates, or removes campaign groups. Operation statuses are returned.

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose campaign groups are being modified.

  • google_ads_searchads360_v23_services__mutate_campaign_groups_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignGroupsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
# File 'lib/google/apis/searchads360_v23/service.rb', line 2661

def mutate_customer_campaign_group(customer_id, google_ads_searchads360_v23_services__mutate_campaign_groups_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/campaignGroups:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignGroupsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_campaign_groups_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignGroupsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignGroupsResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_campaign_label(customer_id, google_ads_searchads360_v23_services__mutate_campaign_labels_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignLabelsResponse

Creates and removes campaign-label relationships. Operation statuses are returned. List of thrown errors: AuthenticationError AuthorizationError DatabaseError FieldError HeaderError InternalError LabelError MutateError NewResourceCreationError QuotaError RequestError

Parameters:

  • customer_id (String)

    Required. ID of the customer whose campaign-label relationships are being modified.

  • google_ads_searchads360_v23_services__mutate_campaign_labels_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignLabelsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
# File 'lib/google/apis/searchads360_v23/service.rb', line 2699

def mutate_customer_campaign_label(customer_id, google_ads_searchads360_v23_services__mutate_campaign_labels_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/campaignLabels:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignLabelsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_campaign_labels_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignLabelsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignLabelsResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_campaign_shared_set(customer_id, google_ads_searchads360_v23_services__mutate_campaign_shared_sets_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignSharedSetsResponse

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose campaign shared sets are being modified.

  • google_ads_searchads360_v23_services__mutate_campaign_shared_sets_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignSharedSetsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
# File 'lib/google/apis/searchads360_v23/service.rb', line 2774

def mutate_customer_campaign_shared_set(customer_id, google_ads_searchads360_v23_services__mutate_campaign_shared_sets_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/campaignSharedSets:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignSharedSetsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_campaign_shared_sets_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignSharedSetsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCampaignSharedSetsResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_conversion_action(customer_id, google_ads_searchads360_v23_services__mutate_conversion_actions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateConversionActionsResponse

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose conversion actions are being modified.

  • google_ads_searchads360_v23_services__mutate_conversion_actions_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateConversionActionsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
# File 'lib/google/apis/searchads360_v23/service.rb', line 2892

def mutate_customer_conversion_action(customer_id, google_ads_searchads360_v23_services__mutate_conversion_actions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/conversionActions:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateConversionActionsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_conversion_actions_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateConversionActionsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateConversionActionsResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_conversion_custom_variable(customer_id, google_ads_searchads360_v23_services__mutate_conversion_custom_variables_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateConversionCustomVariablesResponse

Creates or updates conversion custom variables. Operation statuses are returned. List of thrown errors: AuthenticationError AuthorizationError ConversionCustomVariableError DatabaseError HeaderError InternalError QuotaError RequestError

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose conversion custom variables are being modified.

  • google_ads_searchads360_v23_services__mutate_conversion_custom_variables_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateConversionCustomVariablesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
# File 'lib/google/apis/searchads360_v23/service.rb', line 2929

def mutate_customer_conversion_custom_variable(customer_id, google_ads_searchads360_v23_services__mutate_conversion_custom_variables_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/conversionCustomVariables:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateConversionCustomVariablesRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_conversion_custom_variables_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateConversionCustomVariablesResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateConversionCustomVariablesResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_conversion_goal_campaign_config(customer_id, google_ads_searchads360_v23_services__mutate_conversion_goal_campaign_configs_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateConversionGoalCampaignConfigsResponse

Creates, updates or removes conversion goal campaign config. Operation statuses are returned.

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose custom conversion goals are being modified.

  • google_ads_searchads360_v23_services__mutate_conversion_goal_campaign_configs_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateConversionGoalCampaignConfigsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
# File 'lib/google/apis/searchads360_v23/service.rb', line 2964

def mutate_customer_conversion_goal_campaign_config(customer_id, google_ads_searchads360_v23_services__mutate_conversion_goal_campaign_configs_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/conversionGoalCampaignConfigs:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateConversionGoalCampaignConfigsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_conversion_goal_campaign_configs_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateConversionGoalCampaignConfigsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateConversionGoalCampaignConfigsResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_conversion_value_rule(customer_id, google_ads_searchads360_v23_services__mutate_conversion_value_rules_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateConversionValueRulesResponse

Creates, updates, or removes conversion value rules. Operation statuses are returned.

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose conversion value rules are being modified.

  • google_ads_searchads360_v23_services__mutate_conversion_value_rules_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateConversionValueRulesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
# File 'lib/google/apis/searchads360_v23/service.rb', line 3034

def mutate_customer_conversion_value_rule(customer_id, google_ads_searchads360_v23_services__mutate_conversion_value_rules_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/conversionValueRules:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateConversionValueRulesRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_conversion_value_rules_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateConversionValueRulesResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateConversionValueRulesResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_conversion_value_rule_set(customer_id, google_ads_searchads360_v23_services__mutate_conversion_value_rule_sets_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateConversionValueRuleSetsResponse

Creates, updates or removes conversion value rule sets. Operation statuses are returned.

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose conversion value rule sets are being modified.

  • google_ads_searchads360_v23_services__mutate_conversion_value_rule_sets_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateConversionValueRuleSetsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
# File 'lib/google/apis/searchads360_v23/service.rb', line 2999

def mutate_customer_conversion_value_rule_set(customer_id, google_ads_searchads360_v23_services__mutate_conversion_value_rule_sets_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/conversionValueRuleSets:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateConversionValueRuleSetsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_conversion_value_rule_sets_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateConversionValueRuleSetsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateConversionValueRuleSetsResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_custom_audience(customer_id, google_ads_searchads360_v23_services__mutate_custom_audiences_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomAudiencesResponse

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose custom audiences are being modified.

  • google_ads_searchads360_v23_services__mutate_custom_audiences_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomAudiencesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
# File 'lib/google/apis/searchads360_v23/service.rb', line 3072

def mutate_customer_custom_audience(customer_id, google_ads_searchads360_v23_services__mutate_custom_audiences_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/customAudiences:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomAudiencesRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_custom_audiences_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomAudiencesResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomAudiencesResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_custom_conversion_goal(customer_id, google_ads_searchads360_v23_services__mutate_custom_conversion_goals_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomConversionGoalsResponse

Creates, updates or removes custom conversion goals. Operation statuses are returned.

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose custom conversion goals are being modified.

  • google_ads_searchads360_v23_services__mutate_custom_conversion_goals_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomConversionGoalsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
# File 'lib/google/apis/searchads360_v23/service.rb', line 3167

def mutate_customer_custom_conversion_goal(customer_id, google_ads_searchads360_v23_services__mutate_custom_conversion_goals_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/customConversionGoals:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomConversionGoalsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_custom_conversion_goals_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomConversionGoalsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomConversionGoalsResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_custom_interest(customer_id, google_ads_searchads360_v23_services__mutate_custom_interests_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomInterestsResponse

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose custom interests are being modified.

  • google_ads_searchads360_v23_services__mutate_custom_interests_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomInterestsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
# File 'lib/google/apis/searchads360_v23/service.rb', line 3203

def mutate_customer_custom_interest(customer_id, google_ads_searchads360_v23_services__mutate_custom_interests_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/customInterests:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomInterestsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_custom_interests_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomInterestsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomInterestsResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_customer_asset(customer_id, google_ads_searchads360_v23_services__mutate_customer_assets_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerAssetsResponse

Creates, updates, or removes customer assets. Operation statuses are returned. List of thrown errors: AssetLinkError AuthenticationError AuthorizationError FieldError HeaderError InternalError MutateError QuotaError RequestError

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose customer assets are being modified.

  • google_ads_searchads360_v23_services__mutate_customer_assets_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerAssetsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
# File 'lib/google/apis/searchads360_v23/service.rb', line 3272

def mutate_customer_customer_asset(customer_id, google_ads_searchads360_v23_services__mutate_customer_assets_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/customerAssets:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerAssetsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_customer_assets_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerAssetsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerAssetsResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_customer_asset_set(customer_id, google_ads_searchads360_v23_services__mutate_customer_asset_sets_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerAssetSetsResponse

Creates, or removes customer asset sets. Operation statuses are returned.

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose customer asset sets are being modified.

  • google_ads_searchads360_v23_services__mutate_customer_asset_sets_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerAssetSetsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
# File 'lib/google/apis/searchads360_v23/service.rb', line 3236

def mutate_customer_customer_asset_set(customer_id, google_ads_searchads360_v23_services__mutate_customer_asset_sets_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/customerAssetSets:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerAssetSetsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_customer_asset_sets_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerAssetSetsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerAssetSetsResponse
  command.params['customerId'] = customer_id unless customer_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

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose customer link are being modified.

  • google_ads_searchads360_v23_services__mutate_customer_client_link_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerClientLinkRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
# File 'lib/google/apis/searchads360_v23/service.rb', line 3309

def mutate_customer_customer_client_link(customer_id, google_ads_searchads360_v23_services__mutate_customer_client_link_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/customerClientLinks:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerClientLinkRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_customer_client_link_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerClientLinkResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerClientLinkResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_customer_conversion_goal(customer_id, google_ads_searchads360_v23_services__mutate_customer_conversion_goals_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerConversionGoalsResponse

Creates, updates or removes customer conversion goals. Operation statuses are returned.

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose customer conversion goals are being modified.

  • google_ads_searchads360_v23_services__mutate_customer_conversion_goals_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerConversionGoalsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
# File 'lib/google/apis/searchads360_v23/service.rb', line 3344

def mutate_customer_customer_conversion_goal(customer_id, google_ads_searchads360_v23_services__mutate_customer_conversion_goals_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/customerConversionGoals:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerConversionGoalsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_customer_conversion_goals_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerConversionGoalsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerConversionGoalsResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_customer_customizer(customer_id, google_ads_searchads360_v23_services__mutate_customer_customizers_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerCustomizersResponse

Creates, updates or removes customer customizers. Operation statuses are returned.

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose customer customizers are being modified.

  • google_ads_searchads360_v23_services__mutate_customer_customizers_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerCustomizersRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
# File 'lib/google/apis/searchads360_v23/service.rb', line 1032

def mutate_customer_customer_customizer(customer_id, google_ads_searchads360_v23_services__mutate_customer_customizers_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/CustomerCustomizers:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerCustomizersRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_customer_customizers_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerCustomizersResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerCustomizersResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_customer_label(customer_id, google_ads_searchads360_v23_services__mutate_customer_labels_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerLabelsResponse

Creates and removes customer-label relationships. Operation statuses are returned. List of thrown errors: AuthenticationError AuthorizationError DatabaseError HeaderError InternalError LabelError MutateError QuotaError RequestError

Parameters:

  • customer_id (String)

    Required. ID of the customer whose customer-label relationships are being modified.

  • google_ads_searchads360_v23_services__mutate_customer_labels_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerLabelsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
# File 'lib/google/apis/searchads360_v23/service.rb', line 3381

def mutate_customer_customer_label(customer_id, google_ads_searchads360_v23_services__mutate_customer_labels_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/customerLabels:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerLabelsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_customer_labels_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerLabelsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerLabelsResponse
  command.params['customerId'] = customer_id unless customer_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

Updates customer manager links. Operation statuses are returned. List of thrown errors: AuthenticationError AuthorizationError DatabaseError FieldError FieldMaskError HeaderError InternalError ManagerLinkError MutateError QuotaError RequestError

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose customer manager links are being modified.

  • google_ads_searchads360_v23_services__mutate_customer_manager_link_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerManagerLinkRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
# File 'lib/google/apis/searchads360_v23/service.rb', line 3493

def mutate_customer_customer_manager_link(customer_id, google_ads_searchads360_v23_services__mutate_customer_manager_link_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/customerManagerLinks:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerManagerLinkRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_customer_manager_link_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerManagerLinkResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerManagerLinkResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_customer_negative_criterium(customer_id, google_ads_searchads360_v23_services__mutate_customer_negative_criteria_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerNegativeCriteriaResponse

Creates or removes criteria. Operation statuses are returned. List of thrown errors: AuthenticationError AuthorizationError CriterionError DatabaseError FieldError HeaderError InternalError MutateError QuotaError RequestError

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose criteria are being modified.

  • google_ads_searchads360_v23_services__mutate_customer_negative_criteria_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerNegativeCriteriaRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
# File 'lib/google/apis/searchads360_v23/service.rb', line 3529

def mutate_customer_customer_negative_criterium(customer_id, google_ads_searchads360_v23_services__mutate_customer_negative_criteria_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/customerNegativeCriteria:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerNegativeCriteriaRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_customer_negative_criteria_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerNegativeCriteriaResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerNegativeCriteriaResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_customer_sk_ad_network_conversion_value_schema(customer_id, google_ads_searchads360_v23_services__mutate_customer_sk_ad_network_conversion_value_schema_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerSkAdNetworkConversionValueSchemaResponse

Creates or updates the CustomerSkAdNetworkConversionValueSchema. List of thrown errors: AuthenticationError AuthorizationError FieldError InternalError MutateError

Parameters:

  • customer_id (String)

    The ID of the customer whose shared sets are being modified.

  • google_ads_searchads360_v23_services__mutate_customer_sk_ad_network_conversion_value_schema_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerSkAdNetworkConversionValueSchemaRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
# File 'lib/google/apis/searchads360_v23/service.rb', line 3564

def mutate_customer_customer_sk_ad_network_conversion_value_schema(customer_id, google_ads_searchads360_v23_services__mutate_customer_sk_ad_network_conversion_value_schema_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/customerSkAdNetworkConversionValueSchemas:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerSkAdNetworkConversionValueSchemaRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_customer_sk_ad_network_conversion_value_schema_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerSkAdNetworkConversionValueSchemaResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerSkAdNetworkConversionValueSchemaResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_customer_user_access(customer_id, google_ads_searchads360_v23_services__mutate_customer_user_access_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerUserAccessResponse

Updates, removes permission of a user on a given customer. Operation statuses are returned. List of thrown errors: AuthenticationError AuthorizationError CustomerUserAccessError FieldMaskError HeaderError InternalError MutateError QuotaError RequestError

Parameters:

  • customer_id (String)

    Required. The ID of the customer being modified.

  • google_ads_searchads360_v23_services__mutate_customer_user_access_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerUserAccessRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
# File 'lib/google/apis/searchads360_v23/service.rb', line 3636

def mutate_customer_customer_user_access(customer_id, google_ads_searchads360_v23_services__mutate_customer_user_access_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/customerUserAccesses:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerUserAccessRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_customer_user_access_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerUserAccessResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerUserAccessResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_customer_user_access_invitation(customer_id, google_ads_searchads360_v23_services__mutate_customer_user_access_invitation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerUserAccessInvitationResponse

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose access invitation is being modified.

  • google_ads_searchads360_v23_services__mutate_customer_user_access_invitation_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerUserAccessInvitationRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
# File 'lib/google/apis/searchads360_v23/service.rb', line 3599

def mutate_customer_customer_user_access_invitation(customer_id, google_ads_searchads360_v23_services__mutate_customer_user_access_invitation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/customerUserAccessInvitations:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerUserAccessInvitationRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_customer_user_access_invitation_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerUserAccessInvitationResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomerUserAccessInvitationResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_customizer_attribute(customer_id, google_ads_searchads360_v23_services__mutate_customizer_attributes_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomizerAttributesResponse

Creates, updates or removes customizer attributes. Operation statuses are returned.

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose customizer attributes are being modified.

  • google_ads_searchads360_v23_services__mutate_customizer_attributes_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomizerAttributesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
# File 'lib/google/apis/searchads360_v23/service.rb', line 3671

def mutate_customer_customizer_attribute(customer_id, google_ads_searchads360_v23_services__mutate_customizer_attributes_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/customizerAttributes:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomizerAttributesRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_customizer_attributes_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomizerAttributesResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateCustomizerAttributesResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_experiment(customer_id, google_ads_searchads360_v23_services__mutate_experiments_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateExperimentsResponse

Creates, updates, or removes experiments. Operation statuses are returned. List of thrown errors: AuthenticationError AuthorizationError ExperimentError HeaderError InternalError QuotaError RequestError

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose experiments are being modified.

  • google_ads_searchads360_v23_services__mutate_experiments_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateExperimentsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
# File 'lib/google/apis/searchads360_v23/service.rb', line 3969

def mutate_customer_experiment(customer_id, google_ads_searchads360_v23_services__mutate_experiments_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/experiments:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateExperimentsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_experiments_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateExperimentsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateExperimentsResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_experiment_arm(customer_id, google_ads_searchads360_v23_services__mutate_experiment_arms_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateExperimentArmsResponse

Creates, updates, or removes experiment arms. Operation statuses are returned. List of thrown errors: AuthenticationError AuthorizationError ExperimentArmError HeaderError InternalError QuotaError RequestError

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose experiments are being modified.

  • google_ads_searchads360_v23_services__mutate_experiment_arms_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateExperimentArmsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
# File 'lib/google/apis/searchads360_v23/service.rb', line 3818

def mutate_customer_experiment_arm(customer_id, google_ads_searchads360_v23_services__mutate_experiment_arms_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/experimentArms:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateExperimentArmsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_experiment_arms_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateExperimentArmsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateExperimentArmsResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_goal(customer_id, google_ads_searchads360_v23_services__mutate_goals_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateGoalsResponse

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose goals are being modified.

  • google_ads_searchads360_v23_services__mutate_goals_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateGoalsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
# File 'lib/google/apis/searchads360_v23/service.rb', line 1067

def mutate_customer_goal(customer_id, google_ads_searchads360_v23_services__mutate_goals_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/Goals:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateGoalsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_goals_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateGoalsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateGoalsResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_keyword_plan(customer_id, google_ads_searchads360_v23_services__mutate_keyword_plans_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateKeywordPlansResponse

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose keyword plans are being modified.

  • google_ads_searchads360_v23_services__mutate_keyword_plans_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateKeywordPlansRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
# File 'lib/google/apis/searchads360_v23/service.rb', line 4330

def mutate_customer_keyword_plan(customer_id, google_ads_searchads360_v23_services__mutate_keyword_plans_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/keywordPlans:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateKeywordPlansRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_keyword_plans_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateKeywordPlansResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateKeywordPlansResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_keyword_plan_ad_group(customer_id, google_ads_searchads360_v23_services__mutate_keyword_plan_ad_groups_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateKeywordPlanAdGroupsResponse

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose Keyword Plan ad groups are being modified.

  • google_ads_searchads360_v23_services__mutate_keyword_plan_ad_groups_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateKeywordPlanAdGroupsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
# File 'lib/google/apis/searchads360_v23/service.rb', line 4216

def mutate_customer_keyword_plan_ad_group(customer_id, google_ads_searchads360_v23_services__mutate_keyword_plan_ad_groups_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/keywordPlanAdGroups:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateKeywordPlanAdGroupsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_keyword_plan_ad_groups_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateKeywordPlanAdGroupsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateKeywordPlanAdGroupsResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_keyword_plan_ad_group_keyword(customer_id, google_ads_searchads360_v23_services__mutate_keyword_plan_ad_group_keywords_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateKeywordPlanAdGroupKeywordsResponse

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose Keyword Plan ad group keywords are being modified.

  • google_ads_searchads360_v23_services__mutate_keyword_plan_ad_group_keywords_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateKeywordPlanAdGroupKeywordsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
# File 'lib/google/apis/searchads360_v23/service.rb', line 4177

def mutate_customer_keyword_plan_ad_group_keyword(customer_id, google_ads_searchads360_v23_services__mutate_keyword_plan_ad_group_keywords_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/keywordPlanAdGroupKeywords:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateKeywordPlanAdGroupKeywordsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_keyword_plan_ad_group_keywords_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateKeywordPlanAdGroupKeywordsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateKeywordPlanAdGroupKeywordsResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_keyword_plan_campaign(customer_id, google_ads_searchads360_v23_services__mutate_keyword_plan_campaigns_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateKeywordPlanCampaignsResponse

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose Keyword Plan campaigns are being modified.

  • google_ads_searchads360_v23_services__mutate_keyword_plan_campaigns_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateKeywordPlanCampaignsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
# File 'lib/google/apis/searchads360_v23/service.rb', line 4293

def mutate_customer_keyword_plan_campaign(customer_id, google_ads_searchads360_v23_services__mutate_keyword_plan_campaigns_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/keywordPlanCampaigns:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateKeywordPlanCampaignsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_keyword_plan_campaigns_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateKeywordPlanCampaignsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateKeywordPlanCampaignsResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_keyword_plan_campaign_keyword(customer_id, google_ads_searchads360_v23_services__mutate_keyword_plan_campaign_keywords_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateKeywordPlanCampaignKeywordsResponse

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose campaign keywords are being modified.

  • google_ads_searchads360_v23_services__mutate_keyword_plan_campaign_keywords_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateKeywordPlanCampaignKeywordsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
# File 'lib/google/apis/searchads360_v23/service.rb', line 4254

def mutate_customer_keyword_plan_campaign_keyword(customer_id, google_ads_searchads360_v23_services__mutate_keyword_plan_campaign_keywords_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/keywordPlanCampaignKeywords:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateKeywordPlanCampaignKeywordsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_keyword_plan_campaign_keywords_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateKeywordPlanCampaignKeywordsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateKeywordPlanCampaignKeywordsResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_label(customer_id, google_ads_searchads360_v23_services__mutate_labels_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateLabelsResponse

Parameters:

  • customer_id (String)

    Required. ID of the customer whose labels are being modified.

  • google_ads_searchads360_v23_services__mutate_labels_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateLabelsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
# File 'lib/google/apis/searchads360_v23/service.rb', line 4369

def mutate_customer_label(customer_id, google_ads_searchads360_v23_services__mutate_labels_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/labels:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateLabelsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_labels_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateLabelsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateLabelsResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_recommendation_subscription_recommendation_subscription(customer_id, google_ads_searchads360_v23_services__mutate_recommendation_subscription_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateRecommendationSubscriptionResponse

Parameters:

  • customer_id (String)

    Required. The ID of the subscribing customer.

  • google_ads_searchads360_v23_services__mutate_recommendation_subscription_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateRecommendationSubscriptionRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
# File 'lib/google/apis/searchads360_v23/service.rb', line 4787

def mutate_customer_recommendation_subscription_recommendation_subscription(customer_id, google_ads_searchads360_v23_services__mutate_recommendation_subscription_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/recommendationSubscriptions:mutateRecommendationSubscription', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateRecommendationSubscriptionRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_recommendation_subscription_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateRecommendationSubscriptionResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateRecommendationSubscriptionResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_remarketing_action(customer_id, google_ads_searchads360_v23_services__mutate_remarketing_actions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateRemarketingActionsResponse

Creates or updates remarketing actions. Operation statuses are returned. List of thrown errors: AuthenticationError AuthorizationError ConversionActionError HeaderError InternalError QuotaError RequestError

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose remarketing actions are being modified.

  • google_ads_searchads360_v23_services__mutate_remarketing_actions_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateRemarketingActionsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
# File 'lib/google/apis/searchads360_v23/service.rb', line 4929

def mutate_customer_remarketing_action(customer_id, google_ads_searchads360_v23_services__mutate_remarketing_actions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/remarketingActions:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateRemarketingActionsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_remarketing_actions_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateRemarketingActionsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateRemarketingActionsResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_search_ads360(customer_id, google_ads_searchads360_v23_services__mutate_search_ads360_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateSearchAds360Response

This method is essentially a wrapper around a series of mutate methods. The only features it offers over calling those methods directly are: - Atomic transactions - Temp resource names (described below) - Somewhat reduced latency over making a series of mutate calls Note: Only resources that support atomic transactions are included, so this method can't replace all calls to individual services. ## Atomic Transaction Benefits Atomicity makes error handling much easier. If you're making a series of changes and one fails, it can leave your account in an inconsistent state. With atomicity, you either reach the chosen state directly, or the request fails and you can retry. ## Temp Resource Names Temp resource names are a special type of resource name used to create a resource and reference that resource in the same request. For example, if a is created with resource_name equal to , that resource name can be reused in the field in the same request. That way, the two resources are created and linked atomically. To create a temp resource name, put a negative number in the part of the name that the server would normally allocate. Note: - Resources must be created with a temp name before the name can be reused. For example, the previous example would fail if the mutate order was reversed. - Temp names are not remembered across requests. - There's no limit to the number of temp names in a request. - Each temp name must use a unique negative number, even if the resource types differ. ## Latency It's important to group mutates by resource type or the request may time out and fail. Latency is roughly equal to a series of calls to individual mutate methods, where each change in resource type is a new call. For example, mutating is like 2 calls, while mutating is like 4 calls. List of thrown errors: AdCustomizerError AdError AdGroupAdError AdGroupCriterionError AdGroupError AssetError AuthenticationError AuthorizationError BiddingError CampaignBudgetError CampaignCriterionError CampaignError CampaignExperimentError CampaignSharedSetError CollectionSizeError ContextError ConversionActionError CriterionError CustomerFeedError DatabaseError DateError DateRangeError DistinctError ExtensionFeedItemError ExtensionSettingError FeedAttributeReferenceError FeedError FeedItemError FeedItemSetError FieldError FieldMaskError FunctionParsingError HeaderError ImageError InternalError KeywordPlanAdGroupKeywordError KeywordPlanCampaignError KeywordPlanError LabelError ListOperationError MediaUploadError MutateError NewResourceCreationError NullError OperationAccessDeniedError PolicyFindingError PolicyViolationError QuotaError RangeError RequestError ResourceCountLimitExceededError SettingError SharedSetError SizeLimitError StringFormatError StringLengthError UrlFieldError UserListError YoutubeVideoRegistrationError

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose resources are being modified.

  • google_ads_searchads360_v23_services__mutate_search_ads360_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateSearchAds360Request) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
# File 'lib/google/apis/searchads360_v23/service.rb', line 5004

def mutate_customer_search_ads360(customer_id, google_ads_searchads360_v23_services__mutate_search_ads360_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/searchAds360:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateSearchAds360Request::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_search_ads360_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateSearchAds360Response::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateSearchAds360Response
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_shared_criterium(customer_id, google_ads_searchads360_v23_services__mutate_shared_criteria_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateSharedCriteriaResponse

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose shared criteria are being modified.

  • google_ads_searchads360_v23_services__mutate_shared_criteria_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateSharedCriteriaRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
# File 'lib/google/apis/searchads360_v23/service.rb', line 5079

def mutate_customer_shared_criterium(customer_id, google_ads_searchads360_v23_services__mutate_shared_criteria_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/sharedCriteria:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateSharedCriteriaRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_shared_criteria_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateSharedCriteriaResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateSharedCriteriaResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_shared_set(customer_id, google_ads_searchads360_v23_services__mutate_shared_sets_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateSharedSetsResponse

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose shared sets are being modified.

  • google_ads_searchads360_v23_services__mutate_shared_sets_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateSharedSetsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
# File 'lib/google/apis/searchads360_v23/service.rb', line 5119

def mutate_customer_shared_set(customer_id, google_ads_searchads360_v23_services__mutate_shared_sets_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/sharedSets:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateSharedSetsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_shared_sets_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateSharedSetsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateSharedSetsResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_smart_campaign_setting(customer_id, google_ads_searchads360_v23_services__mutate_smart_campaign_settings_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateSmartCampaignSettingsResponse

Updates Smart campaign settings for campaigns.

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose Smart campaign settings are being modified.

  • google_ads_searchads360_v23_services__mutate_smart_campaign_settings_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateSmartCampaignSettingsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
# File 'lib/google/apis/searchads360_v23/service.rb', line 5184

def mutate_customer_smart_campaign_setting(customer_id, google_ads_searchads360_v23_services__mutate_smart_campaign_settings_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/smartCampaignSettings:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateSmartCampaignSettingsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_smart_campaign_settings_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateSmartCampaignSettingsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateSmartCampaignSettingsResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_user_list(customer_id, google_ads_searchads360_v23_services__mutate_user_lists_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateUserListsResponse

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose user lists are being modified.

  • google_ads_searchads360_v23_services__mutate_user_lists_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateUserListsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
# File 'lib/google/apis/searchads360_v23/service.rb', line 5296

def mutate_customer_user_list(customer_id, google_ads_searchads360_v23_services__mutate_user_lists_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/userLists:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateUserListsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_user_lists_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateUserListsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateUserListsResponse
  command.params['customerId'] = customer_id unless customer_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

#mutate_customer_user_list_customer_type(customer_id, google_ads_searchads360_v23_services__mutate_user_list_customer_types_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateUserListCustomerTypesResponse

Attach or remove user list customer types. Operation statuses are returned. List of thrown errors: AuthenticationError AuthorizationError UserListCustomerTypeError HeaderError InternalError QuotaError RequestError

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose user list customer types are being modified.

  • google_ads_searchads360_v23_services__mutate_user_list_customer_types_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateUserListCustomerTypesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
# File 'lib/google/apis/searchads360_v23/service.rb', line 5257

def mutate_customer_user_list_customer_type(customer_id, google_ads_searchads360_v23_services__mutate_user_list_customer_types_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/userListCustomerTypes:mutate', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateUserListCustomerTypesRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__mutate_user_list_customer_types_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateUserListCustomerTypesResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMutateUserListCustomerTypesResponse
  command.params['customerId'] = customer_id unless customer_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

#promote_customer_campaign_draft(campaign_draft, google_ads_searchads360_v23_services__promote_campaign_draft_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleLongrunningOperation

Promotes the changes in a draft back to the base campaign. This method returns a Long Running Operation (LRO) indicating if the Promote is done. Use google. longrunning.Operations.GetOperation to poll the LRO until it is done. Only a done status is returned in the response. See the status in the Campaign Draft resource to determine if the promotion was successful. If the LRO failed, use CampaignDraftService.ListCampaignDraftAsyncErrors to view the list of error reasons. List of thrown errors: AuthenticationError AuthorizationError CampaignDraftError HeaderError InternalError QuotaError RequestError

Parameters:

  • campaign_draft (String)

    Required. The resource name of the campaign draft to promote.

  • google_ads_searchads360_v23_services__promote_campaign_draft_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesPromoteCampaignDraftRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
# File 'lib/google/apis/searchads360_v23/service.rb', line 2628

def promote_customer_campaign_draft(campaign_draft, google_ads_searchads360_v23_services__promote_campaign_draft_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/{+campaignDraft}:promote', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesPromoteCampaignDraftRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__promote_campaign_draft_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleLongrunningOperation
  command.params['campaignDraft'] = campaign_draft unless campaign_draft.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#promote_customer_experiment_experiment(resource_name, google_ads_searchads360_v23_services__promote_experiment_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleLongrunningOperation

Promotes the trial campaign thus applying changes in the trial campaign to the base campaign. This method returns a long running operation that tracks the promotion of the experiment campaign. If it fails, a list of errors can be retrieved using the ListExperimentAsyncErrors method. The operation's metadata will be a string containing the resource name of the created experiment. List of thrown errors: AuthenticationError AuthorizationError ExperimentError HeaderError InternalError QuotaError RequestError

Parameters:

  • resource_name (String)

    Required. The resource name of the experiment to promote.

  • google_ads_searchads360_v23_services__promote_experiment_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesPromoteExperimentRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
# File 'lib/google/apis/searchads360_v23/service.rb', line 4009

def promote_customer_experiment_experiment(resource_name, google_ads_searchads360_v23_services__promote_experiment_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/{+resourceName}:promoteExperiment', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesPromoteExperimentRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__promote_experiment_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleLongrunningOperation
  command.params['resourceName'] = resource_name unless resource_name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#provide_customer_local_services_lead_lead_feedback(resource_name, google_ads_searchads360_v23_services__provide_lead_feedback_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesProvideLeadFeedbackResponse

RPC to provide feedback on Local Services Lead resources.

Parameters:

  • resource_name (String)

    Required. The resource name of the local services lead that for which the feedback is being provided.

  • google_ads_searchads360_v23_services__provide_lead_feedback_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesProvideLeadFeedbackRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
# File 'lib/google/apis/searchads360_v23/service.rb', line 4438

def provide_customer_local_services_lead_lead_feedback(resource_name, google_ads_searchads360_v23_services__provide_lead_feedback_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/{+resourceName}:provideLeadFeedback', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesProvideLeadFeedbackRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__provide_lead_feedback_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesProvideLeadFeedbackResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesProvideLeadFeedbackResponse
  command.params['resourceName'] = resource_name unless resource_name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

Regenerate ThirdPartyAppAnalyticsLink.shareable_link_id that should be provided to the third party when setting up app analytics. List of thrown errors: AuthenticationError AuthorizationError HeaderError InternalError QuotaError RequestError

Parameters:

  • resource_name (String)

    Resource name of the third party app analytics link.

  • google_ads_searchads360_v23_services__regenerate_shareable_link_id_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesRegenerateShareableLinkIdRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
# File 'lib/google/apis/searchads360_v23/service.rb', line 5220

def regenerate_customer_third_party_app_analytics_link_shareable_link_id(resource_name, google_ads_searchads360_v23_services__regenerate_shareable_link_id_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/{+resourceName}:regenerateShareableLinkId', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesRegenerateShareableLinkIdRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__regenerate_shareable_link_id_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesRegenerateShareableLinkIdResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesRegenerateShareableLinkIdResponse
  command.params['resourceName'] = resource_name unless resource_name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#remove_customer_ad_group_ad_automatically_created_assets(ad_group_ad, google_ads_searchads360_v23_services__remove_automatically_created_assets_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleProtobufEmpty

Parameters:

  • ad_group_ad (String)

    Required. The resource name of the AdGroupAd from which to remove automatically created assets.

  • google_ads_searchads360_v23_services__remove_automatically_created_assets_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesRemoveAutomaticallyCreatedAssetsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
# File 'lib/google/apis/searchads360_v23/service.rb', line 1296

def remove_customer_ad_group_ad_automatically_created_assets(ad_group_ad, google_ads_searchads360_v23_services__remove_automatically_created_assets_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/{+adGroupAd}:removeAutomaticallyCreatedAssets', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesRemoveAutomaticallyCreatedAssetsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__remove_automatically_created_assets_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleProtobufEmpty
  command.params['adGroupAd'] = ad_group_ad unless ad_group_ad.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#remove_customer_campaign_automatically_created_asset(customer_id, google_ads_searchads360_v23_services__remove_campaign_automatically_created_asset_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesRemoveCampaignAutomaticallyCreatedAssetResponse

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose assets are being removed.

  • google_ads_searchads360_v23_services__remove_campaign_automatically_created_asset_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesRemoveCampaignAutomaticallyCreatedAssetRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



683
684
685
686
687
688
689
690
691
692
693
# File 'lib/google/apis/searchads360_v23/service.rb', line 683

def remove_customer_campaign_automatically_created_asset(customer_id, google_ads_searchads360_v23_services__remove_campaign_automatically_created_asset_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}:removeCampaignAutomaticallyCreatedAsset', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesRemoveCampaignAutomaticallyCreatedAssetRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__remove_campaign_automatically_created_asset_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesRemoveCampaignAutomaticallyCreatedAssetResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesRemoveCampaignAutomaticallyCreatedAssetResponse
  command.params['customerId'] = customer_id unless customer_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

Parameters:

  • customer_id (String)

    Required. The ID of the customer for which the data link is updated.

  • google_ads_searchads360_v23_services__remove_data_link_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesRemoveDataLinkRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
# File 'lib/google/apis/searchads360_v23/service.rb', line 3746

def remove_customer_data_link(customer_id, google_ads_searchads360_v23_services__remove_data_link_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/dataLinks:remove', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesRemoveDataLinkRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__remove_data_link_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesRemoveDataLinkResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesRemoveDataLinkResponse
  command.params['customerId'] = customer_id unless customer_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

Parameters:

  • customer_id (String)

    Required. The ID of the customer being modified.

  • google_ads_searchads360_v23_services__remove_product_link_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesRemoveProductLinkRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
# File 'lib/google/apis/searchads360_v23/service.rb', line 4750

def remove_customer_product_link(customer_id, google_ads_searchads360_v23_services__remove_product_link_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/productLinks:remove', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesRemoveProductLinkRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__remove_product_link_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesRemoveProductLinkResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesRemoveProductLinkResponse
  command.params['customerId'] = customer_id unless customer_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

Remove a product link invitation.

Parameters:

  • customer_id (String)

    Required. The ID of the product link invitation being removed.

  • google_ads_searchads360_v23_services__remove_product_link_invitation_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesRemoveProductLinkInvitationRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
# File 'lib/google/apis/searchads360_v23/service.rb', line 4647

def remove_customer_product_link_invitation(customer_id, google_ads_searchads360_v23_services__remove_product_link_invitation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/productLinkInvitations:remove', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesRemoveProductLinkInvitationRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__remove_product_link_invitation_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesRemoveProductLinkInvitationResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesRemoveProductLinkInvitationResponse
  command.params['customerId'] = customer_id unless customer_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

#run_customer_batch_job(resource_name, google_ads_searchads360_v23_services__run_batch_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleLongrunningOperation

Runs the batch job. The Operation.metadata field type is BatchJobMetadata. When finished, the long running operation will not contain errors or a response. Instead, use ListBatchJobResults to get the results of the job. List of thrown errors: AuthenticationError AuthorizationError BatchJobError HeaderError InternalError QuotaError RequestError

Parameters:

  • resource_name (String)

    Required. The resource name of the BatchJob to run.

  • google_ads_searchads360_v23_services__run_batch_job_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesRunBatchJobRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
# File 'lib/google/apis/searchads360_v23/service.rb', line 2106

def run_customer_batch_job(resource_name, google_ads_searchads360_v23_services__run_batch_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/{+resourceName}:run', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesRunBatchJobRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__run_batch_job_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleLongrunningOperation
  command.params['resourceName'] = resource_name unless resource_name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#run_customer_offline_user_data_job(resource_name, google_ads_searchads360_v23_services__run_offline_user_data_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleLongrunningOperation

Runs the offline user data job. When finished, the long running operation will contain the processing result or failure information, if any. List of thrown errors: AuthenticationError AuthorizationError DatabaseError HeaderError InternalError OfflineUserDataJobError QuotaError RequestError

Parameters:

  • resource_name (String)

    Required. The resource name of the OfflineUserDataJob to run.

  • google_ads_searchads360_v23_services__run_offline_user_data_job_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesRunOfflineUserDataJobRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
# File 'lib/google/apis/searchads360_v23/service.rb', line 4547

def run_customer_offline_user_data_job(resource_name, google_ads_searchads360_v23_services__run_offline_user_data_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/{+resourceName}:run', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesRunOfflineUserDataJobRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__run_offline_user_data_job_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleLongrunningOperation
  command.params['resourceName'] = resource_name unless resource_name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#schedule_customer_experiment_experiment(resource_name, google_ads_searchads360_v23_services__schedule_experiment_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleLongrunningOperation

Schedule an experiment. The in design campaign will be converted into a real campaign (called the experiment campaign) that will begin serving ads if successfully created. The experiment is scheduled immediately with status INITIALIZING. This method returns a long running operation that tracks the forking of the in design campaign. If the forking fails, a list of errors can be retrieved using the ListExperimentAsyncErrors method. The operation's metadata will be a string containing the resource name of the created experiment. List of thrown errors: AuthenticationError AuthorizationError ExperimentError DatabaseError DateError DateRangeError FieldError HeaderError InternalError QuotaError RangeError RequestError

Parameters:

  • resource_name (String)

    Required. The scheduled experiment.

  • google_ads_searchads360_v23_services__schedule_experiment_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesScheduleExperimentRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
# File 'lib/google/apis/searchads360_v23/service.rb', line 4052

def schedule_customer_experiment_experiment(resource_name, google_ads_searchads360_v23_services__schedule_experiment_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/{+resourceName}:scheduleExperiment', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesScheduleExperimentRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__schedule_experiment_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleLongrunningOperation
  command.params['resourceName'] = resource_name unless resource_name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#search_customer_audience_insights_attributes(customer_id, google_ads_searchads360_v23_services__list_audience_insights_attributes_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListAudienceInsightsAttributesResponse

Searches for audience attributes that can be used to generate insights. List of thrown errors: AuthenticationError AuthorizationError FieldError HeaderError InternalError QuotaError RangeError RequestError

Parameters:

  • customer_id (String)

    Required. The ID of the customer.

  • google_ads_searchads360_v23_services__list_audience_insights_attributes_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListAudienceInsightsAttributesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



719
720
721
722
723
724
725
726
727
728
729
# File 'lib/google/apis/searchads360_v23/service.rb', line 719

def search_customer_audience_insights_attributes(customer_id, google_ads_searchads360_v23_services__list_audience_insights_attributes_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}:searchAudienceInsightsAttributes', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListAudienceInsightsAttributesRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__list_audience_insights_attributes_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListAudienceInsightsAttributesResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesListAudienceInsightsAttributesResponse
  command.params['customerId'] = customer_id unless customer_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

#search_customer_search_ads360s(customer_id, google_ads_searchads360_v23_services__search_search_ads360_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesSearchSearchAds360Response

Parameters:

  • customer_id (String)

    Required. The ID of the customer being queried.

  • google_ads_searchads360_v23_services__search_search_ads360_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesSearchSearchAds360Request) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
# File 'lib/google/apis/searchads360_v23/service.rb', line 5040

def search_customer_search_ads360s(customer_id, google_ads_searchads360_v23_services__search_search_ads360_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/searchAds360:search', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesSearchSearchAds360Request::Representation
  command.request_object = google_ads_searchads360_v23_services__search_search_ads360_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesSearchSearchAds360Response::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesSearchSearchAds360Response
  command.params['customerId'] = customer_id unless customer_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

#search_search_ads360_fields(google_ads_searchads360_v23_services__search_search_ads360_fields_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesSearchSearchAds360FieldsResponse

Returns all fields that match the search query. List of thrown errors: AuthenticationError AuthorizationError HeaderError InternalError QueryError QuotaError RequestError

Parameters:

  • google_ads_searchads360_v23_services__search_search_ads360_fields_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesSearchSearchAds360FieldsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
# File 'lib/google/apis/searchads360_v23/service.rb', line 5472

def search_search_ads360_fields(google_ads_searchads360_v23_services__search_search_ads360_fields_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/searchAds360Fields:search', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesSearchSearchAds360FieldsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__search_search_ads360_fields_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesSearchSearchAds360FieldsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesSearchSearchAds360FieldsResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#start_customer_identity_verification(customer_id, google_ads_searchads360_v23_services__start_identity_verification_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleProtobufEmpty

Starts Identity Verification for a given verification program type. Statuses are returned. List of thrown errors: AuthenticationError AuthorizationError HeaderError InternalError QuotaError RequestError

Parameters:

  • customer_id (String)

    Required. The Id of the customer for whom we are creating this verification.

  • google_ads_searchads360_v23_services__start_identity_verification_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesStartIdentityVerificationRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



755
756
757
758
759
760
761
762
763
764
765
# File 'lib/google/apis/searchads360_v23/service.rb', line 755

def start_customer_identity_verification(customer_id, google_ads_searchads360_v23_services__start_identity_verification_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}:startIdentityVerification', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesStartIdentityVerificationRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__start_identity_verification_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleProtobufEmpty
  command.params['customerId'] = customer_id unless customer_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

#suggest_customer_keyword_themes(customer_id, google_ads_searchads360_v23_services__suggest_keyword_themes_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesSuggestKeywordThemesResponse

Suggests keyword themes to advertise on.

Parameters:

  • customer_id (String)

    Required. The ID of the customer.

  • google_ads_searchads360_v23_services__suggest_keyword_themes_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesSuggestKeywordThemesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



788
789
790
791
792
793
794
795
796
797
798
# File 'lib/google/apis/searchads360_v23/service.rb', line 788

def suggest_customer_keyword_themes(customer_id, google_ads_searchads360_v23_services__suggest_keyword_themes_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}:suggestKeywordThemes', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesSuggestKeywordThemesRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__suggest_keyword_themes_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesSuggestKeywordThemesResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesSuggestKeywordThemesResponse
  command.params['customerId'] = customer_id unless customer_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

#suggest_customer_smart_campaign_ad(customer_id, google_ads_searchads360_v23_services__suggest_smart_campaign_ad_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesSuggestSmartCampaignAdResponse

Suggests a Smart campaign ad compatible with the Ad family of resources, based on data points such as targeting and the business to advertise.

Parameters:

  • customer_id (String)

    Required. The ID of the customer.

  • google_ads_searchads360_v23_services__suggest_smart_campaign_ad_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesSuggestSmartCampaignAdRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



822
823
824
825
826
827
828
829
830
831
832
# File 'lib/google/apis/searchads360_v23/service.rb', line 822

def suggest_customer_smart_campaign_ad(customer_id, google_ads_searchads360_v23_services__suggest_smart_campaign_ad_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}:suggestSmartCampaignAd', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesSuggestSmartCampaignAdRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__suggest_smart_campaign_ad_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesSuggestSmartCampaignAdResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesSuggestSmartCampaignAdResponse
  command.params['customerId'] = customer_id unless customer_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

#suggest_customer_smart_campaign_budget_options(customer_id, google_ads_searchads360_v23_services__suggest_smart_campaign_budget_options_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesSuggestSmartCampaignBudgetOptionsResponse

Returns BudgetOption suggestions.

Parameters:

  • customer_id (String)

    Required. The ID of the customer whose budget options are to be suggested.

  • google_ads_searchads360_v23_services__suggest_smart_campaign_budget_options_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesSuggestSmartCampaignBudgetOptionsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



855
856
857
858
859
860
861
862
863
864
865
# File 'lib/google/apis/searchads360_v23/service.rb', line 855

def suggest_customer_smart_campaign_budget_options(customer_id, google_ads_searchads360_v23_services__suggest_smart_campaign_budget_options_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}:suggestSmartCampaignBudgetOptions', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesSuggestSmartCampaignBudgetOptionsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__suggest_smart_campaign_budget_options_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesSuggestSmartCampaignBudgetOptionsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesSuggestSmartCampaignBudgetOptionsResponse
  command.params['customerId'] = customer_id unless customer_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

#suggest_customer_travel_assets(customer_id, google_ads_searchads360_v23_services__suggest_travel_assets_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesSuggestTravelAssetsResponse

Returns Travel Asset suggestions. Asset suggestions are returned on a best- effort basis. There are no guarantees that all possible asset types will be returned for any given hotel property.

Parameters:

  • customer_id (String)

    Required. The ID of the customer.

  • google_ads_searchads360_v23_services__suggest_travel_assets_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesSuggestTravelAssetsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



890
891
892
893
894
895
896
897
898
899
900
# File 'lib/google/apis/searchads360_v23/service.rb', line 890

def suggest_customer_travel_assets(customer_id, google_ads_searchads360_v23_services__suggest_travel_assets_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}:suggestTravelAssets', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesSuggestTravelAssetsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__suggest_travel_assets_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesSuggestTravelAssetsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesSuggestTravelAssetsResponse
  command.params['customerId'] = customer_id unless customer_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

#suggest_geo_target_constant(google_ads_searchads360_v23_services__suggest_geo_target_constants_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesSuggestGeoTargetConstantsResponse

Returns GeoTargetConstant suggestions by location name or by resource name. List of thrown errors: AuthenticationError AuthorizationError GeoTargetConstantSuggestionError HeaderError InternalError QuotaError RequestError

Parameters:

  • google_ads_searchads360_v23_services__suggest_geo_target_constants_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesSuggestGeoTargetConstantsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
# File 'lib/google/apis/searchads360_v23/service.rb', line 5330

def suggest_geo_target_constant(google_ads_searchads360_v23_services__suggest_geo_target_constants_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/geoTargetConstants:suggest', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesSuggestGeoTargetConstantsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__suggest_geo_target_constants_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesSuggestGeoTargetConstantsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesSuggestGeoTargetConstantsResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#suggest_keyword_theme_constant(google_ads_searchads360_v23_services__suggest_keyword_theme_constants_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesSuggestKeywordThemeConstantsResponse

Returns KeywordThemeConstant suggestions by keyword themes. List of thrown errors: AuthenticationError AuthorizationError HeaderError InternalError QuotaError RequestError

Parameters:

  • google_ads_searchads360_v23_services__suggest_keyword_theme_constants_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesSuggestKeywordThemeConstantsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
# File 'lib/google/apis/searchads360_v23/service.rb', line 5407

def suggest_keyword_theme_constant(google_ads_searchads360_v23_services__suggest_keyword_theme_constants_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/keywordThemeConstants:suggest', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesSuggestKeywordThemeConstantsRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__suggest_keyword_theme_constants_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesSuggestKeywordThemeConstantsResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesSuggestKeywordThemeConstantsResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

Parameters:

  • customer_id (String)

    Required. The ID of the customer for which the data link is created.

  • google_ads_searchads360_v23_services__update_data_link_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesUpdateDataLinkRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
# File 'lib/google/apis/searchads360_v23/service.rb', line 3782

def update_customer_data_link(customer_id, google_ads_searchads360_v23_services__update_data_link_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/dataLinks:update', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesUpdateDataLinkRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__update_data_link_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesUpdateDataLinkResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesUpdateDataLinkResponse
  command.params['customerId'] = customer_id unless customer_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

Update a product link invitation.

Parameters:

  • customer_id (String)

    Required. The ID of the customer being modified.

  • google_ads_searchads360_v23_services__update_product_link_invitation_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesUpdateProductLinkInvitationRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
# File 'lib/google/apis/searchads360_v23/service.rb', line 4680

def update_customer_product_link_invitation(customer_id, google_ads_searchads360_v23_services__update_product_link_invitation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}/productLinkInvitations:update', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesUpdateProductLinkInvitationRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__update_product_link_invitation_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesUpdateProductLinkInvitationResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesUpdateProductLinkInvitationResponse
  command.params['customerId'] = customer_id unless customer_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

#upload_customer_user_data(customer_id, google_ads_searchads360_v23_services__upload_user_data_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesUploadUserDataResponse

Parameters:

  • customer_id (String)

    Required. The ID of the customer for which to update the user data.

  • google_ads_searchads360_v23_services__upload_user_data_request_object (Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesUploadUserDataRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



926
927
928
929
930
931
932
933
934
935
936
# File 'lib/google/apis/searchads360_v23/service.rb', line 926

def upload_customer_user_data(customer_id, google_ads_searchads360_v23_services__upload_user_data_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v23/customers/{+customerId}:uploadUserData', options)
  command.request_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesUploadUserDataRequest::Representation
  command.request_object = google_ads_searchads360_v23_services__upload_user_data_request_object
  command.response_representation = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesUploadUserDataResponse::Representation
  command.response_class = Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesUploadUserDataResponse
  command.params['customerId'] = customer_id unless customer_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