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

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

Overview

REST client for the LiveStreamService service.

Provides methods for handling LiveStream objects.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#cdn_config_path, #live_stream_path, #network_path

Constructor Details

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

Create a new LiveStreamService REST client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the LiveStreamService 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/live_stream_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

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

  @live_stream_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 LiveStreamService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all LiveStreamService clients
::Google::Ads::AdManager::V1::LiveStreamService::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/live_stream_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_live_streams(request, options = nil) ⇒ ::Google::Ads::AdManager::V1::BatchActivateLiveStreamsResponse #batch_activate_live_streams(parent: nil, names: nil) ⇒ ::Google::Ads::AdManager::V1::BatchActivateLiveStreamsResponse

Batch activates LiveStream 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::LiveStreamService::Rest::Client.new

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

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

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

Overloads:

  • #batch_activate_live_streams(request, options = nil) ⇒ ::Google::Ads::AdManager::V1::BatchActivateLiveStreamsResponse

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

    Parameters:

    • request (::Google::Ads::AdManager::V1::BatchActivateLiveStreamsRequest, ::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_live_streams(parent: nil, names: nil) ⇒ ::Google::Ads::AdManager::V1::BatchActivateLiveStreamsResponse

    Pass arguments to batch_activate_live_streams 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 LiveStreams to activate. Format: networks/{network_code}/liveStreams/{live_stream_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.



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
783
784
785
786
787
788
789
790
 
# File 'lib/google/ads/ad_manager/v1/live_stream_service/rest/client.rb', line 757

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

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

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

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

  @live_stream_service_stub.batch_activate_live_streams 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_archive_live_streams(request, options = nil) ⇒ ::Google::Ads::AdManager::V1::BatchArchiveLiveStreamsResponse #batch_archive_live_streams(parent: nil, names: nil) ⇒ ::Google::Ads::AdManager::V1::BatchArchiveLiveStreamsResponse

Batch archives LiveStream 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::LiveStreamService::Rest::Client.new

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

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

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

Overloads:

  • #batch_archive_live_streams(request, options = nil) ⇒ ::Google::Ads::AdManager::V1::BatchArchiveLiveStreamsResponse

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

    Parameters:

    • request (::Google::Ads::AdManager::V1::BatchArchiveLiveStreamsRequest, ::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_archive_live_streams(parent: nil, names: nil) ⇒ ::Google::Ads::AdManager::V1::BatchArchiveLiveStreamsResponse

    Pass arguments to batch_archive_live_streams 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 LiveStreams to archive. Format: networks/{network_code}/liveStreams/{live_stream_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.



919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
 
# File 'lib/google/ads/ad_manager/v1/live_stream_service/rest/client.rb', line 919

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

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

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

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

  @live_stream_service_stub.batch_archive_live_streams 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_live_streams(request, options = nil) ⇒ ::Google::Ads::AdManager::V1::BatchCreateLiveStreamsResponse #batch_create_live_streams(parent: nil, requests: nil) ⇒ ::Google::Ads::AdManager::V1::BatchCreateLiveStreamsResponse

Batch creates LiveStream 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::LiveStreamService::Rest::Client.new

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

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

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

Overloads:

  • #batch_create_live_streams(request, options = nil) ⇒ ::Google::Ads::AdManager::V1::BatchCreateLiveStreamsResponse

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

    Parameters:

    • request (::Google::Ads::AdManager::V1::BatchCreateLiveStreamsRequest, ::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_live_streams(parent: nil, requests: nil) ⇒ ::Google::Ads::AdManager::V1::BatchCreateLiveStreamsResponse

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

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

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



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
537
538
539
540
541
542
543
 
# File 'lib/google/ads/ad_manager/v1/live_stream_service/rest/client.rb', line 510

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

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

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

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

  @live_stream_service_stub.batch_create_live_streams 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_pause_ads_live_streams(request, options = nil) ⇒ ::Google::Ads::AdManager::V1::BatchPauseAdsLiveStreamsResponse #batch_pause_ads_live_streams(parent: nil, names: nil) ⇒ ::Google::Ads::AdManager::V1::BatchPauseAdsLiveStreamsResponse

Batch pauses ads on LiveStream 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::LiveStreamService::Rest::Client.new

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

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

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

Overloads:

  • #batch_pause_ads_live_streams(request, options = nil) ⇒ ::Google::Ads::AdManager::V1::BatchPauseAdsLiveStreamsResponse

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

    Parameters:

    • request (::Google::Ads::AdManager::V1::BatchPauseAdsLiveStreamsRequest, ::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_pause_ads_live_streams(parent: nil, names: nil) ⇒ ::Google::Ads::AdManager::V1::BatchPauseAdsLiveStreamsResponse

    Pass arguments to batch_pause_ads_live_streams 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 LiveStreams to pause ads on. Format: networks/{network_code}/liveStreams/{live_stream_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.



1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
 
# File 'lib/google/ads/ad_manager/v1/live_stream_service/rest/client.rb', line 1000

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

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

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

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

  @live_stream_service_stub.batch_pause_ads_live_streams 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_pause_live_streams(request, options = nil) ⇒ ::Google::Ads::AdManager::V1::BatchPauseLiveStreamsResponse #batch_pause_live_streams(parent: nil, names: nil) ⇒ ::Google::Ads::AdManager::V1::BatchPauseLiveStreamsResponse

Batch pauses LiveStream 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::LiveStreamService::Rest::Client.new

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

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

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

Overloads:

  • #batch_pause_live_streams(request, options = nil) ⇒ ::Google::Ads::AdManager::V1::BatchPauseLiveStreamsResponse

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

    Parameters:

    • request (::Google::Ads::AdManager::V1::BatchPauseLiveStreamsRequest, ::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_pause_live_streams(parent: nil, names: nil) ⇒ ::Google::Ads::AdManager::V1::BatchPauseLiveStreamsResponse

    Pass arguments to batch_pause_live_streams 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 LiveStreams to pause. Format: networks/{network_code}/liveStreams/{live_stream_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.



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
863
864
865
866
867
868
869
870
871
 
# File 'lib/google/ads/ad_manager/v1/live_stream_service/rest/client.rb', line 838

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

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

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

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

  @live_stream_service_stub.batch_pause_live_streams 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_refresh_master_playlists(request, options = nil) ⇒ ::Google::Ads::AdManager::V1::BatchRefreshMasterPlaylistsResponse #batch_refresh_master_playlists(parent: nil, names: nil) ⇒ ::Google::Ads::AdManager::V1::BatchRefreshMasterPlaylistsResponse

Batch refreshes master playlists on LiveStream 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::LiveStreamService::Rest::Client.new

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

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

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

Overloads:

  • #batch_refresh_master_playlists(request, options = nil) ⇒ ::Google::Ads::AdManager::V1::BatchRefreshMasterPlaylistsResponse

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

    Parameters:

    • request (::Google::Ads::AdManager::V1::BatchRefreshMasterPlaylistsRequest, ::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_refresh_master_playlists(parent: nil, names: nil) ⇒ ::Google::Ads::AdManager::V1::BatchRefreshMasterPlaylistsResponse

    Pass arguments to batch_refresh_master_playlists 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 LiveStreams to refresh master playlists on. Format: networks/{network_code}/liveStreams/{live_stream_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.



1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
 
# File 'lib/google/ads/ad_manager/v1/live_stream_service/rest/client.rb', line 1082

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

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

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

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

  @live_stream_service_stub.batch_refresh_master_playlists 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_live_streams(request, options = nil) ⇒ ::Google::Ads::AdManager::V1::BatchUpdateLiveStreamsResponse #batch_update_live_streams(parent: nil, requests: nil) ⇒ ::Google::Ads::AdManager::V1::BatchUpdateLiveStreamsResponse

Batch updates LiveStream 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::LiveStreamService::Rest::Client.new

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

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

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

Overloads:

  • #batch_update_live_streams(request, options = nil) ⇒ ::Google::Ads::AdManager::V1::BatchUpdateLiveStreamsResponse

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

    Parameters:

    • request (::Google::Ads::AdManager::V1::BatchUpdateLiveStreamsRequest, ::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_live_streams(parent: nil, requests: nil) ⇒ ::Google::Ads::AdManager::V1::BatchUpdateLiveStreamsResponse

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

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

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



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
703
704
705
706
707
708
709
 
# File 'lib/google/ads/ad_manager/v1/live_stream_service/rest/client.rb', line 676

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

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

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

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

  @live_stream_service_stub.batch_update_live_streams 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 LiveStreamService 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/live_stream_service/rest/client.rb', line 96

def configure
  yield @config if block_given?
  @config
end

#create_live_stream(request, options = nil) ⇒ ::Google::Ads::AdManager::V1::LiveStream #create_live_stream(parent: nil, live_stream: nil) ⇒ ::Google::Ads::AdManager::V1::LiveStream

Creates a LiveStream 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::LiveStreamService::Rest::Client.new

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

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

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

Overloads:

  • #create_live_stream(request, options = nil) ⇒ ::Google::Ads::AdManager::V1::LiveStream

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

    Parameters:

    • request (::Google::Ads::AdManager::V1::CreateLiveStreamRequest, ::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_live_stream(parent: nil, live_stream: nil) ⇒ ::Google::Ads::AdManager::V1::LiveStream

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

    • live_stream (::Google::Ads::AdManager::V1::LiveStream, ::Hash) (defaults to: nil) —

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



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
453
454
455
456
457
458
459
 
# File 'lib/google/ads/ad_manager/v1/live_stream_service/rest/client.rb', line 426

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

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

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

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

  @live_stream_service_stub.create_live_stream 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_live_stream(request, options = nil) ⇒ ::Google::Ads::AdManager::V1::LiveStream #get_live_stream(name: nil) ⇒ ::Google::Ads::AdManager::V1::LiveStream

Retrieves a LiveStream 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::LiveStreamService::Rest::Client.new

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

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

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

Overloads:

  • #get_live_stream(request, options = nil) ⇒ ::Google::Ads::AdManager::V1::LiveStream

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

    Parameters:

    • request (::Google::Ads::AdManager::V1::GetLiveStreamRequest, ::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_live_stream(name: nil) ⇒ ::Google::Ads::AdManager::V1::LiveStream

    Pass arguments to get_live_stream 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 LiveStream. Format: networks/{network_code}/liveStreams/{live_stream_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/live_stream_service/rest/client.rb', line 223

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

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

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

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

  @live_stream_service_stub.get_live_stream 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_live_streams(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Ads::AdManager::V1::LiveStream> #list_live_streams(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil, skip: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Ads::AdManager::V1::LiveStream>

Lists LiveStream 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::LiveStreamService::Rest::Client.new

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

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

Overloads:

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

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

    Parameters:

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

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

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

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

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

      • assetKey
      • createTime
      • customAssetKey
      • displayName
      • dynamicAdInsertionType
      • effectiveAssetKey
      • endTime
      • sourceContentConfigurations
      • startTime
      • status
      • streamingFormat
      • updateTime
    • 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.



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
372
373
374
375
376
377
378
 
# File 'lib/google/ads/ad_manager/v1/live_stream_service/rest/client.rb', line 343

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

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

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

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

  @live_stream_service_stub.list_live_streams request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @live_stream_service_stub, :list_live_streams, "live_streams", 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/live_stream_service/rest/client.rb', line 173

def logger
  @live_stream_service_stub.logger
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


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

def universe_domain
  @live_stream_service_stub.universe_domain
end

#update_live_stream(request, options = nil) ⇒ ::Google::Ads::AdManager::V1::LiveStream #update_live_stream(live_stream: nil, update_mask: nil) ⇒ ::Google::Ads::AdManager::V1::LiveStream

Updates a LiveStream 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::LiveStreamService::Rest::Client.new

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

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

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

Overloads:

  • #update_live_stream(request, options = nil) ⇒ ::Google::Ads::AdManager::V1::LiveStream

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

    Parameters:

    • request (::Google::Ads::AdManager::V1::UpdateLiveStreamRequest, ::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_live_stream(live_stream: nil, update_mask: nil) ⇒ ::Google::Ads::AdManager::V1::LiveStream

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



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
619
620
621
622
623
624
625
 
# File 'lib/google/ads/ad_manager/v1/live_stream_service/rest/client.rb', line 592

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

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

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

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

  @live_stream_service_stub.update_live_stream 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