Class: Google::Ads::GoogleAds::V17::Services::CustomerService::Client

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

Overview

Client for the CustomerService service.

Service to manage customers.

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

#conversion_action_path, #customer_path

Constructor Details

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

Create a new CustomerService client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the CustomerService client.

Yield Parameters:



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
156
157
158
159
160
161
 
# File 'lib/google/ads/google_ads/v17/services/customer_service/client.rb', line 123

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/v17/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 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

  @customer_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Ads::GoogleAds::V17::Services::CustomerService::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
  )
end

Instance Attribute Details

#customer_service_stub ⇒ Object (readonly) 



43
44
45
 
# File 'lib/google/ads/google_ads/v17/services/customer_service/client.rb', line 43

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.

Examples:


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

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/google/ads/google_ads/v17/services/customer_service/client.rb', line 63

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 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.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



93
94
95
96
 
# File 'lib/google/ads/google_ads/v17/services/customer_service/client.rb', line 93

def configure
  yield @config if block_given?
  @config
end

#create_customer_client(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V17::Services::CreateCustomerClientResponse #create_customer_client(customer_id: nil, customer_client: nil, email_address: nil, access_role: nil, validate_only: nil) ⇒ ::Google::Ads::GoogleAds::V17::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]()

Examples:

Basic example

require "google/ads/google_ads/v17/services"

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

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

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

# The returned object is of type Google::Ads::GoogleAds::V17::Services::CreateCustomerClientResponse.
p result

Overloads:

  • #create_customer_client(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V17::Services::CreateCustomerClientResponse

    Pass arguments to ‘create_customer_client` via a request object, either of type Google::Ads::GoogleAds::V17::Services::CreateCustomerClientRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Ads::GoogleAds::V17::Services::CreateCustomerClientRequest, ::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.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #create_customer_client(customer_id: nil, customer_client: nil, email_address: nil, access_role: nil, validate_only: nil) ⇒ ::Google::Ads::GoogleAds::V17::Services::CreateCustomerClientResponse

    Pass arguments to ‘create_customer_client` 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 Manager under whom client customer is being created.

    • customer_client (::Google::Ads::GoogleAds::V17::Resources::Customer, ::Hash) (defaults to: nil) —

      Required. The new client customer to create. The resource name on this customer will be ignored.

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

      Email address of the user who should be invited on the created client customer. Accessible only to customers on the allow-list.

    • access_role (::Google::Ads::GoogleAds::V17::Enums::AccessRoleEnum::AccessRole) (defaults to: nil) —

      The proposed role of user on the created client customer. Accessible only to customers on the allow-list.

    • 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.



422
423
424
425
426
427
428
429
430
431
432
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
 
# File 'lib/google/ads/google_ads/v17/services/customer_service/client.rb', line 422

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

  request = ::Gapic::Protobuf.coerce request,
                                     to: ::Google::Ads::GoogleAds::V17::Services::CreateCustomerClientRequest

  # 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.create_customer_client.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.create_customer_client.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_customer_client.retry_policy

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

  @customer_service_stub.call_rpc :create_customer_client, 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

#list_accessible_customers(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V17::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]()

Examples:

Basic example

require "google/ads/google_ads/v17/services"

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

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

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

# The returned object is of type Google::Ads::GoogleAds::V17::Services::ListAccessibleCustomersResponse.
p result

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

Parameters:

  • request (::Google::Ads::GoogleAds::V17::Services::ListAccessibleCustomersRequest, ::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.

  • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



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
346
347
348
349
350
 
# File 'lib/google/ads/google_ads/v17/services/customer_service/client.rb', line 316

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

  request = ::Gapic::Protobuf.coerce request,
                                     to: ::Google::Ads::GoogleAds::V17::Services::ListAccessibleCustomersRequest

  # 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.list_accessible_customers.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

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

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

  @customer_service_stub.call_rpc :list_accessible_customers, 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

#mutate_customer(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V17::Services::MutateCustomerResponse #mutate_customer(customer_id: nil, operation: nil, validate_only: nil, response_content_type: nil) ⇒ ::Google::Ads::GoogleAds::V17::Services::MutateCustomerResponse

Updates a customer. Operation statuses are returned.

List of thrown errors:

[AuthenticationError]()
[AuthorizationError]()
[DatabaseError]()
[FieldMaskError]()
[HeaderError]()
[InternalError]()
[QuotaError]()
[RequestError]()
[UrlFieldError]()

Examples:

Basic example

require "google/ads/google_ads/v17/services"

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

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

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

# The returned object is of type Google::Ads::GoogleAds::V17::Services::MutateCustomerResponse.
p result

Overloads:

  • #mutate_customer(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V17::Services::MutateCustomerResponse

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

    Parameters:

    • request (::Google::Ads::GoogleAds::V17::Services::MutateCustomerRequest, ::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.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #mutate_customer(customer_id: nil, operation: nil, validate_only: nil, response_content_type: nil) ⇒ ::Google::Ads::GoogleAds::V17::Services::MutateCustomerResponse

    Pass arguments to ‘mutate_customer` 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 being modified.

    • operation (::Google::Ads::GoogleAds::V17::Services::CustomerOperation, ::Hash) (defaults to: nil) —

      Required. The operation to perform on the customer

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

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

    • response_content_type (::Google::Ads::GoogleAds::V17::Enums::ResponseContentTypeEnum::ResponseContentType) (defaults to: nil) —

      The response content type setting. Determines whether the mutable resource or just the resource name should be returned post mutation.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/google/ads/google_ads/v17/services/customer_service/client.rb', line 228

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

  request = ::Gapic::Protobuf.coerce request,
                                     to: ::Google::Ads::GoogleAds::V17::Services::MutateCustomerRequest

  # 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_customer.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_customer.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.mutate_customer.retry_policy

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

  @customer_service_stub.call_rpc :mutate_customer, 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

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


103
104
105
 
# File 'lib/google/ads/google_ads/v17/services/customer_service/client.rb', line 103

def universe_domain
  @customer_service_stub.universe_domain
end