class Google::Ads::GoogleAds::V7::Services::KeywordPlanCampaignKeywordService::Client
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.
Attributes
@private
Public Class Methods
Configure the KeywordPlanCampaignKeywordService
Client
class.
See {::Google::Ads::GoogleAds::V7::Services::KeywordPlanCampaignKeywordService::Client::Configuration} for a description of the configuration fields.
## Example
To modify the configuration for all KeywordPlanCampaignKeywordService
clients:
::Google::Ads::GoogleAds::V7::Services::KeywordPlanCampaignKeywordService::Client.configure do |config| config.timeout = 10.0 end
@yield [config] Configure the Client
client. @yieldparam config [Client::Configuration]
@return [Client::Configuration]
# File lib/google/ads/google_ads/v7/services/keyword_plan_campaign_keyword_service/client.rb, line 61 def self.configure @configure ||= begin default_config = Client::Configuration.new default_config.timeout = 3600.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
Create a new KeywordPlanCampaignKeywordService
client object.
## Examples
To create a new KeywordPlanCampaignKeywordService
client with the default configuration:
client = ::Google::Ads::GoogleAds::V7::Services::KeywordPlanCampaignKeywordService::Client.new
To create a new KeywordPlanCampaignKeywordService
client with a custom configuration:
client = ::Google::Ads::GoogleAds::V7::Services::KeywordPlanCampaignKeywordService::Client.new do |config| config.timeout = 10.0 end
@yield [config] Configure the KeywordPlanCampaignKeywordService
client. @yieldparam config [Client::Configuration]
# File lib/google/ads/google_ads/v7/services/keyword_plan_campaign_keyword_service/client.rb, line 119 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/v7/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 scope and endpoint are unchanged from default, # but only if the default endpoint does not have a region prefix. enable_self_signed_jwt = @config.scope == Client.configure.scope && @config.endpoint == Client.configure.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::V7::Services::KeywordPlanCampaignKeywordService::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end
Public Instance Methods
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 {Client.configure}.
See {::Google::Ads::GoogleAds::V7::Services::KeywordPlanCampaignKeywordService::Client::Configuration} for a description of the configuration fields.
@yield [config] Configure the Client
client. @yieldparam config [Client::Configuration]
@return [Client::Configuration]
# File lib/google/ads/google_ads/v7/services/keyword_plan_campaign_keyword_service/client.rb, line 94 def configure yield @config if block_given? @config end
Returns the requested plan in full detail.
List of thrown errors:
[AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()
@overload get_keyword_plan_campaign_keyword
(request, options = nil)
Pass arguments to `get_keyword_plan_campaign_keyword` via a request object, either of type {::Google::Ads::GoogleAds::V7::Services::GetKeywordPlanCampaignKeywordRequest} or an equivalent Hash. @param request [::Google::Ads::GoogleAds::V7::Services::GetKeywordPlanCampaignKeywordRequest, ::Hash] A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload get_keyword_plan_campaign_keyword
(resource_name: nil)
Pass arguments to `get_keyword_plan_campaign_keyword` 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). @param resource_name [::String] Required. The resource name of the plan to fetch.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Ads::GoogleAds::V7::Resources::KeywordPlanCampaignKeyword] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Ads::GoogleAds::V7::Resources::KeywordPlanCampaignKeyword]
@raise [Google::Ads::GoogleAds::Error] if the RPC is aborted.
# File lib/google/ads/google_ads/v7/services/keyword_plan_campaign_keyword_service/client.rb, line 195 def get_keyword_plan_campaign_keyword request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V7::Services::GetKeywordPlanCampaignKeywordRequest # 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.get_keyword_plan_campaign_keyword.metadata.to_h # Set x-goog-api-client and x-goog-user-project 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-user-project"] = @quota_project_id if @quota_project_id header_params = { "resource_name" => request.resource_name } 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.get_keyword_plan_campaign_keyword.timeout, metadata: metadata, retry_policy: @config.rpcs.get_keyword_plan_campaign_keyword.retry_policy options.apply_defaults metadata: @config.metadata, retry_policy: @config.retry_policy @keyword_plan_campaign_keyword_service_stub.call_rpc :get_keyword_plan_campaign_keyword, request, options: options do |response, operation| yield response, operation if block_given? return response end # rescue GRPC::BadStatus => grpc_error # raise Google::Ads::GoogleAds::Error.new grpc_error.message end
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]()
@overload mutate_keyword_plan_campaign_keywords
(request, options = nil)
Pass arguments to `mutate_keyword_plan_campaign_keywords` via a request object, either of type {::Google::Ads::GoogleAds::V7::Services::MutateKeywordPlanCampaignKeywordsRequest} or an equivalent Hash. @param request [::Google::Ads::GoogleAds::V7::Services::MutateKeywordPlanCampaignKeywordsRequest, ::Hash] A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload mutate_keyword_plan_campaign_keywords
(customer_id: nil, operations: nil, partial_failure: nil, validate_only: nil)
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). @param customer_id [::String] Required. The ID of the customer whose campaign keywords are being modified. @param operations [::Array<::Google::Ads::GoogleAds::V7::Services::KeywordPlanCampaignKeywordOperation, ::Hash>] Required. The list of operations to perform on individual Keyword Plan campaign keywords. @param partial_failure [::Boolean] 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. @param validate_only [::Boolean] If true, the request is validated but not executed. Only errors are returned, not results.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Ads::GoogleAds::V7::Services::MutateKeywordPlanCampaignKeywordsResponse] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Ads::GoogleAds::V7::Services::MutateKeywordPlanCampaignKeywordsResponse]
@raise [Google::Ads::GoogleAds::Error] if the RPC is aborted.
# File lib/google/ads/google_ads/v7/services/keyword_plan_campaign_keyword_service/client.rb, line 288 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::V7::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 and x-goog-user-project 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-user-project"] = @quota_project_id if @quota_project_id header_params = { "customer_id" => request.customer_id } 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 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? return response end # rescue GRPC::BadStatus => grpc_error # raise Google::Ads::GoogleAds::Error.new grpc_error.message end