Autogenerated update (2020-06-24)

Update:
- cloudbuild_v1
- cloudbuild_v1alpha1
- cloudbuild_v1alpha2
- cloudfunctions_v1
- dialogflow_v2
- dialogflow_v2beta1
- displayvideo_v1
- documentai_v1beta2
- doubleclicksearch_v2
- fcm_v1
- healthcare_v1
- healthcare_v1beta1
- monitoring_v3
- spanner_v1
- speech_v1
- speech_v1p1beta1
This commit is contained in:
Google APIs 2020-06-24 00:38:30 +00:00
parent 16c24bd5d6
commit b7da348cd1
41 changed files with 4776 additions and 339 deletions

View File

@ -25,7 +25,7 @@ module Google
# @see https://cloud.google.com/cloud-build/docs/ # @see https://cloud.google.com/cloud-build/docs/
module CloudbuildV1 module CloudbuildV1
VERSION = 'V1' VERSION = 'V1'
REVISION = '20200606' REVISION = '20200619'
# View and manage your data across Google Cloud Platform services # View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

View File

@ -703,48 +703,6 @@ module Google
command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
# Starts asynchronous cancellation on a long-running operation. The server
# makes a best effort to cancel the operation, but success is not
# guaranteed. If the server doesn't support this method, it returns
# `google.rpc.Code.UNIMPLEMENTED`. Clients can use
# Operations.GetOperation or
# other methods to check whether the cancellation succeeded or whether the
# operation completed despite cancellation. On successful cancellation,
# the operation is not deleted; instead, it becomes an operation with
# an Operation.error value with a google.rpc.Status.code of 1,
# corresponding to `Code.CANCELLED`.
# @param [String] name
# The name of the operation resource to be cancelled.
# @param [Google::Apis::CloudbuildV1::CancelOperationRequest] cancel_operation_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudbuildV1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudbuildV1::Empty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def cancel_vbeta1_project_location_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'vbeta1/{+name}:cancel', options)
command.request_representation = Google::Apis::CloudbuildV1::CancelOperationRequest::Representation
command.request_object = cancel_operation_request_object
command.response_representation = Google::Apis::CloudbuildV1::Empty::Representation
command.response_class = Google::Apis::CloudbuildV1::Empty
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
protected protected

View File

@ -25,7 +25,7 @@ module Google
# @see https://cloud.google.com/cloud-build/docs/ # @see https://cloud.google.com/cloud-build/docs/
module CloudbuildV1alpha1 module CloudbuildV1alpha1
VERSION = 'V1alpha1' VERSION = 'V1alpha1'
REVISION = '20200606' REVISION = '20200619'
# View and manage your data across Google Cloud Platform services # View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

View File

@ -25,7 +25,7 @@ module Google
# @see https://cloud.google.com/cloud-build/docs/ # @see https://cloud.google.com/cloud-build/docs/
module CloudbuildV1alpha2 module CloudbuildV1alpha2
VERSION = 'V1alpha2' VERSION = 'V1alpha2'
REVISION = '20200606' REVISION = '20200619'
# View and manage your data across Google Cloud Platform services # View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

View File

@ -25,7 +25,7 @@ module Google
# @see https://cloud.google.com/functions # @see https://cloud.google.com/functions
module CloudfunctionsV1 module CloudfunctionsV1
VERSION = 'V1' VERSION = 'V1'
REVISION = '20200504' REVISION = '20200610'
# View and manage your data across Google Cloud Platform services # View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

View File

@ -34,7 +34,7 @@ module Google
# ` # `
# "audit_configs": [ # "audit_configs": [
# ` # `
# "service": "allServices" # "service": "allServices",
# "audit_log_configs": [ # "audit_log_configs": [
# ` # `
# "log_type": "DATA_READ", # "log_type": "DATA_READ",
@ -43,18 +43,18 @@ module Google
# ] # ]
# `, # `,
# ` # `
# "log_type": "DATA_WRITE", # "log_type": "DATA_WRITE"
# `, # `,
# ` # `
# "log_type": "ADMIN_READ", # "log_type": "ADMIN_READ"
# ` # `
# ] # ]
# `, # `,
# ` # `
# "service": "sampleservice.googleapis.com" # "service": "sampleservice.googleapis.com",
# "audit_log_configs": [ # "audit_log_configs": [
# ` # `
# "log_type": "DATA_READ", # "log_type": "DATA_READ"
# `, # `,
# ` # `
# "log_type": "DATA_WRITE", # "log_type": "DATA_WRITE",
@ -106,7 +106,7 @@ module Google
# ] # ]
# `, # `,
# ` # `
# "log_type": "DATA_WRITE", # "log_type": "DATA_WRITE"
# ` # `
# ] # ]
# ` # `

View File

@ -26,7 +26,7 @@ module Google
# @see https://cloud.google.com/dialogflow/ # @see https://cloud.google.com/dialogflow/
module DialogflowV2 module DialogflowV2
VERSION = 'V2' VERSION = 'V2'
REVISION = '20200615' REVISION = '20200622'
# View and manage your data across Google Cloud Platform services # View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

View File

@ -190,6 +190,13 @@ module Google
# @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess] # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess]
attr_accessor :conversation_success attr_accessor :conversation_success
# Indicates that interaction with the Dialogflow agent has ended.
# This message is generated by Dialogflow only and not supposed to be
# defined by the user.
# Corresponds to the JSON property `endInteraction`
# @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteraction]
attr_accessor :end_interaction
# Indicates that the conversation should be handed off to a human agent. # Indicates that the conversation should be handed off to a human agent.
# Dialogflow only uses this to determine which conversations were handed off # Dialogflow only uses this to determine which conversations were handed off
# to a human agent for measurement purposes. What else to do with this signal # to a human agent for measurement purposes. What else to do with this signal
@ -204,11 +211,41 @@ module Google
# @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff] # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff]
attr_accessor :human_agent_handoff attr_accessor :human_agent_handoff
# Indicates that the conversation should be handed off to a live agent.
# Dialogflow only uses this to determine which conversations were handed off
# to a human agent for measurement purposes. What else to do with this signal
# is up to you and your handoff procedures.
# You may set this, for example:
# * In the entry_fulfillment of a Page if
# entering the page indicates something went extremely wrong in the
# conversation.
# * In a webhook response when you determine that the customer issue can only
# be handled by a human.
# Corresponds to the JSON property `liveAgentHandoff`
# @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoff]
attr_accessor :live_agent_handoff
# Represents an audio message that is composed of both segments
# synthesized from the Dialogflow agent prompts and ones hosted externally
# at the specified URIs.
# The external URIs are specified via
# play_audio.
# This message is generated by Dialogflow only and not supposed to be
# defined by the user.
# Corresponds to the JSON property `mixedAudio`
# @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudio]
attr_accessor :mixed_audio
# Returns a response containing a custom, platform-specific payload. # Returns a response containing a custom, platform-specific payload.
# Corresponds to the JSON property `payload` # Corresponds to the JSON property `payload`
# @return [Hash<String,Object>] # @return [Hash<String,Object>]
attr_accessor :payload attr_accessor :payload
# Specifies an audio clip to be played by the client as part of the response.
# Corresponds to the JSON property `playAudio`
# @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio]
attr_accessor :play_audio
# The text response message. # The text response message.
# Corresponds to the JSON property `text` # Corresponds to the JSON property `text`
# @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageText] # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageText]
@ -221,8 +258,12 @@ module Google
# Update properties of this object # Update properties of this object
def update!(**args) def update!(**args)
@conversation_success = args[:conversation_success] if args.key?(:conversation_success) @conversation_success = args[:conversation_success] if args.key?(:conversation_success)
@end_interaction = args[:end_interaction] if args.key?(:end_interaction)
@human_agent_handoff = args[:human_agent_handoff] if args.key?(:human_agent_handoff) @human_agent_handoff = args[:human_agent_handoff] if args.key?(:human_agent_handoff)
@live_agent_handoff = args[:live_agent_handoff] if args.key?(:live_agent_handoff)
@mixed_audio = args[:mixed_audio] if args.key?(:mixed_audio)
@payload = args[:payload] if args.key?(:payload) @payload = args[:payload] if args.key?(:payload)
@play_audio = args[:play_audio] if args.key?(:play_audio)
@text = args[:text] if args.key?(:text) @text = args[:text] if args.key?(:text)
end end
end end
@ -257,6 +298,21 @@ module Google
end end
end end
# Indicates that interaction with the Dialogflow agent has ended.
# This message is generated by Dialogflow only and not supposed to be
# defined by the user.
class GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteraction
include Google::Apis::Core::Hashable
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
end
end
# Indicates that the conversation should be handed off to a human agent. # Indicates that the conversation should be handed off to a human agent.
# Dialogflow only uses this to determine which conversations were handed off # Dialogflow only uses this to determine which conversations were handed off
# to a human agent for measurement purposes. What else to do with this signal # to a human agent for measurement purposes. What else to do with this signal
@ -286,11 +342,140 @@ module Google
end end
end end
# Indicates that the conversation should be handed off to a live agent.
# Dialogflow only uses this to determine which conversations were handed off
# to a human agent for measurement purposes. What else to do with this signal
# is up to you and your handoff procedures.
# You may set this, for example:
# * In the entry_fulfillment of a Page if
# entering the page indicates something went extremely wrong in the
# conversation.
# * In a webhook response when you determine that the customer issue can only
# be handled by a human.
class GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoff
include Google::Apis::Core::Hashable
# Custom metadata for your handoff procedure. Dialogflow doesn't impose
# any structure on this.
# Corresponds to the JSON property `metadata`
# @return [Hash<String,Object>]
attr_accessor :metadata
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@metadata = args[:metadata] if args.key?(:metadata)
end
end
# Represents an audio message that is composed of both segments
# synthesized from the Dialogflow agent prompts and ones hosted externally
# at the specified URIs.
# The external URIs are specified via
# play_audio.
# This message is generated by Dialogflow only and not supposed to be
# defined by the user.
class GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudio
include Google::Apis::Core::Hashable
# Segments this audio response is composed of.
# Corresponds to the JSON property `segments`
# @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegment>]
attr_accessor :segments
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@segments = args[:segments] if args.key?(:segments)
end
end
# Represents one segment of audio.
class GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegment
include Google::Apis::Core::Hashable
# Whether the playback of this segment can be interrupted by the end
# user's speech and the client should then start the next Dialogflow
# request.
# Corresponds to the JSON property `allowPlaybackInterruption`
# @return [Boolean]
attr_accessor :allow_playback_interruption
alias_method :allow_playback_interruption?, :allow_playback_interruption
# Raw audio synthesized from the Dialogflow agent's response using
# the output config specified in the request.
# Corresponds to the JSON property `audio`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :audio
# Client-specific URI that points to an audio clip accessible to the
# client. Dialogflow does not impose any validation on it.
# Corresponds to the JSON property `uri`
# @return [String]
attr_accessor :uri
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@allow_playback_interruption = args[:allow_playback_interruption] if args.key?(:allow_playback_interruption)
@audio = args[:audio] if args.key?(:audio)
@uri = args[:uri] if args.key?(:uri)
end
end
# Specifies an audio clip to be played by the client as part of the response.
class GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio
include Google::Apis::Core::Hashable
# Whether the playback of this message can be interrupted by the end
# user's speech and the client can then starts the next Dialogflow
# request.
# Corresponds to the JSON property `allowPlaybackInterruption`
# @return [Boolean]
attr_accessor :allow_playback_interruption
alias_method :allow_playback_interruption?, :allow_playback_interruption
# Required. URI of the audio clip. Dialogflow does not impose any validation on
# this
# value. It is specific to the client that reads it.
# Corresponds to the JSON property `audioUri`
# @return [String]
attr_accessor :audio_uri
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@allow_playback_interruption = args[:allow_playback_interruption] if args.key?(:allow_playback_interruption)
@audio_uri = args[:audio_uri] if args.key?(:audio_uri)
end
end
# The text response message. # The text response message.
class GoogleCloudDialogflowCxV3beta1ResponseMessageText class GoogleCloudDialogflowCxV3beta1ResponseMessageText
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# A collection of text responses. # Whether the playback of this message can be interrupted by the end
# user's speech and the client can then starts the next Dialogflow
# request.
# Corresponds to the JSON property `allowPlaybackInterruption`
# @return [Boolean]
attr_accessor :allow_playback_interruption
alias_method :allow_playback_interruption?, :allow_playback_interruption
# Required. A collection of text responses.
# Corresponds to the JSON property `text` # Corresponds to the JSON property `text`
# @return [Array<String>] # @return [Array<String>]
attr_accessor :text attr_accessor :text
@ -301,6 +486,7 @@ module Google
# Update properties of this object # Update properties of this object
def update!(**args) def update!(**args)
@allow_playback_interruption = args[:allow_playback_interruption] if args.key?(:allow_playback_interruption)
@text = args[:text] if args.key?(:text) @text = args[:text] if args.key?(:text)
end end
end end
@ -4721,9 +4907,6 @@ module Google
# Carousel Rich Business Messaging (RBM) rich card. # Carousel Rich Business Messaging (RBM) rich card.
# Rich cards allow you to respond to users with more vivid content, e.g. # Rich cards allow you to respond to users with more vivid content, e.g.
# with media and suggestions. # with media and suggestions.
# For more details about RBM rich cards, please see:
# https://developers.google.com/business-communications/rcs-business-messaging/
# guides/build/messages/send#rich-cards
# If you want to show a single card with more control over the layout, # If you want to show a single card with more control over the layout,
# please use RbmStandaloneCard instead. # please use RbmStandaloneCard instead.
# Corresponds to the JSON property `rbmCarouselRichCard` # Corresponds to the JSON property `rbmCarouselRichCard`
@ -4733,9 +4916,6 @@ module Google
# Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card.
# Rich cards allow you to respond to users with more vivid content, e.g. # Rich cards allow you to respond to users with more vivid content, e.g.
# with media and suggestions. # with media and suggestions.
# For more details about RBM rich cards, please see:
# https://developers.google.com/business-communications/rcs-business-messaging/
# guides/build/messages/send#rich-cards
# You can group multiple rich cards into one using RbmCarouselCard but # You can group multiple rich cards into one using RbmCarouselCard but
# carousel cards will give you less control over the card layout. # carousel cards will give you less control over the card layout.
# Corresponds to the JSON property `rbmStandaloneRichCard` # Corresponds to the JSON property `rbmStandaloneRichCard`
@ -5443,7 +5623,7 @@ module Google
attr_accessor :file_uri attr_accessor :file_uri
# Required for cards with vertical orientation. The height of the media # Required for cards with vertical orientation. The height of the media
# within a rich card with a vertical layout. (https://goo.gl/NeFCjz). # within a rich card with a vertical layout.
# For a standalone card with horizontal layout, height is not # For a standalone card with horizontal layout, height is not
# customizable, and this field is ignored. # customizable, and this field is ignored.
# Corresponds to the JSON property `height` # Corresponds to the JSON property `height`
@ -5474,9 +5654,6 @@ module Google
# Carousel Rich Business Messaging (RBM) rich card. # Carousel Rich Business Messaging (RBM) rich card.
# Rich cards allow you to respond to users with more vivid content, e.g. # Rich cards allow you to respond to users with more vivid content, e.g.
# with media and suggestions. # with media and suggestions.
# For more details about RBM rich cards, please see:
# https://developers.google.com/business-communications/rcs-business-messaging/
# guides/build/messages/send#rich-cards
# If you want to show a single card with more control over the layout, # If you want to show a single card with more control over the layout,
# please use RbmStandaloneCard instead. # please use RbmStandaloneCard instead.
class GoogleCloudDialogflowV2beta1IntentMessageRbmCarouselCard class GoogleCloudDialogflowV2beta1IntentMessageRbmCarouselCard
@ -5507,9 +5684,6 @@ module Google
# Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card.
# Rich cards allow you to respond to users with more vivid content, e.g. # Rich cards allow you to respond to users with more vivid content, e.g.
# with media and suggestions. # with media and suggestions.
# For more details about RBM rich cards, please see:
# https://developers.google.com/business-communications/rcs-business-messaging/
# guides/build/messages/send#rich-cards
# You can group multiple rich cards into one using RbmCarouselCard but # You can group multiple rich cards into one using RbmCarouselCard but
# carousel cards will give you less control over the card layout. # carousel cards will give you less control over the card layout.
class GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCard class GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCard
@ -5549,13 +5723,13 @@ module Google
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# Opens the user's default dialer app with the specified phone number # Opens the user's default dialer app with the specified phone number
# but does not dial automatically (https://goo.gl/ergbB2). # but does not dial automatically.
# Corresponds to the JSON property `dial` # Corresponds to the JSON property `dial`
# @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionDial] # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionDial]
attr_accessor :dial attr_accessor :dial
# Opens the user's default web browser app to the specified uri # Opens the user's default web browser app to the specified uri
# (https://goo.gl/6GLJD2). If the user has an app installed that is # If the user has an app installed that is
# registered as the default handler for the URL, then this app will be # registered as the default handler for the URL, then this app will be
# opened instead, and its icon will be used in the suggested action UI. # opened instead, and its icon will be used in the suggested action UI.
# Corresponds to the JSON property `openUrl` # Corresponds to the JSON property `openUrl`
@ -5570,7 +5744,7 @@ module Google
attr_accessor :postback_data attr_accessor :postback_data
# Opens the device's location chooser so the user can pick a location # Opens the device's location chooser so the user can pick a location
# to send back to the agent (https://goo.gl/GXotJW). # to send back to the agent.
# Corresponds to the JSON property `shareLocation` # Corresponds to the JSON property `shareLocation`
# @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionShareLocation] # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionShareLocation]
attr_accessor :share_location attr_accessor :share_location
@ -5595,7 +5769,7 @@ module Google
end end
# Opens the user's default dialer app with the specified phone number # Opens the user's default dialer app with the specified phone number
# but does not dial automatically (https://goo.gl/ergbB2). # but does not dial automatically.
class GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionDial class GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionDial
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
@ -5618,7 +5792,7 @@ module Google
end end
# Opens the user's default web browser app to the specified uri # Opens the user's default web browser app to the specified uri
# (https://goo.gl/6GLJD2). If the user has an app installed that is # If the user has an app installed that is
# registered as the default handler for the URL, then this app will be # registered as the default handler for the URL, then this app will be
# opened instead, and its icon will be used in the suggested action UI. # opened instead, and its icon will be used in the suggested action UI.
class GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionOpenUri class GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionOpenUri
@ -5640,7 +5814,7 @@ module Google
end end
# Opens the device's location chooser so the user can pick a location # Opens the device's location chooser so the user can pick a location
# to send back to the agent (https://goo.gl/GXotJW). # to send back to the agent.
class GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionShareLocation class GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionShareLocation
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable

View File

@ -58,12 +58,42 @@ module Google
include Google::Apis::Core::JsonObjectSupport include Google::Apis::Core::JsonObjectSupport
end end
class GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteraction
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff class GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff
class Representation < Google::Apis::Core::JsonRepresentation; end class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport include Google::Apis::Core::JsonObjectSupport
end end
class GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoff
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudio
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegment
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3beta1ResponseMessageText class GoogleCloudDialogflowCxV3beta1ResponseMessageText
class Representation < Google::Apis::Core::JsonRepresentation; end class Representation < Google::Apis::Core::JsonRepresentation; end
@ -1113,9 +1143,17 @@ module Google
class Representation < Google::Apis::Core::JsonRepresentation class Representation < Google::Apis::Core::JsonRepresentation
property :conversation_success, as: 'conversationSuccess', class: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess, decorator: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess::Representation property :conversation_success, as: 'conversationSuccess', class: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess, decorator: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess::Representation
property :end_interaction, as: 'endInteraction', class: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteraction, decorator: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteraction::Representation
property :human_agent_handoff, as: 'humanAgentHandoff', class: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff, decorator: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff::Representation property :human_agent_handoff, as: 'humanAgentHandoff', class: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff, decorator: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff::Representation
property :live_agent_handoff, as: 'liveAgentHandoff', class: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoff, decorator: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoff::Representation
property :mixed_audio, as: 'mixedAudio', class: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudio, decorator: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudio::Representation
hash :payload, as: 'payload' hash :payload, as: 'payload'
property :play_audio, as: 'playAudio', class: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio, decorator: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio::Representation
property :text, as: 'text', class: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageText, decorator: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageText::Representation property :text, as: 'text', class: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageText, decorator: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageText::Representation
end end
@ -1128,6 +1166,12 @@ module Google
end end
end end
class GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteraction
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff class GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff
# @private # @private
class Representation < Google::Apis::Core::JsonRepresentation class Representation < Google::Apis::Core::JsonRepresentation
@ -1135,9 +1179,42 @@ module Google
end end
end end
class GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoff
# @private
class Representation < Google::Apis::Core::JsonRepresentation
hash :metadata, as: 'metadata'
end
end
class GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudio
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :segments, as: 'segments', class: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegment, decorator: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegment::Representation
end
end
class GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegment
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :allow_playback_interruption, as: 'allowPlaybackInterruption'
property :audio, :base64 => true, as: 'audio'
property :uri, as: 'uri'
end
end
class GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :allow_playback_interruption, as: 'allowPlaybackInterruption'
property :audio_uri, as: 'audioUri'
end
end
class GoogleCloudDialogflowCxV3beta1ResponseMessageText class GoogleCloudDialogflowCxV3beta1ResponseMessageText
# @private # @private
class Representation < Google::Apis::Core::JsonRepresentation class Representation < Google::Apis::Core::JsonRepresentation
property :allow_playback_interruption, as: 'allowPlaybackInterruption'
collection :text, as: 'text' collection :text, as: 'text'
end end
end end

View File

@ -26,7 +26,7 @@ module Google
# @see https://cloud.google.com/dialogflow/ # @see https://cloud.google.com/dialogflow/
module DialogflowV2beta1 module DialogflowV2beta1
VERSION = 'V2beta1' VERSION = 'V2beta1'
REVISION = '20200615' REVISION = '20200622'
# View and manage your data across Google Cloud Platform services # View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

View File

@ -190,6 +190,13 @@ module Google
# @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess] # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess]
attr_accessor :conversation_success attr_accessor :conversation_success
# Indicates that interaction with the Dialogflow agent has ended.
# This message is generated by Dialogflow only and not supposed to be
# defined by the user.
# Corresponds to the JSON property `endInteraction`
# @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteraction]
attr_accessor :end_interaction
# Indicates that the conversation should be handed off to a human agent. # Indicates that the conversation should be handed off to a human agent.
# Dialogflow only uses this to determine which conversations were handed off # Dialogflow only uses this to determine which conversations were handed off
# to a human agent for measurement purposes. What else to do with this signal # to a human agent for measurement purposes. What else to do with this signal
@ -204,11 +211,41 @@ module Google
# @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff] # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff]
attr_accessor :human_agent_handoff attr_accessor :human_agent_handoff
# Indicates that the conversation should be handed off to a live agent.
# Dialogflow only uses this to determine which conversations were handed off
# to a human agent for measurement purposes. What else to do with this signal
# is up to you and your handoff procedures.
# You may set this, for example:
# * In the entry_fulfillment of a Page if
# entering the page indicates something went extremely wrong in the
# conversation.
# * In a webhook response when you determine that the customer issue can only
# be handled by a human.
# Corresponds to the JSON property `liveAgentHandoff`
# @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoff]
attr_accessor :live_agent_handoff
# Represents an audio message that is composed of both segments
# synthesized from the Dialogflow agent prompts and ones hosted externally
# at the specified URIs.
# The external URIs are specified via
# play_audio.
# This message is generated by Dialogflow only and not supposed to be
# defined by the user.
# Corresponds to the JSON property `mixedAudio`
# @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudio]
attr_accessor :mixed_audio
# Returns a response containing a custom, platform-specific payload. # Returns a response containing a custom, platform-specific payload.
# Corresponds to the JSON property `payload` # Corresponds to the JSON property `payload`
# @return [Hash<String,Object>] # @return [Hash<String,Object>]
attr_accessor :payload attr_accessor :payload
# Specifies an audio clip to be played by the client as part of the response.
# Corresponds to the JSON property `playAudio`
# @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio]
attr_accessor :play_audio
# The text response message. # The text response message.
# Corresponds to the JSON property `text` # Corresponds to the JSON property `text`
# @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageText] # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageText]
@ -221,8 +258,12 @@ module Google
# Update properties of this object # Update properties of this object
def update!(**args) def update!(**args)
@conversation_success = args[:conversation_success] if args.key?(:conversation_success) @conversation_success = args[:conversation_success] if args.key?(:conversation_success)
@end_interaction = args[:end_interaction] if args.key?(:end_interaction)
@human_agent_handoff = args[:human_agent_handoff] if args.key?(:human_agent_handoff) @human_agent_handoff = args[:human_agent_handoff] if args.key?(:human_agent_handoff)
@live_agent_handoff = args[:live_agent_handoff] if args.key?(:live_agent_handoff)
@mixed_audio = args[:mixed_audio] if args.key?(:mixed_audio)
@payload = args[:payload] if args.key?(:payload) @payload = args[:payload] if args.key?(:payload)
@play_audio = args[:play_audio] if args.key?(:play_audio)
@text = args[:text] if args.key?(:text) @text = args[:text] if args.key?(:text)
end end
end end
@ -257,6 +298,21 @@ module Google
end end
end end
# Indicates that interaction with the Dialogflow agent has ended.
# This message is generated by Dialogflow only and not supposed to be
# defined by the user.
class GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteraction
include Google::Apis::Core::Hashable
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
end
end
# Indicates that the conversation should be handed off to a human agent. # Indicates that the conversation should be handed off to a human agent.
# Dialogflow only uses this to determine which conversations were handed off # Dialogflow only uses this to determine which conversations were handed off
# to a human agent for measurement purposes. What else to do with this signal # to a human agent for measurement purposes. What else to do with this signal
@ -286,11 +342,140 @@ module Google
end end
end end
# Indicates that the conversation should be handed off to a live agent.
# Dialogflow only uses this to determine which conversations were handed off
# to a human agent for measurement purposes. What else to do with this signal
# is up to you and your handoff procedures.
# You may set this, for example:
# * In the entry_fulfillment of a Page if
# entering the page indicates something went extremely wrong in the
# conversation.
# * In a webhook response when you determine that the customer issue can only
# be handled by a human.
class GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoff
include Google::Apis::Core::Hashable
# Custom metadata for your handoff procedure. Dialogflow doesn't impose
# any structure on this.
# Corresponds to the JSON property `metadata`
# @return [Hash<String,Object>]
attr_accessor :metadata
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@metadata = args[:metadata] if args.key?(:metadata)
end
end
# Represents an audio message that is composed of both segments
# synthesized from the Dialogflow agent prompts and ones hosted externally
# at the specified URIs.
# The external URIs are specified via
# play_audio.
# This message is generated by Dialogflow only and not supposed to be
# defined by the user.
class GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudio
include Google::Apis::Core::Hashable
# Segments this audio response is composed of.
# Corresponds to the JSON property `segments`
# @return [Array<Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegment>]
attr_accessor :segments
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@segments = args[:segments] if args.key?(:segments)
end
end
# Represents one segment of audio.
class GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegment
include Google::Apis::Core::Hashable
# Whether the playback of this segment can be interrupted by the end
# user's speech and the client should then start the next Dialogflow
# request.
# Corresponds to the JSON property `allowPlaybackInterruption`
# @return [Boolean]
attr_accessor :allow_playback_interruption
alias_method :allow_playback_interruption?, :allow_playback_interruption
# Raw audio synthesized from the Dialogflow agent's response using
# the output config specified in the request.
# Corresponds to the JSON property `audio`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :audio
# Client-specific URI that points to an audio clip accessible to the
# client. Dialogflow does not impose any validation on it.
# Corresponds to the JSON property `uri`
# @return [String]
attr_accessor :uri
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@allow_playback_interruption = args[:allow_playback_interruption] if args.key?(:allow_playback_interruption)
@audio = args[:audio] if args.key?(:audio)
@uri = args[:uri] if args.key?(:uri)
end
end
# Specifies an audio clip to be played by the client as part of the response.
class GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio
include Google::Apis::Core::Hashable
# Whether the playback of this message can be interrupted by the end
# user's speech and the client can then starts the next Dialogflow
# request.
# Corresponds to the JSON property `allowPlaybackInterruption`
# @return [Boolean]
attr_accessor :allow_playback_interruption
alias_method :allow_playback_interruption?, :allow_playback_interruption
# Required. URI of the audio clip. Dialogflow does not impose any validation on
# this
# value. It is specific to the client that reads it.
# Corresponds to the JSON property `audioUri`
# @return [String]
attr_accessor :audio_uri
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@allow_playback_interruption = args[:allow_playback_interruption] if args.key?(:allow_playback_interruption)
@audio_uri = args[:audio_uri] if args.key?(:audio_uri)
end
end
# The text response message. # The text response message.
class GoogleCloudDialogflowCxV3beta1ResponseMessageText class GoogleCloudDialogflowCxV3beta1ResponseMessageText
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# A collection of text responses. # Whether the playback of this message can be interrupted by the end
# user's speech and the client can then starts the next Dialogflow
# request.
# Corresponds to the JSON property `allowPlaybackInterruption`
# @return [Boolean]
attr_accessor :allow_playback_interruption
alias_method :allow_playback_interruption?, :allow_playback_interruption
# Required. A collection of text responses.
# Corresponds to the JSON property `text` # Corresponds to the JSON property `text`
# @return [Array<String>] # @return [Array<String>]
attr_accessor :text attr_accessor :text
@ -301,6 +486,7 @@ module Google
# Update properties of this object # Update properties of this object
def update!(**args) def update!(**args)
@allow_playback_interruption = args[:allow_playback_interruption] if args.key?(:allow_playback_interruption)
@text = args[:text] if args.key?(:text) @text = args[:text] if args.key?(:text)
end end
end end
@ -4287,9 +4473,6 @@ module Google
# Carousel Rich Business Messaging (RBM) rich card. # Carousel Rich Business Messaging (RBM) rich card.
# Rich cards allow you to respond to users with more vivid content, e.g. # Rich cards allow you to respond to users with more vivid content, e.g.
# with media and suggestions. # with media and suggestions.
# For more details about RBM rich cards, please see:
# https://developers.google.com/business-communications/rcs-business-messaging/
# guides/build/messages/send#rich-cards
# If you want to show a single card with more control over the layout, # If you want to show a single card with more control over the layout,
# please use RbmStandaloneCard instead. # please use RbmStandaloneCard instead.
# Corresponds to the JSON property `rbmCarouselRichCard` # Corresponds to the JSON property `rbmCarouselRichCard`
@ -4299,9 +4482,6 @@ module Google
# Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card.
# Rich cards allow you to respond to users with more vivid content, e.g. # Rich cards allow you to respond to users with more vivid content, e.g.
# with media and suggestions. # with media and suggestions.
# For more details about RBM rich cards, please see:
# https://developers.google.com/business-communications/rcs-business-messaging/
# guides/build/messages/send#rich-cards
# You can group multiple rich cards into one using RbmCarouselCard but # You can group multiple rich cards into one using RbmCarouselCard but
# carousel cards will give you less control over the card layout. # carousel cards will give you less control over the card layout.
# Corresponds to the JSON property `rbmStandaloneRichCard` # Corresponds to the JSON property `rbmStandaloneRichCard`
@ -5009,7 +5189,7 @@ module Google
attr_accessor :file_uri attr_accessor :file_uri
# Required for cards with vertical orientation. The height of the media # Required for cards with vertical orientation. The height of the media
# within a rich card with a vertical layout. (https://goo.gl/NeFCjz). # within a rich card with a vertical layout.
# For a standalone card with horizontal layout, height is not # For a standalone card with horizontal layout, height is not
# customizable, and this field is ignored. # customizable, and this field is ignored.
# Corresponds to the JSON property `height` # Corresponds to the JSON property `height`
@ -5040,9 +5220,6 @@ module Google
# Carousel Rich Business Messaging (RBM) rich card. # Carousel Rich Business Messaging (RBM) rich card.
# Rich cards allow you to respond to users with more vivid content, e.g. # Rich cards allow you to respond to users with more vivid content, e.g.
# with media and suggestions. # with media and suggestions.
# For more details about RBM rich cards, please see:
# https://developers.google.com/business-communications/rcs-business-messaging/
# guides/build/messages/send#rich-cards
# If you want to show a single card with more control over the layout, # If you want to show a single card with more control over the layout,
# please use RbmStandaloneCard instead. # please use RbmStandaloneCard instead.
class GoogleCloudDialogflowV2beta1IntentMessageRbmCarouselCard class GoogleCloudDialogflowV2beta1IntentMessageRbmCarouselCard
@ -5073,9 +5250,6 @@ module Google
# Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card.
# Rich cards allow you to respond to users with more vivid content, e.g. # Rich cards allow you to respond to users with more vivid content, e.g.
# with media and suggestions. # with media and suggestions.
# For more details about RBM rich cards, please see:
# https://developers.google.com/business-communications/rcs-business-messaging/
# guides/build/messages/send#rich-cards
# You can group multiple rich cards into one using RbmCarouselCard but # You can group multiple rich cards into one using RbmCarouselCard but
# carousel cards will give you less control over the card layout. # carousel cards will give you less control over the card layout.
class GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCard class GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCard
@ -5115,13 +5289,13 @@ module Google
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# Opens the user's default dialer app with the specified phone number # Opens the user's default dialer app with the specified phone number
# but does not dial automatically (https://goo.gl/ergbB2). # but does not dial automatically.
# Corresponds to the JSON property `dial` # Corresponds to the JSON property `dial`
# @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionDial] # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionDial]
attr_accessor :dial attr_accessor :dial
# Opens the user's default web browser app to the specified uri # Opens the user's default web browser app to the specified uri
# (https://goo.gl/6GLJD2). If the user has an app installed that is # If the user has an app installed that is
# registered as the default handler for the URL, then this app will be # registered as the default handler for the URL, then this app will be
# opened instead, and its icon will be used in the suggested action UI. # opened instead, and its icon will be used in the suggested action UI.
# Corresponds to the JSON property `openUrl` # Corresponds to the JSON property `openUrl`
@ -5136,7 +5310,7 @@ module Google
attr_accessor :postback_data attr_accessor :postback_data
# Opens the device's location chooser so the user can pick a location # Opens the device's location chooser so the user can pick a location
# to send back to the agent (https://goo.gl/GXotJW). # to send back to the agent.
# Corresponds to the JSON property `shareLocation` # Corresponds to the JSON property `shareLocation`
# @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionShareLocation] # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionShareLocation]
attr_accessor :share_location attr_accessor :share_location
@ -5161,7 +5335,7 @@ module Google
end end
# Opens the user's default dialer app with the specified phone number # Opens the user's default dialer app with the specified phone number
# but does not dial automatically (https://goo.gl/ergbB2). # but does not dial automatically.
class GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionDial class GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionDial
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
@ -5184,7 +5358,7 @@ module Google
end end
# Opens the user's default web browser app to the specified uri # Opens the user's default web browser app to the specified uri
# (https://goo.gl/6GLJD2). If the user has an app installed that is # If the user has an app installed that is
# registered as the default handler for the URL, then this app will be # registered as the default handler for the URL, then this app will be
# opened instead, and its icon will be used in the suggested action UI. # opened instead, and its icon will be used in the suggested action UI.
class GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionOpenUri class GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionOpenUri
@ -5206,7 +5380,7 @@ module Google
end end
# Opens the device's location chooser so the user can pick a location # Opens the device's location chooser so the user can pick a location
# to send back to the agent (https://goo.gl/GXotJW). # to send back to the agent.
class GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionShareLocation class GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionShareLocation
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable

View File

@ -58,12 +58,42 @@ module Google
include Google::Apis::Core::JsonObjectSupport include Google::Apis::Core::JsonObjectSupport
end end
class GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteraction
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff class GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff
class Representation < Google::Apis::Core::JsonRepresentation; end class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport include Google::Apis::Core::JsonObjectSupport
end end
class GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoff
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudio
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegment
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3beta1ResponseMessageText class GoogleCloudDialogflowCxV3beta1ResponseMessageText
class Representation < Google::Apis::Core::JsonRepresentation; end class Representation < Google::Apis::Core::JsonRepresentation; end
@ -1161,9 +1191,17 @@ module Google
class Representation < Google::Apis::Core::JsonRepresentation class Representation < Google::Apis::Core::JsonRepresentation
property :conversation_success, as: 'conversationSuccess', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess::Representation property :conversation_success, as: 'conversationSuccess', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess::Representation
property :end_interaction, as: 'endInteraction', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteraction, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteraction::Representation
property :human_agent_handoff, as: 'humanAgentHandoff', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff::Representation property :human_agent_handoff, as: 'humanAgentHandoff', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff::Representation
property :live_agent_handoff, as: 'liveAgentHandoff', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoff, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoff::Representation
property :mixed_audio, as: 'mixedAudio', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudio, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudio::Representation
hash :payload, as: 'payload' hash :payload, as: 'payload'
property :play_audio, as: 'playAudio', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio::Representation
property :text, as: 'text', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageText, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageText::Representation property :text, as: 'text', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageText, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageText::Representation
end end
@ -1176,6 +1214,12 @@ module Google
end end
end end
class GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteraction
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff class GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff
# @private # @private
class Representation < Google::Apis::Core::JsonRepresentation class Representation < Google::Apis::Core::JsonRepresentation
@ -1183,9 +1227,42 @@ module Google
end end
end end
class GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoff
# @private
class Representation < Google::Apis::Core::JsonRepresentation
hash :metadata, as: 'metadata'
end
end
class GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudio
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :segments, as: 'segments', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegment, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegment::Representation
end
end
class GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegment
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :allow_playback_interruption, as: 'allowPlaybackInterruption'
property :audio, :base64 => true, as: 'audio'
property :uri, as: 'uri'
end
end
class GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :allow_playback_interruption, as: 'allowPlaybackInterruption'
property :audio_uri, as: 'audioUri'
end
end
class GoogleCloudDialogflowCxV3beta1ResponseMessageText class GoogleCloudDialogflowCxV3beta1ResponseMessageText
# @private # @private
class Representation < Google::Apis::Core::JsonRepresentation class Representation < Google::Apis::Core::JsonRepresentation
property :allow_playback_interruption, as: 'allowPlaybackInterruption'
collection :text, as: 'text' collection :text, as: 'text'
end end
end end

View File

@ -26,7 +26,7 @@ module Google
# @see https://developers.google.com/display-video/ # @see https://developers.google.com/display-video/
module DisplayvideoV1 module DisplayvideoV1
VERSION = 'V1' VERSION = 'V1'
REVISION = '20200611' REVISION = '20200623'
# Create, see, edit, and permanently delete your Display & Video 360 entities and reports # Create, see, edit, and permanently delete your Display & Video 360 entities and reports
AUTH_DISPLAY_VIDEO = 'https://www.googleapis.com/auth/display-video' AUTH_DISPLAY_VIDEO = 'https://www.googleapis.com/auth/display-video'

View File

@ -704,8 +704,7 @@ module Google
end end
# A single assigned targeting option, which defines the state of a targeting # A single assigned targeting option, which defines the state of a targeting
# option for an entity with targeting settings, such as a Line Item or # option for an entity with targeting settings.
# Insertion Order.
class AssignedTargetingOption class AssignedTargetingOption
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
@ -3810,6 +3809,71 @@ module Google
class FirstAndThirdPartyAudience class FirstAndThirdPartyAudience
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# Output only. The estimated audience size for the Display network in the past
# month.
# If the size is less than 1000, the number will be hidden and 0 will be
# returned due to privacy reasons. Otherwise, the number will be rounded off
# to two significant digits.
# Only returned in GET request.
# Corresponds to the JSON property `activeDisplayAudienceSize`
# @return [Fixnum]
attr_accessor :active_display_audience_size
# Output only. The source of the audience.
# Corresponds to the JSON property `audienceSource`
# @return [String]
attr_accessor :audience_source
# Output only. The type of the audience.
# Corresponds to the JSON property `audienceType`
# @return [String]
attr_accessor :audience_type
# Output only. The description of the first and third party audience.
# Only applicable to first party audiences.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# Output only. The estimated audience size for the Display network.
# If the size is less than 1000, the number will be hidden and 0 will be
# returned due to privacy reasons. Otherwise, the number will be rounded off
# to two significant digits.
# Only returned in GET request.
# Corresponds to the JSON property `displayAudienceSize`
# @return [Fixnum]
attr_accessor :display_audience_size
# Output only. The estimated desktop audience size in Display network.
# If the size is less than 1000, the number will be hidden and 0 will be
# returned due to privacy reasons. Otherwise, the number will be rounded off
# to two significant digits.
# Only applicable to first party audiences.
# Only returned in GET request.
# Corresponds to the JSON property `displayDesktopAudienceSize`
# @return [Fixnum]
attr_accessor :display_desktop_audience_size
# Output only. The estimated mobile app audience size in Display network.
# If the size is less than 1000, the number will be hidden and 0 will be
# returned due to privacy reasons. Otherwise, the number will be rounded off
# to two significant digits.
# Only applicable to first party audiences.
# Only returned in GET request.
# Corresponds to the JSON property `displayMobileAppAudienceSize`
# @return [Fixnum]
attr_accessor :display_mobile_app_audience_size
# Output only. The estimated mobile web audience size in Display network.
# If the size is less than 1000, the number will be hidden and 0 will be
# returned due to privacy reasons. Otherwise, the number will be rounded off
# to two significant digits.
# Only applicable to first party audiences.
# Only returned in GET request.
# Corresponds to the JSON property `displayMobileWebAudienceSize`
# @return [Fixnum]
attr_accessor :display_mobile_web_audience_size
# Output only. The display name of the first and third party audience. # Output only. The display name of the first and third party audience.
# . # .
# Corresponds to the JSON property `displayName` # Corresponds to the JSON property `displayName`
@ -3829,21 +3893,60 @@ module Google
# @return [String] # @return [String]
attr_accessor :first_and_third_party_audience_type attr_accessor :first_and_third_party_audience_type
# Output only. The estimated audience size for Gmail network.
# If the size is less than 1000, the number will be hidden and 0 will be
# returned due to privacy reasons. Otherwise, the number will be rounded off
# to two significant digits.
# Only applicable to first party audiences.
# Only returned in GET request.
# Corresponds to the JSON property `gmailAudienceSize`
# @return [Fixnum]
attr_accessor :gmail_audience_size
# Output only. The duration in days that an entry remains in the audience after
# the
# qualifying event.
# Only applicable to first party audiences.
# Corresponds to the JSON property `membershipDurationDays`
# @return [Fixnum]
attr_accessor :membership_duration_days
# Output only. The resource name of the first and third party audience. # Output only. The resource name of the first and third party audience.
# Corresponds to the JSON property `name` # Corresponds to the JSON property `name`
# @return [String] # @return [String]
attr_accessor :name attr_accessor :name
# Output only. The estimated audience size for YouTube network.
# If the size is less than 1000, the number will be hidden and 0 will be
# returned due to privacy reasons. Otherwise, the number will be rounded off
# to two significant digits.
# Only applicable to first party audiences.
# Only returned in GET request.
# Corresponds to the JSON property `youtubeAudienceSize`
# @return [Fixnum]
attr_accessor :youtube_audience_size
def initialize(**args) def initialize(**args)
update!(**args) update!(**args)
end end
# Update properties of this object # Update properties of this object
def update!(**args) def update!(**args)
@active_display_audience_size = args[:active_display_audience_size] if args.key?(:active_display_audience_size)
@audience_source = args[:audience_source] if args.key?(:audience_source)
@audience_type = args[:audience_type] if args.key?(:audience_type)
@description = args[:description] if args.key?(:description)
@display_audience_size = args[:display_audience_size] if args.key?(:display_audience_size)
@display_desktop_audience_size = args[:display_desktop_audience_size] if args.key?(:display_desktop_audience_size)
@display_mobile_app_audience_size = args[:display_mobile_app_audience_size] if args.key?(:display_mobile_app_audience_size)
@display_mobile_web_audience_size = args[:display_mobile_web_audience_size] if args.key?(:display_mobile_web_audience_size)
@display_name = args[:display_name] if args.key?(:display_name) @display_name = args[:display_name] if args.key?(:display_name)
@first_and_third_party_audience_id = args[:first_and_third_party_audience_id] if args.key?(:first_and_third_party_audience_id) @first_and_third_party_audience_id = args[:first_and_third_party_audience_id] if args.key?(:first_and_third_party_audience_id)
@first_and_third_party_audience_type = args[:first_and_third_party_audience_type] if args.key?(:first_and_third_party_audience_type) @first_and_third_party_audience_type = args[:first_and_third_party_audience_type] if args.key?(:first_and_third_party_audience_type)
@gmail_audience_size = args[:gmail_audience_size] if args.key?(:gmail_audience_size)
@membership_duration_days = args[:membership_duration_days] if args.key?(:membership_duration_days)
@name = args[:name] if args.key?(:name) @name = args[:name] if args.key?(:name)
@youtube_audience_size = args[:youtube_audience_size] if args.key?(:youtube_audience_size)
end end
end end

View File

@ -2202,10 +2202,21 @@ module Google
class FirstAndThirdPartyAudience class FirstAndThirdPartyAudience
# @private # @private
class Representation < Google::Apis::Core::JsonRepresentation class Representation < Google::Apis::Core::JsonRepresentation
property :active_display_audience_size, :numeric_string => true, as: 'activeDisplayAudienceSize'
property :audience_source, as: 'audienceSource'
property :audience_type, as: 'audienceType'
property :description, as: 'description'
property :display_audience_size, :numeric_string => true, as: 'displayAudienceSize'
property :display_desktop_audience_size, :numeric_string => true, as: 'displayDesktopAudienceSize'
property :display_mobile_app_audience_size, :numeric_string => true, as: 'displayMobileAppAudienceSize'
property :display_mobile_web_audience_size, :numeric_string => true, as: 'displayMobileWebAudienceSize'
property :display_name, as: 'displayName' property :display_name, as: 'displayName'
property :first_and_third_party_audience_id, :numeric_string => true, as: 'firstAndThirdPartyAudienceId' property :first_and_third_party_audience_id, :numeric_string => true, as: 'firstAndThirdPartyAudienceId'
property :first_and_third_party_audience_type, as: 'firstAndThirdPartyAudienceType' property :first_and_third_party_audience_type, as: 'firstAndThirdPartyAudienceType'
property :gmail_audience_size, :numeric_string => true, as: 'gmailAudienceSize'
property :membership_duration_days, :numeric_string => true, as: 'membershipDurationDays'
property :name, as: 'name' property :name, as: 'name'
property :youtube_audience_size, :numeric_string => true, as: 'youtubeAudienceSize'
end end
end end

View File

@ -615,6 +615,42 @@ module Google
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
# Creates a new channel. Returns the newly created channel if successful.
# @param [Fixnum] advertiser_id
# The ID of the advertiser that owns the created channel.
# @param [Google::Apis::DisplayvideoV1::Channel] channel_object
# @param [Fixnum] partner_id
# The ID of the partner that owns the created channel.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DisplayvideoV1::Channel] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DisplayvideoV1::Channel]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_advertiser_channel(advertiser_id, channel_object = nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/advertisers/{+advertiserId}/channels', options)
command.request_representation = Google::Apis::DisplayvideoV1::Channel::Representation
command.request_object = channel_object
command.response_representation = Google::Apis::DisplayvideoV1::Channel::Representation
command.response_class = Google::Apis::DisplayvideoV1::Channel
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
command.query['partnerId'] = partner_id unless partner_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates an existing inventory source. # Updates an existing inventory source.
# Returns the updated inventory source if successful. # Returns the updated inventory source if successful.
# Gets a channel for a partner or advertiser. # Gets a channel for a partner or advertiser.
@ -1079,6 +1115,7 @@ module Google
# - `approvalStatus` # - `approvalStatus`
# - `exchangeReviewStatus` # - `exchangeReviewStatus`
# - `dynamic` # - `dynamic`
# - `creativeId`
# * The operator must be `HAS (:)` for the following fields: # * The operator must be `HAS (:)` for the following fields:
# - `lineItemIds` # - `lineItemIds`
# * For `entityStatus`, `minDuration`, `maxDuration`, and `dynamic` there may # * For `entityStatus`, `minDuration`, `maxDuration`, and `dynamic` there may
@ -1090,6 +1127,8 @@ module Google
# `"`duration`s"`. Only seconds are supported with millisecond granularity. # `"`duration`s"`. Only seconds are supported with millisecond granularity.
# * There may be multiple `lineItemIds` restrictions in order to search # * There may be multiple `lineItemIds` restrictions in order to search
# against multiple possible line item IDs. # against multiple possible line item IDs.
# * There may be multiple `creativeId` restrictions in order to search
# against multiple possible creative IDs.
# Examples: # Examples:
# * All native creatives: `creativeType="CREATIVE_TYPE_NATIVE"` # * All native creatives: `creativeType="CREATIVE_TYPE_NATIVE"`
# * All active creatives with 300x400 or 50x100 dimensions: # * All active creatives with 300x400 or 50x100 dimensions:
@ -1101,7 +1140,9 @@ module Google
# (exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED" # (exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED"
# OR exchangeReviewStatus="EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED")` # OR exchangeReviewStatus="EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED")`
# * All video creatives that are associated with line item ID 1 or 2: # * All video creatives that are associated with line item ID 1 or 2:
# creativeType="CREATIVE_TYPE_VIDEO" AND (lineItemIds:1 OR lineItemIds:2) # `creativeType="CREATIVE_TYPE_VIDEO" AND (lineItemIds:1 OR lineItemIds:2)`
# * Find creatives by multiple creative IDs:
# `creativeId=1 OR creativeId=2`
# The length of this field should be no more than 500 characters. # The length of this field should be no more than 500 characters.
# @param [String] order_by # @param [String] order_by
# Field by which to sort the list. # Field by which to sort the list.
@ -3951,6 +3992,42 @@ module Google
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
# Creates a new channel. Returns the newly created channel if successful.
# @param [Fixnum] partner_id
# The ID of the partner that owns the created channel.
# @param [Google::Apis::DisplayvideoV1::Channel] channel_object
# @param [Fixnum] advertiser_id
# The ID of the advertiser that owns the created channel.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DisplayvideoV1::Channel] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DisplayvideoV1::Channel]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_partner_channel(partner_id, channel_object = nil, advertiser_id: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/partners/{+partnerId}/channels', options)
command.request_representation = Google::Apis::DisplayvideoV1::Channel::Representation
command.request_object = channel_object
command.response_representation = Google::Apis::DisplayvideoV1::Channel::Representation
command.response_class = Google::Apis::DisplayvideoV1::Channel
command.params['partnerId'] = partner_id unless partner_id.nil?
command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates an existing inventory source. # Updates an existing inventory source.
# Returns the updated inventory source if successful. # Returns the updated inventory source if successful.
# Gets a channel for a partner or advertiser. # Gets a channel for a partner or advertiser.

View File

@ -27,7 +27,7 @@ module Google
# @see https://cloud.google.com/document-ai/docs/ # @see https://cloud.google.com/document-ai/docs/
module DocumentaiV1beta2 module DocumentaiV1beta2
VERSION = 'V1beta2' VERSION = 'V1beta2'
REVISION = '20200612' REVISION = '20200619'
# View and manage your data across Google Cloud Platform services # View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

View File

@ -20,13 +20,13 @@ module Google
module Apis module Apis
# Search Ads 360 API # Search Ads 360 API
# #
# Reports and modifies your advertising data in DoubleClick Search (for example, # The Search Ads 360 API allows developers to automate uploading conversions and
# campaigns, ad groups, keywords, and conversions). # downloading reports from Search Ads 360.
# #
# @see https://developers.google.com/doubleclick-search/ # @see https://developers.google.com/search-ads
module DoubleclicksearchV2 module DoubleclicksearchV2
VERSION = 'V2' VERSION = 'V2'
REVISION = '20200325' REVISION = '20200616'
# View and manage your advertising data in DoubleClick Search # View and manage your advertising data in DoubleClick Search
AUTH_DOUBLECLICKSEARCH = 'https://www.googleapis.com/auth/doubleclicksearch' AUTH_DOUBLECLICKSEARCH = 'https://www.googleapis.com/auth/doubleclicksearch'

View File

@ -54,7 +54,7 @@ module Google
attr_accessor :segmentation_name attr_accessor :segmentation_name
# The segmentation type that this availability is for (its default value is # The segmentation type that this availability is for (its default value is
# FLOODLIGHT). # `FLOODLIGHT`).
# Corresponds to the JSON property `segmentationType` # Corresponds to the JSON property `segmentationType`
# @return [String] # @return [String]
attr_accessor :segmentation_type attr_accessor :segmentation_type
@ -109,9 +109,9 @@ module Google
# @return [Fixnum] # @return [Fixnum]
attr_accessor :campaign_id attr_accessor :campaign_id
# Sales channel for the product. Acceptable values are: # Sales channel for the product. Acceptable values are: <ul>
# - "local": a physical store # <li>"`local`": a physical store</li> <li>"`online`":
# - "online": an online store # an online store</li> </ul>
# Corresponds to the JSON property `channel` # Corresponds to the JSON property `channel`
# @return [String] # @return [String]
attr_accessor :channel attr_accessor :channel
@ -121,12 +121,13 @@ module Google
# @return [String] # @return [String]
attr_accessor :click_id attr_accessor :click_id
# For offline conversions, advertisers provide this ID. Advertisers can specify # For offline conversions, advertisers provide this ID. Advertisers can
# any ID that is meaningful to them. Each conversion in a request must specify a # specify any ID that is meaningful to them. Each conversion in a request
# unique ID, and the combination of ID and timestamp must be unique amongst all # must specify a unique ID, and the combination of ID and timestamp must be
# conversions within the advertiser. # unique amongst all conversions within the advertiser.<br> For online
# For online conversions, DS copies the dsConversionId or floodlightOrderId into # conversions, DS copies the `dsConversionId` or
# this property depending on the advertiser's Floodlight instructions. # `floodlightOrderId` into this property depending on the
# advertiser's Floodlight instructions.
# Corresponds to the JSON property `conversionId` # Corresponds to the JSON property `conversionId`
# @return [String] # @return [String]
attr_accessor :conversion_id attr_accessor :conversion_id
@ -138,7 +139,7 @@ module Google
# The time at which the conversion took place, in epoch millis UTC. # The time at which the conversion took place, in epoch millis UTC.
# Corresponds to the JSON property `conversionTimestamp` # Corresponds to the JSON property `conversionTimestamp`
# @return [Fixnum] # @return [String]
attr_accessor :conversion_timestamp attr_accessor :conversion_timestamp
# Available to advertisers only after contacting DoubleClick Search customer # Available to advertisers only after contacting DoubleClick Search customer
@ -189,14 +190,14 @@ module Google
# @return [String] # @return [String]
attr_accessor :floodlight_order_id attr_accessor :floodlight_order_id
# ID that DS generates and uses to uniquely identify the inventory account that # ID that DS generates and uses to uniquely identify the inventory account
# contains the product. # that contains the product.
# Corresponds to the JSON property `inventoryAccountId` # Corresponds to the JSON property `inventoryAccountId`
# @return [Fixnum] # @return [Fixnum]
attr_accessor :inventory_account_id attr_accessor :inventory_account_id
# The country registered for the Merchant Center feed that contains the product. # The country registered for the Merchant Center feed that contains the
# Use an ISO 3166 code to specify a country. # product. Use an ISO 3166 code to specify a country.
# Corresponds to the JSON property `productCountry` # Corresponds to the JSON property `productCountry`
# @return [String] # @return [String]
attr_accessor :product_country attr_accessor :product_country
@ -211,8 +212,8 @@ module Google
# @return [String] # @return [String]
attr_accessor :product_id attr_accessor :product_id
# The language registered for the Merchant Center feed that contains the product. # The language registered for the Merchant Center feed that contains the
# Use an ISO 639 code to specify a language. # product. Use an ISO 639 code to specify a language.
# Corresponds to the JSON property `productLanguage` # Corresponds to the JSON property `productLanguage`
# @return [String] # @return [String]
attr_accessor :product_language attr_accessor :product_language
@ -222,11 +223,11 @@ module Google
# @return [Fixnum] # @return [Fixnum]
attr_accessor :quantity_millis attr_accessor :quantity_millis
# The revenue amount of this TRANSACTION conversion, in micros (value multiplied # The revenue amount of this `TRANSACTION` conversion, in micros
# by 1000000, no decimal). For example, to specify a revenue value of "10" enter # (value multiplied by 1000000, no decimal). For example, to specify a
# "10000000" (10 million) in your request. # revenue value of "10" enter "10000000" (10 million) in your request.
# Corresponds to the JSON property `revenueMicros` # Corresponds to the JSON property `revenueMicros`
# @return [Fixnum] # @return [String]
attr_accessor :revenue_micros attr_accessor :revenue_micros
# The numeric segmentation identifier (for example, DoubleClick Search # The numeric segmentation identifier (for example, DoubleClick Search
@ -241,28 +242,31 @@ module Google
# @return [String] # @return [String]
attr_accessor :segmentation_name attr_accessor :segmentation_name
# The segmentation type of this conversion (for example, FLOODLIGHT). # The segmentation type of this conversion (for example,
# `FLOODLIGHT`).
# Corresponds to the JSON property `segmentationType` # Corresponds to the JSON property `segmentationType`
# @return [String] # @return [String]
attr_accessor :segmentation_type attr_accessor :segmentation_type
# The state of the conversion, that is, either ACTIVE or REMOVED. Note: state # The state of the conversion, that is, either `ACTIVE` or
# DELETED is deprecated. # `REMOVED`. Note: state DELETED is deprecated.
# Corresponds to the JSON property `state` # Corresponds to the JSON property `state`
# @return [String] # @return [String]
attr_accessor :state attr_accessor :state
# The ID of the local store for which the product was advertised. Applicable # The ID of the local store for which the product was advertised. Applicable
# only when the channel is "local". # only when the channel is "`local`".
# Corresponds to the JSON property `storeId` # Corresponds to the JSON property `storeId`
# @return [String] # @return [String]
attr_accessor :store_id attr_accessor :store_id
# The type of the conversion, that is, either ACTION or TRANSACTION. An ACTION # The type of the conversion, that is, either `ACTION` or
# conversion is an action by the user that has no monetarily quantifiable value, # `TRANSACTION`. An `ACTION` conversion is an action by
# while a TRANSACTION conversion is an action that does have a monetarily # the user that has no monetarily quantifiable value, while a
# quantifiable value. Examples are email list signups (ACTION) versus ecommerce # `TRANSACTION` conversion is an action that does have a
# purchases (TRANSACTION). # monetarily quantifiable value. Examples are email list signups
# (`ACTION`) versus ecommerce purchases
# (`TRANSACTION`).
# Corresponds to the JSON property `type` # Corresponds to the JSON property `type`
# @return [String] # @return [String]
attr_accessor :type attr_accessor :type
@ -319,7 +323,7 @@ module Google
attr_accessor :conversion attr_accessor :conversion
# Identifies this as a ConversionList resource. Value: the fixed string # Identifies this as a ConversionList resource. Value: the fixed string
# doubleclicksearch#conversionList. # <code>doubleclicksearch#conversionList</code>.
# Corresponds to the JSON property `kind` # Corresponds to the JSON property `kind`
# @return [String] # @return [String]
attr_accessor :kind attr_accessor :kind
@ -335,7 +339,7 @@ module Google
end end
end end
# A message containing the custome dimension. # A message containing the custom dimension.
class CustomDimension class CustomDimension
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
@ -360,7 +364,7 @@ module Google
end end
end end
# A message containing the custome metric. # A message containing the custom metric.
class CustomMetric class CustomMetric
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
@ -386,13 +390,13 @@ module Google
end end
# A DoubleClick Search report. This object contains the report request, some # A DoubleClick Search report. This object contains the report request, some
# report metadata such as currency code, and the generated report rows or report # report metadata such as currency code, and the generated report rows or
# files. # report files.
class Report class Report
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# Asynchronous report only. Contains a list of generated report files once the # Asynchronous report only. Contains a list of generated report files once
# report has successfully completed. # the report has successfully completed.
# Corresponds to the JSON property `files` # Corresponds to the JSON property `files`
# @return [Array<Google::Apis::DoubleclicksearchV2::Report::File>] # @return [Array<Google::Apis::DoubleclicksearchV2::Report::File>]
attr_accessor :files attr_accessor :files
@ -410,7 +414,7 @@ module Google
alias_method :is_report_ready?, :is_report_ready alias_method :is_report_ready?, :is_report_ready
# Identifies this as a Report resource. Value: the fixed string # Identifies this as a Report resource. Value: the fixed string
# doubleclicksearch#report. # `doubleclicksearch#report`.
# Corresponds to the JSON property `kind` # Corresponds to the JSON property `kind`
# @return [String] # @return [String]
attr_accessor :kind attr_accessor :kind
@ -431,9 +435,9 @@ module Google
attr_accessor :rows attr_accessor :rows
# The currency code of all monetary values produced in the report, including # The currency code of all monetary values produced in the report, including
# values that are set by users (e.g., keyword bid settings) and metrics (e.g., # values that are set by users (e.g., keyword bid settings) and metrics
# cost and revenue). The currency code of a report is determined by the # (e.g., cost and revenue). The currency code of a report is determined by
# statisticsCurrency field of the report request. # the `statisticsCurrency` field of the report request.
# Corresponds to the JSON property `statisticsCurrencyCode` # Corresponds to the JSON property `statisticsCurrencyCode`
# @return [String] # @return [String]
attr_accessor :statistics_currency_code attr_accessor :statistics_currency_code
@ -499,68 +503,69 @@ module Google
# Segments a report by a custom dimension. The report must be scoped to an # Segments a report by a custom dimension. The report must be scoped to an
# advertiser or lower, and the custom dimension must already be set up in # advertiser or lower, and the custom dimension must already be set up in
# DoubleClick Search. The custom dimension name, which appears in DoubleClick # DoubleClick Search. The custom dimension name, which appears in DoubleClick
# Search, is case sensitive. # Search, is case sensitive.\
# If used in a conversion report, returns the value of the specified custom # If used in a conversion report, returns the
# dimension for the given conversion, if set. This column does not segment the # value of the specified custom dimension for the given conversion, if set.
# conversion report. # This column does not segment the conversion report.
# Corresponds to the JSON property `customDimensionName` # Corresponds to the JSON property `customDimensionName`
# @return [String] # @return [String]
attr_accessor :custom_dimension_name attr_accessor :custom_dimension_name
# Name of a custom metric to include in the report. The report must be scoped to # Name of a custom metric to include in the report. The report must be scoped
# an advertiser or lower, and the custom metric must already be set up in # to an advertiser or lower, and the custom metric must already be set up in
# DoubleClick Search. The custom metric name, which appears in DoubleClick # DoubleClick Search. The custom metric name, which appears in DoubleClick
# Search, is case sensitive. # Search, is case sensitive.
# Corresponds to the JSON property `customMetricName` # Corresponds to the JSON property `customMetricName`
# @return [String] # @return [String]
attr_accessor :custom_metric_name attr_accessor :custom_metric_name
# Inclusive day in YYYY-MM-DD format. When provided, this overrides the overall # Inclusive day in YYYY-MM-DD format. When provided, this overrides the
# time range of the report for this column only. Must be provided together with # overall time range of the report for this column only. Must be provided
# startDate. # together with `startDate`.
# Corresponds to the JSON property `endDate` # Corresponds to the JSON property `endDate`
# @return [String] # @return [String]
attr_accessor :end_date attr_accessor :end_date
# Synchronous report only. Set to true to group by this column. Defaults to # Synchronous report only. Set to `true` to group by this column.
# false. # Defaults to `false`.
# Corresponds to the JSON property `groupByColumn` # Corresponds to the JSON property `groupByColumn`
# @return [Boolean] # @return [Boolean]
attr_accessor :group_by_column attr_accessor :group_by_column
alias_method :group_by_column?, :group_by_column alias_method :group_by_column?, :group_by_column
# Text used to identify this column in the report output; defaults to columnName # Text used to identify this column in the report output; defaults to
# or savedColumnName when not specified. This can be used to prevent collisions # `columnName` or `savedColumnName` when not specified.
# between DoubleClick Search columns and saved columns with the same name. # This can be used to prevent collisions between DoubleClick Search columns
# and saved columns with the same name.
# Corresponds to the JSON property `headerText` # Corresponds to the JSON property `headerText`
# @return [String] # @return [String]
attr_accessor :header_text attr_accessor :header_text
# The platform that is used to provide data for the custom dimension. Acceptable # The platform that is used to provide data for the custom dimension.
# values are "floodlight". # Acceptable values are "floodlight".
# Corresponds to the JSON property `platformSource` # Corresponds to the JSON property `platformSource`
# @return [String] # @return [String]
attr_accessor :platform_source attr_accessor :platform_source
# Returns metrics only for a specific type of product activity. Accepted values # Returns metrics only for a specific type of product activity. Accepted
# are: # values are: <ul> <li>"`sold`": returns metrics only for products
# - "sold": returns metrics only for products that were sold # that were sold</li> <li>"`advertised`": returns metrics only for
# - "advertised": returns metrics only for products that were advertised in a # products that were advertised in a Shopping campaign, and that might or
# Shopping campaign, and that might or might not have been sold # might not have been sold</li> </ul>
# Corresponds to the JSON property `productReportPerspective` # Corresponds to the JSON property `productReportPerspective`
# @return [String] # @return [String]
attr_accessor :product_report_perspective attr_accessor :product_report_perspective
# Name of a saved column to include in the report. The report must be scoped at # Name of a saved column to include in the report. The report must be scoped
# advertiser or lower, and this saved column must already be created in the # at advertiser or lower, and this saved column must already be created in
# DoubleClick Search UI. # the DoubleClick Search UI.
# Corresponds to the JSON property `savedColumnName` # Corresponds to the JSON property `savedColumnName`
# @return [String] # @return [String]
attr_accessor :saved_column_name attr_accessor :saved_column_name
# Inclusive date in YYYY-MM-DD format. When provided, this overrides the overall # Inclusive date in YYYY-MM-DD format. When provided, this overrides the
# time range of the report for this column only. Must be provided together with # overall time range of the report for this column only. Must be provided
# endDate. # together with `endDate`.
# Corresponds to the JSON property `startDate` # Corresponds to the JSON property `startDate`
# @return [String] # @return [String]
attr_accessor :start_date attr_accessor :start_date
@ -589,49 +594,52 @@ module Google
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# The columns to include in the report. This includes both DoubleClick Search # The columns to include in the report. This includes both DoubleClick Search
# columns and saved columns. For DoubleClick Search columns, only the columnName # columns and saved columns. For DoubleClick Search columns, only the
# parameter is required. For saved columns only the savedColumnName parameter is # `columnName` parameter is required. For saved columns only the
# required. Both columnName and savedColumnName cannot be set in the same stanza. # `savedColumnName` parameter is required. Both
# `columnName` and `savedColumnName` cannot be set in
# the same stanza.\
# The maximum number of columns per request is 300. # The maximum number of columns per request is 300.
# Corresponds to the JSON property `columns` # Corresponds to the JSON property `columns`
# @return [Array<Google::Apis::DoubleclicksearchV2::ReportApiColumnSpec>] # @return [Array<Google::Apis::DoubleclicksearchV2::ReportApiColumnSpec>]
attr_accessor :columns attr_accessor :columns
# Format that the report should be returned in. Currently csv or tsv is # Format that the report should be returned in. Currently `csv` or
# supported. # `tsv` is supported.
# Corresponds to the JSON property `downloadFormat` # Corresponds to the JSON property `downloadFormat`
# @return [String] # @return [String]
attr_accessor :download_format attr_accessor :download_format
# A list of filters to be applied to the report. # A list of filters to be applied to the report.\
# The maximum number of filters per request is 300. # The maximum number of filters per request is 300.
# Corresponds to the JSON property `filters` # Corresponds to the JSON property `filters`
# @return [Array<Google::Apis::DoubleclicksearchV2::ReportRequest::Filter>] # @return [Array<Google::Apis::DoubleclicksearchV2::ReportRequest::Filter>]
attr_accessor :filters attr_accessor :filters
# Determines if removed entities should be included in the report. Defaults to # Determines if removed entities should be included in the report. Defaults
# false. Deprecated, please use includeRemovedEntities instead. # to `false`. Deprecated, please use
# `includeRemovedEntities` instead.
# Corresponds to the JSON property `includeDeletedEntities` # Corresponds to the JSON property `includeDeletedEntities`
# @return [Boolean] # @return [Boolean]
attr_accessor :include_deleted_entities attr_accessor :include_deleted_entities
alias_method :include_deleted_entities?, :include_deleted_entities alias_method :include_deleted_entities?, :include_deleted_entities
# Determines if removed entities should be included in the report. Defaults to # Determines if removed entities should be included in the report. Defaults
# false. # to `false`.
# Corresponds to the JSON property `includeRemovedEntities` # Corresponds to the JSON property `includeRemovedEntities`
# @return [Boolean] # @return [Boolean]
attr_accessor :include_removed_entities attr_accessor :include_removed_entities
alias_method :include_removed_entities?, :include_removed_entities alias_method :include_removed_entities?, :include_removed_entities
# Asynchronous report only. The maximum number of rows per report file. A large # Asynchronous report only. The maximum number of rows per report file. A
# report is split into many files based on this field. Acceptable values are # large report is split into many files based on this field. Acceptable
# 1000000 to 100000000, inclusive. # values are `1000000` to `100000000`, inclusive.
# Corresponds to the JSON property `maxRowsPerFile` # Corresponds to the JSON property `maxRowsPerFile`
# @return [Fixnum] # @return [Fixnum]
attr_accessor :max_rows_per_file attr_accessor :max_rows_per_file
# Synchronous report only. A list of columns and directions defining sorting to # Synchronous report only. A list of columns and directions defining sorting
# be performed on the report rows. # to be performed on the report rows.\
# The maximum number of orderings per request is 300. # The maximum number of orderings per request is 300.
# Corresponds to the JSON property `orderBy` # Corresponds to the JSON property `orderBy`
# @return [Array<Google::Apis::DoubleclicksearchV2::ReportRequest::OrderBy>] # @return [Array<Google::Apis::DoubleclicksearchV2::ReportRequest::OrderBy>]
@ -644,42 +652,47 @@ module Google
# @return [Google::Apis::DoubleclicksearchV2::ReportRequest::ReportScope] # @return [Google::Apis::DoubleclicksearchV2::ReportRequest::ReportScope]
attr_accessor :report_scope attr_accessor :report_scope
# Determines the type of rows that are returned in the report. For example, if # Determines the type of rows that are returned in the report. For example,
# you specify reportType: keyword, each row in the report will contain data # if you specify `reportType: keyword`, each row in the report
# about a keyword. See the Types of Reports reference for the columns that are # will contain data about a keyword. See the [Types of
# Reports](/search-ads/v2/report-types/) reference for the columns that are
# available for each type. # available for each type.
# Corresponds to the JSON property `reportType` # Corresponds to the JSON property `reportType`
# @return [String] # @return [String]
attr_accessor :report_type attr_accessor :report_type
# Synchronous report only. The maximum number of rows to return; additional rows # Synchronous report only. The maximum number of rows to return; additional
# are dropped. Acceptable values are 0 to 10000, inclusive. Defaults to 10000. # rows are dropped. Acceptable values are `0` to
# `10000`, inclusive. Defaults to `10000`.
# Corresponds to the JSON property `rowCount` # Corresponds to the JSON property `rowCount`
# @return [Fixnum] # @return [Fixnum]
attr_accessor :row_count attr_accessor :row_count
# Synchronous report only. Zero-based index of the first row to return. # Synchronous report only. Zero-based index of the first row to return.
# Acceptable values are 0 to 50000, inclusive. Defaults to 0. # Acceptable values are `0` to `50000`, inclusive.
# Defaults to `0`.
# Corresponds to the JSON property `startRow` # Corresponds to the JSON property `startRow`
# @return [Fixnum] # @return [Fixnum]
attr_accessor :start_row attr_accessor :start_row
# Specifies the currency in which monetary will be returned. Possible values are: # Specifies the currency in which monetary will be returned. Possible values
# usd, agency (valid if the report is scoped to agency or lower), advertiser ( # are: `usd`, `agency` (valid if the report is scoped
# valid if the report is scoped to * advertiser or lower), or account (valid if # to agency or lower), `advertiser` (valid if the report is scoped
# the report is scoped to engine account or lower). # to * advertiser or lower), or `account` (valid if the report is
# scoped to engine account or lower).
# Corresponds to the JSON property `statisticsCurrency` # Corresponds to the JSON property `statisticsCurrency`
# @return [String] # @return [String]
attr_accessor :statistics_currency attr_accessor :statistics_currency
# If metrics are requested in a report, this argument will be used to restrict # If metrics are requested in a report, this argument will be used to
# the metrics to a specific time range. # restrict the metrics to a specific time range.
# Corresponds to the JSON property `timeRange` # Corresponds to the JSON property `timeRange`
# @return [Google::Apis::DoubleclicksearchV2::ReportRequest::TimeRange] # @return [Google::Apis::DoubleclicksearchV2::ReportRequest::TimeRange]
attr_accessor :time_range attr_accessor :time_range
# If true, the report would only be created if all the requested stat data are # If `true`, the report would only be created if all the requested
# sourced from a single timezone. Defaults to false. # stat data are sourced from a single timezone. Defaults to
# `false`.
# Corresponds to the JSON property `verifySingleTimeZone` # Corresponds to the JSON property `verifySingleTimeZone`
# @return [Boolean] # @return [Boolean]
attr_accessor :verify_single_time_zone attr_accessor :verify_single_time_zone
@ -722,7 +735,7 @@ module Google
# @return [String] # @return [String]
attr_accessor :operator attr_accessor :operator
# A list of values to filter the column value against. # A list of values to filter the column value against.\
# The maximum number of filter values per request is 300. # The maximum number of filter values per request is 300.
# Corresponds to the JSON property `values` # Corresponds to the JSON property `values`
# @return [Array<Object>] # @return [Array<Object>]
@ -749,7 +762,8 @@ module Google
# @return [Google::Apis::DoubleclicksearchV2::ReportApiColumnSpec] # @return [Google::Apis::DoubleclicksearchV2::ReportApiColumnSpec]
attr_accessor :column attr_accessor :column
# The sort direction, which is either ascending or descending. # The sort direction, which is either `ascending` or
# `descending`.
# Corresponds to the JSON property `sortOrder` # Corresponds to the JSON property `sortOrder`
# @return [String] # @return [String]
attr_accessor :sort_order attr_accessor :sort_order
@ -822,21 +836,23 @@ module Google
end end
end end
# If metrics are requested in a report, this argument will be used to restrict # If metrics are requested in a report, this argument will be used to
# the metrics to a specific time range. # restrict the metrics to a specific time range.
class TimeRange class TimeRange
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# Inclusive UTC timestamp in RFC format, e.g., 2013-07-16T10:16:23.555Z. See # Inclusive UTC timestamp in RFC format, e.g.,
# additional references on how changed attribute reports work. # `2013-07-16T10:16:23.555Z`. See additional references on how
# changed attribute reports work.
# Corresponds to the JSON property `changedAttributesSinceTimestamp` # Corresponds to the JSON property `changedAttributesSinceTimestamp`
# @return [DateTime] # @return [String]
attr_accessor :changed_attributes_since_timestamp attr_accessor :changed_attributes_since_timestamp
# Inclusive UTC timestamp in RFC format, e.g., 2013-07-16T10:16:23.555Z. See # Inclusive UTC timestamp in RFC format, e.g.,
# additional references on how changed metrics reports work. # `2013-07-16T10:16:23.555Z`. See additional references on how
# changed metrics reports work.
# Corresponds to the JSON property `changedMetricsSinceTimestamp` # Corresponds to the JSON property `changedMetricsSinceTimestamp`
# @return [DateTime] # @return [String]
attr_accessor :changed_metrics_since_timestamp attr_accessor :changed_metrics_since_timestamp
# Inclusive date in YYYY-MM-DD format. # Inclusive date in YYYY-MM-DD format.
@ -868,7 +884,7 @@ module Google
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# Identifies this as a SavedColumn resource. Value: the fixed string # Identifies this as a SavedColumn resource. Value: the fixed string
# doubleclicksearch#savedColumn. # <code>doubleclicksearch#savedColumn</code>.
# Corresponds to the JSON property `kind` # Corresponds to the JSON property `kind`
# @return [String] # @return [String]
attr_accessor :kind attr_accessor :kind
@ -897,8 +913,8 @@ module Google
# A list of saved columns. Advertisers create saved columns to report on # A list of saved columns. Advertisers create saved columns to report on
# Floodlight activities, Google Analytics goals, or custom KPIs. To request # Floodlight activities, Google Analytics goals, or custom KPIs. To request
# reports with saved columns, you'll need the saved column names that are # reports with saved columns,
# available from this list. # you'll need the saved column names that are available from this list.
class SavedColumnList class SavedColumnList
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
@ -908,7 +924,7 @@ module Google
attr_accessor :items attr_accessor :items
# Identifies this as a SavedColumnList resource. Value: the fixed string # Identifies this as a SavedColumnList resource. Value: the fixed string
# doubleclicksearch#savedColumnList. # <code>doubleclicksearch#savedColumnList</code>.
# Corresponds to the JSON property `kind` # Corresponds to the JSON property `kind`
# @return [String] # @return [String]
attr_accessor :kind attr_accessor :kind

View File

@ -149,7 +149,7 @@ module Google
property :click_id, as: 'clickId' property :click_id, as: 'clickId'
property :conversion_id, as: 'conversionId' property :conversion_id, as: 'conversionId'
property :conversion_modified_timestamp, :numeric_string => true, as: 'conversionModifiedTimestamp' property :conversion_modified_timestamp, :numeric_string => true, as: 'conversionModifiedTimestamp'
property :conversion_timestamp, :numeric_string => true, as: 'conversionTimestamp' property :conversion_timestamp, as: 'conversionTimestamp'
property :count_millis, :numeric_string => true, as: 'countMillis' property :count_millis, :numeric_string => true, as: 'countMillis'
property :criterion_id, :numeric_string => true, as: 'criterionId' property :criterion_id, :numeric_string => true, as: 'criterionId'
property :currency_code, as: 'currencyCode' property :currency_code, as: 'currencyCode'
@ -167,7 +167,7 @@ module Google
property :product_id, as: 'productId' property :product_id, as: 'productId'
property :product_language, as: 'productLanguage' property :product_language, as: 'productLanguage'
property :quantity_millis, :numeric_string => true, as: 'quantityMillis' property :quantity_millis, :numeric_string => true, as: 'quantityMillis'
property :revenue_micros, :numeric_string => true, as: 'revenueMicros' property :revenue_micros, as: 'revenueMicros'
property :segmentation_id, :numeric_string => true, as: 'segmentationId' property :segmentation_id, :numeric_string => true, as: 'segmentationId'
property :segmentation_name, as: 'segmentationName' property :segmentation_name, as: 'segmentationName'
property :segmentation_type, as: 'segmentationType' property :segmentation_type, as: 'segmentationType'
@ -302,10 +302,8 @@ module Google
class TimeRange class TimeRange
# @private # @private
class Representation < Google::Apis::Core::JsonRepresentation class Representation < Google::Apis::Core::JsonRepresentation
property :changed_attributes_since_timestamp, as: 'changedAttributesSinceTimestamp', type: DateTime property :changed_attributes_since_timestamp, as: 'changedAttributesSinceTimestamp'
property :changed_metrics_since_timestamp, as: 'changedMetricsSinceTimestamp'
property :changed_metrics_since_timestamp, as: 'changedMetricsSinceTimestamp', type: DateTime
property :end_date, as: 'endDate' property :end_date, as: 'endDate'
property :start_date, as: 'startDate' property :start_date, as: 'startDate'
end end

View File

@ -22,8 +22,8 @@ module Google
module DoubleclicksearchV2 module DoubleclicksearchV2
# Search Ads 360 API # Search Ads 360 API
# #
# Reports and modifies your advertising data in DoubleClick Search (for example, # The Search Ads 360 API allows developers to automate uploading conversions and
# campaigns, ad groups, keywords, and conversions). # downloading reports from Search Ads 360.
# #
# @example # @example
# require 'google/apis/doubleclicksearch_v2' # require 'google/apis/doubleclicksearch_v2'
@ -31,7 +31,7 @@ module Google
# Doubleclicksearch = Google::Apis::DoubleclicksearchV2 # Alias the module # Doubleclicksearch = Google::Apis::DoubleclicksearchV2 # Alias the module
# service = Doubleclicksearch::DoubleclicksearchService.new # service = Doubleclicksearch::DoubleclicksearchService.new
# #
# @see https://developers.google.com/doubleclick-search/ # @see https://developers.google.com/search-ads
class DoubleclicksearchService < Google::Apis::Core::BaseService class DoubleclicksearchService < Google::Apis::Core::BaseService
# @return [String] # @return [String]
# API key. Your API key identifies your project and provides you with API access, # API key. Your API key identifies your project and provides you with API access,
@ -39,16 +39,12 @@ module Google
attr_accessor :key attr_accessor :key
# @return [String] # @return [String]
# An opaque string that represents a user for quota purposes. Must not exceed 40 # Available to use for quota purposes for server-side applications. Can be any
# characters. # arbitrary string assigned to a user, but should not exceed 40 characters.
attr_accessor :quota_user attr_accessor :quota_user
# @return [String]
# Deprecated. Please use quotaUser instead.
attr_accessor :user_ip
def initialize def initialize
super('https://www.googleapis.com/', 'doubleclicksearch/v2/') super('https://www.googleapis.com/', '')
@batch_path = 'batch/doubleclicksearch/v2' @batch_path = 'batch/doubleclicksearch/v2'
end end
@ -64,7 +60,8 @@ module Google
# @param [Fixnum] row_count # @param [Fixnum] row_count
# The number of conversions to return per call. # The number of conversions to return per call.
# @param [Fixnum] start_date # @param [Fixnum] start_date
# First date (inclusive) on which to retrieve conversions. Format is yyyymmdd. # First date (inclusive) on which to retrieve conversions. Format is
# yyyymmdd.
# @param [Fixnum] start_row # @param [Fixnum] start_row
# The 0-based starting index for retrieving conversions results. # The 0-based starting index for retrieving conversions results.
# @param [Fixnum] ad_group_id # @param [Fixnum] ad_group_id
@ -78,10 +75,8 @@ module Google
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
# @param [String] quota_user # @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40 # Available to use for quota purposes for server-side applications. Can be any
# characters. # arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options # @param [Google::Apis::RequestOptions] options
# Request-specific options # Request-specific options
# #
@ -94,8 +89,8 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required # @raise [Google::Apis::AuthorizationError] Authorization is required
def get_conversion(agency_id, advertiser_id, engine_account_id, end_date, row_count, start_date, start_row, ad_group_id: nil, ad_id: nil, campaign_id: nil, criterion_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) def get_conversion(agency_id, advertiser_id, engine_account_id, end_date, row_count, start_date, start_row, ad_group_id: nil, ad_id: nil, campaign_id: nil, criterion_id: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'agency/{agencyId}/advertiser/{advertiserId}/engine/{engineAccountId}/conversion', options) command = make_simple_command(:get, 'doubleclicksearch/v2/agency/{agencyId}/advertiser/{advertiserId}/engine/{engineAccountId}/conversion', options)
command.response_representation = Google::Apis::DoubleclicksearchV2::ConversionList::Representation command.response_representation = Google::Apis::DoubleclicksearchV2::ConversionList::Representation
command.response_class = Google::Apis::DoubleclicksearchV2::ConversionList command.response_class = Google::Apis::DoubleclicksearchV2::ConversionList
command.params['agencyId'] = agency_id unless agency_id.nil? command.params['agencyId'] = agency_id unless agency_id.nil?
@ -111,7 +106,6 @@ module Google
command.query['startRow'] = start_row unless start_row.nil? command.query['startRow'] = start_row unless start_row.nil?
command.query['fields'] = fields unless fields.nil? command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
@ -120,10 +114,8 @@ module Google
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
# @param [String] quota_user # @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40 # Available to use for quota purposes for server-side applications. Can be any
# characters. # arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options # @param [Google::Apis::RequestOptions] options
# Request-specific options # Request-specific options
# #
@ -136,15 +128,14 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required # @raise [Google::Apis::AuthorizationError] Authorization is required
def insert_conversion(conversion_list_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) def insert_conversion(conversion_list_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'conversion', options) command = make_simple_command(:post, 'doubleclicksearch/v2/conversion', options)
command.request_representation = Google::Apis::DoubleclicksearchV2::ConversionList::Representation command.request_representation = Google::Apis::DoubleclicksearchV2::ConversionList::Representation
command.request_object = conversion_list_object command.request_object = conversion_list_object
command.response_representation = Google::Apis::DoubleclicksearchV2::ConversionList::Representation command.response_representation = Google::Apis::DoubleclicksearchV2::ConversionList::Representation
command.response_class = Google::Apis::DoubleclicksearchV2::ConversionList command.response_class = Google::Apis::DoubleclicksearchV2::ConversionList
command.query['fields'] = fields unless fields.nil? command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
@ -153,10 +144,8 @@ module Google
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
# @param [String] quota_user # @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40 # Available to use for quota purposes for server-side applications. Can be any
# characters. # arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options # @param [Google::Apis::RequestOptions] options
# Request-specific options # Request-specific options
# #
@ -169,28 +158,25 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required # @raise [Google::Apis::AuthorizationError] Authorization is required
def update_conversion(conversion_list_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) def update_conversion(conversion_list_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:put, 'conversion', options) command = make_simple_command(:put, 'doubleclicksearch/v2/conversion', options)
command.request_representation = Google::Apis::DoubleclicksearchV2::ConversionList::Representation command.request_representation = Google::Apis::DoubleclicksearchV2::ConversionList::Representation
command.request_object = conversion_list_object command.request_object = conversion_list_object
command.response_representation = Google::Apis::DoubleclicksearchV2::ConversionList::Representation command.response_representation = Google::Apis::DoubleclicksearchV2::ConversionList::Representation
command.response_class = Google::Apis::DoubleclicksearchV2::ConversionList command.response_class = Google::Apis::DoubleclicksearchV2::ConversionList
command.query['fields'] = fields unless fields.nil? command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
# Updates the availabilities of a batch of floodlight activities in DoubleClick # Updates the availabilities of a batch of floodlight activities in
# Search. # DoubleClick Search.
# @param [Google::Apis::DoubleclicksearchV2::UpdateAvailabilityRequest] update_availability_request_object # @param [Google::Apis::DoubleclicksearchV2::UpdateAvailabilityRequest] update_availability_request_object
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
# @param [String] quota_user # @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40 # Available to use for quota purposes for server-side applications. Can be any
# characters. # arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options # @param [Google::Apis::RequestOptions] options
# Request-specific options # Request-specific options
# #
@ -203,15 +189,14 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required # @raise [Google::Apis::AuthorizationError] Authorization is required
def update_conversion_availability(update_availability_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) def update_conversion_availability(update_availability_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'conversion/updateAvailability', options) command = make_simple_command(:post, 'doubleclicksearch/v2/conversion/updateAvailability', options)
command.request_representation = Google::Apis::DoubleclicksearchV2::UpdateAvailabilityRequest::Representation command.request_representation = Google::Apis::DoubleclicksearchV2::UpdateAvailabilityRequest::Representation
command.request_object = update_availability_request_object command.request_object = update_availability_request_object
command.response_representation = Google::Apis::DoubleclicksearchV2::UpdateAvailabilityResponse::Representation command.response_representation = Google::Apis::DoubleclicksearchV2::UpdateAvailabilityResponse::Representation
command.response_class = Google::Apis::DoubleclicksearchV2::UpdateAvailabilityResponse command.response_class = Google::Apis::DoubleclicksearchV2::UpdateAvailabilityResponse
command.query['fields'] = fields unless fields.nil? command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
@ -220,10 +205,8 @@ module Google
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
# @param [String] quota_user # @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40 # Available to use for quota purposes for server-side applications. Can be any
# characters. # arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options # @param [Google::Apis::RequestOptions] options
# Request-specific options # Request-specific options
# #
@ -236,15 +219,14 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required # @raise [Google::Apis::AuthorizationError] Authorization is required
def generate_report(report_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) def generate_report(report_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'reports/generate', options) command = make_simple_command(:post, 'doubleclicksearch/v2/reports/generate', options)
command.request_representation = Google::Apis::DoubleclicksearchV2::ReportRequest::Representation command.request_representation = Google::Apis::DoubleclicksearchV2::ReportRequest::Representation
command.request_object = report_request_object command.request_object = report_request_object
command.response_representation = Google::Apis::DoubleclicksearchV2::Report::Representation command.response_representation = Google::Apis::DoubleclicksearchV2::Report::Representation
command.response_class = Google::Apis::DoubleclicksearchV2::Report command.response_class = Google::Apis::DoubleclicksearchV2::Report
command.query['fields'] = fields unless fields.nil? command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
@ -254,10 +236,8 @@ module Google
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
# @param [String] quota_user # @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40 # Available to use for quota purposes for server-side applications. Can be any
# characters. # arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options # @param [Google::Apis::RequestOptions] options
# Request-specific options # Request-specific options
# #
@ -270,14 +250,13 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required # @raise [Google::Apis::AuthorizationError] Authorization is required
def get_report(report_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) def get_report(report_id, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'reports/{reportId}', options) command = make_simple_command(:get, 'doubleclicksearch/v2/reports/{reportId}', options)
command.response_representation = Google::Apis::DoubleclicksearchV2::Report::Representation command.response_representation = Google::Apis::DoubleclicksearchV2::Report::Representation
command.response_class = Google::Apis::DoubleclicksearchV2::Report command.response_class = Google::Apis::DoubleclicksearchV2::Report
command.params['reportId'] = report_id unless report_id.nil? command.params['reportId'] = report_id unless report_id.nil?
command.query['fields'] = fields unless fields.nil? command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
@ -289,10 +268,8 @@ module Google
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
# @param [String] quota_user # @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40 # Available to use for quota purposes for server-side applications. Can be any
# characters. # arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [IO, String] download_dest # @param [IO, String] download_dest
# IO stream or filename to receive content download # IO stream or filename to receive content download
# @param [Google::Apis::RequestOptions] options # @param [Google::Apis::RequestOptions] options
@ -307,18 +284,17 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required # @raise [Google::Apis::AuthorizationError] Authorization is required
def get_report_file(report_id, report_fragment, fields: nil, quota_user: nil, user_ip: nil, download_dest: nil, options: nil, &block) def get_report_file(report_id, report_fragment, fields: nil, quota_user: nil, download_dest: nil, options: nil, &block)
if download_dest.nil? if download_dest.nil?
command = make_simple_command(:get, 'reports/{reportId}/files/{reportFragment}', options) command = make_simple_command(:get, 'doubleclicksearch/v2/reports/{reportId}/files/{reportFragment}', options)
else else
command = make_download_command(:get, 'reports/{reportId}/files/{reportFragment}', options) command = make_download_command(:get, 'doubleclicksearch/v2/reports/{reportId}/files/{reportFragment}', options)
command.download_dest = download_dest command.download_dest = download_dest
end end
command.params['reportId'] = report_id unless report_id.nil? command.params['reportId'] = report_id unless report_id.nil?
command.params['reportFragment'] = report_fragment unless report_fragment.nil? command.params['reportFragment'] = report_fragment unless report_fragment.nil?
command.query['fields'] = fields unless fields.nil? command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
@ -327,10 +303,8 @@ module Google
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
# @param [String] quota_user # @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40 # Available to use for quota purposes for server-side applications. Can be any
# characters. # arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options # @param [Google::Apis::RequestOptions] options
# Request-specific options # Request-specific options
# #
@ -343,15 +317,14 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required # @raise [Google::Apis::AuthorizationError] Authorization is required
def request_report(report_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) def request_report(report_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'reports', options) command = make_simple_command(:post, 'doubleclicksearch/v2/reports', options)
command.request_representation = Google::Apis::DoubleclicksearchV2::ReportRequest::Representation command.request_representation = Google::Apis::DoubleclicksearchV2::ReportRequest::Representation
command.request_object = report_request_object command.request_object = report_request_object
command.response_representation = Google::Apis::DoubleclicksearchV2::Report::Representation command.response_representation = Google::Apis::DoubleclicksearchV2::Report::Representation
command.response_class = Google::Apis::DoubleclicksearchV2::Report command.response_class = Google::Apis::DoubleclicksearchV2::Report
command.query['fields'] = fields unless fields.nil? command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
@ -363,10 +336,8 @@ module Google
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
# @param [String] quota_user # @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40 # Available to use for quota purposes for server-side applications. Can be any
# characters. # arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options # @param [Google::Apis::RequestOptions] options
# Request-specific options # Request-specific options
# #
@ -379,15 +350,14 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required # @raise [Google::Apis::AuthorizationError] Authorization is required
def list_saved_columns(agency_id, advertiser_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) def list_saved_columns(agency_id, advertiser_id, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'agency/{agencyId}/advertiser/{advertiserId}/savedcolumns', options) command = make_simple_command(:get, 'doubleclicksearch/v2/agency/{agencyId}/advertiser/{advertiserId}/savedcolumns', options)
command.response_representation = Google::Apis::DoubleclicksearchV2::SavedColumnList::Representation command.response_representation = Google::Apis::DoubleclicksearchV2::SavedColumnList::Representation
command.response_class = Google::Apis::DoubleclicksearchV2::SavedColumnList command.response_class = Google::Apis::DoubleclicksearchV2::SavedColumnList
command.params['agencyId'] = agency_id unless agency_id.nil? command.params['agencyId'] = agency_id unless agency_id.nil?
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
command.query['fields'] = fields unless fields.nil? command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
@ -396,7 +366,6 @@ module Google
def apply_command_defaults(command) def apply_command_defaults(command)
command.query['key'] = key unless key.nil? command.query['key'] = key unless key.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
end end
end end
end end

View File

@ -26,7 +26,7 @@ module Google
# @see https://firebase.google.com/docs/cloud-messaging # @see https://firebase.google.com/docs/cloud-messaging
module FcmV1 module FcmV1
VERSION = 'V1' VERSION = 'V1'
REVISION = '20200615' REVISION = '20200622'
# View and manage your data across Google Cloud Platform services # View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

View File

@ -25,7 +25,7 @@ module Google
# @see https://cloud.google.com/healthcare # @see https://cloud.google.com/healthcare
module HealthcareV1 module HealthcareV1
VERSION = 'V1' VERSION = 'V1'
REVISION = '20200605' REVISION = '20200612'
# View and manage your data across Google Cloud Platform services # View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

View File

@ -34,7 +34,7 @@ module Google
# ` # `
# "audit_configs": [ # "audit_configs": [
# ` # `
# "service": "allServices" # "service": "allServices",
# "audit_log_configs": [ # "audit_log_configs": [
# ` # `
# "log_type": "DATA_READ", # "log_type": "DATA_READ",
@ -43,18 +43,18 @@ module Google
# ] # ]
# `, # `,
# ` # `
# "log_type": "DATA_WRITE", # "log_type": "DATA_WRITE"
# `, # `,
# ` # `
# "log_type": "ADMIN_READ", # "log_type": "ADMIN_READ"
# ` # `
# ] # ]
# `, # `,
# ` # `
# "service": "sampleservice.googleapis.com" # "service": "sampleservice.googleapis.com",
# "audit_log_configs": [ # "audit_log_configs": [
# ` # `
# "log_type": "DATA_READ", # "log_type": "DATA_READ"
# `, # `,
# ` # `
# "log_type": "DATA_WRITE", # "log_type": "DATA_WRITE",
@ -106,7 +106,7 @@ module Google
# ] # ]
# `, # `,
# ` # `
# "log_type": "DATA_WRITE", # "log_type": "DATA_WRITE"
# ` # `
# ] # ]
# ` # `

View File

@ -25,7 +25,7 @@ module Google
# @see https://cloud.google.com/healthcare # @see https://cloud.google.com/healthcare
module HealthcareV1beta1 module HealthcareV1beta1
VERSION = 'V1beta1' VERSION = 'V1beta1'
REVISION = '20200605' REVISION = '20200612'
# View and manage your data across Google Cloud Platform services # View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

View File

@ -179,7 +179,7 @@ module Google
# ` # `
# "audit_configs": [ # "audit_configs": [
# ` # `
# "service": "allServices" # "service": "allServices",
# "audit_log_configs": [ # "audit_log_configs": [
# ` # `
# "log_type": "DATA_READ", # "log_type": "DATA_READ",
@ -188,18 +188,18 @@ module Google
# ] # ]
# `, # `,
# ` # `
# "log_type": "DATA_WRITE", # "log_type": "DATA_WRITE"
# `, # `,
# ` # `
# "log_type": "ADMIN_READ", # "log_type": "ADMIN_READ"
# ` # `
# ] # ]
# `, # `,
# ` # `
# "service": "sampleservice.googleapis.com" # "service": "sampleservice.googleapis.com",
# "audit_log_configs": [ # "audit_log_configs": [
# ` # `
# "log_type": "DATA_READ", # "log_type": "DATA_READ"
# `, # `,
# ` # `
# "log_type": "DATA_WRITE", # "log_type": "DATA_WRITE",
@ -251,7 +251,7 @@ module Google
# ] # ]
# `, # `,
# ` # `
# "log_type": "DATA_WRITE", # "log_type": "DATA_WRITE"
# ` # `
# ] # ]
# ` # `

View File

@ -29,7 +29,7 @@ module Google
# @see https://cloud.google.com/monitoring/api/ # @see https://cloud.google.com/monitoring/api/
module MonitoringV3 module MonitoringV3
VERSION = 'V3' VERSION = 'V3'
REVISION = '20200615' REVISION = '20200622'
# View and manage your data across Google Cloud Platform services # View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

View File

@ -3105,7 +3105,7 @@ module Google
# @return [Array<Google::Apis::MonitoringV3::TimeSeriesData>] # @return [Array<Google::Apis::MonitoringV3::TimeSeriesData>]
attr_accessor :time_series_data attr_accessor :time_series_data
# A descriptor for the labels and points in a timeseries. # A descriptor for the labels and points in a time series.
# Corresponds to the JSON property `timeSeriesDescriptor` # Corresponds to the JSON property `timeSeriesDescriptor`
# @return [Google::Apis::MonitoringV3::TimeSeriesDescriptor] # @return [Google::Apis::MonitoringV3::TimeSeriesDescriptor]
attr_accessor :time_series_descriptor attr_accessor :time_series_descriptor
@ -3691,7 +3691,7 @@ module Google
end end
end end
# A descriptor for the labels and points in a timeseries. # A descriptor for the labels and points in a time series.
class TimeSeriesDescriptor class TimeSeriesDescriptor
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable

View File

@ -0,0 +1,31 @@
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'google/apis/playablelocations_v3/service.rb'
require 'google/apis/playablelocations_v3/classes.rb'
require 'google/apis/playablelocations_v3/representations.rb'
module Google
module Apis
# Playable Locations API
#
#
#
# @see https://developers.google.com/maps/contact-sales/
module PlayablelocationsV3
VERSION = 'V3'
REVISION = '20200622'
end
end
end

View File

@ -0,0 +1,633 @@
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'date'
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module PlayablelocationsV3
# Encapsulates impression event details.
class GoogleMapsPlayablelocationsV3Impression
include Google::Apis::Core::Hashable
# An arbitrary, developer-defined type identifier for each type of game
# object used in your game.
# Since players interact with differ types of game objects in different ways,
# this field allows you to segregate impression data by type for analysis.
# You should assign a unique `game_object_type` ID to represent a distinct
# type of game object in your game.
# For example, 1=monster location, 2=powerup location.
# Corresponds to the JSON property `gameObjectType`
# @return [Fixnum]
attr_accessor :game_object_type
# Required. The type of impression event.
# Corresponds to the JSON property `impressionType`
# @return [String]
attr_accessor :impression_type
# Required. The name of the playable location.
# Corresponds to the JSON property `locationName`
# @return [String]
attr_accessor :location_name
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@game_object_type = args[:game_object_type] if args.key?(:game_object_type)
@impression_type = args[:impression_type] if args.key?(:impression_type)
@location_name = args[:location_name] if args.key?(:location_name)
end
end
# A request for logging impressions.
class GoogleMapsPlayablelocationsV3LogImpressionsRequest
include Google::Apis::Core::Hashable
# Client information.
# Corresponds to the JSON property `clientInfo`
# @return [Google::Apis::PlayablelocationsV3::GoogleMapsUnityClientInfo]
attr_accessor :client_info
# Required. Impression event details. The maximum number of impression reports
# that you
# can log at once is 50.
# Corresponds to the JSON property `impressions`
# @return [Array<Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3Impression>]
attr_accessor :impressions
# Required. A string that uniquely identifies the log impressions request. This
# allows
# you to detect duplicate requests. We recommend that you use UUIDs for this
# value. The value must not exceed 50 characters.
# You should reuse the `request_id` only when retrying a request in case of
# failure. In this case, the request must be identical to the one that
# failed.
# Corresponds to the JSON property `requestId`
# @return [String]
attr_accessor :request_id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@client_info = args[:client_info] if args.key?(:client_info)
@impressions = args[:impressions] if args.key?(:impressions)
@request_id = args[:request_id] if args.key?(:request_id)
end
end
# A response for the LogImpressions method.
# This method returns no data upon success.
class GoogleMapsPlayablelocationsV3LogImpressionsResponse
include Google::Apis::Core::Hashable
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
end
end
# A request for logging your player's bad location reports.
class GoogleMapsPlayablelocationsV3LogPlayerReportsRequest
include Google::Apis::Core::Hashable
# Client information.
# Corresponds to the JSON property `clientInfo`
# @return [Google::Apis::PlayablelocationsV3::GoogleMapsUnityClientInfo]
attr_accessor :client_info
# Required. Player reports. The maximum number of player reports that you can
# log at
# once is 50.
# Corresponds to the JSON property `playerReports`
# @return [Array<Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3PlayerReport>]
attr_accessor :player_reports
# Required. A string that uniquely identifies the log player reports request.
# This
# allows you to detect duplicate requests. We recommend that you use UUIDs
# for this value. The value must not exceed 50 characters.
# You should reuse the `request_id` only when retrying a request in the case
# of a failure. In that case, the request must be identical to the one that
# failed.
# Corresponds to the JSON property `requestId`
# @return [String]
attr_accessor :request_id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@client_info = args[:client_info] if args.key?(:client_info)
@player_reports = args[:player_reports] if args.key?(:player_reports)
@request_id = args[:request_id] if args.key?(:request_id)
end
end
# A response for the LogPlayerReports
# method.
# This method returns no data upon success.
class GoogleMapsPlayablelocationsV3LogPlayerReportsResponse
include Google::Apis::Core::Hashable
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
end
end
# A report submitted by a player about a playable location that is considered
# inappropriate for use in the game.
class GoogleMapsPlayablelocationsV3PlayerReport
include Google::Apis::Core::Hashable
# Language code (in BCP-47 format) indicating the language of the freeform
# description provided in `reason_details`. Examples are "en", "en-US" or
# "ja-Latn". For more information, see
# http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
# Corresponds to the JSON property `languageCode`
# @return [String]
attr_accessor :language_code
# Required. The name of the playable location.
# Corresponds to the JSON property `locationName`
# @return [String]
attr_accessor :location_name
# Required. A free-form description detailing why the playable location is
# considered bad.
# Corresponds to the JSON property `reasonDetails`
# @return [String]
attr_accessor :reason_details
# Required. One or more reasons why this playable location is considered bad.
# Corresponds to the JSON property `reasons`
# @return [Array<String>]
attr_accessor :reasons
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@language_code = args[:language_code] if args.key?(:language_code)
@location_name = args[:location_name] if args.key?(:location_name)
@reason_details = args[:reason_details] if args.key?(:reason_details)
@reasons = args[:reasons] if args.key?(:reasons)
end
end
# Specifies the area to search for playable locations.
class GoogleMapsPlayablelocationsV3SampleAreaFilter
include Google::Apis::Core::Hashable
# Required. The S2 cell ID of the area you want. This must be between cell level
# 11 and
# 14 (inclusive).
# S2 cells are 64-bit integers that identify areas on the Earth. They are
# hierarchical, and can therefore be used for spatial indexing.
# The S2 geometry library is available in a number of languages:
# * [C++](https://github.com/google/s2geometry)
# * [Java](https://github.com/google/s2-geometry-library-java)
# * [Go](https://github.com/golang/geo)
# * [Python](https://github.com/google/s2geometry/tree/master/src/python)
# Corresponds to the JSON property `s2CellId`
# @return [Fixnum]
attr_accessor :s2_cell_id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@s2_cell_id = args[:s2_cell_id] if args.key?(:s2_cell_id)
end
end
# Encapsulates a filter criterion for searching for a set of playable
# locations.
class GoogleMapsPlayablelocationsV3SampleCriterion
include Google::Apis::Core::Hashable
# Specifies which `PlayableLocation` fields are returned.
# `name` (which is used for logging impressions), `center_point` and
# `place_id` (or `plus_code`) are always returned.
# The following fields are omitted unless you specify them here:
# * snapped_point
# * types
# Note: The more fields you include, the more expensive in terms of data and
# associated latency your query will be.
# Corresponds to the JSON property `fieldsToReturn`
# @return [String]
attr_accessor :fields_to_return
# Specifies the filters to use when searching for playable locations.
# Corresponds to the JSON property `filter`
# @return [Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3SampleFilter]
attr_accessor :filter
# Required. An arbitrary, developer-defined identifier of the type of game
# object that
# the playable location is used for. This field allows you to specify
# criteria per game object type when searching for playable locations.
# You should assign a unique `game_object_type` ID across all
# `request_criteria` to represent a distinct type of game object. For
# example, 1=monster location, 2=powerup location.
# The response contains a map<game_object_type, Response>.
# Corresponds to the JSON property `gameObjectType`
# @return [Fixnum]
attr_accessor :game_object_type
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@fields_to_return = args[:fields_to_return] if args.key?(:fields_to_return)
@filter = args[:filter] if args.key?(:filter)
@game_object_type = args[:game_object_type] if args.key?(:game_object_type)
end
end
# Specifies the filters to use when searching for playable locations.
class GoogleMapsPlayablelocationsV3SampleFilter
include Google::Apis::Core::Hashable
# Restricts the set of playable locations to just the
# [types](/maps/documentation/gaming/tt/types) that you want.
# Corresponds to the JSON property `includedTypes`
# @return [Array<String>]
attr_accessor :included_types
# Specifies the maximum number of playable locations to return. This value
# must not be greater than 1000. The default value is 100.
# Only the top-ranking playable locations are returned.
# Corresponds to the JSON property `maxLocationCount`
# @return [Fixnum]
attr_accessor :max_location_count
# A set of options that specifies the separation between playable locations.
# Corresponds to the JSON property `spacing`
# @return [Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3SampleSpacingOptions]
attr_accessor :spacing
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@included_types = args[:included_types] if args.key?(:included_types)
@max_location_count = args[:max_location_count] if args.key?(:max_location_count)
@spacing = args[:spacing] if args.key?(:spacing)
end
end
# A geographical point suitable for placing game objects in location-based
# games.
class GoogleMapsPlayablelocationsV3SamplePlayableLocation
include Google::Apis::Core::Hashable
# An object representing a latitude/longitude pair. This is expressed as a pair
# of doubles representing degrees latitude and degrees longitude. Unless
# specified otherwise, this must conform to the
# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
# standard</a>. Values must be within normalized ranges.
# Corresponds to the JSON property `centerPoint`
# @return [Google::Apis::PlayablelocationsV3::GoogleTypeLatLng]
attr_accessor :center_point
# Required. The name of this playable location.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# A [place ID] (https://developers.google.com/places/place-id)
# Corresponds to the JSON property `placeId`
# @return [String]
attr_accessor :place_id
# A [plus code] (http://openlocationcode.com)
# Corresponds to the JSON property `plusCode`
# @return [String]
attr_accessor :plus_code
# An object representing a latitude/longitude pair. This is expressed as a pair
# of doubles representing degrees latitude and degrees longitude. Unless
# specified otherwise, this must conform to the
# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
# standard</a>. Values must be within normalized ranges.
# Corresponds to the JSON property `snappedPoint`
# @return [Google::Apis::PlayablelocationsV3::GoogleTypeLatLng]
attr_accessor :snapped_point
# A collection of [Playable Location
# Types](/maps/documentation/gaming/tt/types) for this playable location. The
# first type in the collection is the primary type.
# Type information might not be available for all playable locations.
# Corresponds to the JSON property `types`
# @return [Array<String>]
attr_accessor :types
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@center_point = args[:center_point] if args.key?(:center_point)
@name = args[:name] if args.key?(:name)
@place_id = args[:place_id] if args.key?(:place_id)
@plus_code = args[:plus_code] if args.key?(:plus_code)
@snapped_point = args[:snapped_point] if args.key?(:snapped_point)
@types = args[:types] if args.key?(:types)
end
end
# A list of PlayableLocation objects that satisfies a single Criterion.
class GoogleMapsPlayablelocationsV3SamplePlayableLocationList
include Google::Apis::Core::Hashable
# A list of playable locations for this game object type.
# Corresponds to the JSON property `locations`
# @return [Array<Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3SamplePlayableLocation>]
attr_accessor :locations
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@locations = args[:locations] if args.key?(:locations)
end
end
# Life of a query:
# - When a game starts in a new location, your game server issues a
# SamplePlayableLocations
# request. The request specifies the S2 cell, and contains one or more
# "criteria" for filtering:
# - Criterion 0: i locations for long-lived bases, or level 0 monsters, or...
# - Criterion 1: j locations for short-lived bases, or level 1 monsters, ...
# - Criterion 2: k locations for random objects.
# - etc (up to 5 criterion may be specified).
# `PlayableLocationList` will then contain mutually
# exclusive lists of `PlayableLocation` objects that satisfy each of
# the criteria. Think of it as a collection of real-world locations that you
# can then associate with your game state.
# Note: These points are impermanent in nature. E.g, parks can close, and
# places can be removed.
# The response specifies how long you can expect the playable locations to
# last. Once they expire, you should query the `samplePlayableLocations` API
# again to get a fresh view of the real world.
class GoogleMapsPlayablelocationsV3SamplePlayableLocationsRequest
include Google::Apis::Core::Hashable
# Specifies the area to search for playable locations.
# Corresponds to the JSON property `areaFilter`
# @return [Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3SampleAreaFilter]
attr_accessor :area_filter
# Required. Specifies one or more (up to 5) criteria for filtering the
# returned playable locations.
# Corresponds to the JSON property `criteria`
# @return [Array<Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3SampleCriterion>]
attr_accessor :criteria
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@area_filter = args[:area_filter] if args.key?(:area_filter)
@criteria = args[:criteria] if args.key?(:criteria)
end
end
# Response for the
# SamplePlayableLocations
# method.
class GoogleMapsPlayablelocationsV3SamplePlayableLocationsResponse
include Google::Apis::Core::Hashable
# Each PlayableLocation object corresponds to a game_object_type specified
# in the request.
# Corresponds to the JSON property `locationsPerGameObjectType`
# @return [Hash<String,Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3SamplePlayableLocationList>]
attr_accessor :locations_per_game_object_type
# Required. Specifies the "time-to-live" for the set of playable locations. You
# can use
# this value to determine how long to cache the set of playable locations.
# After this length of time, your back-end game server should issue a new
# SamplePlayableLocations
# request to get a fresh set of playable locations (because for example, they
# might have been removed, a park might have closed for the day, a
# business might have closed permanently).
# Corresponds to the JSON property `ttl`
# @return [String]
attr_accessor :ttl
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@locations_per_game_object_type = args[:locations_per_game_object_type] if args.key?(:locations_per_game_object_type)
@ttl = args[:ttl] if args.key?(:ttl)
end
end
# A set of options that specifies the separation between playable locations.
class GoogleMapsPlayablelocationsV3SampleSpacingOptions
include Google::Apis::Core::Hashable
# Required. The minimum spacing between any two playable locations, measured in
# meters.
# The minimum value is 30.
# The maximum value is 1000.
# Inputs will be rounded up to the next 10 meter interval.
# The default value is 200m.
# Set this field to remove tight clusters of playable locations.
# Note:
# The spacing is a greedy algorithm. It optimizes for selecting the highest
# ranking locations first, not to maximize the number of locations selected.
# Consider the following scenario:
# * Rank: A: 2, B: 1, C: 3.
# * Distance: A--200m--B--200m--C
# If spacing=250, it will pick the highest ranked location [B], not [A, C].
# Note:
# Spacing works within the game object type itself, as well as the previous
# ones.
# Suppose three game object types, each with the following spacing:
# * X: 400m, Y: undefined, Z: 200m.
# 1. Add locations for X, within 400m of each other.
# 2. Add locations for Y, without any spacing.
# 3. Finally, add locations for Z within 200m of each other as well X and Y.
# The distance diagram between those locations end up as:
# * From->To.
# * X->X: 400m
# * Y->X, Y->Y: unspecified.
# * Z->X, Z->Y, Z->Z: 200m.
# Corresponds to the JSON property `minSpacingMeters`
# @return [Float]
attr_accessor :min_spacing_meters
# Specifies whether the minimum spacing constraint applies to the
# center-point or to the snapped point of playable locations. The default
# value is `CENTER_POINT`.
# If a snapped point is not available for a playable location, its
# center-point is used instead.
# Set this to the point type used in your game.
# Corresponds to the JSON property `pointType`
# @return [String]
attr_accessor :point_type
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@min_spacing_meters = args[:min_spacing_meters] if args.key?(:min_spacing_meters)
@point_type = args[:point_type] if args.key?(:point_type)
end
end
# Client information.
class GoogleMapsUnityClientInfo
include Google::Apis::Core::Hashable
# API client name and version. For example, the SDK calling the API. The
# exact format is up to the client.
# Corresponds to the JSON property `apiClient`
# @return [String]
attr_accessor :api_client
# Application ID, such as the package name on Android and the bundle
# identifier on iOS platforms.
# Corresponds to the JSON property `applicationId`
# @return [String]
attr_accessor :application_id
# Application version number, such as "1.2.3". The exact format is
# application-dependent.
# Corresponds to the JSON property `applicationVersion`
# @return [String]
attr_accessor :application_version
# Device model as reported by the device. The exact format is
# platform-dependent.
# Corresponds to the JSON property `deviceModel`
# @return [String]
attr_accessor :device_model
# Language code (in BCP-47 format) indicating the UI language of the client.
# Examples are "en", "en-US" or "ja-Latn". For more information, see
# http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
# Corresponds to the JSON property `languageCode`
# @return [String]
attr_accessor :language_code
# Operating system name and version as reported by the OS. For example,
# "Mac OS X 10.10.4". The exact format is platform-dependent.
# Corresponds to the JSON property `operatingSystem`
# @return [String]
attr_accessor :operating_system
# Build number/version of the operating system. e.g., the contents of
# android.os.Build.ID in Android, or the contents of sysctl "kern.osversion"
# in iOS.
# Corresponds to the JSON property `operatingSystemBuild`
# @return [String]
attr_accessor :operating_system_build
# Platform where the application is running.
# Corresponds to the JSON property `platform`
# @return [String]
attr_accessor :platform
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@api_client = args[:api_client] if args.key?(:api_client)
@application_id = args[:application_id] if args.key?(:application_id)
@application_version = args[:application_version] if args.key?(:application_version)
@device_model = args[:device_model] if args.key?(:device_model)
@language_code = args[:language_code] if args.key?(:language_code)
@operating_system = args[:operating_system] if args.key?(:operating_system)
@operating_system_build = args[:operating_system_build] if args.key?(:operating_system_build)
@platform = args[:platform] if args.key?(:platform)
end
end
# An object representing a latitude/longitude pair. This is expressed as a pair
# of doubles representing degrees latitude and degrees longitude. Unless
# specified otherwise, this must conform to the
# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
# standard</a>. Values must be within normalized ranges.
class GoogleTypeLatLng
include Google::Apis::Core::Hashable
# The latitude in degrees. It must be in the range [-90.0, +90.0].
# Corresponds to the JSON property `latitude`
# @return [Float]
attr_accessor :latitude
# The longitude in degrees. It must be in the range [-180.0, +180.0].
# Corresponds to the JSON property `longitude`
# @return [Float]
attr_accessor :longitude
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@latitude = args[:latitude] if args.key?(:latitude)
@longitude = args[:longitude] if args.key?(:longitude)
end
end
end
end
end

View File

@ -0,0 +1,273 @@
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'date'
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module PlayablelocationsV3
class GoogleMapsPlayablelocationsV3Impression
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleMapsPlayablelocationsV3LogImpressionsRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleMapsPlayablelocationsV3LogImpressionsResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleMapsPlayablelocationsV3LogPlayerReportsRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleMapsPlayablelocationsV3LogPlayerReportsResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleMapsPlayablelocationsV3PlayerReport
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleMapsPlayablelocationsV3SampleAreaFilter
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleMapsPlayablelocationsV3SampleCriterion
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleMapsPlayablelocationsV3SampleFilter
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleMapsPlayablelocationsV3SamplePlayableLocation
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleMapsPlayablelocationsV3SamplePlayableLocationList
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleMapsPlayablelocationsV3SamplePlayableLocationsRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleMapsPlayablelocationsV3SamplePlayableLocationsResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleMapsPlayablelocationsV3SampleSpacingOptions
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleMapsUnityClientInfo
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleTypeLatLng
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleMapsPlayablelocationsV3Impression
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :game_object_type, as: 'gameObjectType'
property :impression_type, as: 'impressionType'
property :location_name, as: 'locationName'
end
end
class GoogleMapsPlayablelocationsV3LogImpressionsRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :client_info, as: 'clientInfo', class: Google::Apis::PlayablelocationsV3::GoogleMapsUnityClientInfo, decorator: Google::Apis::PlayablelocationsV3::GoogleMapsUnityClientInfo::Representation
collection :impressions, as: 'impressions', class: Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3Impression, decorator: Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3Impression::Representation
property :request_id, as: 'requestId'
end
end
class GoogleMapsPlayablelocationsV3LogImpressionsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class GoogleMapsPlayablelocationsV3LogPlayerReportsRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :client_info, as: 'clientInfo', class: Google::Apis::PlayablelocationsV3::GoogleMapsUnityClientInfo, decorator: Google::Apis::PlayablelocationsV3::GoogleMapsUnityClientInfo::Representation
collection :player_reports, as: 'playerReports', class: Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3PlayerReport, decorator: Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3PlayerReport::Representation
property :request_id, as: 'requestId'
end
end
class GoogleMapsPlayablelocationsV3LogPlayerReportsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class GoogleMapsPlayablelocationsV3PlayerReport
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :language_code, as: 'languageCode'
property :location_name, as: 'locationName'
property :reason_details, as: 'reasonDetails'
collection :reasons, as: 'reasons'
end
end
class GoogleMapsPlayablelocationsV3SampleAreaFilter
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :s2_cell_id, :numeric_string => true, as: 's2CellId'
end
end
class GoogleMapsPlayablelocationsV3SampleCriterion
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :fields_to_return, as: 'fieldsToReturn'
property :filter, as: 'filter', class: Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3SampleFilter, decorator: Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3SampleFilter::Representation
property :game_object_type, as: 'gameObjectType'
end
end
class GoogleMapsPlayablelocationsV3SampleFilter
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :included_types, as: 'includedTypes'
property :max_location_count, as: 'maxLocationCount'
property :spacing, as: 'spacing', class: Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3SampleSpacingOptions, decorator: Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3SampleSpacingOptions::Representation
end
end
class GoogleMapsPlayablelocationsV3SamplePlayableLocation
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :center_point, as: 'centerPoint', class: Google::Apis::PlayablelocationsV3::GoogleTypeLatLng, decorator: Google::Apis::PlayablelocationsV3::GoogleTypeLatLng::Representation
property :name, as: 'name'
property :place_id, as: 'placeId'
property :plus_code, as: 'plusCode'
property :snapped_point, as: 'snappedPoint', class: Google::Apis::PlayablelocationsV3::GoogleTypeLatLng, decorator: Google::Apis::PlayablelocationsV3::GoogleTypeLatLng::Representation
collection :types, as: 'types'
end
end
class GoogleMapsPlayablelocationsV3SamplePlayableLocationList
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :locations, as: 'locations', class: Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3SamplePlayableLocation, decorator: Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3SamplePlayableLocation::Representation
end
end
class GoogleMapsPlayablelocationsV3SamplePlayableLocationsRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :area_filter, as: 'areaFilter', class: Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3SampleAreaFilter, decorator: Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3SampleAreaFilter::Representation
collection :criteria, as: 'criteria', class: Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3SampleCriterion, decorator: Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3SampleCriterion::Representation
end
end
class GoogleMapsPlayablelocationsV3SamplePlayableLocationsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
hash :locations_per_game_object_type, as: 'locationsPerGameObjectType', class: Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3SamplePlayableLocationList, decorator: Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3SamplePlayableLocationList::Representation
property :ttl, as: 'ttl'
end
end
class GoogleMapsPlayablelocationsV3SampleSpacingOptions
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :min_spacing_meters, as: 'minSpacingMeters'
property :point_type, as: 'pointType'
end
end
class GoogleMapsUnityClientInfo
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :api_client, as: 'apiClient'
property :application_id, as: 'applicationId'
property :application_version, as: 'applicationVersion'
property :device_model, as: 'deviceModel'
property :language_code, as: 'languageCode'
property :operating_system, as: 'operatingSystem'
property :operating_system_build, as: 'operatingSystemBuild'
property :platform, as: 'platform'
end
end
class GoogleTypeLatLng
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :latitude, as: 'latitude'
property :longitude, as: 'longitude'
end
end
end
end
end

View File

@ -0,0 +1,157 @@
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module PlayablelocationsV3
# Playable Locations API
#
#
#
# @example
# require 'google/apis/playablelocations_v3'
#
# Playablelocations = Google::Apis::PlayablelocationsV3 # Alias the module
# service = Playablelocations::PlayableLocationsService.new
#
# @see https://developers.google.com/maps/contact-sales/
class PlayableLocationsService < Google::Apis::Core::BaseService
# @return [String]
# API key. Your API key identifies your project and provides you with API access,
# quota, and reports. Required unless you provide an OAuth 2.0 token.
attr_accessor :key
# @return [String]
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
attr_accessor :quota_user
def initialize
super('https://playablelocations.googleapis.com/', '')
@batch_path = 'batch'
end
# Logs new events when playable locations are displayed, and when they are
# interacted with.
# Impressions are not partially saved; either all impressions are saved and
# this request succeeds, or no impressions are saved, and this request fails.
# @param [Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3LogImpressionsRequest] google_maps_playablelocations_v3_log_impressions_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3LogImpressionsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3LogImpressionsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def log_impressions(google_maps_playablelocations_v3_log_impressions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v3:logImpressions', options)
command.request_representation = Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3LogImpressionsRequest::Representation
command.request_object = google_maps_playablelocations_v3_log_impressions_request_object
command.response_representation = Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3LogImpressionsResponse::Representation
command.response_class = Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3LogImpressionsResponse
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Logs bad playable location reports submitted by players.
# Reports are not partially saved; either all reports are saved and this
# request succeeds, or no reports are saved, and this request fails.
# @param [Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3LogPlayerReportsRequest] google_maps_playablelocations_v3_log_player_reports_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3LogPlayerReportsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3LogPlayerReportsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def log_player_reports(google_maps_playablelocations_v3_log_player_reports_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v3:logPlayerReports', options)
command.request_representation = Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3LogPlayerReportsRequest::Representation
command.request_object = google_maps_playablelocations_v3_log_player_reports_request_object
command.response_representation = Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3LogPlayerReportsResponse::Representation
command.response_class = Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3LogPlayerReportsResponse
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Returns a set of playable locations that lie within a specified area,
# that satisfy optional filter criteria.
# Note: Identical `SamplePlayableLocations` requests can return different
# results as the state of the world changes over time.
# @param [Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3SamplePlayableLocationsRequest] google_maps_playablelocations_v3_sample_playable_locations_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3SamplePlayableLocationsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3SamplePlayableLocationsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def sample_playable_locations(google_maps_playablelocations_v3_sample_playable_locations_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v3:samplePlayableLocations', options)
command.request_representation = Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3SamplePlayableLocationsRequest::Representation
command.request_object = google_maps_playablelocations_v3_sample_playable_locations_request_object
command.response_representation = Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3SamplePlayableLocationsResponse::Representation
command.response_class = Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3SamplePlayableLocationsResponse
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
protected
def apply_command_defaults(command)
command.query['key'] = key unless key.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
end
end
end
end
end

View File

@ -0,0 +1,40 @@
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'google/apis/realtimebidding_v1/service.rb'
require 'google/apis/realtimebidding_v1/classes.rb'
require 'google/apis/realtimebidding_v1/representations.rb'
module Google
module Apis
# Real-time Bidding API
#
# Allows external bidders to manage their RTB integration with Google. This
# includes managing bidder endpoints, QPS quotas, configuring what ad inventory
# to receive via pretargeting, submitting creatives for verification, and
# accessing creative metadata such as approval status.
#
# @see https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/
module RealtimebiddingV1
VERSION = 'V1'
REVISION = '20200623'
# Manage your Ad Exchange buyer account configuration
AUTH_ADEXCHANGE_BUYER = 'https://www.googleapis.com/auth/adexchange.buyer'
# See, create, edit, and delete your Authorized Buyers and Open Bidding account entities
AUTH_REALTIME_BIDDING = 'https://www.googleapis.com/auth/realtime-bidding'
end
end
end

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,565 @@
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'date'
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module RealtimebiddingV1
class AdTechnologyProviders
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class AdvertiserAndBrand
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class CloseUserListRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Creative
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class CreativeServingDecision
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Date
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class DestinationNotCrawlableEvidence
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class DestinationNotWorkingEvidence
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class DestinationUrlEvidence
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class DomainCallEvidence
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class DomainCalls
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class DownloadSizeEvidence
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GetRemarketingTagResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class HtmlContent
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class HttpCallEvidence
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class HttpCookieEvidence
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Image
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ListCreativesResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ListUserListsResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class MediaFile
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class NativeContent
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class OpenUserListRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class PolicyTopicEntry
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class PolicyTopicEvidence
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ServingStatus
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class UrlDownloadSize
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class UrlRestriction
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class UserList
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class VideoContent
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class VideoMetadata
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class WatchCreativesRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class WatchCreativesResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class AdTechnologyProviders
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :detected_provider_ids, as: 'detectedProviderIds'
property :has_unidentified_provider, as: 'hasUnidentifiedProvider'
end
end
class AdvertiserAndBrand
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :advertiser_id, :numeric_string => true, as: 'advertiserId'
property :advertiser_name, as: 'advertiserName'
property :brand_id, :numeric_string => true, as: 'brandId'
property :brand_name, as: 'brandName'
end
end
class CloseUserListRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class Creative
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :account_id, :numeric_string => true, as: 'accountId'
property :ad_choices_destination_url, as: 'adChoicesDestinationUrl'
property :advertiser_name, as: 'advertiserName'
property :agency_id, :numeric_string => true, as: 'agencyId'
property :api_update_time, as: 'apiUpdateTime'
property :creative_format, as: 'creativeFormat'
property :creative_id, as: 'creativeId'
property :creative_serving_decision, as: 'creativeServingDecision', class: Google::Apis::RealtimebiddingV1::CreativeServingDecision, decorator: Google::Apis::RealtimebiddingV1::CreativeServingDecision::Representation
collection :deal_ids, as: 'dealIds'
collection :declared_attributes, as: 'declaredAttributes'
collection :declared_click_through_urls, as: 'declaredClickThroughUrls'
collection :declared_restricted_categories, as: 'declaredRestrictedCategories'
collection :declared_vendor_ids, as: 'declaredVendorIds'
property :html, as: 'html', class: Google::Apis::RealtimebiddingV1::HtmlContent, decorator: Google::Apis::RealtimebiddingV1::HtmlContent::Representation
collection :impression_tracking_urls, as: 'impressionTrackingUrls'
property :name, as: 'name'
property :native, as: 'native', class: Google::Apis::RealtimebiddingV1::NativeContent, decorator: Google::Apis::RealtimebiddingV1::NativeContent::Representation
collection :restricted_categories, as: 'restrictedCategories'
property :version, as: 'version'
property :video, as: 'video', class: Google::Apis::RealtimebiddingV1::VideoContent, decorator: Google::Apis::RealtimebiddingV1::VideoContent::Representation
end
end
class CreativeServingDecision
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :ad_technology_providers, as: 'adTechnologyProviders', class: Google::Apis::RealtimebiddingV1::AdTechnologyProviders, decorator: Google::Apis::RealtimebiddingV1::AdTechnologyProviders::Representation
property :china_serving_status, as: 'chinaServingStatus', class: Google::Apis::RealtimebiddingV1::ServingStatus, decorator: Google::Apis::RealtimebiddingV1::ServingStatus::Representation
property :deals_serving_status, as: 'dealsServingStatus', class: Google::Apis::RealtimebiddingV1::ServingStatus, decorator: Google::Apis::RealtimebiddingV1::ServingStatus::Representation
collection :detected_advertisers, as: 'detectedAdvertisers', class: Google::Apis::RealtimebiddingV1::AdvertiserAndBrand, decorator: Google::Apis::RealtimebiddingV1::AdvertiserAndBrand::Representation
collection :detected_attributes, as: 'detectedAttributes'
collection :detected_click_through_urls, as: 'detectedClickThroughUrls'
collection :detected_domains, as: 'detectedDomains'
collection :detected_languages, as: 'detectedLanguages'
collection :detected_product_categories, as: 'detectedProductCategories'
collection :detected_sensitive_categories, as: 'detectedSensitiveCategories'
collection :detected_vendor_ids, as: 'detectedVendorIds'
property :last_status_update, as: 'lastStatusUpdate'
property :open_auction_serving_status, as: 'openAuctionServingStatus', class: Google::Apis::RealtimebiddingV1::ServingStatus, decorator: Google::Apis::RealtimebiddingV1::ServingStatus::Representation
property :russia_serving_status, as: 'russiaServingStatus', class: Google::Apis::RealtimebiddingV1::ServingStatus, decorator: Google::Apis::RealtimebiddingV1::ServingStatus::Representation
end
end
class Date
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :day, as: 'day'
property :month, as: 'month'
property :year, as: 'year'
end
end
class DestinationNotCrawlableEvidence
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :crawl_time, as: 'crawlTime'
property :crawled_url, as: 'crawledUrl'
property :reason, as: 'reason'
end
end
class DestinationNotWorkingEvidence
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :dns_error, as: 'dnsError'
property :expanded_url, as: 'expandedUrl'
property :http_error, as: 'httpError'
property :invalid_page, as: 'invalidPage'
property :last_check_time, as: 'lastCheckTime'
property :platform, as: 'platform'
property :redirection_error, as: 'redirectionError'
property :url_rejected, as: 'urlRejected'
end
end
class DestinationUrlEvidence
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :destination_url, as: 'destinationUrl'
end
end
class DomainCallEvidence
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :top_http_call_domains, as: 'topHttpCallDomains', class: Google::Apis::RealtimebiddingV1::DomainCalls, decorator: Google::Apis::RealtimebiddingV1::DomainCalls::Representation
property :total_http_call_count, as: 'totalHttpCallCount'
end
end
class DomainCalls
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :domain, as: 'domain'
property :http_call_count, as: 'httpCallCount'
end
end
class DownloadSizeEvidence
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :top_url_download_size_breakdowns, as: 'topUrlDownloadSizeBreakdowns', class: Google::Apis::RealtimebiddingV1::UrlDownloadSize, decorator: Google::Apis::RealtimebiddingV1::UrlDownloadSize::Representation
property :total_download_size_kb, as: 'totalDownloadSizeKb'
end
end
class GetRemarketingTagResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :snippet, as: 'snippet'
end
end
class HtmlContent
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :height, as: 'height'
property :snippet, as: 'snippet'
property :width, as: 'width'
end
end
class HttpCallEvidence
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :urls, as: 'urls'
end
end
class HttpCookieEvidence
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :cookie_names, as: 'cookieNames'
property :max_cookie_count, as: 'maxCookieCount'
end
end
class Image
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :height, as: 'height'
property :url, as: 'url'
property :width, as: 'width'
end
end
class ListCreativesResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :creatives, as: 'creatives', class: Google::Apis::RealtimebiddingV1::Creative, decorator: Google::Apis::RealtimebiddingV1::Creative::Representation
property :next_page_token, as: 'nextPageToken'
end
end
class ListUserListsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :next_page_token, as: 'nextPageToken'
collection :user_lists, as: 'userLists', class: Google::Apis::RealtimebiddingV1::UserList, decorator: Google::Apis::RealtimebiddingV1::UserList::Representation
end
end
class MediaFile
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :bitrate, :numeric_string => true, as: 'bitrate'
property :mime_type, as: 'mimeType'
end
end
class NativeContent
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :advertiser_name, as: 'advertiserName'
property :app_icon, as: 'appIcon', class: Google::Apis::RealtimebiddingV1::Image, decorator: Google::Apis::RealtimebiddingV1::Image::Representation
property :body, as: 'body'
property :call_to_action, as: 'callToAction'
property :click_link_url, as: 'clickLinkUrl'
property :click_tracking_url, as: 'clickTrackingUrl'
property :headline, as: 'headline'
property :image, as: 'image', class: Google::Apis::RealtimebiddingV1::Image, decorator: Google::Apis::RealtimebiddingV1::Image::Representation
property :logo, as: 'logo', class: Google::Apis::RealtimebiddingV1::Image, decorator: Google::Apis::RealtimebiddingV1::Image::Representation
property :price_display_text, as: 'priceDisplayText'
property :star_rating, as: 'starRating'
property :video_url, as: 'videoUrl'
end
end
class OpenUserListRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class PolicyTopicEntry
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :evidences, as: 'evidences', class: Google::Apis::RealtimebiddingV1::PolicyTopicEvidence, decorator: Google::Apis::RealtimebiddingV1::PolicyTopicEvidence::Representation
property :help_center_url, as: 'helpCenterUrl'
property :policy_topic, as: 'policyTopic'
end
end
class PolicyTopicEvidence
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :destination_not_crawlable, as: 'destinationNotCrawlable', class: Google::Apis::RealtimebiddingV1::DestinationNotCrawlableEvidence, decorator: Google::Apis::RealtimebiddingV1::DestinationNotCrawlableEvidence::Representation
property :destination_not_working, as: 'destinationNotWorking', class: Google::Apis::RealtimebiddingV1::DestinationNotWorkingEvidence, decorator: Google::Apis::RealtimebiddingV1::DestinationNotWorkingEvidence::Representation
property :destination_url, as: 'destinationUrl', class: Google::Apis::RealtimebiddingV1::DestinationUrlEvidence, decorator: Google::Apis::RealtimebiddingV1::DestinationUrlEvidence::Representation
property :domain_call, as: 'domainCall', class: Google::Apis::RealtimebiddingV1::DomainCallEvidence, decorator: Google::Apis::RealtimebiddingV1::DomainCallEvidence::Representation
property :download_size, as: 'downloadSize', class: Google::Apis::RealtimebiddingV1::DownloadSizeEvidence, decorator: Google::Apis::RealtimebiddingV1::DownloadSizeEvidence::Representation
property :http_call, as: 'httpCall', class: Google::Apis::RealtimebiddingV1::HttpCallEvidence, decorator: Google::Apis::RealtimebiddingV1::HttpCallEvidence::Representation
property :http_cookie, as: 'httpCookie', class: Google::Apis::RealtimebiddingV1::HttpCookieEvidence, decorator: Google::Apis::RealtimebiddingV1::HttpCookieEvidence::Representation
end
end
class ServingStatus
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :status, as: 'status'
collection :topics, as: 'topics', class: Google::Apis::RealtimebiddingV1::PolicyTopicEntry, decorator: Google::Apis::RealtimebiddingV1::PolicyTopicEntry::Representation
end
end
class UrlDownloadSize
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :download_size_kb, as: 'downloadSizeKb'
property :normalized_url, as: 'normalizedUrl'
end
end
class UrlRestriction
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :end_date, as: 'endDate', class: Google::Apis::RealtimebiddingV1::Date, decorator: Google::Apis::RealtimebiddingV1::Date::Representation
property :restriction_type, as: 'restrictionType'
property :start_date, as: 'startDate', class: Google::Apis::RealtimebiddingV1::Date, decorator: Google::Apis::RealtimebiddingV1::Date::Representation
property :url, as: 'url'
end
end
class UserList
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :description, as: 'description'
property :display_name, as: 'displayName'
property :membership_duration_days, :numeric_string => true, as: 'membershipDurationDays'
property :name, as: 'name'
property :status, as: 'status'
property :url_restriction, as: 'urlRestriction', class: Google::Apis::RealtimebiddingV1::UrlRestriction, decorator: Google::Apis::RealtimebiddingV1::UrlRestriction::Representation
end
end
class VideoContent
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :video_metadata, as: 'videoMetadata', class: Google::Apis::RealtimebiddingV1::VideoMetadata, decorator: Google::Apis::RealtimebiddingV1::VideoMetadata::Representation
property :video_url, as: 'videoUrl'
property :video_vast_xml, as: 'videoVastXml'
end
end
class VideoMetadata
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :duration, as: 'duration'
property :is_valid_vast, as: 'isValidVast'
property :is_vpaid, as: 'isVpaid'
collection :media_files, as: 'mediaFiles', class: Google::Apis::RealtimebiddingV1::MediaFile, decorator: Google::Apis::RealtimebiddingV1::MediaFile::Representation
property :skip_offset, as: 'skipOffset'
property :vast_version, as: 'vastVersion'
end
end
class WatchCreativesRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class WatchCreativesResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :subscription, as: 'subscription'
property :topic, as: 'topic'
end
end
end
end
end

View File

@ -0,0 +1,661 @@
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module RealtimebiddingV1
# Real-time Bidding API
#
# Allows external bidders to manage their RTB integration with Google. This
# includes managing bidder endpoints, QPS quotas, configuring what ad inventory
# to receive via pretargeting, submitting creatives for verification, and
# accessing creative metadata such as approval status.
#
# @example
# require 'google/apis/realtimebidding_v1'
#
# Realtimebidding = Google::Apis::RealtimebiddingV1 # Alias the module
# service = Realtimebidding::RealtimeBiddingService.new
#
# @see https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/
class RealtimeBiddingService < Google::Apis::Core::BaseService
# @return [String]
# API key. Your API key identifies your project and provides you with API access,
# quota, and reports. Required unless you provide an OAuth 2.0 token.
attr_accessor :key
# @return [String]
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
attr_accessor :quota_user
def initialize
super('https://realtimebidding.googleapis.com/', '')
@batch_path = 'batch'
end
# Lists creatives.
# @param [String] parent
# Required. Name of the parent buyer that owns the creatives.
# The pattern for this resource is either `buyers/`buyerAccountId`` or
# `bidders/`bidderAccountId``.
# For `buyers/`buyerAccountId``, the `buyerAccountId` can be one of the
# following:
# 1. The ID of the buyer that is accessing their own creatives.
# 2. The ID of the child seat buyer under a bidder account.
# So for listing creatives pertaining to the child seat buyer (`456`)
# under bidder account (`123`), you would use the pattern: `buyers/456`.
# 3. The ID of the bidder itself.
# So for listing creatives pertaining to bidder (`123`),
# you would use `buyers/123`.
# If you want to access all creatives pertaining to both the bidder and all
# of its child seat accounts, you would use `bidders/`bidderAccountId``,
# e.g., for all creatives pertaining to bidder (`123`), use `bidders/123`.
# @param [String] filter
# Query string to filter creatives. If no filter is specified,
# all active creatives will be returned.
# Example: 'accountId=12345 AND (dealsStatus:DISAPPROVED AND
# disapprovalReason:UNACCEPTABLE_CONTENT) OR
# declaredAttributes:IS_COOKIE_TARGETED'
# @param [Fixnum] page_size
# Requested page size. The server may return fewer creatives than requested
# (due to timeout constraint) even if more are available via another call.
# If unspecified, server will pick an appropriate default.
# Acceptable values are 1 to 1000, inclusive.
# @param [String] page_token
# A token identifying a page of results the server should return.
# Typically, this is the value of
# ListCreativesResponse.nextPageToken
# returned from the previous call to the 'ListCreatives' method.
# @param [String] view
# Controls the amount of information included in the response.
# By default only
# creativeServingDecision
# is included. To retrieve the entire creative
# resource (including the declared
# fields and the creative content) specify the view as "FULL".
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::RealtimebiddingV1::ListCreativesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::RealtimebiddingV1::ListCreativesResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_bidder_creatives(parent, filter: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/creatives', options)
command.response_representation = Google::Apis::RealtimebiddingV1::ListCreativesResponse::Representation
command.response_class = Google::Apis::RealtimebiddingV1::ListCreativesResponse
command.params['parent'] = parent unless parent.nil?
command.query['filter'] = filter unless filter.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['view'] = view unless view.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Watches all creatives pertaining to a bidder. It is sufficient to invoke
# this endpoint once per bidder. A Pub/Sub topic will be created and
# notifications will be pushed to the topic when any of the bidder's
# creatives change status. All of the bidder's service accounts will have
# access to read from the topic.
# Subsequent invocations of this method will return the existing
# Pub/Sub configuration.
# @param [String] parent
# Required. To watch all creatives pertaining to the bidder and all its child
# seat
# accounts, the bidder must follow the pattern `bidders/`bidderAccountId``.
# @param [Google::Apis::RealtimebiddingV1::WatchCreativesRequest] watch_creatives_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::RealtimebiddingV1::WatchCreativesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::RealtimebiddingV1::WatchCreativesResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def watch_creatives(parent, watch_creatives_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}/creatives:watch', options)
command.request_representation = Google::Apis::RealtimebiddingV1::WatchCreativesRequest::Representation
command.request_object = watch_creatives_request_object
command.response_representation = Google::Apis::RealtimebiddingV1::WatchCreativesResponse::Representation
command.response_class = Google::Apis::RealtimebiddingV1::WatchCreativesResponse
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets remarketing tag for a buyer. A remarketing tag is a piece of
# JavaScript code that can be placed on a web page. When a user
# visits a page containing a remarketing tag, Google adds the user to a user
# list.
# @param [String] name
# Required. To fetch remarketing tag for an account, name must follow the
# pattern
# `buyers/`accountId`` where ``accountId``
# represents ID of a buyer that owns the remarketing tag. For a
# bidder accessing remarketing tag on behalf of a child seat buyer,
# ``accountId`` should represent the ID of the child seat buyer.
# To fetch remarketing tag for a specific user list, name
# must follow the pattern
# `buyers/`accountId`/userLists/`userListId``. See
# UserList.name.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::RealtimebiddingV1::GetRemarketingTagResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::RealtimebiddingV1::GetRemarketingTagResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_buyer_remarketing_tag(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}:getRemarketingTag', options)
command.response_representation = Google::Apis::RealtimebiddingV1::GetRemarketingTagResponse::Representation
command.response_class = Google::Apis::RealtimebiddingV1::GetRemarketingTagResponse
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates a creative.
# @param [String] parent
# Required. The name of the parent buyer that the new creative belongs to that
# must
# follow the pattern `buyers/`buyerAccountId``, where ``buyerAccountId``
# represents the account ID of the buyer who owns a creative. For a bidder
# accessing creatives on behalf of a child seat buyer, ``buyerAccountId``
# should represent the account ID of the child seat buyer.
# @param [Google::Apis::RealtimebiddingV1::Creative] creative_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::RealtimebiddingV1::Creative] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::RealtimebiddingV1::Creative]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_buyer_creative(parent, creative_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}/creatives', options)
command.request_representation = Google::Apis::RealtimebiddingV1::Creative::Representation
command.request_object = creative_object
command.response_representation = Google::Apis::RealtimebiddingV1::Creative::Representation
command.response_class = Google::Apis::RealtimebiddingV1::Creative
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets a creative.
# @param [String] name
# Required. Name of the creative to retrieve. See
# creative.name.
# @param [String] view
# Controls the amount of information included in the response.
# By default only
# creativeServingDecision
# is included. To retrieve the entire creative
# resource (including the declared
# fields and the creative content) specify the view as "FULL".
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::RealtimebiddingV1::Creative] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::RealtimebiddingV1::Creative]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_buyer_creative(name, view: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::RealtimebiddingV1::Creative::Representation
command.response_class = Google::Apis::RealtimebiddingV1::Creative
command.params['name'] = name unless name.nil?
command.query['view'] = view unless view.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists creatives.
# @param [String] parent
# Required. Name of the parent buyer that owns the creatives.
# The pattern for this resource is either `buyers/`buyerAccountId`` or
# `bidders/`bidderAccountId``.
# For `buyers/`buyerAccountId``, the `buyerAccountId` can be one of the
# following:
# 1. The ID of the buyer that is accessing their own creatives.
# 2. The ID of the child seat buyer under a bidder account.
# So for listing creatives pertaining to the child seat buyer (`456`)
# under bidder account (`123`), you would use the pattern: `buyers/456`.
# 3. The ID of the bidder itself.
# So for listing creatives pertaining to bidder (`123`),
# you would use `buyers/123`.
# If you want to access all creatives pertaining to both the bidder and all
# of its child seat accounts, you would use `bidders/`bidderAccountId``,
# e.g., for all creatives pertaining to bidder (`123`), use `bidders/123`.
# @param [String] filter
# Query string to filter creatives. If no filter is specified,
# all active creatives will be returned.
# Example: 'accountId=12345 AND (dealsStatus:DISAPPROVED AND
# disapprovalReason:UNACCEPTABLE_CONTENT) OR
# declaredAttributes:IS_COOKIE_TARGETED'
# @param [Fixnum] page_size
# Requested page size. The server may return fewer creatives than requested
# (due to timeout constraint) even if more are available via another call.
# If unspecified, server will pick an appropriate default.
# Acceptable values are 1 to 1000, inclusive.
# @param [String] page_token
# A token identifying a page of results the server should return.
# Typically, this is the value of
# ListCreativesResponse.nextPageToken
# returned from the previous call to the 'ListCreatives' method.
# @param [String] view
# Controls the amount of information included in the response.
# By default only
# creativeServingDecision
# is included. To retrieve the entire creative
# resource (including the declared
# fields and the creative content) specify the view as "FULL".
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::RealtimebiddingV1::ListCreativesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::RealtimebiddingV1::ListCreativesResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_buyer_creatives(parent, filter: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/creatives', options)
command.response_representation = Google::Apis::RealtimebiddingV1::ListCreativesResponse::Representation
command.response_class = Google::Apis::RealtimebiddingV1::ListCreativesResponse
command.params['parent'] = parent unless parent.nil?
command.query['filter'] = filter unless filter.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['view'] = view unless view.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates a creative.
# @param [String] name
# Name of the creative to update. See
# creative.name.
# @param [Google::Apis::RealtimebiddingV1::Creative] creative_object
# @param [String] update_mask
# Field mask to use for partial in-place updates.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::RealtimebiddingV1::Creative] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::RealtimebiddingV1::Creative]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def patch_buyer_creative(name, creative_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:patch, 'v1/{+name}', options)
command.request_representation = Google::Apis::RealtimebiddingV1::Creative::Representation
command.request_object = creative_object
command.response_representation = Google::Apis::RealtimebiddingV1::Creative::Representation
command.response_class = Google::Apis::RealtimebiddingV1::Creative
command.params['name'] = name unless name.nil?
command.query['updateMask'] = update_mask unless update_mask.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Change the status of a user list to CLOSED. This prevents new users from
# being added to the user list.
# @param [String] name
# Required. The name of the user list to close.
# See UserList.name
# @param [Google::Apis::RealtimebiddingV1::CloseUserListRequest] close_user_list_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::RealtimebiddingV1::UserList] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::RealtimebiddingV1::UserList]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def close_user_list(name, close_user_list_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+name}:close', options)
command.request_representation = Google::Apis::RealtimebiddingV1::CloseUserListRequest::Representation
command.request_object = close_user_list_request_object
command.response_representation = Google::Apis::RealtimebiddingV1::UserList::Representation
command.response_class = Google::Apis::RealtimebiddingV1::UserList
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Create a new user list.
# @param [String] parent
# Required. The name of the parent buyer of the user list to be retrieved that
# must follow the pattern `buyers/`buyerAccountId``, where ``buyerAccountId``
# represents the account ID of the buyer who owns user lists. For a bidder
# accessing user lists on behalf of a child seat buyer , ``buyerAccountId``
# should represent the account ID of the child seat buyer.
# @param [Google::Apis::RealtimebiddingV1::UserList] user_list_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::RealtimebiddingV1::UserList] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::RealtimebiddingV1::UserList]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_buyer_user_list(parent, user_list_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}/userLists', options)
command.request_representation = Google::Apis::RealtimebiddingV1::UserList::Representation
command.request_object = user_list_object
command.response_representation = Google::Apis::RealtimebiddingV1::UserList::Representation
command.response_class = Google::Apis::RealtimebiddingV1::UserList
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets a user list by its name.
# @param [String] name
# Required. The name of the user list to be retrieved. See
# UserList.name.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::RealtimebiddingV1::UserList] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::RealtimebiddingV1::UserList]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_buyer_user_list(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::RealtimebiddingV1::UserList::Representation
command.response_class = Google::Apis::RealtimebiddingV1::UserList
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets remarketing tag for a buyer. A remarketing tag is a piece of
# JavaScript code that can be placed on a web page. When a user
# visits a page containing a remarketing tag, Google adds the user to a user
# list.
# @param [String] name
# Required. To fetch remarketing tag for an account, name must follow the
# pattern
# `buyers/`accountId`` where ``accountId``
# represents ID of a buyer that owns the remarketing tag. For a
# bidder accessing remarketing tag on behalf of a child seat buyer,
# ``accountId`` should represent the ID of the child seat buyer.
# To fetch remarketing tag for a specific user list, name
# must follow the pattern
# `buyers/`accountId`/userLists/`userListId``. See
# UserList.name.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::RealtimebiddingV1::GetRemarketingTagResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::RealtimebiddingV1::GetRemarketingTagResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_buyer_user_list_remarketing_tag(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}:getRemarketingTag', options)
command.response_representation = Google::Apis::RealtimebiddingV1::GetRemarketingTagResponse::Representation
command.response_class = Google::Apis::RealtimebiddingV1::GetRemarketingTagResponse
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists the user lists visible to the current user.
# @param [String] parent
# Required. The name of the parent buyer for the user lists to be returned that
# must
# follow the pattern `buyers/`buyerAccountId``, where ``buyerAccountId``
# represents the account ID of the buyer who owns user lists. For a bidder
# accessing user lists on behalf of a child seat buyer , ``buyerAccountId``
# should represent the account ID of the child seat buyer.
# @param [Fixnum] page_size
# The number of results to return per page.
# @param [String] page_token
# Continuation page token (as received from a previous response).
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::RealtimebiddingV1::ListUserListsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::RealtimebiddingV1::ListUserListsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_buyer_user_lists(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/userLists', options)
command.response_representation = Google::Apis::RealtimebiddingV1::ListUserListsResponse::Representation
command.response_class = Google::Apis::RealtimebiddingV1::ListUserListsResponse
command.params['parent'] = parent unless parent.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Change the status of a user list to OPEN. This allows new users to be added
# to the user list.
# @param [String] name
# Required. The name of the user list to open.
# See UserList.name
# @param [Google::Apis::RealtimebiddingV1::OpenUserListRequest] open_user_list_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::RealtimebiddingV1::UserList] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::RealtimebiddingV1::UserList]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def open_user_list(name, open_user_list_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+name}:open', options)
command.request_representation = Google::Apis::RealtimebiddingV1::OpenUserListRequest::Representation
command.request_object = open_user_list_request_object
command.response_representation = Google::Apis::RealtimebiddingV1::UserList::Representation
command.response_class = Google::Apis::RealtimebiddingV1::UserList
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Update the given user list. Only user lists with URLRestrictions can be
# updated.
# @param [String] name
# Output only. Name of the user list that must follow the pattern
# `buyers/`buyer`/userLists/`user_list``, where ``buyer`` represents
# the account ID of the buyer who owns the user list. For a bidder accessing
# user lists on behalf of a child seat buyer, ``buyer`` represents
# the account ID of the child seat buyer. ``user_list`` is an int64
# identifier assigned by Google to uniquely identify a user list.
# @param [Google::Apis::RealtimebiddingV1::UserList] user_list_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::RealtimebiddingV1::UserList] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::RealtimebiddingV1::UserList]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def update_buyer_user_list(name, user_list_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:put, 'v1/{+name}', options)
command.request_representation = Google::Apis::RealtimebiddingV1::UserList::Representation
command.request_object = user_list_object
command.response_representation = Google::Apis::RealtimebiddingV1::UserList::Representation
command.response_class = Google::Apis::RealtimebiddingV1::UserList
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
protected
def apply_command_defaults(command)
command.query['key'] = key unless key.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
end
end
end
end
end

View File

@ -26,7 +26,7 @@ module Google
# @see https://cloud.google.com/spanner/ # @see https://cloud.google.com/spanner/
module SpannerV1 module SpannerV1
VERSION = 'V1' VERSION = 'V1'
REVISION = '20200526' REVISION = '20200616'
# View and manage your data across Google Cloud Platform services # View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

View File

@ -190,10 +190,11 @@ module Google
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# # Transactions # # Transactions
# Each session can have at most one active transaction at a time. After the # Each session can have at most one active transaction at a time (note that
# active transaction is completed, the session can immediately be # standalone reads and queries use a transaction internally and do count
# re-used for the next transaction. It is not necessary to create a # towards the one transaction limit). After the active transaction is
# new session for each transaction. # completed, the session can immediately be re-used for the next transaction.
# It is not necessary to create a new session for each transaction.
# # Transaction Modes # # Transaction Modes
# Cloud Spanner supports three transaction modes: # Cloud Spanner supports three transaction modes:
# 1. Locking read-write. This type of transaction is the only way # 1. Locking read-write. This type of transaction is the only way
@ -555,10 +556,11 @@ module Google
attr_accessor :mutations attr_accessor :mutations
# # Transactions # # Transactions
# Each session can have at most one active transaction at a time. After the # Each session can have at most one active transaction at a time (note that
# active transaction is completed, the session can immediately be # standalone reads and queries use a transaction internally and do count
# re-used for the next transaction. It is not necessary to create a # towards the one transaction limit). After the active transaction is
# new session for each transaction. # completed, the session can immediately be re-used for the next transaction.
# It is not necessary to create a new session for each transaction.
# # Transaction Modes # # Transaction Modes
# Cloud Spanner supports three transaction modes: # Cloud Spanner supports three transaction modes:
# 1. Locking read-write. This type of transaction is the only way # 1. Locking read-write. This type of transaction is the only way
@ -3519,10 +3521,11 @@ module Google
end end
# # Transactions # # Transactions
# Each session can have at most one active transaction at a time. After the # Each session can have at most one active transaction at a time (note that
# active transaction is completed, the session can immediately be # standalone reads and queries use a transaction internally and do count
# re-used for the next transaction. It is not necessary to create a # towards the one transaction limit). After the active transaction is
# new session for each transaction. # completed, the session can immediately be re-used for the next transaction.
# It is not necessary to create a new session for each transaction.
# # Transaction Modes # # Transaction Modes
# Cloud Spanner supports three transaction modes: # Cloud Spanner supports three transaction modes:
# 1. Locking read-write. This type of transaction is the only way # 1. Locking read-write. This type of transaction is the only way
@ -3772,10 +3775,11 @@ module Google
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# # Transactions # # Transactions
# Each session can have at most one active transaction at a time. After the # Each session can have at most one active transaction at a time (note that
# active transaction is completed, the session can immediately be # standalone reads and queries use a transaction internally and do count
# re-used for the next transaction. It is not necessary to create a # towards the one transaction limit). After the active transaction is
# new session for each transaction. # completed, the session can immediately be re-used for the next transaction.
# It is not necessary to create a new session for each transaction.
# # Transaction Modes # # Transaction Modes
# Cloud Spanner supports three transaction modes: # Cloud Spanner supports three transaction modes:
# 1. Locking read-write. This type of transaction is the only way # 1. Locking read-write. This type of transaction is the only way
@ -3997,10 +4001,11 @@ module Google
attr_accessor :id attr_accessor :id
# # Transactions # # Transactions
# Each session can have at most one active transaction at a time. After the # Each session can have at most one active transaction at a time (note that
# active transaction is completed, the session can immediately be # standalone reads and queries use a transaction internally and do count
# re-used for the next transaction. It is not necessary to create a # towards the one transaction limit). After the active transaction is
# new session for each transaction. # completed, the session can immediately be re-used for the next transaction.
# It is not necessary to create a new session for each transaction.
# # Transaction Modes # # Transaction Modes
# Cloud Spanner supports three transaction modes: # Cloud Spanner supports three transaction modes:
# 1. Locking read-write. This type of transaction is the only way # 1. Locking read-write. This type of transaction is the only way

View File

@ -1299,6 +1299,8 @@ module Google
# be queried using the Operations API. # be queried using the Operations API.
# @param [String] database # @param [String] database
# Required. The database whose schema we wish to get. # Required. The database whose schema we wish to get.
# Values are of the form
# `projects/<project>/instances/<instance>/databases/<database>`
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
# @param [String] quota_user # @param [String] quota_user

View File

@ -25,7 +25,7 @@ module Google
# @see https://cloud.google.com/speech-to-text/docs/quickstart-protocol # @see https://cloud.google.com/speech-to-text/docs/quickstart-protocol
module SpeechV1 module SpeechV1
VERSION = 'V1' VERSION = 'V1'
REVISION = '20200409' REVISION = '20200617'
# View and manage your data across Google Cloud Platform services # View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

View File

@ -25,7 +25,7 @@ module Google
# @see https://cloud.google.com/speech-to-text/docs/quickstart-protocol # @see https://cloud.google.com/speech-to-text/docs/quickstart-protocol
module SpeechV1p1beta1 module SpeechV1p1beta1
VERSION = 'V1p1beta1' VERSION = 'V1p1beta1'
REVISION = '20200502' REVISION = '20200617'
# View and manage your data across Google Cloud Platform services # View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'