google-apis-adexchangebuyer2_v2beta1 0.1.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3accb2f3ccf7659006614d074d8705ac76b0c61ef670f113da64035ad2b13042
-  data.tar.gz: 075e955636eba87bf4fc82da76bb48e18aafb7bd3c43d8eb456e3d09931c13fa
+  metadata.gz: 73ce60ba50c8a2cdeeb216ce87f88edc096bf34232c4618e701b23861351291e
+  data.tar.gz: 51711e6fcf844bed62a0cb3fcc24c124d75d722a434a4ad4937971d8fafac0fe
 SHA512:
-  metadata.gz: 29169bb1beff56a34a39b4c6ffcc3b00a564434ce82e6625a05217a7241286e299b41b5920c9a49a32ff9dede823a388087078facbc2e8badee5e00201d02bd2
-  data.tar.gz: 0ca2c57ac159fc5cbb4732097f985dd60b1d438e60718329e8e6274e4e7ca8b609c4c31e539b073acf2c105d7e4b747c7adef0570ac8409af68f35c54f350010
+  metadata.gz: bf7732937c645877949a77e5840dbea7cd531952064d21ecee368d0cd01d28c374faef22d632ab5715a2666df818983b8a71b2cff8f6b442bf946d0c1f28bc55
+  data.tar.gz: 8d22428caf9a4c3939f3f89519c65a0d9f81725798a171c0928e275aec9f0560776021f0131405fbadbf3d156adf1f8230bfa48506a98a839ac1f3eaa09def42

data/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Release history for google-apis-adexchangebuyer2_v2beta1
 
+### v0.6.0 (2021-06-15)
+
+* Regenerated from discovery document revision 20210613
+* Regenerated using generator version 0.3.0
+
+### v0.5.0 (2021-05-26)
+
+* Regenerated from discovery document revision 20210525
+
+### v0.4.0 (2021-05-19)
+
+* Unspecified changes
+
+### v0.3.0 (2021-04-29)
+
+* Regenerated from discovery document revision 20210428
+* Regenerated using generator version 0.2.0
+
+### v0.2.0 (2021-03-04)
+
+* Regenerated from discovery document revision 20210223
+* Regenerated using generator version 0.1.2
+
 ### v0.1.0 (2021-01-07)
 
 * Regenerated using generator version 0.1.1

data/lib/google/apis/adexchangebuyer2_v2beta1/classes.rb

@@ -1443,8 +1443,7 @@ module Google
         # @return [Google::Apis::Adexchangebuyer2V2beta1::NonGuaranteedAuctionTerms]
         attr_accessor :non_guaranteed_auction_terms
       
-        # Terms for Preferred Deals. Note that Preferred Deals cannot be created via the
-        # API at this time, but can be returned in a get or list request.
+        # Terms for Preferred Deals.
         # Corresponds to the JSON property `nonGuaranteedFixedPriceTerms`
         # @return [Google::Apis::Adexchangebuyer2V2beta1::NonGuaranteedFixedPriceTerms]
         attr_accessor :non_guaranteed_fixed_price_terms
@@ -1843,11 +1842,30 @@ module Google
         # @return [Fixnum]
         attr_accessor :guaranteed_looks
       
+        # The lifetime impression cap for CPM sponsorship deals. The deal will stop
+        # serving when the cap is reached.
+        # Corresponds to the JSON property `impressionCap`
+        # @return [Fixnum]
+        attr_accessor :impression_cap
+      
         # Daily minimum looks for CPD deal types.
         # Corresponds to the JSON property `minimumDailyLooks`
         # @return [Fixnum]
         attr_accessor :minimum_daily_looks
       
+        # For sponsorship deals, this is the percentage of the seller's eligible
+        # impressions that the deal will serve until the cap is reached.
+        # Corresponds to the JSON property `percentShareOfVoice`
+        # @return [Fixnum]
+        attr_accessor :percent_share_of_voice
+      
+        # The reservation type for a Programmatic Guaranteed deal. This indicates
+        # whether the number of impressions is fixed, or a percent of available
+        # impressions. If not specified, the default reservation type is STANDARD.
+        # Corresponds to the JSON property `reservationType`
+        # @return [String]
+        attr_accessor :reservation_type
+      
         def initialize(**args)
            update!(**args)
         end
@@ -1857,7 +1875,10 @@ module Google
           @fixed_prices = args[:fixed_prices] if args.key?(:fixed_prices)
           @guaranteed_impressions = args[:guaranteed_impressions] if args.key?(:guaranteed_impressions)
           @guaranteed_looks = args[:guaranteed_looks] if args.key?(:guaranteed_looks)
+          @impression_cap = args[:impression_cap] if args.key?(:impression_cap)
           @minimum_daily_looks = args[:minimum_daily_looks] if args.key?(:minimum_daily_looks)
+          @percent_share_of_voice = args[:percent_share_of_voice] if args.key?(:percent_share_of_voice)
+          @reservation_type = args[:reservation_type] if args.key?(:reservation_type)
         end
       end
       
@@ -2857,8 +2878,7 @@ module Google
         end
       end
       
-      # Terms for Preferred Deals. Note that Preferred Deals cannot be created via the
-      # API at this time, but can be returned in a get or list request.
+      # Terms for Preferred Deals.
       class NonGuaranteedFixedPriceTerms
         include Google::Apis::Core::Hashable
       
@@ -2949,6 +2969,33 @@ module Google
         end
       end
       
+      # Request message to pause serving for finalized deals.
+      class PauseProposalDealsRequest
+        include Google::Apis::Core::Hashable
+      
+        # The external_deal_id's of the deals to be paused. If empty, all the deals in
+        # the proposal will be paused.
+        # Corresponds to the JSON property `externalDealIds`
+        # @return [Array<String>]
+        attr_accessor :external_deal_ids
+      
+        # The reason why the deals are being paused. This human readable message will be
+        # displayed in the seller's UI. (Max length: 1000 unicode code units.)
+        # 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)
+          @external_deal_ids = args[:external_deal_ids] if args.key?(:external_deal_ids)
+          @reason = args[:reason] if args.key?(:reason)
+        end
+      end
+      
       # Request message to pause serving for an already-finalized proposal.
       class PauseProposalRequest
         include Google::Apis::Core::Hashable
@@ -3100,10 +3147,9 @@ module Google
         end
       end
       
-      # Note: this resource requires whitelisting for access. Please contact your
-      # account manager for access to Marketplace resources. A product is a segment of
-      # inventory that a seller wishes to sell. It is associated with certain terms
-      # and targeting information which helps the buyer know more about the inventory.
+      # A product is a segment of inventory that a seller wishes to sell. It is
+      # associated with certain terms and targeting information which helps the buyer
+      # know more about the inventory.
       class Product
         include Google::Apis::Core::Hashable
       
@@ -3220,12 +3266,10 @@ module Google
         end
       end
       
-      # Note: this resource requires whitelisting for access. Please contact your
-      # account manager for access to Marketplace resources. Represents a proposal in
-      # the Marketplace. A proposal is the unit of negotiation between a seller and a
-      # buyer and contains deals which are served. Note: you can not update, create,
-      # or otherwise modify Private Auction or Preferred Deals deals through the API.
-      # Fields are updatable unless noted otherwise.
+      # Represents a proposal in the Marketplace. A proposal is the unit of
+      # negotiation between a seller and a buyer and contains deals which are served.
+      # Note: You can't update, create, or otherwise modify Private Auction deals
+      # through the API. Fields are updatable unless noted otherwise.
       class Proposal
         include Google::Apis::Core::Hashable
       
@@ -3365,11 +3409,9 @@ module Google
         end
       end
       
-      # Note: this resource requires whitelisting for access. Please contact your
-      # account manager for access to Marketplace resources. Represents a publisher
-      # profile (https://support.google.com/admanager/answer/6035806) in Marketplace.
-      # All fields are read only. All string fields are free-form text entered by the
-      # publisher unless noted otherwise.
+      # Represents a publisher profile (https://support.google.com/admanager/answer/
+      # 6035806) in Marketplace. All fields are read only. All string fields are free-
+      # form text entered by the publisher unless noted otherwise.
       class PublisherProfile
         include Google::Apis::Core::Hashable
       
@@ -3604,6 +3646,26 @@ module Google
         end
       end
       
+      # Request message to resume (unpause) serving for already-finalized deals.
+      class ResumeProposalDealsRequest
+        include Google::Apis::Core::Hashable
+      
+        # The external_deal_id's of the deals to resume. If empty, all the deals in the
+        # proposal will be resumed.
+        # Corresponds to the JSON property `externalDealIds`
+        # @return [Array<String>]
+        attr_accessor :external_deal_ids
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @external_deal_ids = args[:external_deal_ids] if args.key?(:external_deal_ids)
+        end
+      end
+      
       # Request message to resume (unpause) serving for an already-finalized proposal.
       class ResumeProposalRequest
         include Google::Apis::Core::Hashable

data/lib/google/apis/adexchangebuyer2_v2beta1/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module Adexchangebuyer2V2beta1
       # Version of the google-apis-adexchangebuyer2_v2beta1 gem
-      GEM_VERSION = "0.1.0"
+      GEM_VERSION = "0.6.0"
 
       # Version of the code generator used to generate this client
-      GENERATOR_VERSION = "0.1.1"
+      GENERATOR_VERSION = "0.3.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20201202"
+      REVISION = "20210613"
     end
   end
 end

data/lib/google/apis/adexchangebuyer2_v2beta1/representations.rb

@@ -478,6 +478,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class PauseProposalDealsRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class PauseProposalRequest
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -556,6 +562,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class ResumeProposalDealsRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class ResumeProposalRequest
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -1136,7 +1148,10 @@ module Google
       
           property :guaranteed_impressions, :numeric_string => true, as: 'guaranteedImpressions'
           property :guaranteed_looks, :numeric_string => true, as: 'guaranteedLooks'
+          property :impression_cap, :numeric_string => true, as: 'impressionCap'
           property :minimum_daily_looks, :numeric_string => true, as: 'minimumDailyLooks'
+          property :percent_share_of_voice, :numeric_string => true, as: 'percentShareOfVoice'
+          property :reservation_type, as: 'reservationType'
         end
       end
       
@@ -1477,6 +1492,14 @@ module Google
         end
       end
       
+      class PauseProposalDealsRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :external_deal_ids, as: 'externalDealIds'
+          property :reason, as: 'reason'
+        end
+      end
+      
       class PauseProposalRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1643,6 +1666,13 @@ module Google
         end
       end
       
+      class ResumeProposalDealsRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :external_deal_ids, as: 'externalDealIds'
+        end
+      end
+      
       class ResumeProposalRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

data/lib/google/apis/adexchangebuyer2_v2beta1/service.rb

@@ -852,6 +852,90 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Update given deals to pause serving. This method will set the `
+        # DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to true for all
+        # listed deals in the request. Currently, this method only applies to PG and PD
+        # deals. For PA deals, please call accounts.proposals.pause endpoint. It is a no-
+        # op to pause already-paused deals. It is an error to call PauseProposalDeals
+        # for deals which are not part of the proposal of proposal_id or which are not
+        # finalized or renegotiating.
+        # @param [String] account_id
+        #   Account ID of the buyer.
+        # @param [String] proposal_id
+        #   The proposal_id of the proposal containing the deals.
+        # @param [Google::Apis::Adexchangebuyer2V2beta1::PauseProposalDealsRequest] pause_proposal_deals_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::Adexchangebuyer2V2beta1::Proposal] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::Adexchangebuyer2V2beta1::Proposal]
+        #
+        # @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 pause_finalized_proposal_proposal_deals(account_id, proposal_id, pause_proposal_deals_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v2beta1/accounts/{accountId}/finalizedProposals/{proposalId}:pause', options)
+          command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::PauseProposalDealsRequest::Representation
+          command.request_object = pause_proposal_deals_request_object
+          command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Proposal::Representation
+          command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Proposal
+          command.params['accountId'] = account_id unless account_id.nil?
+          command.params['proposalId'] = proposal_id unless proposal_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
+        
+        # Update given deals to resume serving. This method will set the `
+        # DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to false for all
+        # listed deals in the request. Currently, this method only applies to PG and PD
+        # deals. For PA deals, please call accounts.proposals.resume endpoint. It is a
+        # no-op to resume running deals or deals paused by the other party. It is an
+        # error to call ResumeProposalDeals for deals which are not part of the proposal
+        # of proposal_id or which are not finalized or renegotiating.
+        # @param [String] account_id
+        #   Account ID of the buyer.
+        # @param [String] proposal_id
+        #   The proposal_id of the proposal containing the deals.
+        # @param [Google::Apis::Adexchangebuyer2V2beta1::ResumeProposalDealsRequest] resume_proposal_deals_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::Adexchangebuyer2V2beta1::Proposal] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::Adexchangebuyer2V2beta1::Proposal]
+        #
+        # @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 resume_finalized_proposal_proposal_deals(account_id, proposal_id, resume_proposal_deals_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v2beta1/accounts/{accountId}/finalizedProposals/{proposalId}:resume', options)
+          command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::ResumeProposalDealsRequest::Representation
+          command.request_object = resume_proposal_deals_request_object
+          command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Proposal::Representation
+          command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Proposal
+          command.params['accountId'] = account_id unless account_id.nil?
+          command.params['proposalId'] = proposal_id unless proposal_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
+        
         # Gets the requested product by ID.
         # @param [String] account_id
         #   Account ID of the buyer.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-adexchangebuyer2_v2beta1
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-08 00:00:00.000000000 Z
+date: 2021-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -52,7 +52,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-adexchangebuyer2_v2beta1/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-adexchangebuyer2_v2beta1/v0.1.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-adexchangebuyer2_v2beta1/v0.6.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-adexchangebuyer2_v2beta1
 post_install_message: 
 rdoc_options: []
@@ -62,14 +62,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.17
 signing_key: 
 specification_version: 4
 summary: Simple REST client for Ad Exchange Buyer API II V2beta1