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

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

Overview

Client for the CustomerService service.

Service to manage customers.

Defined Under Namespace

Classes: Configuration

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

To create a new CustomerService client with the default configuration:

client = ::Google::Ads::GoogleAds::V5::Services::CustomerService::Client.new

To create a new CustomerService client with a custom configuration:

client = ::Google::Ads::GoogleAds::V5::Services::CustomerService::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the CustomerService client.

Yield Parameters:



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
 
# File 'lib/google/ads/google_ads/v5/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/v5/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
  credentials ||= Credentials.default scope: @config.scope
  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::V5::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/v5/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::V5::Services::CustomerService::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/google/ads/google_ads/v5/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.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



91
92
93
94
 
# File 'lib/google/ads/google_ads/v5/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::V5::Services::CreateCustomerClientResponse #create_customer_client(customer_id: nil, customer_client: nil, email_address: nil, access_role: nil) ⇒ ::Google::Ads::GoogleAds::V5::Services::CreateCustomerClientResponse

Creates a new client under manager. The new client customer is returned.

Overloads:

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

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

    Parameters:

    • request (::Google::Ads::GoogleAds::V5::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) ⇒ ::Google::Ads::GoogleAds::V5::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::V5::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::V5::Enums::AccessRoleEnum::AccessRole) (defaults to: nil) —

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
 
# File 'lib/google/ads/google_ads/v5/services/customer_service/client.rb', line 380

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

#get_customer(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V5::Resources::Customer #get_customer(resource_name: nil) ⇒ ::Google::Ads::GoogleAds::V5::Resources::Customer

Returns the requested customer in full detail.

Overloads:

  • #get_customer(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V5::Resources::Customer

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

    Parameters:

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

  • #get_customer(resource_name: nil) ⇒ ::Google::Ads::GoogleAds::V5::Resources::Customer

    Pass arguments to ‘get_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:

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

      Required. The resource name of the customer to fetch.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/google/ads/google_ads/v5/services/customer_service/client.rb', line 178

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V5::Services::GetCustomerRequest

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

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

#list_accessible_customers(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V5::Services::ListAccessibleCustomersResponse

Returns resource names of customers directly accessible by the user authenticating the call.

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

Parameters:

  • request (::Google::Ads::GoogleAds::V5::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.



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
 
# File 'lib/google/ads/google_ads/v5/services/customer_service/client.rb', line 311

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::V5::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 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

  options.apply_defaults timeout:      @config.rpcs.list_accessible_customers.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_accessible_customers.retry_policy
  options.apply_defaults 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::V5::Services::MutateCustomerResponse #mutate_customer(customer_id: nil, operation: nil, validate_only: nil, response_content_type: nil) ⇒ ::Google::Ads::GoogleAds::V5::Services::MutateCustomerResponse

Updates a customer. Operation statuses are returned.

Overloads:

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

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

    Parameters:

    • request (::Google::Ads::GoogleAds::V5::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::V5::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::V5::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::V5::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.



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/google/ads/google_ads/v5/services/customer_service/client.rb', line 252

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V5::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 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_customer.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.mutate_customer.retry_policy
  options.apply_defaults 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