Class: Google::Ads::GoogleAds::V8::Services::AdGroupCriterionService::Client
- Inherits:
-
Object
- Object
- Google::Ads::GoogleAds::V8::Services::AdGroupCriterionService::Client
- Includes:
- Paths
- Defined in:
- lib/google/ads/google_ads/v8/services/ad_group_criterion_service/client.rb
Overview
Client for the AdGroupCriterionService service.
Service to manage ad group criteria.
Defined Under Namespace
Classes: Configuration
Instance Attribute Summary collapse
Class Method Summary collapse
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the AdGroupCriterionService Client class.
Instance Method Summary collapse
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the AdGroupCriterionService Client instance.
-
#get_ad_group_criterion(request, options = nil) {|response, operation| ... } ⇒ ::Google::Ads::GoogleAds::V8::Resources::AdGroupCriterion
Returns the requested criterion in full detail.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new AdGroupCriterionService client object.
-
#mutate_ad_group_criteria(request, options = nil) {|response, operation| ... } ⇒ ::Google::Ads::GoogleAds::V8::Services::MutateAdGroupCriteriaResponse
Creates, updates, or removes criteria.
Methods included from Paths
#ad_group_criterion_label_path, #ad_group_criterion_path, #ad_group_path
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new AdGroupCriterionService client object.
## Examples
To create a new AdGroupCriterionService client with the default configuration:
client = ::Google::Ads::GoogleAds::V8::Services::AdGroupCriterionService::Client.new
To create a new AdGroupCriterionService client with a custom configuration:
client = ::Google::Ads::GoogleAds::V8::Services::AdGroupCriterionService::Client.new do |config|
config.timeout = 10.0
end
116 117 118 119 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 |
# File 'lib/google/ads/google_ads/v8/services/ad_group_criterion_service/client.rb', line 116 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/v8/services/ad_group_criterion_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 @ad_group_criterion_service_stub = ::Gapic::ServiceStub.new( ::Google::Ads::GoogleAds::V8::Services::AdGroupCriterionService::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end |
Instance Attribute Details
#ad_group_criterion_service_stub ⇒ Object (readonly)
37 38 39 |
# File 'lib/google/ads/google_ads/v8/services/ad_group_criterion_service/client.rb', line 37 def ad_group_criterion_service_stub @ad_group_criterion_service_stub end |
Class Method Details
.configure {|config| ... } ⇒ Client::Configuration
Configure the AdGroupCriterionService Client class.
See Configuration for a description of the configuration fields.
## Example
To modify the configuration for all AdGroupCriterionService clients:
::Google::Ads::GoogleAds::V8::Services::AdGroupCriterionService::Client.configure do |config|
config.timeout = 10.0
end
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 |
# File 'lib/google/ads/google_ads/v8/services/ad_group_criterion_service/client.rb', line 58 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 AdGroupCriterionService 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.
91 92 93 94 |
# File 'lib/google/ads/google_ads/v8/services/ad_group_criterion_service/client.rb', line 91 def configure yield @config if block_given? @config end |
#get_ad_group_criterion(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V8::Resources::AdGroupCriterion #get_ad_group_criterion(resource_name: nil) ⇒ ::Google::Ads::GoogleAds::V8::Resources::AdGroupCriterion
Returns the requested criterion in full detail.
List of thrown errors:
[AuthenticationError]()
[AuthorizationError]()
[HeaderError]()
[InternalError]()
[QuotaError]()
[RequestError]()
192 193 194 195 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 |
# File 'lib/google/ads/google_ads/v8/services/ad_group_criterion_service/client.rb', line 192 def get_ad_group_criterion request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V8::Services::GetAdGroupCriterionRequest # 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_ad_group_criterion..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_ad_group_criterion.timeout, metadata: , retry_policy: @config.rpcs.get_ad_group_criterion.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @ad_group_criterion_service_stub.call_rpc :get_ad_group_criterion, 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_ad_group_criteria(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V8::Services::MutateAdGroupCriteriaResponse #mutate_ad_group_criteria(customer_id: nil, operations: nil, partial_failure: nil, validate_only: nil, response_content_type: nil) ⇒ ::Google::Ads::GoogleAds::V8::Services::MutateAdGroupCriteriaResponse
Creates, updates, or removes criteria. Operation statuses are returned.
List of thrown errors:
[AdGroupCriterionError]()
[AdxError]()
[AuthenticationError]()
[AuthorizationError]()
[BiddingError]()
[BiddingStrategyError]()
[CollectionSizeError]()
[ContextError]()
[CriterionError]()
[DatabaseError]()
[DateError]()
[DistinctError]()
[FieldError]()
[FieldMaskError]()
[HeaderError]()
[IdError]()
[InternalError]()
[MultiplierError]()
[MutateError]()
[NewResourceCreationError]()
[NotEmptyError]()
[NullError]()
[OperationAccessDeniedError]()
[OperatorError]()
[PolicyViolationError]()
[QuotaError]()
[RangeError]()
[RequestError]()
[ResourceCountLimitExceededError]()
[SizeLimitError]()
[StringFormatError]()
[StringLengthError]()
[UrlFieldError]()
308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 |
# File 'lib/google/ads/google_ads/v8/services/ad_group_criterion_service/client.rb', line 308 def mutate_ad_group_criteria request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V8::Services::MutateAdGroupCriteriaRequest # 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_ad_group_criteria..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_ad_group_criteria.timeout, metadata: , retry_policy: @config.rpcs.mutate_ad_group_criteria.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @ad_group_criterion_service_stub.call_rpc :mutate_ad_group_criteria, 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 |