Class: Google::Ads::AdManager::V1::EntitySignalsMappingService::Rest::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/ads/ad_manager/v1/entity_signals_mapping_service/rest/client.rb

Overview

REST client for the EntitySignalsMappingService service.

Provides methods for handling EntitySignalsMapping objects.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#entity_signals_mapping_path, #network_path

Constructor Details

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

Create a new EntitySignalsMappingService REST client object.

Examples:


# Create a client using the default configuration
client = ::Google::Ads::AdManager::V1::EntitySignalsMappingService::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Ads::AdManager::V1::EntitySignalsMappingService::Rest::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the EntitySignalsMappingService client.

Yield Parameters:



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
 
# File 'lib/google/ads/ad_manager/v1/entity_signals_mapping_service/rest/client.rb', line 126

def initialize
  # 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

  @entity_signals_mapping_service_stub = ::Google::Ads::AdManager::V1::EntitySignalsMappingService::Rest::ServiceStub.new(
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    credentials: credentials
  )
end

Class Method Details

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

Configure the EntitySignalsMappingService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all EntitySignalsMappingService clients
::Google::Ads::AdManager::V1::EntitySignalsMappingService::Rest::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
78
79
 
# File 'lib/google/ads/ad_manager/v1/entity_signals_mapping_service/rest/client.rb', line 64

def self.configure
  @configure ||= begin
    namespace = ["Google", "Ads", "AdManager", "V1"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#batch_create_entity_signals_mappings(request, options = nil) ⇒ ::Google::Ads::AdManager::V1::BatchCreateEntitySignalsMappingsResponse #batch_create_entity_signals_mappings(parent: nil, requests: nil) ⇒ ::Google::Ads::AdManager::V1::BatchCreateEntitySignalsMappingsResponse

API to batch create EntitySignalsMapping objects.

Examples:

Basic example

require "google/ads/ad_manager/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Ads::AdManager::V1::EntitySignalsMappingService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Ads::AdManager::V1::BatchCreateEntitySignalsMappingsRequest.new

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

# The returned object is of type Google::Ads::AdManager::V1::BatchCreateEntitySignalsMappingsResponse.
p result

Overloads:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
 
# File 'lib/google/ads/ad_manager/v1/entity_signals_mapping_service/rest/client.rb', line 564

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::AdManager::V1::BatchCreateEntitySignalsMappingsRequest

  # 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
  call_metadata = @config.rpcs.batch_create_entity_signals_mappings.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::AdManager::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.batch_create_entity_signals_mappings.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.batch_create_entity_signals_mappings.retry_policy

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

  @entity_signals_mapping_service_stub.batch_create_entity_signals_mappings request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#batch_update_entity_signals_mappings(request, options = nil) ⇒ ::Google::Ads::AdManager::V1::BatchUpdateEntitySignalsMappingsResponse #batch_update_entity_signals_mappings(parent: nil, requests: nil) ⇒ ::Google::Ads::AdManager::V1::BatchUpdateEntitySignalsMappingsResponse

API to batch update EntitySignalsMapping objects.

Examples:

Basic example

require "google/ads/ad_manager/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Ads::AdManager::V1::EntitySignalsMappingService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Ads::AdManager::V1::BatchUpdateEntitySignalsMappingsRequest.new

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

# The returned object is of type Google::Ads::AdManager::V1::BatchUpdateEntitySignalsMappingsResponse.
p result

Overloads:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
 
# File 'lib/google/ads/ad_manager/v1/entity_signals_mapping_service/rest/client.rb', line 648

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::AdManager::V1::BatchUpdateEntitySignalsMappingsRequest

  # 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
  call_metadata = @config.rpcs.batch_update_entity_signals_mappings.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::AdManager::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.batch_update_entity_signals_mappings.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.batch_update_entity_signals_mappings.retry_policy

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

  @entity_signals_mapping_service_stub.batch_update_entity_signals_mappings request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Configure the EntitySignalsMappingService 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:



96
97
98
99
 
# File 'lib/google/ads/ad_manager/v1/entity_signals_mapping_service/rest/client.rb', line 96

def configure
  yield @config if block_given?
  @config
end

#create_entity_signals_mapping(request, options = nil) ⇒ ::Google::Ads::AdManager::V1::EntitySignalsMapping #create_entity_signals_mapping(parent: nil, entity_signals_mapping: nil) ⇒ ::Google::Ads::AdManager::V1::EntitySignalsMapping

API to create an EntitySignalsMapping object.

Examples:

Basic example

require "google/ads/ad_manager/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Ads::AdManager::V1::EntitySignalsMappingService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Ads::AdManager::V1::CreateEntitySignalsMappingRequest.new

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

# The returned object is of type Google::Ads::AdManager::V1::EntitySignalsMapping.
p result

Overloads:

  • #create_entity_signals_mapping(request, options = nil) ⇒ ::Google::Ads::AdManager::V1::EntitySignalsMapping

    Pass arguments to create_entity_signals_mapping via a request object, either of type CreateEntitySignalsMappingRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Ads::AdManager::V1::CreateEntitySignalsMappingRequest, ::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_entity_signals_mapping(parent: nil, entity_signals_mapping: nil) ⇒ ::Google::Ads::AdManager::V1::EntitySignalsMapping

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

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

      Required. The parent resource where this EntitySignalsMapping will be created. Format: networks/{network_code}

    • entity_signals_mapping (::Google::Ads::AdManager::V1::EntitySignalsMapping, ::Hash) (defaults to: nil) —

      Required. The EntitySignalsMapping object to create.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



394
395
396
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
 
# File 'lib/google/ads/ad_manager/v1/entity_signals_mapping_service/rest/client.rb', line 394

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::AdManager::V1::CreateEntitySignalsMappingRequest

  # 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
  call_metadata = @config.rpcs.create_entity_signals_mapping.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::AdManager::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_entity_signals_mapping.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_entity_signals_mapping.retry_policy

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

  @entity_signals_mapping_service_stub.create_entity_signals_mapping request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_entity_signals_mapping(request, options = nil) ⇒ ::Google::Ads::AdManager::V1::EntitySignalsMapping #get_entity_signals_mapping(name: nil) ⇒ ::Google::Ads::AdManager::V1::EntitySignalsMapping

API to retrieve a EntitySignalsMapping object.

Examples:

Basic example

require "google/ads/ad_manager/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Ads::AdManager::V1::EntitySignalsMappingService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Ads::AdManager::V1::GetEntitySignalsMappingRequest.new

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

# The returned object is of type Google::Ads::AdManager::V1::EntitySignalsMapping.
p result

Overloads:

  • #get_entity_signals_mapping(request, options = nil) ⇒ ::Google::Ads::AdManager::V1::EntitySignalsMapping

    Pass arguments to get_entity_signals_mapping via a request object, either of type GetEntitySignalsMappingRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Ads::AdManager::V1::GetEntitySignalsMappingRequest, ::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_entity_signals_mapping(name: nil) ⇒ ::Google::Ads::AdManager::V1::EntitySignalsMapping

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

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

      Required. The resource name of the EntitySignalsMapping. Format: networks/{network_code}/entitySignalsMappings/{entity_signals_mapping_id}

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



204
205
206
207
208
209
210
211
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
 
# File 'lib/google/ads/ad_manager/v1/entity_signals_mapping_service/rest/client.rb', line 204

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::AdManager::V1::GetEntitySignalsMappingRequest

  # 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
  call_metadata = @config.rpcs.get_entity_signals_mapping.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::AdManager::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_entity_signals_mapping.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_entity_signals_mapping.retry_policy

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

  @entity_signals_mapping_service_stub.get_entity_signals_mapping request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_entity_signals_mappings(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Ads::AdManager::V1::EntitySignalsMapping> #list_entity_signals_mappings(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil, skip: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Ads::AdManager::V1::EntitySignalsMapping>

API to retrieve a list of EntitySignalsMapping objects.

Examples:

Basic example

require "google/ads/ad_manager/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Ads::AdManager::V1::EntitySignalsMappingService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Ads::AdManager::V1::ListEntitySignalsMappingsRequest.new

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Ads::AdManager::V1::EntitySignalsMapping.
  p item
end

Overloads:

  • #list_entity_signals_mappings(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Ads::AdManager::V1::EntitySignalsMapping>

    Pass arguments to list_entity_signals_mappings via a request object, either of type ListEntitySignalsMappingsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Ads::AdManager::V1::ListEntitySignalsMappingsRequest, ::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.

  • #list_entity_signals_mappings(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil, skip: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Ads::AdManager::V1::EntitySignalsMapping>

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

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

      Required. The parent, which owns this collection of EntitySignalsMappings. Format: networks/{network_code}

    • page_size (::Integer) (defaults to: nil) —

      Optional. The maximum number of EntitySignalsMappings to return. The service may return fewer than this value. If unspecified, at most 50 EntitySignalsMappings will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

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

      Optional. A page token, received from a previous ListEntitySignalsMappings call. Provide this to retrieve the subsequent page.

      When paginating, all other parameters provided to ListEntitySignalsMappings must match the call that provided the page token.

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

      Optional. Expression to filter the response. See syntax details at https://developers.google.com/ad-manager/api/beta/filters

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

      Optional. Expression to specify sorting order. See syntax details at https://developers.google.com/ad-manager/api/beta/filters#order

    • skip (::Integer) (defaults to: nil) —

      Optional. Number of individual resources to skip while paginating.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call 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
341
342
343
344
345
346
 
# File 'lib/google/ads/ad_manager/v1/entity_signals_mapping_service/rest/client.rb', line 311

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::AdManager::V1::ListEntitySignalsMappingsRequest

  # 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
  call_metadata = @config.rpcs.list_entity_signals_mappings.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::AdManager::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_entity_signals_mappings.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_entity_signals_mappings.retry_policy

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

  @entity_signals_mapping_service_stub.list_entity_signals_mappings request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @entity_signals_mapping_service_stub, :list_entity_signals_mappings, "entity_signals_mappings", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


106
107
108
 
# File 'lib/google/ads/ad_manager/v1/entity_signals_mapping_service/rest/client.rb', line 106

def universe_domain
  @entity_signals_mapping_service_stub.universe_domain
end

#update_entity_signals_mapping(request, options = nil) ⇒ ::Google::Ads::AdManager::V1::EntitySignalsMapping #update_entity_signals_mapping(entity_signals_mapping: nil, update_mask: nil) ⇒ ::Google::Ads::AdManager::V1::EntitySignalsMapping

API to update an EntitySignalsMapping object.

Examples:

Basic example

require "google/ads/ad_manager/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Ads::AdManager::V1::EntitySignalsMappingService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Ads::AdManager::V1::UpdateEntitySignalsMappingRequest.new

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

# The returned object is of type Google::Ads::AdManager::V1::EntitySignalsMapping.
p result

Overloads:

  • #update_entity_signals_mapping(request, options = nil) ⇒ ::Google::Ads::AdManager::V1::EntitySignalsMapping

    Pass arguments to update_entity_signals_mapping via a request object, either of type UpdateEntitySignalsMappingRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Ads::AdManager::V1::UpdateEntitySignalsMappingRequest, ::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_entity_signals_mapping(entity_signals_mapping: nil, update_mask: nil) ⇒ ::Google::Ads::AdManager::V1::EntitySignalsMapping

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

    • entity_signals_mapping (::Google::Ads::AdManager::V1::EntitySignalsMapping, ::Hash) (defaults to: nil) —

      Required. The EntitySignalsMapping to update.

      The EntitySignalsMapping's name is used to identify the EntitySignalsMapping to update. Format: networks/{network_code}/entitySignalsMappings/{entity_signals_mapping}

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      Required. The list of fields to update.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
 
# File 'lib/google/ads/ad_manager/v1/entity_signals_mapping_service/rest/client.rb', line 480

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::AdManager::V1::UpdateEntitySignalsMappingRequest

  # 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
  call_metadata = @config.rpcs.update_entity_signals_mapping.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::AdManager::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_entity_signals_mapping.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_entity_signals_mapping.retry_policy

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

  @entity_signals_mapping_service_stub.update_entity_signals_mapping request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end