Class: Google::Ads::GoogleAds::V7::Services::CustomerService::Client
- Inherits:
-
Object
- Object
- Google::Ads::GoogleAds::V7::Services::CustomerService::Client
- Includes:
- Paths
- Defined in:
- lib/google/ads/google_ads/v7/services/customer_service/client.rb
Overview
Client for the CustomerService service.
Service to manage customers.
Defined Under Namespace
Classes: Configuration
Instance Attribute Summary collapse
- #customer_service_stub ⇒ Object readonly
Class Method Summary collapse
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the CustomerService Client class.
Instance Method Summary collapse
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the CustomerService Client instance.
-
#create_customer_client(request, options = nil) {|response, operation| ... } ⇒ ::Google::Ads::GoogleAds::V7::Services::CreateCustomerClientResponse
Creates a new client under manager.
-
#get_customer(request, options = nil) {|response, operation| ... } ⇒ ::Google::Ads::GoogleAds::V7::Resources::Customer
Returns the requested customer in full detail.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new CustomerService client object.
-
#list_accessible_customers(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V7::Services::ListAccessibleCustomersResponse
Returns resource names of customers directly accessible by the user authenticating the call.
-
#mutate_customer(request, options = nil) {|response, operation| ... } ⇒ ::Google::Ads::GoogleAds::V7::Services::MutateCustomerResponse
Updates a customer.
Methods included from Paths
#conversion_action_path, #customer_path
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new CustomerService client object.
## Examples
To create a new CustomerService client with the default configuration:
client = ::Google::Ads::GoogleAds::V7::Services::CustomerService::Client.new
To create a new CustomerService client with a custom configuration:
client = ::Google::Ads::GoogleAds::V7::Services::CustomerService::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/v7/services/customer_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/v7/services/customer_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 @customer_service_stub = ::Gapic::ServiceStub.new( ::Google::Ads::GoogleAds::V7::Services::CustomerService::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end |
Instance Attribute Details
#customer_service_stub ⇒ Object (readonly)
37 38 39 |
# File 'lib/google/ads/google_ads/v7/services/customer_service/client.rb', line 37 def customer_service_stub @customer_service_stub end |
Class Method Details
.configure {|config| ... } ⇒ Client::Configuration
Configure the CustomerService Client class.
See Configuration for a description of the configuration fields.
## Example
To modify the configuration for all CustomerService clients:
::Google::Ads::GoogleAds::V7::Services::CustomerService::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/v7/services/customer_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 CustomerService 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/v7/services/customer_service/client.rb', line 91 def configure yield @config if block_given? @config end |
#create_customer_client(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V7::Services::CreateCustomerClientResponse #create_customer_client(customer_id: nil, customer_client: nil, email_address: nil, access_role: nil, validate_only: nil) ⇒ ::Google::Ads::GoogleAds::V7::Services::CreateCustomerClientResponse
Creates a new client under manager. The new client customer is returned.
List of thrown errors:
[AccessInvitationError]()
[AuthenticationError]()
[AuthorizationError]()
[CurrencyCodeError]()
[HeaderError]()
[InternalError]()
[ManagerLinkError]()
[QuotaError]()
[RequestError]()
[StringLengthError]()
[TimeZoneError]()
433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 |
# File 'lib/google/ads/google_ads/v7/services/customer_service/client.rb', line 433 def create_customer_client request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V7::Services::CreateCustomerClientRequest # 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.create_customer_client..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.create_customer_client.timeout, metadata: , retry_policy: @config.rpcs.create_customer_client.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @customer_service_stub.call_rpc :create_customer_client, 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 |
#get_customer(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V7::Resources::Customer #get_customer(resource_name: nil) ⇒ ::Google::Ads::GoogleAds::V7::Resources::Customer
Returns the requested customer 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 |
# File 'lib/google/ads/google_ads/v7/services/customer_service/client.rb', line 192 def get_customer request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V7::Services::GetCustomerRequest # 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_customer..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_customer.timeout, metadata: , retry_policy: @config.rpcs.get_customer.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @customer_service_stub.call_rpc :get_customer, 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 |
#list_accessible_customers(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V7::Services::ListAccessibleCustomersResponse
Returns resource names of customers directly accessible by the user authenticating the call.
List of thrown errors:
[AuthenticationError]()
[AuthorizationError]()
[HeaderError]()
[InternalError]()
[QuotaError]()
[RequestError]()
346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 |
# File 'lib/google/ads/google_ads/v7/services/customer_service/client.rb', line 346 def list_accessible_customers request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V7::Services::ListAccessibleCustomersRequest # 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.list_accessible_customers..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 .apply_defaults timeout: @config.rpcs.list_accessible_customers.timeout, metadata: , retry_policy: @config.rpcs.list_accessible_customers.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @customer_service_stub.call_rpc :list_accessible_customers, 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_customer(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V7::Services::MutateCustomerResponse #mutate_customer(customer_id: nil, operation: nil, validate_only: nil, response_content_type: nil) ⇒ ::Google::Ads::GoogleAds::V7::Services::MutateCustomerResponse
Updates a customer. Operation statuses are returned.
List of thrown errors:
[AuthenticationError]()
[AuthorizationError]()
[DatabaseError]()
[FieldMaskError]()
[HeaderError]()
[InternalError]()
[QuotaError]()
[RequestError]()
[UrlFieldError]()
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 |
# File 'lib/google/ads/google_ads/v7/services/customer_service/client.rb', line 278 def mutate_customer request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V7::Services::MutateCustomerRequest # 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_customer..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_customer.timeout, metadata: , retry_policy: @config.rpcs.mutate_customer.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @customer_service_stub.call_rpc :mutate_customer, 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 |