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

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

Overview

REST client for the SiteService service.

Provides methods for handling Site objects.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#network_path, #site_path

Constructor Details

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

Create a new SiteService REST client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the SiteService 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/site_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

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

  @site_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 SiteService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all SiteService clients
::Google::Ads::AdManager::V1::SiteService::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/site_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_sites(request, options = nil) ⇒ ::Google::Ads::AdManager::V1::BatchCreateSitesResponse #batch_create_sites(parent: nil, requests: nil) ⇒ ::Google::Ads::AdManager::V1::BatchCreateSitesResponse

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

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

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

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

Overloads:

  • #batch_create_sites(request, options = nil) ⇒ ::Google::Ads::AdManager::V1::BatchCreateSitesResponse

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

    Parameters:

    • request (::Google::Ads::AdManager::V1::BatchCreateSitesRequest, ::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_sites(parent: nil, requests: nil) ⇒ ::Google::Ads::AdManager::V1::BatchCreateSitesResponse

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

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

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



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
528
529
530
531
532
533
534
535
536
 
# File 'lib/google/ads/ad_manager/v1/site_service/rest/client.rb', line 503

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

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

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

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

  @site_service_stub.batch_create_sites 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_sites(request, options = nil) ⇒ ::Google::Ads::AdManager::V1::BatchDeactivateSitesResponse #batch_deactivate_sites(parent: nil, names: nil) ⇒ ::Google::Ads::AdManager::V1::BatchDeactivateSitesResponse

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

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

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

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

Overloads:

  • #batch_deactivate_sites(request, options = nil) ⇒ ::Google::Ads::AdManager::V1::BatchDeactivateSitesResponse

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

    Parameters:

    • request (::Google::Ads::AdManager::V1::BatchDeactivateSitesRequest, ::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_sites(parent: nil, names: nil) ⇒ ::Google::Ads::AdManager::V1::BatchDeactivateSitesResponse

    Pass arguments to batch_deactivate_sites 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 Site objects to deactivate.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
775
776
777
778
779
780
781
782
 
# File 'lib/google/ads/ad_manager/v1/site_service/rest/client.rb', line 749

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

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

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

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

  @site_service_stub.batch_deactivate_sites 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_submit_sites_for_approval(request, options = nil) ⇒ ::Google::Ads::AdManager::V1::BatchSubmitSitesForApprovalResponse #batch_submit_sites_for_approval(parent: nil, names: nil) ⇒ ::Google::Ads::AdManager::V1::BatchSubmitSitesForApprovalResponse

Submits a list of Site objects for approval.

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

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

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

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

Overloads:

  • #batch_submit_sites_for_approval(request, options = nil) ⇒ ::Google::Ads::AdManager::V1::BatchSubmitSitesForApprovalResponse

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

    Parameters:

    • request (::Google::Ads::AdManager::V1::BatchSubmitSitesForApprovalRequest, ::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_submit_sites_for_approval(parent: nil, names: nil) ⇒ ::Google::Ads::AdManager::V1::BatchSubmitSitesForApprovalResponse

    Pass arguments to batch_submit_sites_for_approval 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 Site objects to submit for approval.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
856
857
858
859
860
861
862
 
# File 'lib/google/ads/ad_manager/v1/site_service/rest/client.rb', line 829

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

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

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

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

  @site_service_stub.batch_submit_sites_for_approval 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_sites(request, options = nil) ⇒ ::Google::Ads::AdManager::V1::BatchUpdateSitesResponse #batch_update_sites(parent: nil, requests: nil) ⇒ ::Google::Ads::AdManager::V1::BatchUpdateSitesResponse

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

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

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

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

Overloads:

  • #batch_update_sites(request, options = nil) ⇒ ::Google::Ads::AdManager::V1::BatchUpdateSitesResponse

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

    Parameters:

    • request (::Google::Ads::AdManager::V1::BatchUpdateSitesRequest, ::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_sites(parent: nil, requests: nil) ⇒ ::Google::Ads::AdManager::V1::BatchUpdateSitesResponse

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

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

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



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
694
695
696
697
698
699
700
701
702
 
# File 'lib/google/ads/ad_manager/v1/site_service/rest/client.rb', line 669

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

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

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

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

  @site_service_stub.batch_update_sites 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 SiteService 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/site_service/rest/client.rb', line 96

def configure
  yield @config if block_given?
  @config
end

#create_site(request, options = nil) ⇒ ::Google::Ads::AdManager::V1::Site #create_site(parent: nil, site: nil) ⇒ ::Google::Ads::AdManager::V1::Site

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

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

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

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

Overloads:

  • #create_site(request, options = nil) ⇒ ::Google::Ads::AdManager::V1::Site

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

    Parameters:

    • request (::Google::Ads::AdManager::V1::CreateSiteRequest, ::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_site(parent: nil, site: nil) ⇒ ::Google::Ads::AdManager::V1::Site

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

    • site (::Google::Ads::AdManager::V1::Site, ::Hash) (defaults to: nil) —

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



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
444
445
446
447
448
449
450
451
452
 
# File 'lib/google/ads/ad_manager/v1/site_service/rest/client.rb', line 419

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

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

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

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

  @site_service_stub.create_site 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_site(request, options = nil) ⇒ ::Google::Ads::AdManager::V1::Site #get_site(name: nil) ⇒ ::Google::Ads::AdManager::V1::Site

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

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

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

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

Overloads:

  • #get_site(request, options = nil) ⇒ ::Google::Ads::AdManager::V1::Site

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

    Parameters:

    • request (::Google::Ads::AdManager::V1::GetSiteRequest, ::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_site(name: nil) ⇒ ::Google::Ads::AdManager::V1::Site

    Pass arguments to get_site 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 Site. Format: networks/{network_code}/sites/{site_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/site_service/rest/client.rb', line 223

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

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

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

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

  @site_service_stub.get_site 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_sites(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Ads::AdManager::V1::Site> #list_sites(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil, skip: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Ads::AdManager::V1::Site>

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

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

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

Overloads:

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

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

    Parameters:

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

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

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

      Optional. The maximum number of Sites to return. The service may return fewer than this value. If unspecified, at most 50 Sites 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 ListSites call. Provide this to retrieve the subsequent page.

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

      Filterable fields:

      • approvalStatus
      • approvalStatusUpdateTime
      • childNetworkCode
      • name
      • url
    • 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.



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
363
364
365
366
367
368
369
370
371
 
# File 'lib/google/ads/ad_manager/v1/site_service/rest/client.rb', line 336

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

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

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

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

  @site_service_stub.list_sites request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @site_service_stub, :list_sites, "sites", 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/site_service/rest/client.rb', line 173

def logger
  @site_service_stub.logger
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


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

def universe_domain
  @site_service_stub.universe_domain
end

#update_site(request, options = nil) ⇒ ::Google::Ads::AdManager::V1::Site #update_site(site: nil, update_mask: nil) ⇒ ::Google::Ads::AdManager::V1::Site

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

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

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

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

Overloads:

  • #update_site(request, options = nil) ⇒ ::Google::Ads::AdManager::V1::Site

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

    Parameters:

    • request (::Google::Ads::AdManager::V1::UpdateSiteRequest, ::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_site(site: nil, update_mask: nil) ⇒ ::Google::Ads::AdManager::V1::Site

    Pass arguments to update_site 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.



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
610
611
612
613
614
615
616
617
618
 
# File 'lib/google/ads/ad_manager/v1/site_service/rest/client.rb', line 585

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

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

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

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

  @site_service_stub.update_site 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