Class: Google::Ads::GoogleAds::V18::Services::KeywordPlanCampaignKeywordService::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/ads/google_ads/v18/services/keyword_plan_campaign_keyword_service/client.rb

Overview

Client for the KeywordPlanCampaignKeywordService service.

Service to manage Keyword Plan campaign keywords. KeywordPlanCampaign is required to add the campaign keywords. Only negative keywords are supported. A maximum of 1000 negative keywords are allowed per plan. This includes both campaign negative keywords and ad group negative keywords.

Defined Under Namespace

Classes: Configuration

Constant Summary collapse

API_VERSION = 
""
DEFAULT_ENDPOINT_TEMPLATE = 
"googleads.$UNIVERSE_DOMAIN$"

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#keyword_plan_campaign_keyword_path, #keyword_plan_campaign_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new KeywordPlanCampaignKeywordService client object.

Examples:


# Create a client using the default configuration
client = ::Google::Ads::GoogleAds::V18::Services::KeywordPlanCampaignKeywordService::Client.new

# Create a client using a custom configuration
client = ::Google::Ads::GoogleAds::V18::Services::KeywordPlanCampaignKeywordService::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the KeywordPlanCampaignKeywordService client.

Yield Parameters:



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/google/ads/google_ads/v18/services/keyword_plan_campaign_keyword_service/client.rb', line 126

def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/ads/google_ads/v18/services/keyword_plan_campaign_keyword_service_services_pb"

  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
                           !@config.endpoint.split(".").first.include?("-"))
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @keyword_plan_campaign_keyword_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Ads::GoogleAds::V18::Services::KeywordPlanCampaignKeywordService::Stub,
    credentials: credentials,
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors,
    channel_pool_config: @config.channel_pool,
    logger: @config.logger
  )

  @keyword_plan_campaign_keyword_service_stub.stub_logger&.info do |entry|
    entry.set_system_name
    entry.set_service
    entry.message = "Created client for #{entry.service}"
    entry.set_credentials_fields credentials
    entry.set "customEndpoint", @config.endpoint if @config.endpoint
    entry.set "defaultTimeout", @config.timeout if @config.timeout
    entry.set "quotaProject", @quota_project_id if @quota_project_id
  end
end

Instance Attribute Details

#keyword_plan_campaign_keyword_service_stub ⇒ Object (readonly) 



46
47
48
 
# File 'lib/google/ads/google_ads/v18/services/keyword_plan_campaign_keyword_service/client.rb', line 46

def keyword_plan_campaign_keyword_service_stub
  @keyword_plan_campaign_keyword_service_stub
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the KeywordPlanCampaignKeywordService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all KeywordPlanCampaignKeywordService clients
::Google::Ads::GoogleAds::V18::Services::KeywordPlanCampaignKeywordService::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/google/ads/google_ads/v18/services/keyword_plan_campaign_keyword_service/client.rb', line 66

def self.configure
  @configure ||= begin
    default_config = Client::Configuration.new

    default_config.timeout = 14_400.0
    default_config.retry_policy = {
      initial_delay: 5.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#configure {|config| ... } ⇒ Client::Configuration

Configure the KeywordPlanCampaignKeywordService Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



96
97
98
99
 
# File 'lib/google/ads/google_ads/v18/services/keyword_plan_campaign_keyword_service/client.rb', line 96

def configure
  yield @config if block_given?
  @config
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


182
183
184
 
# File 'lib/google/ads/google_ads/v18/services/keyword_plan_campaign_keyword_service/client.rb', line 182

def logger
  @keyword_plan_campaign_keyword_service_stub.logger
end

#mutate_keyword_plan_campaign_keywords(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V18::Services::MutateKeywordPlanCampaignKeywordsResponse #mutate_keyword_plan_campaign_keywords(customer_id: nil, operations: nil, partial_failure: nil, validate_only: nil) ⇒ ::Google::Ads::GoogleAds::V18::Services::MutateKeywordPlanCampaignKeywordsResponse

Creates, updates, or removes Keyword Plan campaign keywords. Operation statuses are returned.

List of thrown errors:

[AuthenticationError]()
[AuthorizationError]()
[DatabaseError]()
[FieldError]()
[HeaderError]()
[InternalError]()
[KeywordPlanAdGroupKeywordError]()
[KeywordPlanCampaignKeywordError]()
[QuotaError]()
[RequestError]()
[ResourceCountLimitExceededError]()

Examples:

Basic example

require "google/ads/google_ads/v18/services"

# Create a client object. The client can be reused for multiple calls.
client = Google::Ads::GoogleAds::V18::Services::KeywordPlanCampaignKeywordService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Ads::GoogleAds::V18::Services::MutateKeywordPlanCampaignKeywordsRequest.new

# Call the mutate_keyword_plan_campaign_keywords method.
result = client.mutate_keyword_plan_campaign_keywords request

# The returned object is of type Google::Ads::GoogleAds::V18::Services::MutateKeywordPlanCampaignKeywordsResponse.
p result

Overloads:

  • #mutate_keyword_plan_campaign_keywords(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V18::Services::MutateKeywordPlanCampaignKeywordsResponse

    Pass arguments to ‘mutate_keyword_plan_campaign_keywords` via a request object, either of type MutateKeywordPlanCampaignKeywordsRequest or an equivalent Hash.

    Parameters:

  • #mutate_keyword_plan_campaign_keywords(customer_id: nil, operations: nil, partial_failure: nil, validate_only: nil) ⇒ ::Google::Ads::GoogleAds::V18::Services::MutateKeywordPlanCampaignKeywordsResponse

    Pass arguments to ‘mutate_keyword_plan_campaign_keywords` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • customer_id (::String) (defaults to: nil) —

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

    • operations (::Array<::Google::Ads::GoogleAds::V18::Services::KeywordPlanCampaignKeywordOperation, ::Hash>) (defaults to: nil) —

      Required. The list of operations to perform on individual Keyword Plan campaign keywords.

    • partial_failure (::Boolean) (defaults to: nil) —

      If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false.

    • validate_only (::Boolean) (defaults to: nil) —

      If true, the request is validated but not executed. Only errors are returned, not results.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Ads::GoogleAds::Error) —

    if the RPC is aborted.



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/google/ads/google_ads/v18/services/keyword_plan_campaign_keyword_service/client.rb', line 258

def mutate_keyword_plan_campaign_keywords request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request,
                                     to: ::Google::Ads::GoogleAds::V18::Services::MutateKeywordPlanCampaignKeywordsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.mutate_keyword_plan_campaign_keywords.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Ads::GoogleAds::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.customer_id
    header_params["customer_id"] = request.customer_id
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.mutate_keyword_plan_campaign_keywords.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.mutate_keyword_plan_campaign_keywords.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @keyword_plan_campaign_keyword_service_stub.call_rpc :mutate_keyword_plan_campaign_keywords, request,
                                                       options: options do |response, operation|
    yield response, operation if block_given?
  end
  # rescue GRPC::BadStatus => grpc_error
  #  raise Google::Ads::GoogleAds::Error.new grpc_error.message
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


106
107
108
 
# File 'lib/google/ads/google_ads/v18/services/keyword_plan_campaign_keyword_service/client.rb', line 106

def universe_domain
  @keyword_plan_campaign_keyword_service_stub.universe_domain
end