class Google::Ads::GoogleAds::V8::Services::CustomerService::Client

Client for the CustomerService service.

Service to manage customers.

Attributes

customer_service_stub[R]

@private

Public Class Methods

configure() { |configure| ... } click to toggle source

Configure the CustomerService Client class.

See {::Google::Ads::GoogleAds::V8::Services::CustomerService::Client::Configuration} for a description of the configuration fields.

@example

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

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/ads/google_ads/v8/services/customer_service/client.rb, line 57
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
new() { |config| ... } click to toggle source

Create a new CustomerService client object.

@example

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

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

@yield [config] Configure the CustomerService client. @yieldparam config [Client::Configuration]

# File lib/google/ads/google_ads/v8/services/customer_service/client.rb, line 108
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/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 == 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::V8::Services::CustomerService::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Public Instance Methods

configure() { |config| ... } click to toggle source

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 {Client.configure}.

See {::Google::Ads::GoogleAds::V8::Services::CustomerService::Client::Configuration} for a description of the configuration fields.

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/ads/google_ads/v8/services/customer_service/client.rb, line 87
def configure
  yield @config if block_given?
  @config
end
create_customer_client(request, options = nil) { |response, operation| ... } click to toggle source

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]()

@overload create_customer_client(request, options = nil)

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

@param request [::Google::Ads::GoogleAds::V8::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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload create_customer_client(customer_id: nil, customer_client: nil, email_address: nil, access_role: nil, validate_only: nil)

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

@param customer_id [::String]
  Required. The ID of the Manager under whom client customer is being created.
@param customer_client [::Google::Ads::GoogleAds::V8::Resources::Customer, ::Hash]
  Required. The new client customer to create. The resource name on this customer
  will be ignored.
@param email_address [::String]
  Email address of the user who should be invited on the created client
  customer. Accessible only to customers on the allow-list.
@param access_role [::Google::Ads::GoogleAds::V8::Enums::AccessRoleEnum::AccessRole]
  The proposed role of user on the created client customer.
  Accessible only to customers on the allow-list.
@param validate_only [::Boolean]
  If true, the request is validated but not executed. Only errors are
  returned, not results.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Ads::GoogleAds::V8::Services::CreateCustomerClientResponse] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Ads::GoogleAds::V8::Services::CreateCustomerClientResponse]

@raise [Google::Ads::GoogleAds::Error] if the RPC is aborted.

# File lib/google/ads/google_ads/v8/services/customer_service/client.rb, line 430
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::V8::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 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
get_customer(request, options = nil) { |response, operation| ... } click to toggle source

Returns the requested customer in full detail.

List of thrown errors:

[AuthenticationError]()
[AuthorizationError]()
[HeaderError]()
[InternalError]()
[QuotaError]()
[RequestError]()

@overload get_customer(request, options = nil)

Pass arguments to `get_customer` via a request object, either of type
{::Google::Ads::GoogleAds::V8::Services::GetCustomerRequest} or an equivalent Hash.

@param request [::Google::Ads::GoogleAds::V8::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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload get_customer(resource_name: nil)

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

@param resource_name [::String]
  Required. The resource name of the customer to fetch.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Ads::GoogleAds::V8::Resources::Customer] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Ads::GoogleAds::V8::Resources::Customer]

@raise [Google::Ads::GoogleAds::Error] if the RPC is aborted.

# File lib/google/ads/google_ads/v8/services/customer_service/client.rb, line 183
def get_customer request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request,
                                     to: ::Google::Ads::GoogleAds::V8::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 timeout:      @config.timeout,
                         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) { |response, operation| ... } click to toggle source

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

List of thrown errors:

[AuthenticationError]()
[AuthorizationError]()
[HeaderError]()
[InternalError]()
[QuotaError]()
[RequestError]()

@overload list_accessible_customers(request, options = nil)

Pass arguments to `list_accessible_customers` via a request object, either of type
{::Google::Ads::GoogleAds::V8::Services::ListAccessibleCustomersRequest} or an equivalent Hash.

@param request [::Google::Ads::GoogleAds::V8::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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Ads::GoogleAds::V8::Services::ListAccessibleCustomersResponse] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Ads::GoogleAds::V8::Services::ListAccessibleCustomersResponse]

@raise [Google::Ads::GoogleAds::Error] if the RPC is aborted.

# File lib/google/ads/google_ads/v8/services/customer_service/client.rb, line 341
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::V8::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 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) { |response, operation| ... } click to toggle source

Updates a customer. Operation statuses are returned.

List of thrown errors:

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

@overload mutate_customer(request, options = nil)

Pass arguments to `mutate_customer` via a request object, either of type
{::Google::Ads::GoogleAds::V8::Services::MutateCustomerRequest} or an equivalent Hash.

@param request [::Google::Ads::GoogleAds::V8::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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload mutate_customer(customer_id: nil, operation: nil, validate_only: nil, response_content_type: nil)

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

@param customer_id [::String]
  Required. The ID of the customer being modified.
@param operation [::Google::Ads::GoogleAds::V8::Services::CustomerOperation, ::Hash]
  Required. The operation to perform on the customer
@param validate_only [::Boolean]
  If true, the request is validated but not executed. Only errors are
  returned, not results.
@param response_content_type [::Google::Ads::GoogleAds::V8::Enums::ResponseContentTypeEnum::ResponseContentType]
  The response content type setting. Determines whether the mutable resource
  or just the resource name should be returned post mutation.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Ads::GoogleAds::V8::Services::MutateCustomerResponse] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Ads::GoogleAds::V8::Services::MutateCustomerResponse]

@raise [Google::Ads::GoogleAds::Error] if the RPC is aborted.

# File lib/google/ads/google_ads/v8/services/customer_service/client.rb, line 271
def mutate_customer request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request,
                                     to: ::Google::Ads::GoogleAds::V8::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 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