class Google::Shopping::Merchant::Promotions::V1::PromotionsService::Rest::Client

def list_promotions request, options = nil

Other tags:
    Example: Basic example -

Raises:
  • (::Google::Cloud::Error) - if the REST call is aborted.

Returns:
  • (::Gapic::Rest::PagedEnumerable<::Google::Shopping::Merchant::Promotions::V1::Promotion>) -

Other tags:
    Yieldparam: operation -
    Yieldparam: result -

Other tags:
    Yield: - Access the result along with the TransportOperation object

Parameters:
  • page_token (::String) --
  • page_size (::Integer) --
  • parent (::String) --
  • options (::Gapic::CallOptions, ::Hash) --
  • request (::Google::Shopping::Merchant::Promotions::V1::ListPromotionsRequest, ::Hash) --

Overloads:
  • list_promotions(parent: nil, page_size: nil, page_token: nil)
  • list_promotions(request, options = nil)
def list_promotions request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?
  request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Merchant::Promotions::V1::ListPromotionsRequest
  # 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_promotions.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::Shopping::Merchant::Promotions::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_promotions.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_promotions.retry_policy
  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy
  @promotions_service_stub.list_promotions request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @promotions_service_stub, :list_promotions, "promotions", 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