google-apis-authorizedbuyersmarketplace_v1 0.22.0 → 0.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6149f11cb3e1b338ff7e885922200e5798eb72a663d6355e0d2e355e12153ab
-  data.tar.gz: ed287bf4d81fcd86559f7560cb08c52f15d038328f29e0ad8813fefe9e22356f
+  metadata.gz: 5e1a4a3d47cfbb8dbe12642842b849d73c1d9fabe40eb3f978ae34eebdb0e2fb
+  data.tar.gz: b607395fb6c10cef060ca684ac728b4609b4759b97b85fbce81b9257576d7fd8
 SHA512:
-  metadata.gz: a4385a8fe232ee25df2bd11fb14f8e1e24aa5db5d7a945b264ad854db3c99b3d4eb01da330320e8927eab47507b391cb2fce28c0387abf0dce430b2fdfc0614f
-  data.tar.gz: c39ea92f4c7d6917b21cae9e6367c3881f1ab71c8dfbe7f123e3eb1a1cf972d44db756e2df0179d56851df381454a53b26738e4798d5771fb6c0ae0abfc61ce0
+  metadata.gz: b00cea97c958ca17bd8748676cbf2bc7d62214bd534dc7a8ea73a9ce382089841b756d2b3ac9d4c6094d63e5ea873a3b52b3456f7d36524297d5e67a1fd0763e
+  data.tar.gz: 515248feb306fad55825df5c39849c889e5f6904d04ba23685dd70881e81d306c0bca609f0037c048e234fb57078d98d8637aa42a448c8655e1715b8f6078dfd

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release history for google-apis-authorizedbuyersmarketplace_v1
 
+### v0.24.0 (2024-04-21)
+
+* Regenerated from discovery document revision 20240418
+
+### v0.23.0 (2024-03-10)
+
+* Regenerated from discovery document revision 20240304
+
 ### v0.22.0 (2024-02-23)
 
 * Regenerated using generator version 0.14.0

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

@@ -168,6 +168,13 @@ module Google
         # @return [String]
         attr_accessor :display_name
       
+        # Output only. If set, this field contains the list of DSP specific seat ids set
+        # by media planners that are eligible to transact on this deal. The seat ID is
+        # in the calling DSP's namespace.
+        # Corresponds to the JSON property `eligibleSeatIds`
+        # @return [Array<String>]
+        attr_accessor :eligible_seat_ids
+      
         # Immutable. The unique identifier for the auction package. Format: `buyers/`
         # accountId`/auctionPackages/`auctionPackageId`` The auction_package_id part of
         # name is sent in the BidRequest to all RTB bidders and is returned as deal_id
@@ -176,12 +183,27 @@ module Google
         # @return [String]
         attr_accessor :name
       
-        # Output only. The list of clients of the current buyer that are subscribed to
-        # the AuctionPackage. Format: `buyers/`buyerAccountId`/clients/`clientAccountId``
+        # Output only. The list of buyers that are subscribed to the AuctionPackage.
+        # This field is only populated when calling as a bidder. Format: `buyers/`
+        # buyerAccountId``
+        # Corresponds to the JSON property `subscribedBuyers`
+        # @return [Array<String>]
+        attr_accessor :subscribed_buyers
+      
+        # Output only. When calling as a buyer, the list of clients of the current buyer
+        # that are subscribed to the AuctionPackage. When calling as a bidder, the list
+        # of clients that are subscribed to the AuctionPackage owned by the bidder or
+        # its buyers. Format: `buyers/`buyerAccountId`/clients/`clientAccountId``
         # Corresponds to the JSON property `subscribedClients`
         # @return [Array<String>]
         attr_accessor :subscribed_clients
       
+        # Output only. The list of media planners that are subscribed to the
+        # AuctionPackage. This field is only populated when calling as a bidder.
+        # Corresponds to the JSON property `subscribedMediaPlanners`
+        # @return [Array<Google::Apis::AuthorizedbuyersmarketplaceV1::MediaPlanner>]
+        attr_accessor :subscribed_media_planners
+      
         # Output only. Time the auction package was last updated. This value is only
         # increased when this auction package is updated but never when a buyer
         # subscribed.
@@ -199,8 +221,11 @@ module Google
           @creator = args[:creator] if args.key?(:creator)
           @description = args[:description] if args.key?(:description)
           @display_name = args[:display_name] if args.key?(:display_name)
+          @eligible_seat_ids = args[:eligible_seat_ids] if args.key?(:eligible_seat_ids)
           @name = args[:name] if args.key?(:name)
+          @subscribed_buyers = args[:subscribed_buyers] if args.key?(:subscribed_buyers)
           @subscribed_clients = args[:subscribed_clients] if args.key?(:subscribed_clients)
+          @subscribed_media_planners = args[:subscribed_media_planners] if args.key?(:subscribed_media_planners)
           @update_time = args[:update_time] if args.key?(:update_time)
         end
       end
@@ -551,13 +576,14 @@ module Google
         # Output only. When the client field is populated, this field refers to the
         # buyer who creates and manages the client buyer and gets billed on behalf of
         # the client buyer; when the buyer field is populated, this field is the same
-        # value as buyer. Format : `buyers/`buyerAccountId``
+        # value as buyer; when the deal belongs to a media planner account, this field
+        # will be empty. Format : `buyers/`buyerAccountId``
         # Corresponds to the JSON property `billedBuyer`
         # @return [String]
         attr_accessor :billed_buyer
       
-        # Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/`
-        # buyerAccountId``
+        # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource.
+        # Format: `buyers/`buyerAccountId``
         # Corresponds to the JSON property `buyer`
         # @return [String]
         attr_accessor :buyer
@@ -600,6 +626,13 @@ module Google
         # @return [String]
         attr_accessor :display_name
       
+        # Output only. If set, this field contains the list of DSP specific seat ids set
+        # by media planners that are eligible to transact on this deal. The seat ID is
+        # in the calling DSP's namespace.
+        # Corresponds to the JSON property `eligibleSeatIds`
+        # @return [Array<String>]
+        attr_accessor :eligible_seat_ids
+      
         # Represents an amount of money with its currency type.
         # Corresponds to the JSON property `estimatedGrossSpend`
         # @return [Google::Apis::AuthorizedbuyersmarketplaceV1::Money]
@@ -619,6 +652,11 @@ module Google
         # @return [String]
         attr_accessor :flight_start_time
       
+        # Describes a single Media Planner account.
+        # Corresponds to the JSON property `mediaPlanner`
+        # @return [Google::Apis::AuthorizedbuyersmarketplaceV1::MediaPlanner]
+        attr_accessor :media_planner
+      
         # Immutable. The unique identifier of the deal. Auto-generated by the server
         # when a deal is created. Format: buyers/`accountId`/proposals/`proposalId`/
         # deals/`dealId`
@@ -691,9 +729,11 @@ module Google
           @delivery_control = args[:delivery_control] if args.key?(:delivery_control)
           @description = args[:description] if args.key?(:description)
           @display_name = args[:display_name] if args.key?(:display_name)
+          @eligible_seat_ids = args[:eligible_seat_ids] if args.key?(:eligible_seat_ids)
           @estimated_gross_spend = args[:estimated_gross_spend] if args.key?(:estimated_gross_spend)
           @flight_end_time = args[:flight_end_time] if args.key?(:flight_end_time)
           @flight_start_time = args[:flight_start_time] if args.key?(:flight_start_time)
+          @media_planner = args[:media_planner] if args.key?(:media_planner)
           @name = args[:name] if args.key?(:name)
           @preferred_deal_terms = args[:preferred_deal_terms] if args.key?(:preferred_deal_terms)
           @private_auction_terms = args[:private_auction_terms] if args.key?(:private_auction_terms)
@@ -1217,6 +1257,25 @@ module Google
         end
       end
       
+      # Describes a single Media Planner account.
+      class MediaPlanner
+        include Google::Apis::Core::Hashable
+      
+        # Output only. Account ID of the media planner.
+        # Corresponds to the JSON property `accountId`
+        # @return [String]
+        attr_accessor :account_id
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @account_id = args[:account_id] if args.key?(:account_id)
+        end
+      end
+      
       # Mobile application targeting settings.
       class MobileApplicationTargeting
         include Google::Apis::Core::Hashable

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

@@ -16,13 +16,13 @@ module Google
   module Apis
     module AuthorizedbuyersmarketplaceV1
       # Version of the google-apis-authorizedbuyersmarketplace_v1 gem
-      GEM_VERSION = "0.22.0"
+      GEM_VERSION = "0.24.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.14.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20231129"
+      REVISION = "20240418"
     end
   end
 end

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

@@ -238,6 +238,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class MediaPlanner
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class MobileApplicationTargeting
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -456,8 +462,12 @@ module Google
           property :creator, as: 'creator'
           property :description, as: 'description'
           property :display_name, as: 'displayName'
+          collection :eligible_seat_ids, as: 'eligibleSeatIds'
           property :name, as: 'name'
+          collection :subscribed_buyers, as: 'subscribedBuyers'
           collection :subscribed_clients, as: 'subscribedClients'
+          collection :subscribed_media_planners, as: 'subscribedMediaPlanners', class: Google::Apis::AuthorizedbuyersmarketplaceV1::MediaPlanner, decorator: Google::Apis::AuthorizedbuyersmarketplaceV1::MediaPlanner::Representation
+      
           property :update_time, as: 'updateTime'
         end
       end
@@ -579,10 +589,13 @@ module Google
       
           property :description, as: 'description'
           property :display_name, as: 'displayName'
+          collection :eligible_seat_ids, as: 'eligibleSeatIds'
           property :estimated_gross_spend, as: 'estimatedGrossSpend', class: Google::Apis::AuthorizedbuyersmarketplaceV1::Money, decorator: Google::Apis::AuthorizedbuyersmarketplaceV1::Money::Representation
       
           property :flight_end_time, as: 'flightEndTime'
           property :flight_start_time, as: 'flightStartTime'
+          property :media_planner, as: 'mediaPlanner', class: Google::Apis::AuthorizedbuyersmarketplaceV1::MediaPlanner, decorator: Google::Apis::AuthorizedbuyersmarketplaceV1::MediaPlanner::Representation
+      
           property :name, as: 'name'
           property :preferred_deal_terms, as: 'preferredDealTerms', class: Google::Apis::AuthorizedbuyersmarketplaceV1::PreferredDealTerms, decorator: Google::Apis::AuthorizedbuyersmarketplaceV1::PreferredDealTerms::Representation
       
@@ -761,6 +774,13 @@ module Google
         end
       end
       
+      class MediaPlanner
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :account_id, as: 'accountId'
+        end
+      end
+      
       class MobileApplicationTargeting
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

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

@@ -52,6 +52,56 @@ module Google
           @batch_path = 'batch'
         end
         
+        # List the auction packages. Buyers can use the URL path "/v1/buyers/`accountId`/
+        # auctionPackages" to list auction packages for the current buyer and its
+        # clients. Bidders can use the URL path "/v1/bidders/`accountId`/auctionPackages"
+        # to list auction packages for the bidder, its media planners, its buyers, and
+        # all their clients.
+        # @param [String] parent
+        #   Required. Name of the parent buyer that can access the auction package. Format:
+        #   `buyers/`accountId``. When used with a bidder account, the auction packages
+        #   that the bidder, its media planners, its buyers and clients are subscribed to
+        #   will be listed, in the format `bidders/`accountId``.
+        # @param [String] filter
+        #   Optional. Optional query string using the [Cloud API list filtering syntax](/
+        #   authorized-buyers/apis/guides/list-filters). Only supported when parent is
+        #   bidder. Supported columns for filtering are: * displayName * createTime *
+        #   updateTime * eligibleSeatIds
+        # @param [Fixnum] page_size
+        #   Requested page size. The server may return fewer results than requested. Max
+        #   allowed page size is 500.
+        # @param [String] page_token
+        #   The page token as returned. ListAuctionPackagesResponse.nextPageToken
+        # @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::AuthorizedbuyersmarketplaceV1::ListAuctionPackagesResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AuthorizedbuyersmarketplaceV1::ListAuctionPackagesResponse]
+        #
+        # @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_auction_packages(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1/{+parent}/auctionPackages', options)
+          command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::ListAuctionPackagesResponse::Representation
+          command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::ListAuctionPackagesResponse
+          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['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Lists finalized deals. Use the URL path "/v1/buyers/`accountId`/finalizedDeals"
         # to list finalized deals for the current buyer and its clients. Bidders can
         # use the URL path "/v1/bidders/`accountId`/finalizedDeals" to list finalized
@@ -65,7 +115,7 @@ module Google
         #   developers.google.com/authorized-buyers/apis/guides/list-filters) Supported
         #   columns for filtering are: * deal.displayName * deal.dealType * deal.
         #   createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime *
-        #   dealServingStatus
+        #   deal.eligibleSeatIds * dealServingStatus
         # @param [String] order_by
         #   An optional query string to sort finalized deals using the [Cloud API sorting
         #   syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order).
@@ -143,10 +193,21 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # List the auction packages subscribed by a buyer and its clients.
+        # List the auction packages. Buyers can use the URL path "/v1/buyers/`accountId`/
+        # auctionPackages" to list auction packages for the current buyer and its
+        # clients. Bidders can use the URL path "/v1/bidders/`accountId`/auctionPackages"
+        # to list auction packages for the bidder, its media planners, its buyers, and
+        # all their clients.
         # @param [String] parent
         #   Required. Name of the parent buyer that can access the auction package. Format:
-        #   `buyers/`accountId``
+        #   `buyers/`accountId``. When used with a bidder account, the auction packages
+        #   that the bidder, its media planners, its buyers and clients are subscribed to
+        #   will be listed, in the format `bidders/`accountId``.
+        # @param [String] filter
+        #   Optional. Optional query string using the [Cloud API list filtering syntax](/
+        #   authorized-buyers/apis/guides/list-filters). Only supported when parent is
+        #   bidder. Supported columns for filtering are: * displayName * createTime *
+        #   updateTime * eligibleSeatIds
         # @param [Fixnum] page_size
         #   Requested page size. The server may return fewer results than requested. Max
         #   allowed page size is 500.
@@ -169,11 +230,12 @@ 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_buyer_auction_packages(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
+        def list_buyer_auction_packages(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
           command = make_simple_command(:get, 'v1/{+parent}/auctionPackages', options)
           command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::ListAuctionPackagesResponse::Representation
           command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::ListAuctionPackagesResponse
           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['fields'] = fields unless fields.nil?
@@ -844,7 +906,7 @@ module Google
         #   developers.google.com/authorized-buyers/apis/guides/list-filters) Supported
         #   columns for filtering are: * deal.displayName * deal.dealType * deal.
         #   createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime *
-        #   dealServingStatus
+        #   deal.eligibleSeatIds * dealServingStatus
         # @param [String] order_by
         #   An optional query string to sort finalized deals using the [Cloud API sorting
         #   syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order).

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-authorizedbuyersmarketplace_v1
 version: !ruby/object:Gem::Version
-  version: 0.22.0
+  version: 0.24.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-25 00:00:00.000000000 Z
+date: 2024-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -58,7 +58,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/main/generated/google-apis-authorizedbuyersmarketplace_v1/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-authorizedbuyersmarketplace_v1/v0.22.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-authorizedbuyersmarketplace_v1/v0.24.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-authorizedbuyersmarketplace_v1
 post_install_message: 
 rdoc_options: []