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

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

Overview

Client for the ProductLinkInvitationService service.

This service allows management of product link invitations from Google Ads accounts to other accounts.

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_path, #product_link_invitation_path

Constructor Details

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

Create a new ProductLinkInvitationService client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the ProductLinkInvitationService client.

Yield Parameters:



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
 
# File 'lib/google/ads/google_ads/v17/services/product_link_invitation_service/client.rb', line 124

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

  @product_link_invitation_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Ads::GoogleAds::V17::Services::ProductLinkInvitationService::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



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

def product_link_invitation_service_stub
  @product_link_invitation_service_stub
end

Class Method Details

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

Configure the ProductLinkInvitationService Client class.

See Configuration for a description of the configuration fields.

Examples:


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

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



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

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



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

def configure
  yield @config if block_given?
  @config
end

#create_product_link_invitation(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V17::Services::CreateProductLinkInvitationResponse #create_product_link_invitation(customer_id: nil, product_link_invitation: nil) ⇒ ::Google::Ads::GoogleAds::V17::Services::CreateProductLinkInvitationResponse

Creates a product link invitation.

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::ProductLinkInvitationService::Client.new

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

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

# The returned object is of type Google::Ads::GoogleAds::V17::Services::CreateProductLinkInvitationResponse.
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.



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
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
 
# File 'lib/google/ads/google_ads/v17/services/product_link_invitation_service/client.rb', line 212

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

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

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

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

  @product_link_invitation_service_stub.call_rpc :create_product_link_invitation, 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

#remove_product_link_invitation(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V17::Services::RemoveProductLinkInvitationResponse #remove_product_link_invitation(customer_id: nil, resource_name: nil) ⇒ ::Google::Ads::GoogleAds::V17::Services::RemoveProductLinkInvitationResponse

Remove a product link invitation.

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::ProductLinkInvitationService::Client.new

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

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

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

Overloads:

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

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

    Parameters:

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

  • #remove_product_link_invitation(customer_id: nil, resource_name: nil) ⇒ ::Google::Ads::GoogleAds::V17::Services::RemoveProductLinkInvitationResponse

    Pass arguments to ‘remove_product_link_invitation` 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 product link invitation being removed.

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

      Required. The resource name of the product link invitation being removed. expected, in this format:

      ‘ `

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
 
# File 'lib/google/ads/google_ads/v17/services/product_link_invitation_service/client.rb', line 397

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

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

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

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

  @product_link_invitation_service_stub.call_rpc :remove_product_link_invitation, 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) 


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

def universe_domain
  @product_link_invitation_service_stub.universe_domain
end

#update_product_link_invitation(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V17::Services::UpdateProductLinkInvitationResponse #update_product_link_invitation(customer_id: nil, product_link_invitation_status: nil, resource_name: nil) ⇒ ::Google::Ads::GoogleAds::V17::Services::UpdateProductLinkInvitationResponse

Update a product link invitation.

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::ProductLinkInvitationService::Client.new

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

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

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

Overloads:

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

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

    Parameters:

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

  • #update_product_link_invitation(customer_id: nil, product_link_invitation_status: nil, resource_name: nil) ⇒ ::Google::Ads::GoogleAds::V17::Services::UpdateProductLinkInvitationResponse

    Pass arguments to ‘update_product_link_invitation` 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.

    • product_link_invitation_status (::Google::Ads::GoogleAds::V17::Enums::ProductLinkInvitationStatusEnum::ProductLinkInvitationStatus) (defaults to: nil) —

      Required. The product link invitation to be created.

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

      Required. Resource name of the product link invitation.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



304
305
306
307
308
309
310
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
341
342
343
344
345
346
 
# File 'lib/google/ads/google_ads/v17/services/product_link_invitation_service/client.rb', line 304

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

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

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

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

  @product_link_invitation_service_stub.call_rpc :update_product_link_invitation, 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