Class: Google::Ads::GoogleAds::V7::Services::KeywordPlanAdGroupKeywordService::Client
- Inherits:
-
Object
- Object
- Google::Ads::GoogleAds::V7::Services::KeywordPlanAdGroupKeywordService::Client
- Includes:
- Paths
- Defined in:
- lib/google/ads/google_ads/v7/services/keyword_plan_ad_group_keyword_service/client.rb
Overview
Client for the KeywordPlanAdGroupKeywordService service.
Service to manage Keyword Plan ad group keywords. KeywordPlanAdGroup is required to add ad group keywords. Positive and negative keywords are supported. A maximum of 10,000 positive keywords are allowed per keyword plan. A maximum of 1,000 negative keywords are allower per keyword plan. This includes campaign negative keywords and ad group negative keywords.
Defined Under Namespace
Classes: Configuration
Instance Attribute Summary collapse
Class Method Summary collapse
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the KeywordPlanAdGroupKeywordService Client class.
Instance Method Summary collapse
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the KeywordPlanAdGroupKeywordService Client instance.
-
#get_keyword_plan_ad_group_keyword(request, options = nil) {|response, operation| ... } ⇒ ::Google::Ads::GoogleAds::V7::Resources::KeywordPlanAdGroupKeyword
Returns the requested Keyword Plan ad group keyword in full detail.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new KeywordPlanAdGroupKeywordService client object.
-
#mutate_keyword_plan_ad_group_keywords(request, options = nil) {|response, operation| ... } ⇒ ::Google::Ads::GoogleAds::V7::Services::MutateKeywordPlanAdGroupKeywordsResponse
Creates, updates, or removes Keyword Plan ad group keywords.
Methods included from Paths
#keyword_plan_ad_group_keyword_path, #keyword_plan_ad_group_path
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new KeywordPlanAdGroupKeywordService client object.
## Examples
To create a new KeywordPlanAdGroupKeywordService client with the default configuration:
client = ::Google::Ads::GoogleAds::V7::Services::KeywordPlanAdGroupKeywordService::Client.new
To create a new KeywordPlanAdGroupKeywordService client with a custom configuration:
client = ::Google::Ads::GoogleAds::V7::Services::KeywordPlanAdGroupKeywordService::Client.new do |config|
config.timeout = 10.0
end
120 121 122 123 124 125 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 |
# File 'lib/google/ads/google_ads/v7/services/keyword_plan_ad_group_keyword_service/client.rb', line 120 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_ad_group_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_ad_group_keyword_service_stub = ::Gapic::ServiceStub.new( ::Google::Ads::GoogleAds::V7::Services::KeywordPlanAdGroupKeywordService::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end |
Instance Attribute Details
#keyword_plan_ad_group_keyword_service_stub ⇒ Object (readonly)
41 42 43 |
# File 'lib/google/ads/google_ads/v7/services/keyword_plan_ad_group_keyword_service/client.rb', line 41 def keyword_plan_ad_group_keyword_service_stub @keyword_plan_ad_group_keyword_service_stub end |
Class Method Details
.configure {|config| ... } ⇒ Client::Configuration
Configure the KeywordPlanAdGroupKeywordService Client class.
See Configuration for a description of the configuration fields.
## Example
To modify the configuration for all KeywordPlanAdGroupKeywordService clients:
::Google::Ads::GoogleAds::V7::Services::KeywordPlanAdGroupKeywordService::Client.configure do |config|
config.timeout = 10.0
end
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 |
# File 'lib/google/ads/google_ads/v7/services/keyword_plan_ad_group_keyword_service/client.rb', line 62 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 |
Instance Method Details
#configure {|config| ... } ⇒ Client::Configuration
Configure the KeywordPlanAdGroupKeywordService 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.
95 96 97 98 |
# File 'lib/google/ads/google_ads/v7/services/keyword_plan_ad_group_keyword_service/client.rb', line 95 def configure yield @config if block_given? @config end |
#get_keyword_plan_ad_group_keyword(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V7::Resources::KeywordPlanAdGroupKeyword #get_keyword_plan_ad_group_keyword(resource_name: nil) ⇒ ::Google::Ads::GoogleAds::V7::Resources::KeywordPlanAdGroupKeyword
Returns the requested Keyword Plan ad group keyword in full detail.
List of thrown errors:
[AuthenticationError]()
[AuthorizationError]()
[HeaderError]()
[InternalError]()
[QuotaError]()
[RequestError]()
196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 |
# File 'lib/google/ads/google_ads/v7/services/keyword_plan_ad_group_keyword_service/client.rb', line 196 def get_keyword_plan_ad_group_keyword request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V7::Services::GetKeywordPlanAdGroupKeywordRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.get_keyword_plan_ad_group_keyword..to_h # Set x-goog-api-client and x-goog-user-project headers [:"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 [:"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("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.get_keyword_plan_ad_group_keyword.timeout, metadata: , retry_policy: @config.rpcs.get_keyword_plan_ad_group_keyword.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @keyword_plan_ad_group_keyword_service_stub.call_rpc :get_keyword_plan_ad_group_keyword, request, 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 |
#mutate_keyword_plan_ad_group_keywords(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V7::Services::MutateKeywordPlanAdGroupKeywordsResponse #mutate_keyword_plan_ad_group_keywords(customer_id: nil, operations: nil, partial_failure: nil, validate_only: nil) ⇒ ::Google::Ads::GoogleAds::V7::Services::MutateKeywordPlanAdGroupKeywordsResponse
Creates, updates, or removes Keyword Plan ad group keywords. Operation statuses are returned.
List of thrown errors:
[AuthenticationError]()
[AuthorizationError]()
[DatabaseError]()
[FieldError]()
[HeaderError]()
[InternalError]()
[KeywordPlanAdGroupKeywordError]()
[KeywordPlanError]()
[MutateError]()
[QuotaError]()
[RequestError]()
[ResourceCountLimitExceededError]()
291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 |
# File 'lib/google/ads/google_ads/v7/services/keyword_plan_ad_group_keyword_service/client.rb', line 291 def mutate_keyword_plan_ad_group_keywords request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V7::Services::MutateKeywordPlanAdGroupKeywordsRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.mutate_keyword_plan_ad_group_keywords..to_h # Set x-goog-api-client and x-goog-user-project headers [:"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 [:"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("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.mutate_keyword_plan_ad_group_keywords.timeout, metadata: , retry_policy: @config.rpcs.mutate_keyword_plan_ad_group_keywords.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @keyword_plan_ad_group_keyword_service_stub.call_rpc :mutate_keyword_plan_ad_group_keywords, request, 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 |