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

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

Overview

REST client for the CustomFieldService service.

Provides methods for handling CustomField objects.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#custom_field_path, #network_path

Constructor Details

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

Create a new CustomFieldService REST client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the CustomFieldService 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
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/google/ads/ad_manager/v1/custom_field_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

  @custom_field_service_stub = ::Google::Ads::AdManager::V1::CustomFieldService::Rest::ServiceStub.new(
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    credentials: credentials,
    logger: @config.logger
  )

  @custom_field_service_stub.logger(stub: true)&.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

Class Method Details

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

Configure the CustomFieldService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all CustomFieldService clients
::Google::Ads::AdManager::V1::CustomFieldService::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/custom_field_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_activate_custom_fields(request, options = nil) ⇒ ::Google::Ads::AdManager::V1::BatchActivateCustomFieldsResponse #batch_activate_custom_fields(parent: nil, names: nil) ⇒ ::Google::Ads::AdManager::V1::BatchActivateCustomFieldsResponse

Activates a list of CustomField 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::CustomFieldService::Rest::Client.new

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

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

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

Overloads:

  • #batch_activate_custom_fields(request, options = nil) ⇒ ::Google::Ads::AdManager::V1::BatchActivateCustomFieldsResponse

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

    Parameters:

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

  • #batch_activate_custom_fields(parent: nil, names: nil) ⇒ ::Google::Ads::AdManager::V1::BatchActivateCustomFieldsResponse

    Pass arguments to batch_activate_custom_fields 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. Format: networks/{network_code}

    • names (::Array<::String>) (defaults to: nil) —

      Required. The resource names of the CustomField objects to activate. Format: networks/{network_code}/customFields/{custom_field_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.



741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
 
# File 'lib/google/ads/ad_manager/v1/custom_field_service/rest/client.rb', line 741

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

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

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

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

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

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

API to batch create CustomField 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::CustomFieldService::Rest::Client.new

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

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

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

Overloads:

  • #batch_create_custom_fields(request, options = nil) ⇒ ::Google::Ads::AdManager::V1::BatchCreateCustomFieldsResponse

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

    Parameters:

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

  • #batch_create_custom_fields(parent: nil, requests: nil) ⇒ ::Google::Ads::AdManager::V1::BatchCreateCustomFieldsResponse

    Pass arguments to batch_create_custom_fields 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 CustomFields will be created. Format: networks/{network_code} The parent field in the CreateCustomFieldRequest must match this field.

    • requests (::Array<::Google::Ads::AdManager::V1::CreateCustomFieldRequest, ::Hash>) (defaults to: nil) —

      Required. The CustomField objects to create. A maximum of 100 objects can be created in a batch.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
 
# File 'lib/google/ads/ad_manager/v1/custom_field_service/rest/client.rb', line 494

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

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

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

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

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

#batch_deactivate_custom_fields(request, options = nil) ⇒ ::Google::Ads::AdManager::V1::BatchDeactivateCustomFieldsResponse #batch_deactivate_custom_fields(parent: nil, names: nil) ⇒ ::Google::Ads::AdManager::V1::BatchDeactivateCustomFieldsResponse

Deactivates a list of CustomField 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::CustomFieldService::Rest::Client.new

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

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

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

Overloads:

  • #batch_deactivate_custom_fields(request, options = nil) ⇒ ::Google::Ads::AdManager::V1::BatchDeactivateCustomFieldsResponse

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

    Parameters:

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

  • #batch_deactivate_custom_fields(parent: nil, names: nil) ⇒ ::Google::Ads::AdManager::V1::BatchDeactivateCustomFieldsResponse

    Pass arguments to batch_deactivate_custom_fields 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. Format: networks/{network_code}

    • names (::Array<::String>) (defaults to: nil) —

      Required. The resource names of the CustomField objects to deactivate. Format: networks/{network_code}/customFields/{custom_field_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.



822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
 
# File 'lib/google/ads/ad_manager/v1/custom_field_service/rest/client.rb', line 822

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

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

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

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

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

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

API to batch update CustomField 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::CustomFieldService::Rest::Client.new

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

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

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

Overloads:

  • #batch_update_custom_fields(request, options = nil) ⇒ ::Google::Ads::AdManager::V1::BatchUpdateCustomFieldsResponse

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

    Parameters:

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

  • #batch_update_custom_fields(parent: nil, requests: nil) ⇒ ::Google::Ads::AdManager::V1::BatchUpdateCustomFieldsResponse

    Pass arguments to batch_update_custom_fields 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 CustomFields will be updated. Format: networks/{network_code} The parent field in the UpdateCustomFieldRequest must match this field.

    • requests (::Array<::Google::Ads::AdManager::V1::UpdateCustomFieldRequest, ::Hash>) (defaults to: nil) —

      Required. The CustomField objects to update. A maximum of 100 objects can be updated in a batch.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
 
# File 'lib/google/ads/ad_manager/v1/custom_field_service/rest/client.rb', line 660

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

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

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

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

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

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

Configure the CustomFieldService 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/custom_field_service/rest/client.rb', line 96

def configure
  yield @config if block_given?
  @config
end

#create_custom_field(request, options = nil) ⇒ ::Google::Ads::AdManager::V1::CustomField #create_custom_field(parent: nil, custom_field: nil) ⇒ ::Google::Ads::AdManager::V1::CustomField

API to create a CustomField 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::CustomFieldService::Rest::Client.new

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

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

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

Overloads:

  • #create_custom_field(request, options = nil) ⇒ ::Google::Ads::AdManager::V1::CustomField

    Pass arguments to create_custom_field via a request object, either of type Google::Ads::AdManager::V1::CreateCustomFieldRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Ads::AdManager::V1::CreateCustomFieldRequest, ::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_custom_field(parent: nil, custom_field: nil) ⇒ ::Google::Ads::AdManager::V1::CustomField

    Pass arguments to create_custom_field 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 CustomField will be created. Format: networks/{network_code}

    • custom_field (::Google::Ads::AdManager::V1::CustomField, ::Hash) (defaults to: nil) —

      Required. The CustomField 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.



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
440
441
442
443
 
# File 'lib/google/ads/ad_manager/v1/custom_field_service/rest/client.rb', line 410

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

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

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

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

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

#get_custom_field(request, options = nil) ⇒ ::Google::Ads::AdManager::V1::CustomField #get_custom_field(name: nil) ⇒ ::Google::Ads::AdManager::V1::CustomField

API to retrieve a CustomField 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::CustomFieldService::Rest::Client.new

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

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

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

Overloads:

  • #get_custom_field(request, options = nil) ⇒ ::Google::Ads::AdManager::V1::CustomField

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

    Parameters:

    • request (::Google::Ads::AdManager::V1::GetCustomFieldRequest, ::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_custom_field(name: nil) ⇒ ::Google::Ads::AdManager::V1::CustomField

    Pass arguments to get_custom_field 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 CustomField. Format: networks/{network_code}/customFields/{custom_field_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.



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
255
256
 
# File 'lib/google/ads/ad_manager/v1/custom_field_service/rest/client.rb', line 223

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

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

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

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

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

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

API to retrieve a list of CustomField 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::CustomFieldService::Rest::Client.new

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

# Call the list_custom_fields method.
result = client.list_custom_fields 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::CustomField.
  p item
end

Overloads:

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

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

    Parameters:

    • request (::Google::Ads::AdManager::V1::ListCustomFieldsRequest, ::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_custom_fields(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil, skip: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Ads::AdManager::V1::CustomField>

    Pass arguments to list_custom_fields 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 CustomFields. Format: networks/{network_code}

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

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

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

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

      When paginating, all other parameters provided to ListCustomFields 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.



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/google/ads/ad_manager/v1/custom_field_service/rest/client.rb', line 327

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

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

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

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

  @custom_field_service_stub.list_custom_fields request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @custom_field_service_stub, :list_custom_fields, "custom_fields", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


173
174
175
 
# File 'lib/google/ads/ad_manager/v1/custom_field_service/rest/client.rb', line 173

def logger
  @custom_field_service_stub.logger
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


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

def universe_domain
  @custom_field_service_stub.universe_domain
end

#update_custom_field(request, options = nil) ⇒ ::Google::Ads::AdManager::V1::CustomField #update_custom_field(custom_field: nil, update_mask: nil) ⇒ ::Google::Ads::AdManager::V1::CustomField

API to update a CustomField 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::CustomFieldService::Rest::Client.new

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

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

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

Overloads:

  • #update_custom_field(request, options = nil) ⇒ ::Google::Ads::AdManager::V1::CustomField

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

    Parameters:

    • request (::Google::Ads::AdManager::V1::UpdateCustomFieldRequest, ::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_custom_field(custom_field: nil, update_mask: nil) ⇒ ::Google::Ads::AdManager::V1::CustomField

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

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
 
# File 'lib/google/ads/ad_manager/v1/custom_field_service/rest/client.rb', line 576

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

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

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

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

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