Class: Google::Ads::GoogleAds::V18::Services::CustomerManagerLinkService::Client

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

Overview

Client for the CustomerManagerLinkService service.

Service to manage customer-manager links.

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

#customer_manager_link_path, #customer_path

Constructor Details

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

Create a new CustomerManagerLinkService client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the CustomerManagerLinkService 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
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/google/ads/google_ads/v18/services/customer_manager_link_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/v18/services/customer_manager_link_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_manager_link_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Ads::GoogleAds::V18::Services::CustomerManagerLinkService::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,
    logger: @config.logger
  )

  @customer_manager_link_service_stub.stub_logger&.info do |entry|
    entry.set_system_name
    entry.set_service
    entry.message = "Created client for #{entry.service}"
    entry.set_credentials_fields credentials
    entry.set "customEndpoint", @config.endpoint if @config.endpoint
    entry.set "defaultTimeout", @config.timeout if @config.timeout
    entry.set "quotaProject", @quota_project_id if @quota_project_id
  end
end

Instance Attribute Details



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

def customer_manager_link_service_stub
  @customer_manager_link_service_stub
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the CustomerManagerLinkService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all CustomerManagerLinkService clients
::Google::Ads::GoogleAds::V18::Services::CustomerManagerLinkService::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/v18/services/customer_manager_link_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 CustomerManagerLinkService 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/v18/services/customer_manager_link_service/client.rb', line 93

def configure
  yield @config if block_given?
  @config
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


179
180
181
 
# File 'lib/google/ads/google_ads/v18/services/customer_manager_link_service/client.rb', line 179

def logger
  @customer_manager_link_service_stub.logger
end

#move_manager_link(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V18::Services::MoveManagerLinkResponse #move_manager_link(customer_id: nil, previous_customer_manager_link: nil, new_manager: nil, validate_only: nil) ⇒ ::Google::Ads::GoogleAds::V18::Services::MoveManagerLinkResponse

Moves a client customer to a new manager customer. This simplifies the complex request that requires two operations to move a client customer to a new manager, for example:

  1. Update operation with Status INACTIVE (previous manager) and,

  2. Update operation with Status ACTIVE (new manager).

List of thrown errors:

[AuthenticationError]()
[AuthorizationError]()
[DatabaseError]()
[FieldError]()
[HeaderError]()
[InternalError]()
[MutateError]()
[QuotaError]()
[RequestError]()

Examples:

Basic example

require "google/ads/google_ads/v18/services"

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

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

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

# The returned object is of type Google::Ads::GoogleAds::V18::Services::MoveManagerLinkResponse.
p result

Overloads:

  • #move_manager_link(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V18::Services::MoveManagerLinkResponse

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

    Parameters:

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

  • #move_manager_link(customer_id: nil, previous_customer_manager_link: nil, new_manager: nil, validate_only: nil) ⇒ ::Google::Ads::GoogleAds::V18::Services::MoveManagerLinkResponse

    Pass arguments to ‘move_manager_link` 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 client customer that is being moved.

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

      Required. The resource name of the previous CustomerManagerLink. The resource name has the form: ‘customers/customer_id/customerManagerLinks/manager_customer_id~manager_link_id`

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

      Required. The resource name of the new manager customer that the client wants to move to. Customer resource names have the format: “customers/{customer_id}”

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



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/google/ads/google_ads/v18/services/customer_manager_link_service/client.rb', line 362

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

  request = ::Gapic::Protobuf.coerce request,
                                     to: ::Google::Ads::GoogleAds::V18::Services::MoveManagerLinkRequest

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

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

  @customer_manager_link_service_stub.call_rpc :move_manager_link, request,
                                               options: options do |response, operation|
    yield response, operation if block_given?
  end
  # rescue GRPC::BadStatus => grpc_error
  #  raise Google::Ads::GoogleAds::Error.new grpc_error.message
end

#mutate_customer_manager_link(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V18::Services::MutateCustomerManagerLinkResponse #mutate_customer_manager_link(customer_id: nil, operations: nil, validate_only: nil) ⇒ ::Google::Ads::GoogleAds::V18::Services::MutateCustomerManagerLinkResponse

Updates customer manager links. Operation statuses are returned.

List of thrown errors:

[AuthenticationError]()
[AuthorizationError]()
[DatabaseError]()
[FieldError]()
[FieldMaskError]()
[HeaderError]()
[InternalError]()
[ManagerLinkError]()
[MutateError]()
[QuotaError]()
[RequestError]()

Examples:

Basic example

require "google/ads/google_ads/v18/services"

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

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

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

# The returned object is of type Google::Ads::GoogleAds::V18::Services::MutateCustomerManagerLinkResponse.
p result

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



249
250
251
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
288
289
290
 
# File 'lib/google/ads/google_ads/v18/services/customer_manager_link_service/client.rb', line 249

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

  request = ::Gapic::Protobuf.coerce request,
                                     to: ::Google::Ads::GoogleAds::V18::Services::MutateCustomerManagerLinkRequest

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

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

  @customer_manager_link_service_stub.call_rpc :mutate_customer_manager_link, request,
                                               options: options do |response, operation|
    yield response, operation if block_given?
  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/v18/services/customer_manager_link_service/client.rb', line 103

def universe_domain
  @customer_manager_link_service_stub.universe_domain
end