From b7da348cd1b1b19f5df0801763545a061792a90a Mon Sep 17 00:00:00 2001 From: Google APIs Date: Wed, 24 Jun 2020 00:38:30 +0000 Subject: [PATCH] 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 --- generated/google/apis/cloudbuild_v1.rb | 2 +- .../google/apis/cloudbuild_v1/service.rb | 42 - generated/google/apis/cloudbuild_v1alpha1.rb | 2 +- generated/google/apis/cloudbuild_v1alpha2.rb | 2 +- generated/google/apis/cloudfunctions_v1.rb | 2 +- .../google/apis/cloudfunctions_v1/classes.rb | 12 +- generated/google/apis/dialogflow_v2.rb | 2 +- .../google/apis/dialogflow_v2/classes.rb | 214 ++- .../apis/dialogflow_v2/representations.rb | 77 + generated/google/apis/dialogflow_v2beta1.rb | 2 +- .../google/apis/dialogflow_v2beta1/classes.rb | 214 ++- .../dialogflow_v2beta1/representations.rb | 77 + generated/google/apis/displayvideo_v1.rb | 2 +- .../google/apis/displayvideo_v1/classes.rb | 107 +- .../apis/displayvideo_v1/representations.rb | 11 + .../google/apis/displayvideo_v1/service.rb | 79 +- generated/google/apis/documentai_v1beta2.rb | 2 +- generated/google/apis/doubleclicksearch_v2.rb | 8 +- .../apis/doubleclicksearch_v2/classes.rb | 238 +-- .../doubleclicksearch_v2/representations.rb | 10 +- .../apis/doubleclicksearch_v2/service.rb | 125 +- generated/google/apis/fcm_v1.rb | 2 +- generated/google/apis/healthcare_v1.rb | 2 +- .../google/apis/healthcare_v1/classes.rb | 12 +- generated/google/apis/healthcare_v1beta1.rb | 2 +- .../google/apis/healthcare_v1beta1/classes.rb | 12 +- generated/google/apis/monitoring_v3.rb | 2 +- .../google/apis/monitoring_v3/classes.rb | 4 +- generated/google/apis/playablelocations_v3.rb | 31 + .../apis/playablelocations_v3/classes.rb | 633 ++++++++ .../playablelocations_v3/representations.rb | 273 ++++ .../apis/playablelocations_v3/service.rb | 157 ++ generated/google/apis/realtimebidding_v1.rb | 40 + .../google/apis/realtimebidding_v1/classes.rb | 1436 +++++++++++++++++ .../realtimebidding_v1/representations.rb | 565 +++++++ .../google/apis/realtimebidding_v1/service.rb | 661 ++++++++ generated/google/apis/spanner_v1.rb | 2 +- generated/google/apis/spanner_v1/classes.rb | 45 +- generated/google/apis/spanner_v1/service.rb | 2 + generated/google/apis/speech_v1.rb | 2 +- generated/google/apis/speech_v1p1beta1.rb | 2 +- 41 files changed, 4776 insertions(+), 339 deletions(-) create mode 100644 generated/google/apis/playablelocations_v3.rb create mode 100644 generated/google/apis/playablelocations_v3/classes.rb create mode 100644 generated/google/apis/playablelocations_v3/representations.rb create mode 100644 generated/google/apis/playablelocations_v3/service.rb create mode 100644 generated/google/apis/realtimebidding_v1.rb create mode 100644 generated/google/apis/realtimebidding_v1/classes.rb create mode 100644 generated/google/apis/realtimebidding_v1/representations.rb create mode 100644 generated/google/apis/realtimebidding_v1/service.rb diff --git a/generated/google/apis/cloudbuild_v1.rb b/generated/google/apis/cloudbuild_v1.rb index db75f9eb5..7201ceb25 100644 --- a/generated/google/apis/cloudbuild_v1.rb +++ b/generated/google/apis/cloudbuild_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/cloud-build/docs/ module CloudbuildV1 VERSION = 'V1' - REVISION = '20200606' + REVISION = '20200619' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudbuild_v1/service.rb b/generated/google/apis/cloudbuild_v1/service.rb index fd33ce11a..dbf7ca9e8 100644 --- a/generated/google/apis/cloudbuild_v1/service.rb +++ b/generated/google/apis/cloudbuild_v1/service.rb @@ -703,48 +703,6 @@ module Google command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) 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 diff --git a/generated/google/apis/cloudbuild_v1alpha1.rb b/generated/google/apis/cloudbuild_v1alpha1.rb index 78ea37ca0..2f46eb34a 100644 --- a/generated/google/apis/cloudbuild_v1alpha1.rb +++ b/generated/google/apis/cloudbuild_v1alpha1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/cloud-build/docs/ module CloudbuildV1alpha1 VERSION = 'V1alpha1' - REVISION = '20200606' + REVISION = '20200619' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudbuild_v1alpha2.rb b/generated/google/apis/cloudbuild_v1alpha2.rb index 98a402c3d..9daed183d 100644 --- a/generated/google/apis/cloudbuild_v1alpha2.rb +++ b/generated/google/apis/cloudbuild_v1alpha2.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/cloud-build/docs/ module CloudbuildV1alpha2 VERSION = 'V1alpha2' - REVISION = '20200606' + REVISION = '20200619' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudfunctions_v1.rb b/generated/google/apis/cloudfunctions_v1.rb index 06696f352..3e1246196 100644 --- a/generated/google/apis/cloudfunctions_v1.rb +++ b/generated/google/apis/cloudfunctions_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/functions module CloudfunctionsV1 VERSION = 'V1' - REVISION = '20200504' + REVISION = '20200610' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudfunctions_v1/classes.rb b/generated/google/apis/cloudfunctions_v1/classes.rb index c009ed802..d75abe7c0 100644 --- a/generated/google/apis/cloudfunctions_v1/classes.rb +++ b/generated/google/apis/cloudfunctions_v1/classes.rb @@ -34,7 +34,7 @@ module Google # ` # "audit_configs": [ # ` - # "service": "allServices" + # "service": "allServices", # "audit_log_configs": [ # ` # "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": [ # ` - # "log_type": "DATA_READ", + # "log_type": "DATA_READ" # `, # ` # "log_type": "DATA_WRITE", @@ -106,7 +106,7 @@ module Google # ] # `, # ` - # "log_type": "DATA_WRITE", + # "log_type": "DATA_WRITE" # ` # ] # ` diff --git a/generated/google/apis/dialogflow_v2.rb b/generated/google/apis/dialogflow_v2.rb index 7ad765044..279a2d270 100644 --- a/generated/google/apis/dialogflow_v2.rb +++ b/generated/google/apis/dialogflow_v2.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/dialogflow/ module DialogflowV2 VERSION = 'V2' - REVISION = '20200615' + REVISION = '20200622' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/dialogflow_v2/classes.rb b/generated/google/apis/dialogflow_v2/classes.rb index 67da9eb45..d1edd4f7a 100644 --- a/generated/google/apis/dialogflow_v2/classes.rb +++ b/generated/google/apis/dialogflow_v2/classes.rb @@ -190,6 +190,13 @@ module Google # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess] 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. # 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 @@ -204,11 +211,41 @@ module Google # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff] 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. # Corresponds to the JSON property `payload` # @return [Hash] 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. # Corresponds to the JSON property `text` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageText] @@ -221,8 +258,12 @@ module Google # Update properties of this object def update!(**args) @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) + @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) + @play_audio = args[:play_audio] if args.key?(:play_audio) @text = args[:text] if args.key?(:text) end end @@ -257,6 +298,21 @@ module Google 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. # 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 @@ -286,11 +342,140 @@ module Google 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] + 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] + 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. class GoogleCloudDialogflowCxV3beta1ResponseMessageText 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` # @return [Array] attr_accessor :text @@ -301,6 +486,7 @@ module Google # Update properties of this object def update!(**args) + @allow_playback_interruption = args[:allow_playback_interruption] if args.key?(:allow_playback_interruption) @text = args[:text] if args.key?(:text) end end @@ -4721,9 +4907,6 @@ module Google # Carousel Rich Business Messaging (RBM) rich card. # Rich cards allow you to respond to users with more vivid content, e.g. # 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, # please use RbmStandaloneCard instead. # Corresponds to the JSON property `rbmCarouselRichCard` @@ -4733,9 +4916,6 @@ module Google # Standalone Rich Business Messaging (RBM) rich card. # Rich cards allow you to respond to users with more vivid content, e.g. # 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 # carousel cards will give you less control over the card layout. # Corresponds to the JSON property `rbmStandaloneRichCard` @@ -5443,7 +5623,7 @@ module Google attr_accessor :file_uri # 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 # customizable, and this field is ignored. # Corresponds to the JSON property `height` @@ -5474,9 +5654,6 @@ module Google # Carousel Rich Business Messaging (RBM) rich card. # Rich cards allow you to respond to users with more vivid content, e.g. # 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, # please use RbmStandaloneCard instead. class GoogleCloudDialogflowV2beta1IntentMessageRbmCarouselCard @@ -5507,9 +5684,6 @@ module Google # Standalone Rich Business Messaging (RBM) rich card. # Rich cards allow you to respond to users with more vivid content, e.g. # 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 # carousel cards will give you less control over the card layout. class GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCard @@ -5549,13 +5723,13 @@ module Google include Google::Apis::Core::Hashable # 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` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionDial] attr_accessor :dial # 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 # opened instead, and its icon will be used in the suggested action UI. # Corresponds to the JSON property `openUrl` @@ -5570,7 +5744,7 @@ module Google attr_accessor :postback_data # 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` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionShareLocation] attr_accessor :share_location @@ -5595,7 +5769,7 @@ module Google end # 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 include Google::Apis::Core::Hashable @@ -5618,7 +5792,7 @@ module Google end # 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 # opened instead, and its icon will be used in the suggested action UI. class GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionOpenUri @@ -5640,7 +5814,7 @@ module Google end # 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 include Google::Apis::Core::Hashable diff --git a/generated/google/apis/dialogflow_v2/representations.rb b/generated/google/apis/dialogflow_v2/representations.rb index d0a01a0dd..e3e47b82d 100644 --- a/generated/google/apis/dialogflow_v2/representations.rb +++ b/generated/google/apis/dialogflow_v2/representations.rb @@ -58,12 +58,42 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteraction + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport 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 Representation < Google::Apis::Core::JsonRepresentation; end @@ -1113,9 +1143,17 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation 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 :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' + 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 end @@ -1128,6 +1166,12 @@ module Google end end + class GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteraction + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + class GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1135,9 +1179,42 @@ module Google 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 # @private class Representation < Google::Apis::Core::JsonRepresentation + property :allow_playback_interruption, as: 'allowPlaybackInterruption' collection :text, as: 'text' end end diff --git a/generated/google/apis/dialogflow_v2beta1.rb b/generated/google/apis/dialogflow_v2beta1.rb index 64d8a430d..66991ac91 100644 --- a/generated/google/apis/dialogflow_v2beta1.rb +++ b/generated/google/apis/dialogflow_v2beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/dialogflow/ module DialogflowV2beta1 VERSION = 'V2beta1' - REVISION = '20200615' + REVISION = '20200622' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/dialogflow_v2beta1/classes.rb b/generated/google/apis/dialogflow_v2beta1/classes.rb index e638a3958..b769e851d 100644 --- a/generated/google/apis/dialogflow_v2beta1/classes.rb +++ b/generated/google/apis/dialogflow_v2beta1/classes.rb @@ -190,6 +190,13 @@ module Google # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess] 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. # 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 @@ -204,11 +211,41 @@ module Google # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff] 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. # Corresponds to the JSON property `payload` # @return [Hash] 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. # Corresponds to the JSON property `text` # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageText] @@ -221,8 +258,12 @@ module Google # Update properties of this object def update!(**args) @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) + @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) + @play_audio = args[:play_audio] if args.key?(:play_audio) @text = args[:text] if args.key?(:text) end end @@ -257,6 +298,21 @@ module Google 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. # 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 @@ -286,11 +342,140 @@ module Google 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] + 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] + 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. class GoogleCloudDialogflowCxV3beta1ResponseMessageText 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` # @return [Array] attr_accessor :text @@ -301,6 +486,7 @@ module Google # Update properties of this object def update!(**args) + @allow_playback_interruption = args[:allow_playback_interruption] if args.key?(:allow_playback_interruption) @text = args[:text] if args.key?(:text) end end @@ -4287,9 +4473,6 @@ module Google # Carousel Rich Business Messaging (RBM) rich card. # Rich cards allow you to respond to users with more vivid content, e.g. # 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, # please use RbmStandaloneCard instead. # Corresponds to the JSON property `rbmCarouselRichCard` @@ -4299,9 +4482,6 @@ module Google # Standalone Rich Business Messaging (RBM) rich card. # Rich cards allow you to respond to users with more vivid content, e.g. # 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 # carousel cards will give you less control over the card layout. # Corresponds to the JSON property `rbmStandaloneRichCard` @@ -5009,7 +5189,7 @@ module Google attr_accessor :file_uri # 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 # customizable, and this field is ignored. # Corresponds to the JSON property `height` @@ -5040,9 +5220,6 @@ module Google # Carousel Rich Business Messaging (RBM) rich card. # Rich cards allow you to respond to users with more vivid content, e.g. # 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, # please use RbmStandaloneCard instead. class GoogleCloudDialogflowV2beta1IntentMessageRbmCarouselCard @@ -5073,9 +5250,6 @@ module Google # Standalone Rich Business Messaging (RBM) rich card. # Rich cards allow you to respond to users with more vivid content, e.g. # 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 # carousel cards will give you less control over the card layout. class GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCard @@ -5115,13 +5289,13 @@ module Google include Google::Apis::Core::Hashable # 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` # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionDial] attr_accessor :dial # 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 # opened instead, and its icon will be used in the suggested action UI. # Corresponds to the JSON property `openUrl` @@ -5136,7 +5310,7 @@ module Google attr_accessor :postback_data # 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` # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionShareLocation] attr_accessor :share_location @@ -5161,7 +5335,7 @@ module Google end # 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 include Google::Apis::Core::Hashable @@ -5184,7 +5358,7 @@ module Google end # 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 # opened instead, and its icon will be used in the suggested action UI. class GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionOpenUri @@ -5206,7 +5380,7 @@ module Google end # 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 include Google::Apis::Core::Hashable diff --git a/generated/google/apis/dialogflow_v2beta1/representations.rb b/generated/google/apis/dialogflow_v2beta1/representations.rb index 36e05b848..d6f7a7e26 100644 --- a/generated/google/apis/dialogflow_v2beta1/representations.rb +++ b/generated/google/apis/dialogflow_v2beta1/representations.rb @@ -58,12 +58,42 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteraction + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport 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 Representation < Google::Apis::Core::JsonRepresentation; end @@ -1161,9 +1191,17 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation 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 :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' + 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 end @@ -1176,6 +1214,12 @@ module Google end end + class GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteraction + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + class GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1183,9 +1227,42 @@ module Google 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 # @private class Representation < Google::Apis::Core::JsonRepresentation + property :allow_playback_interruption, as: 'allowPlaybackInterruption' collection :text, as: 'text' end end diff --git a/generated/google/apis/displayvideo_v1.rb b/generated/google/apis/displayvideo_v1.rb index 877a38554..a7ee412df 100644 --- a/generated/google/apis/displayvideo_v1.rb +++ b/generated/google/apis/displayvideo_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/display-video/ module DisplayvideoV1 VERSION = 'V1' - REVISION = '20200611' + REVISION = '20200623' # Create, see, edit, and permanently delete your Display & Video 360 entities and reports AUTH_DISPLAY_VIDEO = 'https://www.googleapis.com/auth/display-video' diff --git a/generated/google/apis/displayvideo_v1/classes.rb b/generated/google/apis/displayvideo_v1/classes.rb index edc34cab0..edb2c9eba 100644 --- a/generated/google/apis/displayvideo_v1/classes.rb +++ b/generated/google/apis/displayvideo_v1/classes.rb @@ -704,8 +704,7 @@ module Google end # 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 - # Insertion Order. + # option for an entity with targeting settings. class AssignedTargetingOption include Google::Apis::Core::Hashable @@ -3810,6 +3809,71 @@ module Google class FirstAndThirdPartyAudience 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. # . # Corresponds to the JSON property `displayName` @@ -3829,21 +3893,60 @@ module Google # @return [String] 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. # Corresponds to the JSON property `name` # @return [String] 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) update!(**args) end # Update properties of this object 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) @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) + @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) + @youtube_audience_size = args[:youtube_audience_size] if args.key?(:youtube_audience_size) end end diff --git a/generated/google/apis/displayvideo_v1/representations.rb b/generated/google/apis/displayvideo_v1/representations.rb index 2151017d2..44613bc0c 100644 --- a/generated/google/apis/displayvideo_v1/representations.rb +++ b/generated/google/apis/displayvideo_v1/representations.rb @@ -2202,10 +2202,21 @@ module Google class FirstAndThirdPartyAudience # @private 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 :first_and_third_party_audience_id, :numeric_string => true, as: 'firstAndThirdPartyAudienceId' 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 :youtube_audience_size, :numeric_string => true, as: 'youtubeAudienceSize' end end diff --git a/generated/google/apis/displayvideo_v1/service.rb b/generated/google/apis/displayvideo_v1/service.rb index 1e0f62995..9692675dd 100644 --- a/generated/google/apis/displayvideo_v1/service.rb +++ b/generated/google/apis/displayvideo_v1/service.rb @@ -615,6 +615,42 @@ module Google execute_or_queue_command(command, &block) 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. # Returns the updated inventory source if successful. # Gets a channel for a partner or advertiser. @@ -1079,6 +1115,7 @@ module Google # - `approvalStatus` # - `exchangeReviewStatus` # - `dynamic` + # - `creativeId` # * The operator must be `HAS (:)` for the following fields: # - `lineItemIds` # * For `entityStatus`, `minDuration`, `maxDuration`, and `dynamic` there may @@ -1090,6 +1127,8 @@ module Google # `"`duration`s"`. Only seconds are supported with millisecond granularity. # * There may be multiple `lineItemIds` restrictions in order to search # against multiple possible line item IDs. + # * There may be multiple `creativeId` restrictions in order to search + # against multiple possible creative IDs. # Examples: # * All native creatives: `creativeType="CREATIVE_TYPE_NATIVE"` # * All active creatives with 300x400 or 50x100 dimensions: @@ -1101,7 +1140,9 @@ module Google # (exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED" # OR exchangeReviewStatus="EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED")` # * 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. # @param [String] order_by # Field by which to sort the list. @@ -3951,6 +3992,42 @@ module Google execute_or_queue_command(command, &block) 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. # Returns the updated inventory source if successful. # Gets a channel for a partner or advertiser. diff --git a/generated/google/apis/documentai_v1beta2.rb b/generated/google/apis/documentai_v1beta2.rb index e0fcc7485..0ad3b6f51 100644 --- a/generated/google/apis/documentai_v1beta2.rb +++ b/generated/google/apis/documentai_v1beta2.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/document-ai/docs/ module DocumentaiV1beta2 VERSION = 'V1beta2' - REVISION = '20200612' + REVISION = '20200619' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/doubleclicksearch_v2.rb b/generated/google/apis/doubleclicksearch_v2.rb index 49b075a95..3281e6eeb 100644 --- a/generated/google/apis/doubleclicksearch_v2.rb +++ b/generated/google/apis/doubleclicksearch_v2.rb @@ -20,13 +20,13 @@ module Google module Apis # Search Ads 360 API # - # Reports and modifies your advertising data in DoubleClick Search (for example, - # campaigns, ad groups, keywords, and conversions). + # The Search Ads 360 API allows developers to automate uploading conversions and + # downloading reports from Search Ads 360. # - # @see https://developers.google.com/doubleclick-search/ + # @see https://developers.google.com/search-ads module DoubleclicksearchV2 VERSION = 'V2' - REVISION = '20200325' + REVISION = '20200616' # View and manage your advertising data in DoubleClick Search AUTH_DOUBLECLICKSEARCH = 'https://www.googleapis.com/auth/doubleclicksearch' diff --git a/generated/google/apis/doubleclicksearch_v2/classes.rb b/generated/google/apis/doubleclicksearch_v2/classes.rb index c03f0dd09..26e47563d 100644 --- a/generated/google/apis/doubleclicksearch_v2/classes.rb +++ b/generated/google/apis/doubleclicksearch_v2/classes.rb @@ -54,7 +54,7 @@ module Google attr_accessor :segmentation_name # The segmentation type that this availability is for (its default value is - # FLOODLIGHT). + # `FLOODLIGHT`). # Corresponds to the JSON property `segmentationType` # @return [String] attr_accessor :segmentation_type @@ -109,9 +109,9 @@ module Google # @return [Fixnum] attr_accessor :campaign_id - # Sales channel for the product. Acceptable values are: - # - "local": a physical store - # - "online": an online store + # Sales channel for the product. Acceptable values are:
    + #
  • "`local`": a physical store
  • "`online`": + # an online store
# Corresponds to the JSON property `channel` # @return [String] attr_accessor :channel @@ -121,12 +121,13 @@ module Google # @return [String] attr_accessor :click_id - # For offline conversions, advertisers provide this ID. Advertisers can specify - # any ID that is meaningful to them. Each conversion in a request must specify a - # unique ID, and the combination of ID and timestamp must be unique amongst all - # conversions within the advertiser. - # For online conversions, DS copies the dsConversionId or floodlightOrderId into - # this property depending on the advertiser's Floodlight instructions. + # For offline conversions, advertisers provide this ID. Advertisers can + # specify any ID that is meaningful to them. Each conversion in a request + # must specify a unique ID, and the combination of ID and timestamp must be + # unique amongst all conversions within the advertiser.
For online + # conversions, DS copies the `dsConversionId` or + # `floodlightOrderId` into this property depending on the + # advertiser's Floodlight instructions. # Corresponds to the JSON property `conversionId` # @return [String] attr_accessor :conversion_id @@ -138,7 +139,7 @@ module Google # The time at which the conversion took place, in epoch millis UTC. # Corresponds to the JSON property `conversionTimestamp` - # @return [Fixnum] + # @return [String] attr_accessor :conversion_timestamp # Available to advertisers only after contacting DoubleClick Search customer @@ -189,14 +190,14 @@ module Google # @return [String] attr_accessor :floodlight_order_id - # ID that DS generates and uses to uniquely identify the inventory account that - # contains the product. + # ID that DS generates and uses to uniquely identify the inventory account + # that contains the product. # Corresponds to the JSON property `inventoryAccountId` # @return [Fixnum] attr_accessor :inventory_account_id - # The country registered for the Merchant Center feed that contains the product. - # Use an ISO 3166 code to specify a country. + # The country registered for the Merchant Center feed that contains the + # product. Use an ISO 3166 code to specify a country. # Corresponds to the JSON property `productCountry` # @return [String] attr_accessor :product_country @@ -211,8 +212,8 @@ module Google # @return [String] attr_accessor :product_id - # The language registered for the Merchant Center feed that contains the product. - # Use an ISO 639 code to specify a language. + # The language registered for the Merchant Center feed that contains the + # product. Use an ISO 639 code to specify a language. # Corresponds to the JSON property `productLanguage` # @return [String] attr_accessor :product_language @@ -222,11 +223,11 @@ module Google # @return [Fixnum] attr_accessor :quantity_millis - # The revenue amount of this TRANSACTION conversion, in micros (value multiplied - # by 1000000, no decimal). For example, to specify a revenue value of "10" enter - # "10000000" (10 million) in your request. + # The revenue amount of this `TRANSACTION` conversion, in micros + # (value multiplied by 1000000, no decimal). For example, to specify a + # revenue value of "10" enter "10000000" (10 million) in your request. # Corresponds to the JSON property `revenueMicros` - # @return [Fixnum] + # @return [String] attr_accessor :revenue_micros # The numeric segmentation identifier (for example, DoubleClick Search @@ -241,28 +242,31 @@ module Google # @return [String] 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` # @return [String] attr_accessor :segmentation_type - # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state - # DELETED is deprecated. + # The state of the conversion, that is, either `ACTIVE` or + # `REMOVED`. Note: state DELETED is deprecated. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state # 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` # @return [String] attr_accessor :store_id - # The type of the conversion, that is, either ACTION or TRANSACTION. An ACTION - # conversion is an action by the user that has no monetarily quantifiable value, - # while a TRANSACTION conversion is an action that does have a monetarily - # quantifiable value. Examples are email list signups (ACTION) versus ecommerce - # purchases (TRANSACTION). + # The type of the conversion, that is, either `ACTION` or + # `TRANSACTION`. An `ACTION` conversion is an action by + # the user that has no monetarily quantifiable value, while a + # `TRANSACTION` conversion is an action that does have a + # monetarily quantifiable value. Examples are email list signups + # (`ACTION`) versus ecommerce purchases + # (`TRANSACTION`). # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -319,7 +323,7 @@ module Google attr_accessor :conversion # Identifies this as a ConversionList resource. Value: the fixed string - # doubleclicksearch#conversionList. + # doubleclicksearch#conversionList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -335,7 +339,7 @@ module Google end end - # A message containing the custome dimension. + # A message containing the custom dimension. class CustomDimension include Google::Apis::Core::Hashable @@ -360,7 +364,7 @@ module Google end end - # A message containing the custome metric. + # A message containing the custom metric. class CustomMetric include Google::Apis::Core::Hashable @@ -386,13 +390,13 @@ module Google end # A DoubleClick Search report. This object contains the report request, some - # report metadata such as currency code, and the generated report rows or report - # files. + # report metadata such as currency code, and the generated report rows or + # report files. class Report include Google::Apis::Core::Hashable - # Asynchronous report only. Contains a list of generated report files once the - # report has successfully completed. + # Asynchronous report only. Contains a list of generated report files once + # the report has successfully completed. # Corresponds to the JSON property `files` # @return [Array] attr_accessor :files @@ -410,7 +414,7 @@ module Google alias_method :is_report_ready?, :is_report_ready # Identifies this as a Report resource. Value: the fixed string - # doubleclicksearch#report. + # `doubleclicksearch#report`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -431,9 +435,9 @@ module Google attr_accessor :rows # 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., - # cost and revenue). The currency code of a report is determined by the - # statisticsCurrency field of the report request. + # values that are set by users (e.g., keyword bid settings) and metrics + # (e.g., cost and revenue). The currency code of a report is determined by + # the `statisticsCurrency` field of the report request. # Corresponds to the JSON property `statisticsCurrencyCode` # @return [String] 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 # advertiser or lower, and the custom dimension must already be set up in # DoubleClick Search. The custom dimension name, which appears in DoubleClick - # Search, is case sensitive. - # If used in a conversion report, returns the value of the specified custom - # dimension for the given conversion, if set. This column does not segment the - # conversion report. + # Search, is case sensitive.\ + # If used in a conversion report, returns the + # value of the specified custom dimension for the given conversion, if set. + # This column does not segment the conversion report. # Corresponds to the JSON property `customDimensionName` # @return [String] attr_accessor :custom_dimension_name - # Name of a custom metric to include in the report. The report must be scoped to - # an advertiser or lower, and the custom metric must already be set up in + # Name of a custom metric to include in the report. The report must be scoped + # 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 # Search, is case sensitive. # Corresponds to the JSON property `customMetricName` # @return [String] attr_accessor :custom_metric_name - # Inclusive day in YYYY-MM-DD format. When provided, this overrides the overall - # time range of the report for this column only. Must be provided together with - # startDate. + # Inclusive day in YYYY-MM-DD format. When provided, this overrides the + # overall time range of the report for this column only. Must be provided + # together with `startDate`. # Corresponds to the JSON property `endDate` # @return [String] attr_accessor :end_date - # Synchronous report only. Set to true to group by this column. Defaults to - # false. + # Synchronous report only. Set to `true` to group by this column. + # Defaults to `false`. # Corresponds to the JSON property `groupByColumn` # @return [Boolean] attr_accessor :group_by_column alias_method :group_by_column?, :group_by_column - # Text used to identify this column in the report output; defaults to columnName - # or savedColumnName when not specified. This can be used to prevent collisions - # between DoubleClick Search columns and saved columns with the same name. + # Text used to identify this column in the report output; defaults to + # `columnName` or `savedColumnName` when not specified. + # This can be used to prevent collisions between DoubleClick Search columns + # and saved columns with the same name. # Corresponds to the JSON property `headerText` # @return [String] attr_accessor :header_text - # The platform that is used to provide data for the custom dimension. Acceptable - # values are "floodlight". + # The platform that is used to provide data for the custom dimension. + # Acceptable values are "floodlight". # Corresponds to the JSON property `platformSource` # @return [String] attr_accessor :platform_source - # Returns metrics only for a specific type of product activity. Accepted values - # are: - # - "sold": returns metrics only for products that were sold - # - "advertised": returns metrics only for products that were advertised in a - # Shopping campaign, and that might or might not have been sold + # Returns metrics only for a specific type of product activity. Accepted + # values are:
  • "`sold`": returns metrics only for products + # that were sold
  • "`advertised`": returns metrics only for + # products that were advertised in a Shopping campaign, and that might or + # might not have been sold
# Corresponds to the JSON property `productReportPerspective` # @return [String] attr_accessor :product_report_perspective - # Name of a saved column to include in the report. The report must be scoped at - # advertiser or lower, and this saved column must already be created in the - # DoubleClick Search UI. + # Name of a saved column to include in the report. The report must be scoped + # at advertiser or lower, and this saved column must already be created in + # the DoubleClick Search UI. # Corresponds to the JSON property `savedColumnName` # @return [String] attr_accessor :saved_column_name - # Inclusive date in YYYY-MM-DD format. When provided, this overrides the overall - # time range of the report for this column only. Must be provided together with - # endDate. + # Inclusive date in YYYY-MM-DD format. When provided, this overrides the + # overall time range of the report for this column only. Must be provided + # together with `endDate`. # Corresponds to the JSON property `startDate` # @return [String] attr_accessor :start_date @@ -589,49 +594,52 @@ module Google include Google::Apis::Core::Hashable # The columns to include in the report. This includes both DoubleClick Search - # columns and saved columns. For DoubleClick Search columns, only the columnName - # parameter is required. For saved columns only the savedColumnName parameter is - # required. Both columnName and savedColumnName cannot be set in the same stanza. + # columns and saved columns. For DoubleClick Search columns, only the + # `columnName` parameter is required. For saved columns only the + # `savedColumnName` parameter is required. Both + # `columnName` and `savedColumnName` cannot be set in + # the same stanza.\ # The maximum number of columns per request is 300. # Corresponds to the JSON property `columns` # @return [Array] attr_accessor :columns - # Format that the report should be returned in. Currently csv or tsv is - # supported. + # Format that the report should be returned in. Currently `csv` or + # `tsv` is supported. # Corresponds to the JSON property `downloadFormat` # @return [String] 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. # Corresponds to the JSON property `filters` # @return [Array] attr_accessor :filters - # Determines if removed entities should be included in the report. Defaults to - # false. Deprecated, please use includeRemovedEntities instead. + # Determines if removed entities should be included in the report. Defaults + # to `false`. Deprecated, please use + # `includeRemovedEntities` instead. # Corresponds to the JSON property `includeDeletedEntities` # @return [Boolean] attr_accessor :include_deleted_entities alias_method :include_deleted_entities?, :include_deleted_entities - # Determines if removed entities should be included in the report. Defaults to - # false. + # Determines if removed entities should be included in the report. Defaults + # to `false`. # Corresponds to the JSON property `includeRemovedEntities` # @return [Boolean] attr_accessor :include_removed_entities alias_method :include_removed_entities?, :include_removed_entities - # Asynchronous report only. The maximum number of rows per report file. A large - # report is split into many files based on this field. Acceptable values are - # 1000000 to 100000000, inclusive. + # Asynchronous report only. The maximum number of rows per report file. A + # large report is split into many files based on this field. Acceptable + # values are `1000000` to `100000000`, inclusive. # Corresponds to the JSON property `maxRowsPerFile` # @return [Fixnum] attr_accessor :max_rows_per_file - # Synchronous report only. A list of columns and directions defining sorting to - # be performed on the report rows. + # Synchronous report only. A list of columns and directions defining sorting + # to be performed on the report rows.\ # The maximum number of orderings per request is 300. # Corresponds to the JSON property `orderBy` # @return [Array] @@ -644,42 +652,47 @@ module Google # @return [Google::Apis::DoubleclicksearchV2::ReportRequest::ReportScope] attr_accessor :report_scope - # Determines the type of rows that are returned in the report. For example, if - # you specify reportType: keyword, each row in the report will contain data - # about a keyword. See the Types of Reports reference for the columns that are + # Determines the type of rows that are returned in the report. For example, + # if you specify `reportType: keyword`, each row in the report + # 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. # Corresponds to the JSON property `reportType` # @return [String] attr_accessor :report_type - # Synchronous report only. The maximum number of rows to return; additional rows - # are dropped. Acceptable values are 0 to 10000, inclusive. Defaults to 10000. + # Synchronous report only. The maximum number of rows to return; additional + # rows are dropped. Acceptable values are `0` to + # `10000`, inclusive. Defaults to `10000`. # Corresponds to the JSON property `rowCount` # @return [Fixnum] attr_accessor :row_count # 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` # @return [Fixnum] attr_accessor :start_row - # Specifies the currency in which monetary will be returned. Possible values are: - # usd, agency (valid if the report is scoped to agency or lower), advertiser ( - # valid if the report is scoped to * advertiser or lower), or account (valid if - # the report is scoped to engine account or lower). + # Specifies the currency in which monetary will be returned. Possible values + # are: `usd`, `agency` (valid if the report is scoped + # to agency or lower), `advertiser` (valid if the report is scoped + # to * advertiser or lower), or `account` (valid if the report is + # scoped to engine account or lower). # Corresponds to the JSON property `statisticsCurrency` # @return [String] attr_accessor :statistics_currency - # If metrics are requested in a report, this argument will be used to restrict - # the metrics to a specific time range. + # If metrics are requested in a report, this argument will be used to + # restrict the metrics to a specific time range. # Corresponds to the JSON property `timeRange` # @return [Google::Apis::DoubleclicksearchV2::ReportRequest::TimeRange] attr_accessor :time_range - # If true, the report would only be created if all the requested stat data are - # sourced from a single timezone. Defaults to false. + # If `true`, the report would only be created if all the requested + # stat data are sourced from a single timezone. Defaults to + # `false`. # Corresponds to the JSON property `verifySingleTimeZone` # @return [Boolean] attr_accessor :verify_single_time_zone @@ -722,7 +735,7 @@ module Google # @return [String] 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. # Corresponds to the JSON property `values` # @return [Array] @@ -749,7 +762,8 @@ module Google # @return [Google::Apis::DoubleclicksearchV2::ReportApiColumnSpec] 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` # @return [String] attr_accessor :sort_order @@ -822,21 +836,23 @@ module Google end end - # If metrics are requested in a report, this argument will be used to restrict - # the metrics to a specific time range. + # If metrics are requested in a report, this argument will be used to + # restrict the metrics to a specific time range. class TimeRange include Google::Apis::Core::Hashable - # Inclusive UTC timestamp in RFC format, e.g., 2013-07-16T10:16:23.555Z. See - # additional references on how changed attribute reports work. + # Inclusive UTC timestamp in RFC format, e.g., + # `2013-07-16T10:16:23.555Z`. See additional references on how + # changed attribute reports work. # Corresponds to the JSON property `changedAttributesSinceTimestamp` - # @return [DateTime] + # @return [String] attr_accessor :changed_attributes_since_timestamp - # Inclusive UTC timestamp in RFC format, e.g., 2013-07-16T10:16:23.555Z. See - # additional references on how changed metrics reports work. + # Inclusive UTC timestamp in RFC format, e.g., + # `2013-07-16T10:16:23.555Z`. See additional references on how + # changed metrics reports work. # Corresponds to the JSON property `changedMetricsSinceTimestamp` - # @return [DateTime] + # @return [String] attr_accessor :changed_metrics_since_timestamp # Inclusive date in YYYY-MM-DD format. @@ -868,7 +884,7 @@ module Google include Google::Apis::Core::Hashable # Identifies this as a SavedColumn resource. Value: the fixed string - # doubleclicksearch#savedColumn. + # doubleclicksearch#savedColumn. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -897,8 +913,8 @@ module Google # A list of saved columns. Advertisers create saved columns to report on # Floodlight activities, Google Analytics goals, or custom KPIs. To request - # reports with saved columns, you'll need the saved column names that are - # available from this list. + # reports with saved columns, + # you'll need the saved column names that are available from this list. class SavedColumnList include Google::Apis::Core::Hashable @@ -908,7 +924,7 @@ module Google attr_accessor :items # Identifies this as a SavedColumnList resource. Value: the fixed string - # doubleclicksearch#savedColumnList. + # doubleclicksearch#savedColumnList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind diff --git a/generated/google/apis/doubleclicksearch_v2/representations.rb b/generated/google/apis/doubleclicksearch_v2/representations.rb index b17810d03..c653f6ac3 100644 --- a/generated/google/apis/doubleclicksearch_v2/representations.rb +++ b/generated/google/apis/doubleclicksearch_v2/representations.rb @@ -149,7 +149,7 @@ module Google property :click_id, as: 'clickId' property :conversion_id, as: 'conversionId' 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 :criterion_id, :numeric_string => true, as: 'criterionId' property :currency_code, as: 'currencyCode' @@ -167,7 +167,7 @@ module Google property :product_id, as: 'productId' property :product_language, as: 'productLanguage' 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_name, as: 'segmentationName' property :segmentation_type, as: 'segmentationType' @@ -302,10 +302,8 @@ module Google class TimeRange # @private class Representation < Google::Apis::Core::JsonRepresentation - property :changed_attributes_since_timestamp, as: 'changedAttributesSinceTimestamp', type: DateTime - - property :changed_metrics_since_timestamp, as: 'changedMetricsSinceTimestamp', type: DateTime - + property :changed_attributes_since_timestamp, as: 'changedAttributesSinceTimestamp' + property :changed_metrics_since_timestamp, as: 'changedMetricsSinceTimestamp' property :end_date, as: 'endDate' property :start_date, as: 'startDate' end diff --git a/generated/google/apis/doubleclicksearch_v2/service.rb b/generated/google/apis/doubleclicksearch_v2/service.rb index a7605cab6..5292d2fab 100644 --- a/generated/google/apis/doubleclicksearch_v2/service.rb +++ b/generated/google/apis/doubleclicksearch_v2/service.rb @@ -22,8 +22,8 @@ module Google module DoubleclicksearchV2 # Search Ads 360 API # - # Reports and modifies your advertising data in DoubleClick Search (for example, - # campaigns, ad groups, keywords, and conversions). + # The Search Ads 360 API allows developers to automate uploading conversions and + # downloading reports from Search Ads 360. # # @example # require 'google/apis/doubleclicksearch_v2' @@ -31,7 +31,7 @@ module Google # Doubleclicksearch = Google::Apis::DoubleclicksearchV2 # Alias the module # service = Doubleclicksearch::DoubleclicksearchService.new # - # @see https://developers.google.com/doubleclick-search/ + # @see https://developers.google.com/search-ads class DoubleclicksearchService < Google::Apis::Core::BaseService # @return [String] # API key. Your API key identifies your project and provides you with API access, @@ -39,16 +39,12 @@ module Google attr_accessor :key # @return [String] - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. + # 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 - # @return [String] - # Deprecated. Please use quotaUser instead. - attr_accessor :user_ip - def initialize - super('https://www.googleapis.com/', 'doubleclicksearch/v2/') + super('https://www.googleapis.com/', '') @batch_path = 'batch/doubleclicksearch/v2' end @@ -64,7 +60,8 @@ module Google # @param [Fixnum] row_count # The number of conversions to return per call. # @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 # The 0-based starting index for retrieving conversions results. # @param [Fixnum] ad_group_id @@ -78,10 +75,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # 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 # @@ -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::ClientError] The request is invalid and should not be retried without modification # @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) - command = make_simple_command(:get, 'agency/{agencyId}/advertiser/{advertiserId}/engine/{engineAccountId}/conversion', options) + 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, 'doubleclicksearch/v2/agency/{agencyId}/advertiser/{advertiserId}/engine/{engineAccountId}/conversion', options) command.response_representation = Google::Apis::DoubleclicksearchV2::ConversionList::Representation command.response_class = Google::Apis::DoubleclicksearchV2::ConversionList 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['fields'] = fields unless fields.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) end @@ -120,10 +114,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # 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 # @@ -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::ClientError] The request is invalid and should not be retried without modification # @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) - command = make_simple_command(:post, 'conversion', options) + def insert_conversion(conversion_list_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'doubleclicksearch/v2/conversion', options) command.request_representation = Google::Apis::DoubleclicksearchV2::ConversionList::Representation command.request_object = conversion_list_object command.response_representation = Google::Apis::DoubleclicksearchV2::ConversionList::Representation command.response_class = Google::Apis::DoubleclicksearchV2::ConversionList command.query['fields'] = fields unless fields.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) end @@ -153,10 +144,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # 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 # @@ -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::ClientError] The request is invalid and should not be retried without modification # @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) - command = make_simple_command(:put, 'conversion', options) + def update_conversion(conversion_list_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'doubleclicksearch/v2/conversion', options) command.request_representation = Google::Apis::DoubleclicksearchV2::ConversionList::Representation command.request_object = conversion_list_object command.response_representation = Google::Apis::DoubleclicksearchV2::ConversionList::Representation command.response_class = Google::Apis::DoubleclicksearchV2::ConversionList command.query['fields'] = fields unless fields.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) end - # Updates the availabilities of a batch of floodlight activities in DoubleClick - # Search. + # Updates the availabilities of a batch of floodlight activities in + # DoubleClick Search. # @param [Google::Apis::DoubleclicksearchV2::UpdateAvailabilityRequest] update_availability_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # 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 # @@ -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::ClientError] The request is invalid and should not be retried without modification # @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) - command = make_simple_command(:post, 'conversion/updateAvailability', options) + def update_conversion_availability(update_availability_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'doubleclicksearch/v2/conversion/updateAvailability', options) command.request_representation = Google::Apis::DoubleclicksearchV2::UpdateAvailabilityRequest::Representation command.request_object = update_availability_request_object command.response_representation = Google::Apis::DoubleclicksearchV2::UpdateAvailabilityResponse::Representation command.response_class = Google::Apis::DoubleclicksearchV2::UpdateAvailabilityResponse command.query['fields'] = fields unless fields.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) end @@ -220,10 +205,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # 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 # @@ -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::ClientError] The request is invalid and should not be retried without modification # @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) - command = make_simple_command(:post, 'reports/generate', options) + def generate_report(report_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'doubleclicksearch/v2/reports/generate', options) command.request_representation = Google::Apis::DoubleclicksearchV2::ReportRequest::Representation command.request_object = report_request_object command.response_representation = Google::Apis::DoubleclicksearchV2::Report::Representation command.response_class = Google::Apis::DoubleclicksearchV2::Report command.query['fields'] = fields unless fields.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) end @@ -254,10 +236,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # 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 # @@ -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::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_report(report_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'reports/{reportId}', options) + def get_report(report_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'doubleclicksearch/v2/reports/{reportId}', options) command.response_representation = Google::Apis::DoubleclicksearchV2::Report::Representation command.response_class = Google::Apis::DoubleclicksearchV2::Report command.params['reportId'] = report_id unless report_id.nil? command.query['fields'] = fields unless fields.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) end @@ -289,10 +268,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # 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 [IO, String] download_dest # IO stream or filename to receive content download # @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::ClientError] The request is invalid and should not be retried without modification # @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? - command = make_simple_command(:get, 'reports/{reportId}/files/{reportFragment}', options) + command = make_simple_command(:get, 'doubleclicksearch/v2/reports/{reportId}/files/{reportFragment}', options) 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 end command.params['reportId'] = report_id unless report_id.nil? command.params['reportFragment'] = report_fragment unless report_fragment.nil? command.query['fields'] = fields unless fields.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) end @@ -327,10 +303,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # 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 # @@ -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::ClientError] The request is invalid and should not be retried without modification # @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) - command = make_simple_command(:post, 'reports', options) + def request_report(report_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'doubleclicksearch/v2/reports', options) command.request_representation = Google::Apis::DoubleclicksearchV2::ReportRequest::Representation command.request_object = report_request_object command.response_representation = Google::Apis::DoubleclicksearchV2::Report::Representation command.response_class = Google::Apis::DoubleclicksearchV2::Report command.query['fields'] = fields unless fields.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) end @@ -363,10 +336,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # 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 # @@ -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::ClientError] The request is invalid and should not be retried without modification # @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) - command = make_simple_command(:get, 'agency/{agencyId}/advertiser/{advertiserId}/savedcolumns', options) + def list_saved_columns(agency_id, advertiser_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'doubleclicksearch/v2/agency/{agencyId}/advertiser/{advertiserId}/savedcolumns', options) command.response_representation = Google::Apis::DoubleclicksearchV2::SavedColumnList::Representation command.response_class = Google::Apis::DoubleclicksearchV2::SavedColumnList command.params['agencyId'] = agency_id unless agency_id.nil? command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? command.query['fields'] = fields unless fields.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) end @@ -396,7 +366,6 @@ module Google def apply_command_defaults(command) command.query['key'] = key unless key.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? end end end diff --git a/generated/google/apis/fcm_v1.rb b/generated/google/apis/fcm_v1.rb index ad83060a3..3c9160679 100644 --- a/generated/google/apis/fcm_v1.rb +++ b/generated/google/apis/fcm_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://firebase.google.com/docs/cloud-messaging module FcmV1 VERSION = 'V1' - REVISION = '20200615' + REVISION = '20200622' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/healthcare_v1.rb b/generated/google/apis/healthcare_v1.rb index 3b5f5858b..816d8c7ce 100644 --- a/generated/google/apis/healthcare_v1.rb +++ b/generated/google/apis/healthcare_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/healthcare module HealthcareV1 VERSION = 'V1' - REVISION = '20200605' + REVISION = '20200612' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/healthcare_v1/classes.rb b/generated/google/apis/healthcare_v1/classes.rb index 4db917734..ab8c16346 100644 --- a/generated/google/apis/healthcare_v1/classes.rb +++ b/generated/google/apis/healthcare_v1/classes.rb @@ -34,7 +34,7 @@ module Google # ` # "audit_configs": [ # ` - # "service": "allServices" + # "service": "allServices", # "audit_log_configs": [ # ` # "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": [ # ` - # "log_type": "DATA_READ", + # "log_type": "DATA_READ" # `, # ` # "log_type": "DATA_WRITE", @@ -106,7 +106,7 @@ module Google # ] # `, # ` - # "log_type": "DATA_WRITE", + # "log_type": "DATA_WRITE" # ` # ] # ` diff --git a/generated/google/apis/healthcare_v1beta1.rb b/generated/google/apis/healthcare_v1beta1.rb index 766282e33..eb4a535ac 100644 --- a/generated/google/apis/healthcare_v1beta1.rb +++ b/generated/google/apis/healthcare_v1beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/healthcare module HealthcareV1beta1 VERSION = 'V1beta1' - REVISION = '20200605' + REVISION = '20200612' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/healthcare_v1beta1/classes.rb b/generated/google/apis/healthcare_v1beta1/classes.rb index b18614549..017733cdb 100644 --- a/generated/google/apis/healthcare_v1beta1/classes.rb +++ b/generated/google/apis/healthcare_v1beta1/classes.rb @@ -179,7 +179,7 @@ module Google # ` # "audit_configs": [ # ` - # "service": "allServices" + # "service": "allServices", # "audit_log_configs": [ # ` # "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": [ # ` - # "log_type": "DATA_READ", + # "log_type": "DATA_READ" # `, # ` # "log_type": "DATA_WRITE", @@ -251,7 +251,7 @@ module Google # ] # `, # ` - # "log_type": "DATA_WRITE", + # "log_type": "DATA_WRITE" # ` # ] # ` diff --git a/generated/google/apis/monitoring_v3.rb b/generated/google/apis/monitoring_v3.rb index 4b9d7f3c1..865ad2012 100644 --- a/generated/google/apis/monitoring_v3.rb +++ b/generated/google/apis/monitoring_v3.rb @@ -29,7 +29,7 @@ module Google # @see https://cloud.google.com/monitoring/api/ module MonitoringV3 VERSION = 'V3' - REVISION = '20200615' + REVISION = '20200622' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/monitoring_v3/classes.rb b/generated/google/apis/monitoring_v3/classes.rb index c273b6314..f49aca422 100644 --- a/generated/google/apis/monitoring_v3/classes.rb +++ b/generated/google/apis/monitoring_v3/classes.rb @@ -3105,7 +3105,7 @@ module Google # @return [Array] 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` # @return [Google::Apis::MonitoringV3::TimeSeriesDescriptor] attr_accessor :time_series_descriptor @@ -3691,7 +3691,7 @@ module Google 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 include Google::Apis::Core::Hashable diff --git a/generated/google/apis/playablelocations_v3.rb b/generated/google/apis/playablelocations_v3.rb new file mode 100644 index 000000000..17e81764f --- /dev/null +++ b/generated/google/apis/playablelocations_v3.rb @@ -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 diff --git a/generated/google/apis/playablelocations_v3/classes.rb b/generated/google/apis/playablelocations_v3/classes.rb new file mode 100644 index 000000000..a83bc498a --- /dev/null +++ b/generated/google/apis/playablelocations_v3/classes.rb @@ -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] + 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] + 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] + 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. + # 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] + 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 + # WGS84 + # standard. 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 + # WGS84 + # standard. 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] + 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] + 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] + 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] + 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 + # WGS84 + # standard. 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 diff --git a/generated/google/apis/playablelocations_v3/representations.rb b/generated/google/apis/playablelocations_v3/representations.rb new file mode 100644 index 000000000..6167a0630 --- /dev/null +++ b/generated/google/apis/playablelocations_v3/representations.rb @@ -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 diff --git a/generated/google/apis/playablelocations_v3/service.rb b/generated/google/apis/playablelocations_v3/service.rb new file mode 100644 index 000000000..f45fe1a8a --- /dev/null +++ b/generated/google/apis/playablelocations_v3/service.rb @@ -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 diff --git a/generated/google/apis/realtimebidding_v1.rb b/generated/google/apis/realtimebidding_v1.rb new file mode 100644 index 000000000..2dafa9e88 --- /dev/null +++ b/generated/google/apis/realtimebidding_v1.rb @@ -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 diff --git a/generated/google/apis/realtimebidding_v1/classes.rb b/generated/google/apis/realtimebidding_v1/classes.rb new file mode 100644 index 000000000..6ea008d02 --- /dev/null +++ b/generated/google/apis/realtimebidding_v1/classes.rb @@ -0,0 +1,1436 @@ +# 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 + + # Detected ad technology provider information. + class AdTechnologyProviders + include Google::Apis::Core::Hashable + + # The detected ad technology provider IDs for this creative. + # See https://storage.googleapis.com/adx-rtb-dictionaries/providers.csv for + # mapping of provider ID to provided name, a privacy policy URL, and a list + # of domains which can be attributed to the provider. + # If the creative contains provider IDs that are outside of those listed in + # the `BidRequest.adslot.consented_providers_settings.consented_providers` + # field on the [Google bid + # protocol](https://developers.google.com/authorized-buyers/rtb/downloads/ + # realtime-bidding-proto) + # and the + # `BidRequest.user.ext.consented_providers_settings.consented_providers` + # field on the [OpenRTB + # protocol](https://developers.google.com/authorized-buyers/rtb/downloads/ + # openrtb-adx-proto), + # and a bid is submitted with that creative for an impression + # that will serve to an EEA user, the bid will be filtered before the + # auction. + # Corresponds to the JSON property `detectedProviderIds` + # @return [Array] + attr_accessor :detected_provider_ids + + # Whether the creative contains an unidentified ad technology provider. + # If true for a given creative, any bid submitted with that creative for an + # impression that will serve to an EEA user will be filtered before the + # auction. + # Corresponds to the JSON property `hasUnidentifiedProvider` + # @return [Boolean] + attr_accessor :has_unidentified_provider + alias_method :has_unidentified_provider?, :has_unidentified_provider + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @detected_provider_ids = args[:detected_provider_ids] if args.key?(:detected_provider_ids) + @has_unidentified_provider = args[:has_unidentified_provider] if args.key?(:has_unidentified_provider) + end + end + + # Detected advertiser and brand information. + class AdvertiserAndBrand + include Google::Apis::Core::Hashable + + # See https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt + # for the list of possible values. + # Can be used to filter the response of the + # creatives.list + # method. + # Corresponds to the JSON property `advertiserId` + # @return [Fixnum] + attr_accessor :advertiser_id + + # Advertiser name. + # Can be used to filter the response of the + # creatives.list + # method. + # Corresponds to the JSON property `advertiserName` + # @return [String] + attr_accessor :advertiser_name + + # Detected brand ID or zero if no brand has been detected. + # See https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt for + # the list of possible values. + # Can be used to filter the response of the + # creatives.list + # method. + # Corresponds to the JSON property `brandId` + # @return [Fixnum] + attr_accessor :brand_id + + # Brand name. + # Can be used to filter the response of the + # creatives.list + # method. + # Corresponds to the JSON property `brandName` + # @return [String] + attr_accessor :brand_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) + @advertiser_name = args[:advertiser_name] if args.key?(:advertiser_name) + @brand_id = args[:brand_id] if args.key?(:brand_id) + @brand_name = args[:brand_name] if args.key?(:brand_name) + end + end + + # A request to close a specified user list. + class CloseUserListRequest + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # A creative and its classification data. + class Creative + include Google::Apis::Core::Hashable + + # Output only. ID of the buyer account that this creative is owned by. + # Can be used to filter the response of the + # creatives.list + # method with equality and inequality check. + # Corresponds to the JSON property `accountId` + # @return [Fixnum] + attr_accessor :account_id + + # The link to AdChoices destination page. This is only supported for native + # ads. + # Corresponds to the JSON property `adChoicesDestinationUrl` + # @return [String] + attr_accessor :ad_choices_destination_url + + # The name of the company being advertised in the creative. + # Can be used to filter the response of the + # creatives.list + # method. + # Corresponds to the JSON property `advertiserName` + # @return [String] + attr_accessor :advertiser_name + + # The agency ID for this creative. + # Corresponds to the JSON property `agencyId` + # @return [Fixnum] + attr_accessor :agency_id + + # Output only. The last update timestamp of the creative via API. + # Corresponds to the JSON property `apiUpdateTime` + # @return [String] + attr_accessor :api_update_time + + # Output only. The format of this creative. + # Can be used to filter the response of the + # creatives.list + # method. + # Corresponds to the JSON property `creativeFormat` + # @return [String] + attr_accessor :creative_format + + # Buyer-specific creative ID that references this creative in bid responses. + # This field is Ignored in update operations. Can be used to filter the + # response of the + # creatives.list + # method. + # The maximum length of the creative ID is 128 bytes. + # Corresponds to the JSON property `creativeId` + # @return [String] + attr_accessor :creative_id + + # Top level status and detected attributes of a creative. + # Corresponds to the JSON property `creativeServingDecision` + # @return [Google::Apis::RealtimebiddingV1::CreativeServingDecision] + attr_accessor :creative_serving_decision + + # Output only. IDs of all of the deals with which this creative has been used + # in bidding. + # Can be used to filter the response of the + # creatives.list + # method. + # Corresponds to the JSON property `dealIds` + # @return [Array] + attr_accessor :deal_ids + + # All declared attributes for the ads that may be shown from this creative. + # Can be used to filter the response of the + # creatives.list + # method. + # If the `excluded_attribute` field of a [bid + # request](https://developers.google.com/authorized-buyers/rtb/downloads/ + # realtime-bidding-proto") + # contains one of the attributes that were declared or detected for a given + # creative, and a bid is submitted with that creative, the bid will be + # filtered before the auction. + # Corresponds to the JSON property `declaredAttributes` + # @return [Array] + attr_accessor :declared_attributes + + # The set of declared destination URLs for the creative. + # Can be used to filter the response of the + # creatives.list + # method. + # Corresponds to the JSON property `declaredClickThroughUrls` + # @return [Array] + attr_accessor :declared_click_through_urls + + # All declared restricted categories for the ads that may be shown from this + # creative. Can be used to filter the response of the + # creatives.list + # method. + # Corresponds to the JSON property `declaredRestrictedCategories` + # @return [Array] + attr_accessor :declared_restricted_categories + + # IDs for the declared ad technology vendors that may be used by this + # creative. See + # https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for + # possible values. + # Can be used to filter the response of the + # creatives.list + # method. + # Corresponds to the JSON property `declaredVendorIds` + # @return [Array] + attr_accessor :declared_vendor_ids + + # HTML content for a creative. + # Corresponds to the JSON property `html` + # @return [Google::Apis::RealtimebiddingV1::HtmlContent] + attr_accessor :html + + # The set of URLs to be called to record an impression. + # Corresponds to the JSON property `impressionTrackingUrls` + # @return [Array] + attr_accessor :impression_tracking_urls + + # Output only. Name of the creative. + # Follows the pattern `buyers/`buyer`/creatives/`creative``, where + # ``buyer`` represents the account ID of the buyer who owns the creative, + # and ``creative`` is the buyer-specific creative ID that references this + # creative in the bid response. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Native content for a creative. + # Corresponds to the JSON property `native` + # @return [Google::Apis::RealtimebiddingV1::NativeContent] + attr_accessor :native + + # All restricted categories for the ads that may be shown from this creative. + # Corresponds to the JSON property `restrictedCategories` + # @return [Array] + attr_accessor :restricted_categories + + # Output only. The version of this creative. + # Version for a new creative is 1 and it increments during subsequent + # creative updates. + # Corresponds to the JSON property `version` + # @return [Fixnum] + attr_accessor :version + + # Video content for a creative. + # Corresponds to the JSON property `video` + # @return [Google::Apis::RealtimebiddingV1::VideoContent] + attr_accessor :video + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @ad_choices_destination_url = args[:ad_choices_destination_url] if args.key?(:ad_choices_destination_url) + @advertiser_name = args[:advertiser_name] if args.key?(:advertiser_name) + @agency_id = args[:agency_id] if args.key?(:agency_id) + @api_update_time = args[:api_update_time] if args.key?(:api_update_time) + @creative_format = args[:creative_format] if args.key?(:creative_format) + @creative_id = args[:creative_id] if args.key?(:creative_id) + @creative_serving_decision = args[:creative_serving_decision] if args.key?(:creative_serving_decision) + @deal_ids = args[:deal_ids] if args.key?(:deal_ids) + @declared_attributes = args[:declared_attributes] if args.key?(:declared_attributes) + @declared_click_through_urls = args[:declared_click_through_urls] if args.key?(:declared_click_through_urls) + @declared_restricted_categories = args[:declared_restricted_categories] if args.key?(:declared_restricted_categories) + @declared_vendor_ids = args[:declared_vendor_ids] if args.key?(:declared_vendor_ids) + @html = args[:html] if args.key?(:html) + @impression_tracking_urls = args[:impression_tracking_urls] if args.key?(:impression_tracking_urls) + @name = args[:name] if args.key?(:name) + @native = args[:native] if args.key?(:native) + @restricted_categories = args[:restricted_categories] if args.key?(:restricted_categories) + @version = args[:version] if args.key?(:version) + @video = args[:video] if args.key?(:video) + end + end + + # Top level status and detected attributes of a creative. + class CreativeServingDecision + include Google::Apis::Core::Hashable + + # Detected ad technology provider information. + # Corresponds to the JSON property `adTechnologyProviders` + # @return [Google::Apis::RealtimebiddingV1::AdTechnologyProviders] + attr_accessor :ad_technology_providers + + # Serving status of the creative for a transaction type or a region. + # Corresponds to the JSON property `chinaServingStatus` + # @return [Google::Apis::RealtimebiddingV1::ServingStatus] + attr_accessor :china_serving_status + + # Serving status of the creative for a transaction type or a region. + # Corresponds to the JSON property `dealsServingStatus` + # @return [Google::Apis::RealtimebiddingV1::ServingStatus] + attr_accessor :deals_serving_status + + # Detected advertisers and brands. + # Corresponds to the JSON property `detectedAdvertisers` + # @return [Array] + attr_accessor :detected_advertisers + + # Publisher-excludable attributes that were detected for this creative. + # Can be used to filter the response of the + # creatives.list + # method. + # If the `excluded_attribute` field of a [bid + # request](https://developers.google.com/authorized-buyers/rtb/downloads/ + # realtime-bidding-proto) + # contains one of the attributes that were declared or detected for a given + # creative, and a bid is submitted with that creative, the bid will be + # filtered before the auction. + # Corresponds to the JSON property `detectedAttributes` + # @return [Array] + attr_accessor :detected_attributes + + # The set of detected destination URLs for the creative. + # Can be used to filter the response of the + # creatives.list + # method. + # Corresponds to the JSON property `detectedClickThroughUrls` + # @return [Array] + attr_accessor :detected_click_through_urls + + # The detected domains for this creative. + # Corresponds to the JSON property `detectedDomains` + # @return [Array] + attr_accessor :detected_domains + + # The detected languages for this creative. The order is + # arbitrary. The codes are 2 or 5 characters and are documented at + # https://developers.google.com/adwords/api/docs/appendix/languagecodes. + # Can be used to filter the response of the + # creatives.list + # method. + # Corresponds to the JSON property `detectedLanguages` + # @return [Array] + attr_accessor :detected_languages + + # Detected product categories, if any. + # See the ad-product-categories.txt file in the technical documentation + # for a list of IDs. + # Can be used to filter the response of the + # creatives.list + # method. + # Corresponds to the JSON property `detectedProductCategories` + # @return [Array] + attr_accessor :detected_product_categories + + # Detected sensitive categories, if any. + # Can be used to filter the response of the + # creatives.list + # method. + # See the ad-sensitive-categories.txt file in the technical documentation + # for a list of IDs. You should use these IDs along with the + # excluded-sensitive-category field in the bid request to filter your bids. + # Corresponds to the JSON property `detectedSensitiveCategories` + # @return [Array] + attr_accessor :detected_sensitive_categories + + # IDs of the ad technology vendors that were detected to be + # used by this creative. See + # https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for + # possible values. + # Can be used to filter the response of the + # creatives.list + # method. + # If the `allowed_vendor_type` field of a [bid + # request](https://developers.google.com/authorized-buyers/rtb/downloads/ + # realtime-bidding-proto) + # does not contain one of the vendor type IDs that were declared or + # detected for a given creative, and a bid is submitted with that creative, + # the bid will be filtered before the auction. + # Corresponds to the JSON property `detectedVendorIds` + # @return [Array] + attr_accessor :detected_vendor_ids + + # The last time the creative status was updated. + # Can be used to filter the response of the + # creatives.list + # method. + # Corresponds to the JSON property `lastStatusUpdate` + # @return [String] + attr_accessor :last_status_update + + # Serving status of the creative for a transaction type or a region. + # Corresponds to the JSON property `openAuctionServingStatus` + # @return [Google::Apis::RealtimebiddingV1::ServingStatus] + attr_accessor :open_auction_serving_status + + # Serving status of the creative for a transaction type or a region. + # Corresponds to the JSON property `russiaServingStatus` + # @return [Google::Apis::RealtimebiddingV1::ServingStatus] + attr_accessor :russia_serving_status + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @ad_technology_providers = args[:ad_technology_providers] if args.key?(:ad_technology_providers) + @china_serving_status = args[:china_serving_status] if args.key?(:china_serving_status) + @deals_serving_status = args[:deals_serving_status] if args.key?(:deals_serving_status) + @detected_advertisers = args[:detected_advertisers] if args.key?(:detected_advertisers) + @detected_attributes = args[:detected_attributes] if args.key?(:detected_attributes) + @detected_click_through_urls = args[:detected_click_through_urls] if args.key?(:detected_click_through_urls) + @detected_domains = args[:detected_domains] if args.key?(:detected_domains) + @detected_languages = args[:detected_languages] if args.key?(:detected_languages) + @detected_product_categories = args[:detected_product_categories] if args.key?(:detected_product_categories) + @detected_sensitive_categories = args[:detected_sensitive_categories] if args.key?(:detected_sensitive_categories) + @detected_vendor_ids = args[:detected_vendor_ids] if args.key?(:detected_vendor_ids) + @last_status_update = args[:last_status_update] if args.key?(:last_status_update) + @open_auction_serving_status = args[:open_auction_serving_status] if args.key?(:open_auction_serving_status) + @russia_serving_status = args[:russia_serving_status] if args.key?(:russia_serving_status) + end + end + + # Represents a whole or partial calendar date, e.g. a birthday. The time of day + # and time zone are either specified elsewhere or are not significant. The date + # is relative to the Proleptic Gregorian Calendar. This can represent: + # * A full date, with non-zero year, month and day values + # * A month and day value, with a zero year, e.g. an anniversary + # * A year on its own, with zero month and day values + # * A year and month value, with a zero day, e.g. a credit card expiration date + # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. + class Date + include Google::Apis::Core::Hashable + + # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 + # if specifying a year by itself or a year and month where the day is not + # significant. + # Corresponds to the JSON property `day` + # @return [Fixnum] + attr_accessor :day + + # Month of year. Must be from 1 to 12, or 0 if specifying a year without a + # month and day. + # Corresponds to the JSON property `month` + # @return [Fixnum] + attr_accessor :month + + # Year of date. Must be from 1 to 9999, or 0 if specifying a date without + # a year. + # Corresponds to the JSON property `year` + # @return [Fixnum] + attr_accessor :year + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @day = args[:day] if args.key?(:day) + @month = args[:month] if args.key?(:month) + @year = args[:year] if args.key?(:year) + end + end + + # Evidence that the creative's destination URL was not crawlable by Google. + class DestinationNotCrawlableEvidence + include Google::Apis::Core::Hashable + + # Approximate time of the crawl. + # Corresponds to the JSON property `crawlTime` + # @return [String] + attr_accessor :crawl_time + + # Destination URL that was attempted to be crawled. + # Corresponds to the JSON property `crawledUrl` + # @return [String] + attr_accessor :crawled_url + + # Reason of destination not crawlable. + # Corresponds to the JSON property `reason` + # @return [String] + attr_accessor :reason + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @crawl_time = args[:crawl_time] if args.key?(:crawl_time) + @crawled_url = args[:crawled_url] if args.key?(:crawled_url) + @reason = args[:reason] if args.key?(:reason) + end + end + + # Evidence of the creative's destination URL not functioning properly or + # having been incorrectly set up. + class DestinationNotWorkingEvidence + include Google::Apis::Core::Hashable + + # DNS lookup errors. + # Corresponds to the JSON property `dnsError` + # @return [String] + attr_accessor :dns_error + + # The full non-working URL. + # Corresponds to the JSON property `expandedUrl` + # @return [String] + attr_accessor :expanded_url + + # HTTP error code (e.g. 404 or 5xx) + # Corresponds to the JSON property `httpError` + # @return [Fixnum] + attr_accessor :http_error + + # Page was crawled successfully, but was detected as either a page with + # no content or an error page. + # Corresponds to the JSON property `invalidPage` + # @return [String] + attr_accessor :invalid_page + + # Approximate time when the ad destination was last checked. + # Corresponds to the JSON property `lastCheckTime` + # @return [String] + attr_accessor :last_check_time + + # Platform of the non-working URL. + # Corresponds to the JSON property `platform` + # @return [String] + attr_accessor :platform + + # HTTP redirect chain error. + # Corresponds to the JSON property `redirectionError` + # @return [String] + attr_accessor :redirection_error + + # Rejected because of malformed URLs or invalid requests. + # Corresponds to the JSON property `urlRejected` + # @return [String] + attr_accessor :url_rejected + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @dns_error = args[:dns_error] if args.key?(:dns_error) + @expanded_url = args[:expanded_url] if args.key?(:expanded_url) + @http_error = args[:http_error] if args.key?(:http_error) + @invalid_page = args[:invalid_page] if args.key?(:invalid_page) + @last_check_time = args[:last_check_time] if args.key?(:last_check_time) + @platform = args[:platform] if args.key?(:platform) + @redirection_error = args[:redirection_error] if args.key?(:redirection_error) + @url_rejected = args[:url_rejected] if args.key?(:url_rejected) + end + end + + # The full landing page URL of the destination. + class DestinationUrlEvidence + include Google::Apis::Core::Hashable + + # The full landing page URL of the destination. + # Corresponds to the JSON property `destinationUrl` + # @return [String] + attr_accessor :destination_url + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @destination_url = args[:destination_url] if args.key?(:destination_url) + end + end + + # Number of HTTP calls made by a creative, broken down by domain. + class DomainCallEvidence + include Google::Apis::Core::Hashable + + # Breakdown of the most frequent domains called via HTTP by the creative. + # Corresponds to the JSON property `topHttpCallDomains` + # @return [Array] + attr_accessor :top_http_call_domains + + # The total number of HTTP calls made by the creative, including but not + # limited to the number of calls in the top_http_call_domains. + # Corresponds to the JSON property `totalHttpCallCount` + # @return [Fixnum] + attr_accessor :total_http_call_count + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @top_http_call_domains = args[:top_http_call_domains] if args.key?(:top_http_call_domains) + @total_http_call_count = args[:total_http_call_count] if args.key?(:total_http_call_count) + end + end + + # The number of HTTP calls made to the given domain. + class DomainCalls + include Google::Apis::Core::Hashable + + # The domain name. + # Corresponds to the JSON property `domain` + # @return [String] + attr_accessor :domain + + # Number of HTTP calls made to the domain. + # Corresponds to the JSON property `httpCallCount` + # @return [Fixnum] + attr_accessor :http_call_count + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @domain = args[:domain] if args.key?(:domain) + @http_call_count = args[:http_call_count] if args.key?(:http_call_count) + end + end + + # Total download size and URL-level download size breakdown for resources in + # a creative. + class DownloadSizeEvidence + include Google::Apis::Core::Hashable + + # Download size broken down by URLs with the top download size. + # Corresponds to the JSON property `topUrlDownloadSizeBreakdowns` + # @return [Array] + attr_accessor :top_url_download_size_breakdowns + + # Total download size (in kilobytes) for all the resources in the creative. + # Corresponds to the JSON property `totalDownloadSizeKb` + # @return [Fixnum] + attr_accessor :total_download_size_kb + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @top_url_download_size_breakdowns = args[:top_url_download_size_breakdowns] if args.key?(:top_url_download_size_breakdowns) + @total_download_size_kb = args[:total_download_size_kb] if args.key?(:total_download_size_kb) + end + end + + # Response for a request to get remarketing tag. + class GetRemarketingTagResponse + include Google::Apis::Core::Hashable + + # A HTML tag that can be placed on the advertiser's page to add users to a + # user list. For more information and code samples on using snippet on your + # website refer to [Tag your site for remarketing]( + # https://support.google.com/google-ads/answer/2476688). + # Corresponds to the JSON property `snippet` + # @return [String] + attr_accessor :snippet + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @snippet = args[:snippet] if args.key?(:snippet) + end + end + + # HTML content for a creative. + class HtmlContent + include Google::Apis::Core::Hashable + + # The height of the HTML snippet in pixels. + # Can be used to filter the response of the + # creatives.list + # method. + # Corresponds to the JSON property `height` + # @return [Fixnum] + attr_accessor :height + + # The HTML snippet that displays the ad when inserted in the web page. + # Corresponds to the JSON property `snippet` + # @return [String] + attr_accessor :snippet + + # The width of the HTML snippet in pixels. + # Can be used to filter the response of the + # creatives.list + # method. + # Corresponds to the JSON property `width` + # @return [Fixnum] + attr_accessor :width + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @height = args[:height] if args.key?(:height) + @snippet = args[:snippet] if args.key?(:snippet) + @width = args[:width] if args.key?(:width) + end + end + + # HTTP calls made by a creative that resulted in policy violations. + class HttpCallEvidence + include Google::Apis::Core::Hashable + + # URLs of HTTP calls made by the creative. + # Corresponds to the JSON property `urls` + # @return [Array] + attr_accessor :urls + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @urls = args[:urls] if args.key?(:urls) + end + end + + # Evidence for HTTP cookie-related policy violations. + class HttpCookieEvidence + include Google::Apis::Core::Hashable + + # Names of cookies that violate Google policies. + # For TOO_MANY_COOKIES policy, this will be the cookie names of top domains + # with the largest number of cookies. For other policies, this will be all + # the cookie names that violate the policy. + # Corresponds to the JSON property `cookieNames` + # @return [Array] + attr_accessor :cookie_names + + # The largest number of cookies set by a creative. If this field is set, + # cookie_names above will be set to the cookie names of top domains with + # the largest number of cookies. + # This field will only be set for TOO_MANY_COOKIES policy. + # Corresponds to the JSON property `maxCookieCount` + # @return [Fixnum] + attr_accessor :max_cookie_count + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @cookie_names = args[:cookie_names] if args.key?(:cookie_names) + @max_cookie_count = args[:max_cookie_count] if args.key?(:max_cookie_count) + end + end + + # An image resource. You may provide a larger image than was requested, + # so long as the aspect ratio is preserved. + class Image + include Google::Apis::Core::Hashable + + # Image height in pixels. + # Corresponds to the JSON property `height` + # @return [Fixnum] + attr_accessor :height + + # The URL of the image. + # Corresponds to the JSON property `url` + # @return [String] + attr_accessor :url + + # Image width in pixels. + # Corresponds to the JSON property `width` + # @return [Fixnum] + attr_accessor :width + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @height = args[:height] if args.key?(:height) + @url = args[:url] if args.key?(:url) + @width = args[:width] if args.key?(:width) + end + end + + # A response for listing creatives. + class ListCreativesResponse + include Google::Apis::Core::Hashable + + # The list of creatives. + # Corresponds to the JSON property `creatives` + # @return [Array] + attr_accessor :creatives + + # A token to retrieve the next page of results. + # Pass this value in the + # ListCreativesRequest.pageToken + # field in the subsequent call to the `ListCreatives` method to retrieve the + # next page of results. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @creatives = args[:creatives] if args.key?(:creatives) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # The list user list response. + class ListUserListsResponse + include Google::Apis::Core::Hashable + + # The continuation page token to send back to the server in a subsequent + # request. + # Due to a currently known issue, it is recommended that the caller keep + # invoking the list method till the time a next page token is not returned + # (even if the result set is empty). + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # List of user lists from the search. + # Corresponds to the JSON property `userLists` + # @return [Array] + attr_accessor :user_lists + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @user_lists = args[:user_lists] if args.key?(:user_lists) + end + end + + # Information about each media file in the VAST. + class MediaFile + include Google::Apis::Core::Hashable + + # Bitrate of the video file, in Kbps. + # Can be used to filter the response of the + # creatives.list + # method. + # Corresponds to the JSON property `bitrate` + # @return [Fixnum] + attr_accessor :bitrate + + # The MIME type of this media file. + # Can be used to filter the response of the + # creatives.list + # method. + # Corresponds to the JSON property `mimeType` + # @return [String] + attr_accessor :mime_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @bitrate = args[:bitrate] if args.key?(:bitrate) + @mime_type = args[:mime_type] if args.key?(:mime_type) + end + end + + # Native content for a creative. + class NativeContent + include Google::Apis::Core::Hashable + + # The name of the advertiser or sponsor, to be displayed in the ad creative. + # Corresponds to the JSON property `advertiserName` + # @return [String] + attr_accessor :advertiser_name + + # An image resource. You may provide a larger image than was requested, + # so long as the aspect ratio is preserved. + # Corresponds to the JSON property `appIcon` + # @return [Google::Apis::RealtimebiddingV1::Image] + attr_accessor :app_icon + + # A long description of the ad. + # Corresponds to the JSON property `body` + # @return [String] + attr_accessor :body + + # A label for the button that the user is supposed to click. + # Corresponds to the JSON property `callToAction` + # @return [String] + attr_accessor :call_to_action + + # The URL that the browser/SDK will load when the user clicks the ad. + # Corresponds to the JSON property `clickLinkUrl` + # @return [String] + attr_accessor :click_link_url + + # The URL to use for click tracking. + # Corresponds to the JSON property `clickTrackingUrl` + # @return [String] + attr_accessor :click_tracking_url + + # A short title for the ad. + # Corresponds to the JSON property `headline` + # @return [String] + attr_accessor :headline + + # An image resource. You may provide a larger image than was requested, + # so long as the aspect ratio is preserved. + # Corresponds to the JSON property `image` + # @return [Google::Apis::RealtimebiddingV1::Image] + attr_accessor :image + + # An image resource. You may provide a larger image than was requested, + # so long as the aspect ratio is preserved. + # Corresponds to the JSON property `logo` + # @return [Google::Apis::RealtimebiddingV1::Image] + attr_accessor :logo + + # The price of the promoted app including currency info. + # Corresponds to the JSON property `priceDisplayText` + # @return [String] + attr_accessor :price_display_text + + # The app rating in the app store. Must be in the range [0-5]. + # Corresponds to the JSON property `starRating` + # @return [Float] + attr_accessor :star_rating + + # The URL to fetch a native video ad. + # Corresponds to the JSON property `videoUrl` + # @return [String] + attr_accessor :video_url + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @advertiser_name = args[:advertiser_name] if args.key?(:advertiser_name) + @app_icon = args[:app_icon] if args.key?(:app_icon) + @body = args[:body] if args.key?(:body) + @call_to_action = args[:call_to_action] if args.key?(:call_to_action) + @click_link_url = args[:click_link_url] if args.key?(:click_link_url) + @click_tracking_url = args[:click_tracking_url] if args.key?(:click_tracking_url) + @headline = args[:headline] if args.key?(:headline) + @image = args[:image] if args.key?(:image) + @logo = args[:logo] if args.key?(:logo) + @price_display_text = args[:price_display_text] if args.key?(:price_display_text) + @star_rating = args[:star_rating] if args.key?(:star_rating) + @video_url = args[:video_url] if args.key?(:video_url) + end + end + + # A request to open a specified user list. + class OpenUserListRequest + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # Each policy topic entry will represent a violation of a policy topic for a + # creative, with the policy topic information and optional evidence for the + # policy violation. + class PolicyTopicEntry + include Google::Apis::Core::Hashable + + # Pieces of evidence associated with this policy topic entry. + # Corresponds to the JSON property `evidences` + # @return [Array] + attr_accessor :evidences + + # URL of the help center article describing this policy topic. + # Corresponds to the JSON property `helpCenterUrl` + # @return [String] + attr_accessor :help_center_url + + # Policy topic this entry refers to. For example, "ALCOHOL", + # "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible + # policy topics is not fixed for a particular API version and may change at + # any time. + # Can be used to filter the response of the + # creatives.list + # method + # Corresponds to the JSON property `policyTopic` + # @return [String] + attr_accessor :policy_topic + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @evidences = args[:evidences] if args.key?(:evidences) + @help_center_url = args[:help_center_url] if args.key?(:help_center_url) + @policy_topic = args[:policy_topic] if args.key?(:policy_topic) + end + end + + # Evidence associated with a policy topic entry. + class PolicyTopicEvidence + include Google::Apis::Core::Hashable + + # Evidence that the creative's destination URL was not crawlable by Google. + # Corresponds to the JSON property `destinationNotCrawlable` + # @return [Google::Apis::RealtimebiddingV1::DestinationNotCrawlableEvidence] + attr_accessor :destination_not_crawlable + + # Evidence of the creative's destination URL not functioning properly or + # having been incorrectly set up. + # Corresponds to the JSON property `destinationNotWorking` + # @return [Google::Apis::RealtimebiddingV1::DestinationNotWorkingEvidence] + attr_accessor :destination_not_working + + # The full landing page URL of the destination. + # Corresponds to the JSON property `destinationUrl` + # @return [Google::Apis::RealtimebiddingV1::DestinationUrlEvidence] + attr_accessor :destination_url + + # Number of HTTP calls made by a creative, broken down by domain. + # Corresponds to the JSON property `domainCall` + # @return [Google::Apis::RealtimebiddingV1::DomainCallEvidence] + attr_accessor :domain_call + + # Total download size and URL-level download size breakdown for resources in + # a creative. + # Corresponds to the JSON property `downloadSize` + # @return [Google::Apis::RealtimebiddingV1::DownloadSizeEvidence] + attr_accessor :download_size + + # HTTP calls made by a creative that resulted in policy violations. + # Corresponds to the JSON property `httpCall` + # @return [Google::Apis::RealtimebiddingV1::HttpCallEvidence] + attr_accessor :http_call + + # Evidence for HTTP cookie-related policy violations. + # Corresponds to the JSON property `httpCookie` + # @return [Google::Apis::RealtimebiddingV1::HttpCookieEvidence] + attr_accessor :http_cookie + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @destination_not_crawlable = args[:destination_not_crawlable] if args.key?(:destination_not_crawlable) + @destination_not_working = args[:destination_not_working] if args.key?(:destination_not_working) + @destination_url = args[:destination_url] if args.key?(:destination_url) + @domain_call = args[:domain_call] if args.key?(:domain_call) + @download_size = args[:download_size] if args.key?(:download_size) + @http_call = args[:http_call] if args.key?(:http_call) + @http_cookie = args[:http_cookie] if args.key?(:http_cookie) + end + end + + # Serving status of the creative for a transaction type or a region. + class ServingStatus + include Google::Apis::Core::Hashable + + # Serving status for the given transaction type (e.g., open auction, + # deals) or region (e.g., China, Russia). + # Can be used to filter the response of the + # creatives.list + # method. + # Corresponds to the JSON property `status` + # @return [String] + attr_accessor :status + + # Policy topics related to the serving decision for this transaction type + # (e.g., open auction, deals) or region (e.g., China, Russia). + # Topics may be present only if status is DISAPPROVED. + # Corresponds to the JSON property `topics` + # @return [Array] + attr_accessor :topics + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @status = args[:status] if args.key?(:status) + @topics = args[:topics] if args.key?(:topics) + end + end + + # The URL-level breakdown for the download size. + class UrlDownloadSize + include Google::Apis::Core::Hashable + + # Download size of the URL in kilobytes. + # Corresponds to the JSON property `downloadSizeKb` + # @return [Fixnum] + attr_accessor :download_size_kb + + # The normalized URL with query parameters and fragment removed. + # Corresponds to the JSON property `normalizedUrl` + # @return [String] + attr_accessor :normalized_url + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @download_size_kb = args[:download_size_kb] if args.key?(:download_size_kb) + @normalized_url = args[:normalized_url] if args.key?(:normalized_url) + end + end + + # Represents the URL restriction (for the URL captured by the pixel callback) + # for a user list. + class UrlRestriction + include Google::Apis::Core::Hashable + + # Represents a whole or partial calendar date, e.g. a birthday. The time of day + # and time zone are either specified elsewhere or are not significant. The date + # is relative to the Proleptic Gregorian Calendar. This can represent: + # * A full date, with non-zero year, month and day values + # * A month and day value, with a zero year, e.g. an anniversary + # * A year on its own, with zero month and day values + # * A year and month value, with a zero day, e.g. a credit card expiration date + # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. + # Corresponds to the JSON property `endDate` + # @return [Google::Apis::RealtimebiddingV1::Date] + attr_accessor :end_date + + # The restriction type for the specified URL. + # Corresponds to the JSON property `restrictionType` + # @return [String] + attr_accessor :restriction_type + + # Represents a whole or partial calendar date, e.g. a birthday. The time of day + # and time zone are either specified elsewhere or are not significant. The date + # is relative to the Proleptic Gregorian Calendar. This can represent: + # * A full date, with non-zero year, month and day values + # * A month and day value, with a zero year, e.g. an anniversary + # * A year on its own, with zero month and day values + # * A year and month value, with a zero day, e.g. a credit card expiration date + # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. + # Corresponds to the JSON property `startDate` + # @return [Google::Apis::RealtimebiddingV1::Date] + attr_accessor :start_date + + # Required. The URL to use for applying the restriction on the user list. + # Corresponds to the JSON property `url` + # @return [String] + attr_accessor :url + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @end_date = args[:end_date] if args.key?(:end_date) + @restriction_type = args[:restriction_type] if args.key?(:restriction_type) + @start_date = args[:start_date] if args.key?(:start_date) + @url = args[:url] if args.key?(:url) + end + end + + # Represents an Authorized Buyers user list. Authorized Buyers can + # create/update/list user lists. Once a user list is created + # in the system, Authorized Buyers can add users to the user list using + # the bulk uploader API. Alternatively, users can be added by hosting a + # tag on the advertiser's page. + class UserList + include Google::Apis::Core::Hashable + + # The description for the user list. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # Required. Display name of the user list. This must be unique across all user + # lists + # for a given account. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Required. The number of days a user's cookie stays on the user list. + # The field must be between 0 and 540 inclusive. + # Corresponds to the JSON property `membershipDurationDays` + # @return [Fixnum] + attr_accessor :membership_duration_days + + # 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. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Output only. The status of the user list. A new user list starts out as open. + # Corresponds to the JSON property `status` + # @return [String] + attr_accessor :status + + # Represents the URL restriction (for the URL captured by the pixel callback) + # for a user list. + # Corresponds to the JSON property `urlRestriction` + # @return [Google::Apis::RealtimebiddingV1::UrlRestriction] + attr_accessor :url_restriction + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @description = args[:description] if args.key?(:description) + @display_name = args[:display_name] if args.key?(:display_name) + @membership_duration_days = args[:membership_duration_days] if args.key?(:membership_duration_days) + @name = args[:name] if args.key?(:name) + @status = args[:status] if args.key?(:status) + @url_restriction = args[:url_restriction] if args.key?(:url_restriction) + end + end + + # Video content for a creative. + class VideoContent + include Google::Apis::Core::Hashable + + # Video metadata for a creative. + # Corresponds to the JSON property `videoMetadata` + # @return [Google::Apis::RealtimebiddingV1::VideoMetadata] + attr_accessor :video_metadata + + # The URL to fetch a video ad. + # Corresponds to the JSON property `videoUrl` + # @return [String] + attr_accessor :video_url + + # The contents of a VAST document for a video ad. + # This document should conform to the VAST 2.0 or 3.0 standard. + # Corresponds to the JSON property `videoVastXml` + # @return [String] + attr_accessor :video_vast_xml + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @video_metadata = args[:video_metadata] if args.key?(:video_metadata) + @video_url = args[:video_url] if args.key?(:video_url) + @video_vast_xml = args[:video_vast_xml] if args.key?(:video_vast_xml) + end + end + + # Video metadata for a creative. + class VideoMetadata + include Google::Apis::Core::Hashable + + # The duration of the ad. + # Can be used to filter the response of the + # creatives.list + # method. + # Corresponds to the JSON property `duration` + # @return [String] + attr_accessor :duration + + # Is this a valid VAST ad? + # Can be used to filter the response of the + # creatives.list + # method. + # Corresponds to the JSON property `isValidVast` + # @return [Boolean] + attr_accessor :is_valid_vast + alias_method :is_valid_vast?, :is_valid_vast + + # Is this a VPAID ad? + # Can be used to filter the response of the + # creatives.list + # method. + # Corresponds to the JSON property `isVpaid` + # @return [Boolean] + attr_accessor :is_vpaid + alias_method :is_vpaid?, :is_vpaid + + # The list of all media files declared in the VAST. If there are multiple + # VASTs in a wrapper chain, this includes the media files from the deepest + # one in the chain. + # Corresponds to the JSON property `mediaFiles` + # @return [Array] + attr_accessor :media_files + + # The minimum duration that the user has to watch before being able to + # skip this ad. If the field is not set, the ad is not skippable. If + # the field is set, the ad is skippable. + # Can be used to filter the response of the + # creatives.list + # method. + # Corresponds to the JSON property `skipOffset` + # @return [String] + attr_accessor :skip_offset + + # The maximum VAST version across all wrapped VAST documents. + # Can be used to filter the response of the + # creatives.list + # method. + # Corresponds to the JSON property `vastVersion` + # @return [String] + attr_accessor :vast_version + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @duration = args[:duration] if args.key?(:duration) + @is_valid_vast = args[:is_valid_vast] if args.key?(:is_valid_vast) + @is_vpaid = args[:is_vpaid] if args.key?(:is_vpaid) + @media_files = args[:media_files] if args.key?(:media_files) + @skip_offset = args[:skip_offset] if args.key?(:skip_offset) + @vast_version = args[:vast_version] if args.key?(:vast_version) + end + end + + # A request to receive push notifications when any of the creatives belonging + # to the bidder changes status. + class WatchCreativesRequest + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # A response for the request to receive push notification when a bidder's + # creatives change status. + class WatchCreativesResponse + include Google::Apis::Core::Hashable + + # The Pub/Sub subscription that can be used to pull creative status + # notifications. This would be of the format + # `projects/`project_id`/subscriptions/`subscription_id``. + # Subscription is created with pull delivery. All service accounts belonging + # to the bidder will have read access to this subscription. + # Subscriptions that are inactive for more than 90 days will be disabled. + # Please use + # watchCreatives to + # re-enable the subscription. + # Corresponds to the JSON property `subscription` + # @return [String] + attr_accessor :subscription + + # The Pub/Sub topic that will be used to publish creative serving + # status notifications. This would be of the format + # `projects/`project_id`/topics/`topic_id``. + # Corresponds to the JSON property `topic` + # @return [String] + attr_accessor :topic + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @subscription = args[:subscription] if args.key?(:subscription) + @topic = args[:topic] if args.key?(:topic) + end + end + end + end +end diff --git a/generated/google/apis/realtimebidding_v1/representations.rb b/generated/google/apis/realtimebidding_v1/representations.rb new file mode 100644 index 000000000..7776dd6f1 --- /dev/null +++ b/generated/google/apis/realtimebidding_v1/representations.rb @@ -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 diff --git a/generated/google/apis/realtimebidding_v1/service.rb b/generated/google/apis/realtimebidding_v1/service.rb new file mode 100644 index 000000000..dd8188541 --- /dev/null +++ b/generated/google/apis/realtimebidding_v1/service.rb @@ -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 diff --git a/generated/google/apis/spanner_v1.rb b/generated/google/apis/spanner_v1.rb index d64a49a35..863fefb83 100644 --- a/generated/google/apis/spanner_v1.rb +++ b/generated/google/apis/spanner_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/spanner/ module SpannerV1 VERSION = 'V1' - REVISION = '20200526' + REVISION = '20200616' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/spanner_v1/classes.rb b/generated/google/apis/spanner_v1/classes.rb index 5e037a5f3..b02f9fc2d 100644 --- a/generated/google/apis/spanner_v1/classes.rb +++ b/generated/google/apis/spanner_v1/classes.rb @@ -190,10 +190,11 @@ module Google include Google::Apis::Core::Hashable # # Transactions - # Each session can have at most one active transaction at a time. After the - # active transaction is completed, the session can immediately be - # re-used for the next transaction. It is not necessary to create a - # new session for each transaction. + # Each session can have at most one active transaction at a time (note that + # standalone reads and queries use a transaction internally and do count + # towards the one transaction limit). After the active transaction is + # 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 # Cloud Spanner supports three transaction modes: # 1. Locking read-write. This type of transaction is the only way @@ -555,10 +556,11 @@ module Google attr_accessor :mutations # # Transactions - # Each session can have at most one active transaction at a time. After the - # active transaction is completed, the session can immediately be - # re-used for the next transaction. It is not necessary to create a - # new session for each transaction. + # Each session can have at most one active transaction at a time (note that + # standalone reads and queries use a transaction internally and do count + # towards the one transaction limit). After the active transaction is + # 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 # Cloud Spanner supports three transaction modes: # 1. Locking read-write. This type of transaction is the only way @@ -3519,10 +3521,11 @@ module Google end # # Transactions - # Each session can have at most one active transaction at a time. After the - # active transaction is completed, the session can immediately be - # re-used for the next transaction. It is not necessary to create a - # new session for each transaction. + # Each session can have at most one active transaction at a time (note that + # standalone reads and queries use a transaction internally and do count + # towards the one transaction limit). After the active transaction is + # 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 # Cloud Spanner supports three transaction modes: # 1. Locking read-write. This type of transaction is the only way @@ -3772,10 +3775,11 @@ module Google include Google::Apis::Core::Hashable # # Transactions - # Each session can have at most one active transaction at a time. After the - # active transaction is completed, the session can immediately be - # re-used for the next transaction. It is not necessary to create a - # new session for each transaction. + # Each session can have at most one active transaction at a time (note that + # standalone reads and queries use a transaction internally and do count + # towards the one transaction limit). After the active transaction is + # 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 # Cloud Spanner supports three transaction modes: # 1. Locking read-write. This type of transaction is the only way @@ -3997,10 +4001,11 @@ module Google attr_accessor :id # # Transactions - # Each session can have at most one active transaction at a time. After the - # active transaction is completed, the session can immediately be - # re-used for the next transaction. It is not necessary to create a - # new session for each transaction. + # Each session can have at most one active transaction at a time (note that + # standalone reads and queries use a transaction internally and do count + # towards the one transaction limit). After the active transaction is + # 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 # Cloud Spanner supports three transaction modes: # 1. Locking read-write. This type of transaction is the only way diff --git a/generated/google/apis/spanner_v1/service.rb b/generated/google/apis/spanner_v1/service.rb index 1607751a9..1e61b4717 100644 --- a/generated/google/apis/spanner_v1/service.rb +++ b/generated/google/apis/spanner_v1/service.rb @@ -1299,6 +1299,8 @@ module Google # be queried using the Operations API. # @param [String] database # Required. The database whose schema we wish to get. + # Values are of the form + # `projects//instances//databases/` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/speech_v1.rb b/generated/google/apis/speech_v1.rb index 8eb59445e..998f3007e 100644 --- a/generated/google/apis/speech_v1.rb +++ b/generated/google/apis/speech_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/speech-to-text/docs/quickstart-protocol module SpeechV1 VERSION = 'V1' - REVISION = '20200409' + REVISION = '20200617' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/speech_v1p1beta1.rb b/generated/google/apis/speech_v1p1beta1.rb index 114e9efc5..6590aa8c5 100644 --- a/generated/google/apis/speech_v1p1beta1.rb +++ b/generated/google/apis/speech_v1p1beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/speech-to-text/docs/quickstart-protocol module SpeechV1p1beta1 VERSION = 'V1p1beta1' - REVISION = '20200502' + REVISION = '20200617' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'