{ "name": "authorizedbuyersmarketplace", "servicePath": "", "canonicalName": "Authorized Buyers Marketplace", "protocol": "rest", "ownerDomain": "google.com", "id": "authorizedbuyersmarketplace:v1", "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/authorized-buyers-marketplace": { "description": "See, create, edit, and delete your Authorized Buyers Marketplace entities." } } } }, "parameters": { "fields": { "description": "Selector specifying which fields to include in a partial response.", "location": "query", "type": "string" }, "upload_protocol": { "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query", "type": "string" }, "access_token": { "type": "string", "description": "OAuth access token.", "location": "query" }, "uploadType": { "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query", "type": "string" }, "key": { "type": "string", "description": "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.", "location": "query" }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks.", "default": "true", "location": "query" }, "quotaUser": { "description": "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.", "location": "query", "type": "string" }, "$.xgafv": { "location": "query", "enum": [ "1", "2" ], "description": "V1 error format.", "enumDescriptions": [ "v1 error format", "v2 error format" ], "type": "string" }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user.", "location": "query" }, "alt": { "location": "query", "description": "Data format for response.", "default": "json", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "type": "string", "enum": [ "json", "media", "proto" ] }, "callback": { "description": "JSONP", "location": "query", "type": "string" } }, "title": "Authorized Buyers Marketplace API", "rootUrl": "https://authorizedbuyersmarketplace.googleapis.com/", "version": "v1", "description": "The Authorized Buyers Marketplace API lets buyers programmatically discover inventory; propose, retrieve and negotiate deals with publishers.", "batchPath": "batch", "documentationLink": "https://developers.google.com/authorized-buyers/apis/marketplace/reference/rest/", "kind": "discovery#restDescription", "basePath": "", "mtlsRootUrl": "https://authorizedbuyersmarketplace.mtls.googleapis.com/", "version_module": true, "discoveryVersion": "v1", "ownerName": "Google", "baseUrl": "https://authorizedbuyersmarketplace.googleapis.com/", "schemas": { "InventoryTypeTargeting": { "id": "InventoryTypeTargeting", "description": "Targeting of the inventory types a bid request can originate from.", "properties": { "inventoryTypes": { "description": "The list of targeted inventory types for the bid request.", "items": { "type": "string", "enumDescriptions": [ "Unspecified inventory type", "Desktop or mobile web browser excluding ads inside a video player", "Mobile apps other than video players and web browsers", "Instream video and audio" ], "enum": [ "INVENTORY_TYPE_UNSPECIFIED", "BROWSER", "MOBILE_APP", "VIDEO_PLAYER" ] }, "type": "array" } }, "type": "object" }, "PrivateData": { "description": "Buyers are allowed to store certain types of private data in a proposal.", "properties": { "referenceId": { "type": "string", "description": "A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units)." } }, "type": "object", "id": "PrivateData" }, "PublisherProfile": { "description": "The values in the publisher profile are supplied by the publisher. All fields are not filterable unless stated otherwise.", "properties": { "mediaKitUrl": { "type": "string", "description": "URL to additional marketing and sales materials." }, "name": { "type": "string", "description": "Name of the publisher profile. Format: `buyers/{buyer}/publisherProfiles/{publisher_profile}`" }, "pitchStatement": { "description": "Statement explaining what's unique about publisher's business, and why buyers should partner with the publisher.", "type": "string" }, "publisherCode": { "type": "string", "description": "A unique identifying code for the seller. This value is the same for all of the seller's parent and child publisher profiles. Can be used to filter the response of the publisherProfiles.list method." }, "audienceDescription": { "description": "Description on the publisher's audience.", "type": "string" }, "directDealsContact": { "type": "string", "description": "Contact information for direct reservation deals. This is free text entered by the publisher and may include information like names, phone numbers and email addresses." }, "overview": { "description": "Overview of the publisher.", "type": "string" }, "programmaticDealsContact": { "type": "string", "description": "Contact information for programmatic deals. This is free text entered by the publisher and may include information like names, phone numbers and email addresses." }, "samplePageUrl": { "type": "string", "description": "URL to a sample content page." }, "topHeadlines": { "type": "array", "description": "Up to three key metrics and rankings. For example, \"#1 Mobile News Site for 20 Straight Months\".", "items": { "type": "string" } }, "displayName": { "type": "string", "description": "Display name of the publisher profile. Can be used to filter the response of the publisherProfiles.list method." }, "domains": { "type": "array", "description": "The list of domains represented in this publisher profile. Empty if this is a parent profile. These are top private domains, meaning that these will not contain a string like \"photos.google.co.uk/123\", but will instead contain \"google.co.uk\". Can be used to filter the response of the publisherProfiles.list method.", "items": { "type": "string" } }, "mobileApps": { "description": "The list of apps represented in this publisher profile. Empty if this is a parent profile.", "items": { "$ref": "PublisherProfileMobileApplication" }, "type": "array" }, "logoUrl": { "description": "A Google public URL to the logo for this publisher profile. The logo is stored as a PNG, JPG, or GIF image.", "type": "string" }, "isParent": { "description": "Indicates if this profile is the parent profile of the seller. A parent profile represents all the inventory from the seller, as opposed to child profile that is created to brand a portion of inventory. One seller has only one parent publisher profile, and can have multiple child profiles. See https://support.google.com/admanager/answer/6035806 for details. Can be used to filter the response of the publisherProfiles.list method by setting the filter to \"is_parent: true\".", "type": "boolean" } }, "type": "object", "id": "PublisherProfile" }, "TimeOfDay": { "type": "object", "description": "Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.", "properties": { "seconds": { "format": "int32", "description": "Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.", "type": "integer" }, "minutes": { "format": "int32", "description": "Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.", "type": "integer" }, "nanos": { "format": "int32", "type": "integer", "description": "Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999." }, "hours": { "description": "Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", "type": "integer", "format": "int32" } }, "id": "TimeOfDay" }, "ListFinalizedDealsResponse": { "type": "object", "description": "Response message for listing finalized deals.", "properties": { "finalizedDeals": { "type": "array", "description": "The list of finalized deals.", "items": { "$ref": "FinalizedDeal" } }, "nextPageToken": { "description": "Token to fetch the next page of results.", "type": "string" } }, "id": "ListFinalizedDealsResponse" }, "DayPartTargeting": { "description": "Represents Daypart targeting.", "properties": { "dayParts": { "description": "The targeted weekdays and times", "items": { "$ref": "DayPart" }, "type": "array" }, "timeZoneType": { "type": "string", "description": "The time zone type of the day parts", "enumDescriptions": [ "Default value. This field is unused.", "The publisher's time zone", "The user's time zone" ], "enum": [ "TIME_ZONE_TYPE_UNSPECIFIED", "SELLER", "USER" ] } }, "type": "object", "id": "DayPartTargeting" }, "ListDealsResponse": { "id": "ListDealsResponse", "type": "object", "description": "Response message for listing deals in a proposal.", "properties": { "deals": { "description": "The list of deals.", "items": { "$ref": "Deal" }, "type": "array" }, "nextPageToken": { "description": "Token to fetch the next page of results.", "type": "string" } } }, "DeliveryControl": { "type": "object", "description": "Message contains details about how the deal will be paced.", "properties": { "deliveryRateType": { "enum": [ "DELIVERY_RATE_TYPE_UNSPECIFIED", "EVENLY", "FRONT_LOADED", "AS_FAST_AS_POSSIBLE" ], "readOnly": true, "type": "string", "description": "Output only. Specifies how the impression delivery will be paced.", "enumDescriptions": [ "A placeholder for an undefined delivery rate type.", "Impressions are served uniformly over the life of the deal.", "Impressions are served front-loaded.", "Impressions are served as fast as possible." ] }, "companionDeliveryType": { "type": "string", "description": "Output only. Specifies roadblocking in a main companion lineitem.", "enumDescriptions": [ "A placeholder for an unspecified companion delivery type.", "Companions are not required to serve a creative set. The creative set can serve an inventory that has zero or more matching companions.", "At least one companion must be served in order for the creative set to be used.", "All companions in the set must be served in order for the creative set to be used. This can still serve to inventory that has more companions than can be filled." ], "enum": [ "COMPANION_DELIVERY_TYPE_UNSPECIFIED", "DELIVERY_OPTIONAL", "DELIVERY_AT_LEAST_ONE", "DELIVERY_ALL" ], "readOnly": true }, "creativeRotationType": { "enum": [ "CREATIVE_ROTATION_TYPE_UNSPECIFIED", "ROTATION_EVEN", "ROTATION_OPTIMIZED", "ROTATION_MANUAL", "ROTATION_SEQUENTIAL" ], "readOnly": true, "type": "string", "description": "Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.", "enumDescriptions": [ "Creatives are displayed roughly the same number of times over the duration of the deal.", "Creatives are displayed roughly the same number of times over the duration of the deal.", "Creatives are served roughly proportionally to their performance.", "Creatives are served roughly proportionally to their weights.", "Creatives are served exactly in sequential order, also known as Storyboarding." ] }, "frequencyCap": { "description": "Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.", "items": { "$ref": "FrequencyCap" }, "type": "array", "readOnly": true }, "roadblockingType": { "type": "string", "description": "Output only. Specifies the roadblocking type in display creatives.", "enumDescriptions": [ "A placeholder for an unspecified roadblocking type.", "Only one creative from a deal can serve per ad request. https://support.google.com/admanager/answer/177277.", "Any number of creatives from a deal can serve together per ad request.", "As many creatives from a deal as can fit on a page will serve. This could mean anywhere from one to all of a deal's creatives given the size constraints of ad slots on a page.", "All or none of the creatives from a deal will serve.", "A main/companion creative set roadblocking type." ], "enum": [ "ROADBLOCKING_TYPE_UNSPECIFIED", "ONLY_ONE", "ONE_OR_MORE", "AS_MANY_AS_POSSIBLE", "ALL_ROADBLOCK", "CREATIVE_SET" ], "readOnly": true } }, "id": "DeliveryControl" }, "ListClientsResponse": { "type": "object", "description": "Response message for the list method.", "properties": { "clients": { "description": "The returned list of clients.", "items": { "$ref": "Client" }, "type": "array" }, "nextPageToken": { "type": "string", "description": "A token to retrieve the next page of results. Pass this value in the ListClientsRequest.pageToken field in the subsequent call to the list method to retrieve the next page of results." } }, "id": "ListClientsResponse" }, "AuctionPackage": { "id": "AuctionPackage", "type": "object", "description": "Defines a segment of inventory that buyer wants to buy. It's created by buyer and could be shared with multiple buyers.", "properties": { "subscribedClients": { "readOnly": true, "type": "array", "description": "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}`", "items": { "type": "string" } }, "name": { "type": "string", "description": "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 by the bidder in the BidResponse." }, "creator": { "readOnly": true, "type": "string", "description": "Output only. The buyer that created this auction package. Format: `buyers/{buyerAccountId}`" }, "description": { "description": "Output only. A description of the auction package.", "type": "string", "readOnly": true }, "subscribedBuyers": { "readOnly": true, "type": "array", "description": "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}`", "items": { "type": "string" } }, "displayName": { "type": "string", "description": "The display_name assigned to the auction package." }, "dealOwnerSeatId": { "description": "Output only. If set, this field contains the DSP specific seat id set by the media planner account that is considered the owner of this deal. The seat ID is in the calling DSP's namespace.", "type": "string", "readOnly": true }, "updateTime": { "type": "string", "description": "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.", "format": "google-datetime", "readOnly": true }, "floorPriceCpm": { "readOnly": true, "description": "Output only. The minimum price a buyer has to bid to compete in this auction package. If this is field is not populated, there is no floor price.", "$ref": "Money" }, "createTime": { "type": "string", "description": "Output only. Time the auction package was created.", "format": "google-datetime", "readOnly": true }, "eligibleSeatIds": { "readOnly": true, "type": "array", "description": "Output only. If set, this field identifies a seat that the media planner selected as the owner of this auction package. This is a seat ID in the DSP's namespace that was provided to the media planner.", "items": { "type": "string" } }, "subscribedMediaPlanners": { "readOnly": true, "description": "Output only. The list of media planners that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder.", "items": { "$ref": "MediaPlanner" }, "type": "array" } } }, "UpdateDealRequest": { "id": "UpdateDealRequest", "description": "Request message for updating the deal at the given revision number.", "properties": { "deal": { "description": "Required. The deal to update. The deal's `name` field is used to identify the deal to be updated. Note: proposal_revision will have to be provided within the resource or else an error will be thrown. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}", "$ref": "Deal" }, "updateMask": { "format": "google-fieldmask", "type": "string", "description": "List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path \"*\" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask." } }, "type": "object" }, "ActivateClientUserRequest": { "description": "Request message for activating a client user.", "properties": {}, "type": "object", "id": "ActivateClientUserRequest" }, "TimeZone": { "id": "TimeZone", "type": "object", "description": "Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones).", "properties": { "id": { "type": "string", "description": "IANA Time Zone Database time zone. For example \"America/New_York\"." }, "version": { "type": "string", "description": "Optional. IANA Time Zone Database version number. For example \"2019a\"." } } }, "SubscribeClientsRequest": { "id": "SubscribeClientsRequest", "type": "object", "description": "Request message for SubscribeAuctionPackageClients.", "properties": { "clients": { "description": "Optional. A list of client buyers to subscribe to the auction package, with client buyer in the format `buyers/{accountId}/clients/{clientAccountId}`. The current buyer will be subscribed to the auction package regardless of the list contents if not already.", "items": { "type": "string" }, "type": "array" } } }, "SendRfpRequest": { "id": "SendRfpRequest", "description": "Request to send an RFP. All fields in this request are proposed to publisher and subject to changes by publisher during later negotiation.", "properties": { "publisherProfile": { "type": "string", "description": "Required. The profile of the publisher who will receive this RFP in the format: `buyers/{accountId}/publisherProfiles/{publisherProfileId}`." }, "geoTargeting": { "description": "Geo criteria IDs to be targeted. Refer to Geo tables.", "$ref": "CriteriaTargeting" }, "preferredDealTerms": { "description": "The terms for preferred deals.", "$ref": "PreferredDealTerms" }, "estimatedGrossSpend": { "description": "Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.", "$ref": "Money" }, "flightStartTime": { "description": "Required. Proposed flight start time of the RFP. A timestamp in RFC3339 UTC \"Zulu\" format. Note that the specified value will be truncated to a granularity of one second.", "type": "string", "format": "google-datetime" }, "client": { "description": "If the current buyer is sending the RFP on behalf of its client, use this field to specify the name of the client in the format: `buyers/{accountId}/clients/{clientAccountid}`.", "type": "string" }, "displayName": { "description": "Required. The display name of the proposal being created by this RFP.", "type": "string" }, "inventorySizeTargeting": { "description": "Inventory sizes to be targeted. Only PIXEL inventory size type is supported.", "$ref": "InventorySizeTargeting" }, "buyerContacts": { "description": "Contact information for the buyer.", "items": { "$ref": "Contact" }, "type": "array" }, "note": { "type": "string", "description": "A message that is sent to the publisher. Maximum length is 1024 characters." }, "programmaticGuaranteedTerms": { "description": "The terms for programmatic guaranteed deals.", "$ref": "ProgrammaticGuaranteedTerms" }, "flightEndTime": { "format": "google-datetime", "description": "Required. Proposed flight end time of the RFP. A timestamp in RFC3339 UTC \"Zulu\" format. Note that the specified value will be truncated to a granularity of one second.", "type": "string" } }, "type": "object" }, "OperatingSystemTargeting": { "type": "object", "description": "Represents targeting information for operating systems.", "properties": { "operatingSystemCriteria": { "description": "IDs of operating systems to be included/excluded.", "$ref": "CriteriaTargeting" }, "operatingSystemVersionCriteria": { "description": "IDs of operating system versions to be included/excluded.", "$ref": "CriteriaTargeting" } }, "id": "OperatingSystemTargeting" }, "DealPausingInfo": { "id": "DealPausingInfo", "description": "Information related to deal pausing.", "properties": { "pausingConsented": { "type": "boolean", "description": "Whether pausing is consented between buyer and seller for the deal." }, "pauseRole": { "enum": [ "BUYER_SELLER_ROLE_UNSPECIFIED", "BUYER", "SELLER" ], "description": "The party that first paused the deal; unspecified for active deals.", "enumDescriptions": [ "A placeholder for an undefined buyer/seller role.", "Specifies the role as buyer.", "Specifies the role as seller." ], "type": "string" }, "pauseReason": { "description": "The reason for the pausing of the deal; empty for active deals.", "type": "string" } }, "type": "object" }, "VideoTargeting": { "id": "VideoTargeting", "type": "object", "description": "Represents targeting information about video.", "properties": { "targetedPositionTypes": { "type": "array", "description": "A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.", "items": { "enum": [ "POSITION_TYPE_UNSPECIFIED", "PREROLL", "MIDROLL", "POSTROLL" ], "type": "string", "enumDescriptions": [ "A placeholder for an undefined video position.", "Ad is played before the video.", "Ad is played during the video.", "Ad is played after the video." ] } }, "excludedPositionTypes": { "description": "A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.", "items": { "enum": [ "POSITION_TYPE_UNSPECIFIED", "PREROLL", "MIDROLL", "POSTROLL" ], "type": "string", "enumDescriptions": [ "A placeholder for an undefined video position.", "Ad is played before the video.", "Ad is played during the video.", "Ad is played after the video." ] }, "type": "array" } } }, "CancelNegotiationRequest": { "id": "CancelNegotiationRequest", "description": "Request to cancel an ongoing negotiation.", "properties": {}, "type": "object" }, "InventorySizeTargeting": { "description": "Represents the size of an ad unit that can be targeted on a bid request.", "properties": { "targetedInventorySizes": { "description": "A list of inventory sizes to be included.", "items": { "$ref": "AdSize" }, "type": "array" }, "excludedInventorySizes": { "type": "array", "description": "A list of inventory sizes to be excluded.", "items": { "$ref": "AdSize" } } }, "type": "object", "id": "InventorySizeTargeting" }, "PrivateAuctionTerms": { "id": "PrivateAuctionTerms", "description": "Pricing terms for Private Auctions.", "properties": { "openAuctionAllowed": { "readOnly": true, "description": "Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.", "type": "boolean" }, "floorPrice": { "description": "The minimum price buyer has to bid to compete in the private auction.", "$ref": "Price" } }, "type": "object" }, "CriteriaTargeting": { "description": "Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax.", "properties": { "excludedCriteriaIds": { "type": "array", "description": "A list of numeric IDs to be excluded.", "items": { "type": "string", "format": "int64" } }, "targetedCriteriaIds": { "type": "array", "description": "A list of numeric IDs to be included.", "items": { "type": "string", "format": "int64" } } }, "type": "object", "id": "CriteriaTargeting" }, "ActivateClientRequest": { "description": "Request message for activating a client.", "properties": {}, "type": "object", "id": "ActivateClientRequest" }, "DeactivateClientRequest": { "type": "object", "description": "Request message for disabling a client.", "properties": {}, "id": "DeactivateClientRequest" }, "FinalizedDeal": { "id": "FinalizedDeal", "description": "A finalized deal is a snapshot of the deal when both buyer and seller accept the deal. The buyer or seller can update the deal after it's been finalized and renegotiate on the deal targeting, terms and other fields, while at the same time the finalized snapshot of the deal can still be retrieved using this API. The finalized deal contains a copy of the deal as it existed when most recently finalized, as well as fields related to deal serving such as pause/resume status, RTB metrics, and more.", "properties": { "name": { "type": "string", "description": "The resource name of the finalized deal. Format: `buyers/{accountId}/finalizedDeals/{finalizedDealId}`" }, "readyToServe": { "type": "boolean", "description": "Whether the Programmatic Guaranteed deal is ready for serving." }, "deal": { "description": "A copy of the Deal made upon finalization. During renegotiation, this will reflect the last finalized deal before renegotiation was initiated.", "$ref": "Deal" }, "dealServingStatus": { "enum": [ "DEAL_SERVING_STATUS_UNSPECIFIED", "ACTIVE", "ENDED", "PAUSED_BY_BUYER", "PAUSED_BY_SELLER" ], "description": "Serving status of the deal.", "enumDescriptions": [ "Unspecified.", "The deal is actively serving or ready to serve when the start date is reached.", "The deal serving has ended.", "The deal serving is paused by buyer.", "The deal serving is paused by seller." ], "type": "string" }, "rtbMetrics": { "description": "Real-time bidding metrics for this deal.", "$ref": "RtbMetrics" }, "dealPausingInfo": { "description": "Information related to deal pausing for the deal.", "$ref": "DealPausingInfo" } }, "type": "object" }, "ResumeFinalizedDealRequest": { "id": "ResumeFinalizedDealRequest", "description": "Request message for resuming a finalized deal.", "properties": {}, "type": "object" }, "Deal": { "id": "Deal", "type": "object", "description": "A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals.", "properties": { "client": { "readOnly": true, "description": "Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`", "type": "string" }, "description": { "type": "string", "description": "Output only. Free text description for the deal terms.", "readOnly": true }, "displayName": { "type": "string", "description": "Output only. The name of the deal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the deal.", "readOnly": true }, "creativeRequirements": { "readOnly": true, "description": "Output only. Metadata about the creatives of this deal.", "$ref": "CreativeRequirements" }, "privateAuctionTerms": { "description": "The terms for private auction deals.", "$ref": "PrivateAuctionTerms" }, "createTime": { "type": "string", "description": "Output only. The time of the deal creation.", "format": "google-datetime", "readOnly": true }, "eligibleSeatIds": { "description": "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.", "items": { "type": "string" }, "type": "array", "readOnly": true }, "buyerPermissionType": { "enum": [ "BUYER_PERMISSION_TYPE_UNSPECIFIED", "NEGOTIATOR_ONLY", "BIDDER" ], "readOnly": true, "type": "string", "description": "Output only. The buyer permission type of the deal.", "enumDescriptions": [ "A placeholder for an undefined buyer permission type.", "Only the [Deal.negotiating_buyer] can transact on the deal.", "All buyers under the [Deal.negotiating_buyer]'s bidder can transact on the deal." ] }, "preferredDealTerms": { "description": "The terms for preferred deals.", "$ref": "PreferredDealTerms" }, "estimatedGrossSpend": { "description": "Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.", "$ref": "Money" }, "flightStartTime": { "description": "Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds.", "type": "string", "format": "google-datetime" }, "dealType": { "description": "Output only. Type of deal.", "enumDescriptions": [ "Default, unspecified deal type.", "Preferred deals.", "Private auction deals.", "Programmatic guaranteed deals." ], "type": "string", "readOnly": true, "enum": [ "DEAL_TYPE_UNSPECIFIED", "PREFERRED_DEAL", "PRIVATE_AUCTION", "PROGRAMMATIC_GUARANTEED" ] }, "flightEndTime": { "format": "google-datetime", "type": "string", "description": "Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not necessary for Private Auction deals." }, "buyer": { "type": "string", "description": "Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId}`", "readOnly": true }, "sellerTimeZone": { "description": "Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.", "$ref": "TimeZone", "readOnly": true }, "deliveryControl": { "readOnly": true, "description": "Output only. Specifies the pacing set by the publisher.", "$ref": "DeliveryControl" }, "updateTime": { "type": "string", "description": "Output only. The time when the deal was last updated.", "format": "google-datetime", "readOnly": true }, "publisherProfile": { "description": "Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`", "type": "string" }, "billedBuyer": { "description": "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; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId}`", "type": "string", "readOnly": true }, "mediaPlanner": { "description": "Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser).", "$ref": "MediaPlanner", "readOnly": true }, "proposalRevision": { "format": "int64", "readOnly": true, "type": "string", "description": "Output only. The revision number for the proposal and is the same value as proposal.proposal_revision. Each update to deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made." }, "programmaticGuaranteedTerms": { "description": "The terms for programmatic guaranteed deals.", "$ref": "ProgrammaticGuaranteedTerms" }, "name": { "type": "string", "description": "Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}" }, "targeting": { "description": "Specifies the subset of inventory targeted by the deal. Can be updated by the buyer before the deal is finalized.", "$ref": "MarketplaceTargeting" } } }, "Note": { "id": "Note", "type": "object", "description": "A text note attached to the proposal to facilitate the communication between buyers and sellers.", "properties": { "note": { "type": "string", "description": "The text of the note. Maximum length is 1024 characters." }, "createTime": { "description": "Output only. When this note was created.", "type": "string", "readOnly": true, "format": "google-datetime" }, "creatorRole": { "type": "string", "description": "Output only. The role who created the note.", "enumDescriptions": [ "A placeholder for an undefined buyer/seller role.", "Specifies the role as buyer.", "Specifies the role as seller." ], "enum": [ "BUYER_SELLER_ROLE_UNSPECIFIED", "BUYER", "SELLER" ], "readOnly": true } } }, "BatchUpdateDealsRequest": { "description": "Request message for batch updating deals.", "properties": { "requests": { "description": "Required. List of request messages to update deals.", "items": { "$ref": "UpdateDealRequest" }, "type": "array" } }, "type": "object", "id": "BatchUpdateDealsRequest" }, "AddNoteRequest": { "description": "Request to add a note.", "properties": { "note": { "description": "The note to add.", "$ref": "Note" } }, "type": "object", "id": "AddNoteRequest" }, "ListPublisherProfilesResponse": { "id": "ListPublisherProfilesResponse", "type": "object", "description": "Response message for profiles visible to the buyer.", "properties": { "publisherProfiles": { "description": "The list of matching publisher profiles.", "items": { "$ref": "PublisherProfile" }, "type": "array" }, "nextPageToken": { "description": "Token to fetch the next page of results.", "type": "string" } } }, "MediaPlanner": { "description": "Represents a media planner account.", "properties": { "accountId": { "readOnly": true, "deprecated": true, "type": "string", "description": "Output only. Account ID of the media planner." }, "name": { "type": "string", "description": "Identifier. The unique resource name of the media planner. Format: `mediaPlanners/{mediaPlannerAccountId}` Can be used to filter the response of the mediaPlanners.list method." }, "ancestorNames": { "type": "array", "description": "Output only. The ancestor names of the media planner. Format: `mediaPlanners/{mediaPlannerAccountId}` Can be used to filter the response of the mediaPlanners.list method.", "items": { "type": "string" }, "readOnly": true }, "displayName": { "readOnly": true, "type": "string", "description": "Output only. The display name of the media planner. Can be used to filter the response of the mediaPlanners.list method." } }, "type": "object", "id": "MediaPlanner" }, "PublisherProfileMobileApplication": { "type": "object", "description": "A mobile application that contains a external app ID, name, and app store.", "properties": { "appStore": { "enum": [ "APP_STORE_TYPE_UNSPECIFIED", "APPLE_ITUNES", "GOOGLE_PLAY", "ROKU", "AMAZON_FIRE_TV", "PLAYSTATION", "XBOX", "SAMSUNG_TV", "AMAZON", "OPPO", "SAMSUNG", "VIVO", "XIAOMI", "LG_TV" ], "type": "string", "description": "The app store the app belongs to. Can be used to filter the response of the publisherProfiles.list method.", "enumDescriptions": [ "A placeholder for an unknown app store.", "Apple iTunes", "Google Play", "Roku", "Amazon Fire TV", "PlayStation", "Xbox", "Samsung TV", "Amazon Appstore", "OPPO App Market", "Samsung Galaxy Store", "VIVO App Store", "Xiaomi GetApps", "LG TV" ] }, "externalAppId": { "type": "string", "description": "The external ID for the app from its app store. Can be used to filter the response of the publisherProfiles.list method." }, "name": { "type": "string", "description": "The name of the app." } }, "id": "PublisherProfileMobileApplication" }, "DeactivateClientUserRequest": { "id": "DeactivateClientUserRequest", "type": "object", "description": "Request message for deactivating a client user.", "properties": {} }, "DayPart": { "id": "DayPart", "type": "object", "description": "Defines targeting for a period of time on a specific week day.", "properties": { "endTime": { "description": "Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.", "$ref": "TimeOfDay" }, "startTime": { "description": "Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.", "$ref": "TimeOfDay" }, "dayOfWeek": { "type": "string", "description": "Day of week for the period.", "enumDescriptions": [ "The day of the week is unspecified.", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ], "enum": [ "DAY_OF_WEEK_UNSPECIFIED", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ] } } }, "SetReadyToServeRequest": { "id": "SetReadyToServeRequest", "type": "object", "description": "Request message for setting ready to serve for a finalized deal.", "properties": {} }, "AdSize": { "description": "Represents size of a single ad slot, or a creative.", "properties": { "type": { "description": "The type of the ad slot size.", "enumDescriptions": [ "A placeholder for an undefined size type.", "Ad slot with size specified by height and width in pixels.", "Special size to describe an interstitial ad slot.", "Native (mobile) ads rendered by the publisher.", "Fluid size (responsive size) can be resized automatically with the change of outside environment." ], "type": "string", "enum": [ "TYPE_UNSPECIFIED", "PIXEL", "INTERSTITIAL", "NATIVE", "FLUID" ] }, "width": { "format": "int64", "type": "string", "description": "The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`." }, "height": { "format": "int64", "description": "The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.", "type": "string" } }, "type": "object", "id": "AdSize" }, "Money": { "id": "Money", "description": "Represents an amount of money with its currency type.", "properties": { "nanos": { "description": "Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.", "type": "integer", "format": "int32" }, "currencyCode": { "type": "string", "description": "The three-letter currency code defined in ISO 4217." }, "units": { "description": "The whole units of the amount. For example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.", "type": "string", "format": "int64" } }, "type": "object" }, "Contact": { "id": "Contact", "description": "Contains information on how a buyer or seller can be reached.", "properties": { "email": { "type": "string", "description": "Email address for the contact." }, "displayName": { "type": "string", "description": "The display_name of the contact." } }, "type": "object" }, "PauseFinalizedDealRequest": { "type": "object", "description": "Request message for pausing a finalized deal.", "properties": { "reason": { "type": "string", "description": "The reason to pause the finalized deal, will be displayed to the seller. Maximum length is 1000 characters." } }, "id": "PauseFinalizedDealRequest" }, "Empty": { "type": "object", "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "properties": {}, "id": "Empty" }, "MarketplaceTargeting": { "type": "object", "description": "Targeting represents different criteria that can be used to target deals or auction packages. For example, they can choose to target inventory only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise.", "properties": { "videoTargeting": { "readOnly": true, "description": "Output only. Video targeting information.", "$ref": "VideoTargeting" }, "geoTargeting": { "readOnly": true, "description": "Output only. Geo criteria IDs to be included/excluded.", "$ref": "CriteriaTargeting" }, "technologyTargeting": { "readOnly": true, "description": "Output only. Technology targeting information, for example, operating system, device category.", "$ref": "TechnologyTargeting" }, "excludedSensitiveCategoryIds": { "readOnly": true, "description": "Output only. The sensitive content category label IDs excluded. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.", "items": { "type": "string", "format": "int64" }, "type": "array" }, "userListTargeting": { "description": "Buyer user list targeting information. User lists can be uploaded using https://developers.google.com/authorized-buyers/rtb/bulk-uploader.", "$ref": "CriteriaTargeting" }, "verticalTargeting": { "readOnly": true, "description": "Output only. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals", "$ref": "CriteriaTargeting" }, "daypartTargeting": { "description": "Daypart targeting information.", "$ref": "DayPartTargeting" }, "inventorySizeTargeting": { "readOnly": true, "description": "Output only. Inventory sizes to be included/excluded.", "$ref": "InventorySizeTargeting" }, "placementTargeting": { "readOnly": true, "description": "Output only. Placement targeting information, for example, URL, mobile applications.", "$ref": "PlacementTargeting" }, "inventoryTypeTargeting": { "description": "Output only. Inventory type targeting information.", "$ref": "InventoryTypeTargeting", "readOnly": true } }, "id": "MarketplaceTargeting" }, "UriTargeting": { "id": "UriTargeting", "description": "Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply.", "properties": { "targetedUris": { "type": "array", "description": "A list of URLs to be included.", "items": { "type": "string" } }, "excludedUris": { "type": "array", "description": "A list of URLs to be excluded.", "items": { "type": "string" } } }, "type": "object" }, "PlacementTargeting": { "id": "PlacementTargeting", "type": "object", "description": "Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed.", "properties": { "uriTargeting": { "description": "URLs to be included/excluded.", "$ref": "UriTargeting" }, "mobileApplicationTargeting": { "description": "Mobile application targeting information in a deal. This doesn't apply to Auction Packages.", "$ref": "MobileApplicationTargeting" } } }, "ListClientUsersResponse": { "type": "object", "description": "Response message for the list method.", "properties": { "clientUsers": { "description": "The returned list of client users.", "items": { "$ref": "ClientUser" }, "type": "array" }, "nextPageToken": { "description": "A token to retrieve the next page of results. Pass this value in the ListClientUsersRequest.pageToken field in the subsequent call to the list method to retrieve the next page of results.", "type": "string" } }, "id": "ListClientUsersResponse" }, "AcceptProposalRequest": { "id": "AcceptProposalRequest", "description": "Request to accept a proposal. Accepting a proposal implies acceptance of the publisher terms_and_conditions, if any.", "properties": { "proposalRevision": { "type": "string", "description": "The last known client revision number of the proposal.", "format": "int64" } }, "type": "object" }, "Proposal": { "id": "Proposal", "description": "Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer.", "properties": { "proposalRevision": { "description": "Output only. The revision number for the proposal. Each update to the proposal or deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.", "type": "string", "readOnly": true, "format": "int64" }, "buyerPrivateData": { "description": "Buyer private data (hidden from seller).", "$ref": "PrivateData" }, "termsAndConditions": { "type": "string", "description": "Output only. The terms and conditions associated with this proposal. Accepting a proposal implies acceptance of this field. This is created by the seller, the buyer can only view it.", "readOnly": true }, "lastUpdaterOrCommentorRole": { "enum": [ "BUYER_SELLER_ROLE_UNSPECIFIED", "BUYER", "SELLER" ], "readOnly": true, "type": "string", "description": "Output only. The role of the last user that either updated the proposal or left a comment.", "enumDescriptions": [ "A placeholder for an undefined buyer/seller role.", "Specifies the role as buyer.", "Specifies the role as seller." ] }, "name": { "description": "Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId}", "type": "string" }, "notes": { "type": "array", "description": "A list of notes from the buyer and the seller attached to this proposal.", "items": { "$ref": "Note" } }, "updateTime": { "format": "google-datetime", "readOnly": true, "type": "string", "description": "Output only. The time when the proposal was last revised." }, "publisherProfile": { "description": "Immutable. Reference to the seller on the proposal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}` Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.", "type": "string" }, "billedBuyer": { "readOnly": true, "type": "string", "description": "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}`" }, "dealType": { "type": "string", "description": "Output only. Type of deal the proposal contains.", "enumDescriptions": [ "Default, unspecified deal type.", "Preferred deals.", "Private auction deals.", "Programmatic guaranteed deals." ], "enum": [ "DEAL_TYPE_UNSPECIFIED", "PREFERRED_DEAL", "PRIVATE_AUCTION", "PROGRAMMATIC_GUARANTEED" ], "readOnly": true }, "state": { "description": "Output only. Indicates the state of the proposal.", "enumDescriptions": [ "Unspecified proposal state", "When a proposal is waiting for buyer to review.", "When the proposal is waiting for the seller to review.", "When the seller accepted the proposal and sent it to the buyer for review.", "When both buyer and seller has accepted the proposal", "When either buyer or seller has cancelled the proposal" ], "type": "string", "readOnly": true, "enum": [ "STATE_UNSPECIFIED", "BUYER_REVIEW_REQUESTED", "SELLER_REVIEW_REQUESTED", "BUYER_ACCEPTANCE_REQUESTED", "FINALIZED", "TERMINATED" ] }, "buyer": { "description": "Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}`", "type": "string", "readOnly": true }, "pausingConsented": { "description": "Whether pausing is allowed for the proposal. This is a negotiable term between buyers and publishers.", "type": "boolean" }, "buyerContacts": { "description": "Contact information for the buyer.", "items": { "$ref": "Contact" }, "type": "array" }, "client": { "readOnly": true, "description": "Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`", "type": "string" }, "displayName": { "description": "Output only. The descriptive name for the proposal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the proposal.", "type": "string", "readOnly": true }, "originatorRole": { "readOnly": true, "enum": [ "BUYER_SELLER_ROLE_UNSPECIFIED", "BUYER", "SELLER" ], "description": "Output only. Indicates whether the buyer/seller created the proposal.", "enumDescriptions": [ "A placeholder for an undefined buyer/seller role.", "Specifies the role as buyer.", "Specifies the role as seller." ], "type": "string" }, "sellerContacts": { "type": "array", "description": "Output only. Contact information for the seller.", "items": { "$ref": "Contact" }, "readOnly": true }, "isRenegotiating": { "description": "Output only. True if the proposal was previously finalized and is now being renegotiated.", "type": "boolean", "readOnly": true } }, "type": "object" }, "TechnologyTargeting": { "description": "Represents targeting about various types of technology.", "properties": { "deviceCapabilityTargeting": { "description": "IDs of device capabilities to be included/excluded.", "$ref": "CriteriaTargeting" }, "deviceCategoryTargeting": { "description": "IDs of device categories to be included/excluded.", "$ref": "CriteriaTargeting" }, "operatingSystemTargeting": { "description": "Operating system related targeting information.", "$ref": "OperatingSystemTargeting" } }, "type": "object", "id": "TechnologyTargeting" }, "BatchUpdateDealsResponse": { "description": "Response message for batch updating deals.", "properties": { "deals": { "type": "array", "description": "Deals updated.", "items": { "$ref": "Deal" } } }, "type": "object", "id": "BatchUpdateDealsResponse" }, "SubscribeAuctionPackageRequest": { "description": "Request message for SubscribeAuctionPackage.", "properties": {}, "type": "object", "id": "SubscribeAuctionPackageRequest" }, "CreativeRequirements": { "id": "CreativeRequirements", "type": "object", "description": "Message captures data about the creatives in the deal.", "properties": { "creativePreApprovalPolicy": { "readOnly": true, "enum": [ "CREATIVE_PRE_APPROVAL_POLICY_UNSPECIFIED", "SELLER_PRE_APPROVAL_REQUIRED", "SELLER_PRE_APPROVAL_NOT_REQUIRED" ], "description": "Output only. Specifies the creative pre-approval policy.", "enumDescriptions": [ "A placeholder for an undefined creative pre-approval policy.", "The seller needs to approve each creative before it can serve.", "The seller does not need to approve each creative before it can serve." ], "type": "string" }, "maxAdDurationMs": { "readOnly": true, "format": "int64", "description": "Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.", "type": "string" }, "skippableAdType": { "description": "Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.", "enumDescriptions": [ "A placeholder for an unspecified skippable ad type.", "Video ad that can be skipped after 5 seconds. This value will appear in RTB bid requests as SkippableBidRequestType::REQUIRE_SKIPPABLE.", "Video ad that can be skipped after 5 seconds, and is counted as engaged view after 30 seconds. The creative is hosted on YouTube only, and viewcount of the YouTube video increments after the engaged view. This value will appear in RTB bid requests as SkippableBidRequestType::REQUIRE_SKIPPABLE.", "This video ad is not skippable. This value will appear in RTB bid requests as SkippableBidRequestType::BLOCK_SKIPPABLE.", "This video ad can be skipped after 5 seconds or not-skippable. This value will appear in RTB bid requests as SkippableBidRequestType::ALLOW_SKIPPABLE." ], "type": "string", "readOnly": true, "enum": [ "SKIPPABLE_AD_TYPE_UNSPECIFIED", "SKIPPABLE", "INSTREAM_SELECT", "NOT_SKIPPABLE", "ANY" ] }, "creativeSafeFrameCompatibility": { "enum": [ "CREATIVE_SAFE_FRAME_COMPATIBILITY_UNSPECIFIED", "COMPATIBLE", "INCOMPATIBLE" ], "readOnly": true, "type": "string", "description": "Output only. Specifies whether the creative is safeFrame compatible.", "enumDescriptions": [ "A placeholder for an undefined creative safe-frame compatibility.", "The creatives need to be compatible with the safe frame option.", "The creatives can be incompatible with the safe frame option." ] }, "creativeFormat": { "readOnly": true, "enum": [ "CREATIVE_FORMAT_UNSPECIFIED", "DISPLAY", "VIDEO", "AUDIO" ], "description": "Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.", "enumDescriptions": [ "A placeholder for an unspecified creative format.", "Banner creatives such as image or HTML5 assets.", "Video creatives that can be played in a video player.", "Audio creatives that can play during audio content or point to a third party ad server." ], "type": "string" }, "programmaticCreativeSource": { "type": "string", "description": "Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.", "enumDescriptions": [ "A placeholder for an undefined programmatic creative source.", "The advertiser provides the creatives.", "The publisher provides the creatives to be served." ], "enum": [ "PROGRAMMATIC_CREATIVE_SOURCE_UNSPECIFIED", "ADVERTISER", "PUBLISHER" ], "readOnly": true } } }, "UnsubscribeClientsRequest": { "id": "UnsubscribeClientsRequest", "type": "object", "description": "Request message for UnsubscribeAuctionPackage.", "properties": { "clients": { "type": "array", "description": "Optional. A list of client buyers to unsubscribe from the auction package, with client buyer in the format `buyers/{accountId}/clients/{clientAccountId}`.", "items": { "type": "string" } } } }, "Client": { "type": "object", "description": "A client represents an agency, a brand, or an advertiser customer of the buyer. Based on the client's role, its client users will have varying levels of restricted access to the Marketplace and certain other sections of the Authorized Buyers UI.", "properties": { "partnerClientId": { "description": "Arbitrary unique identifier provided by the buyer. This field can be used to associate a client with an identifier in the namespace of the buyer, lookup clients by that identifier and verify whether an Authorized Buyers account of the client already exists. If present, must be unique across all the clients.", "type": "string" }, "role": { "enum": [ "CLIENT_ROLE_UNSPECIFIED", "CLIENT_DEAL_VIEWER", "CLIENT_DEAL_NEGOTIATOR", "CLIENT_DEAL_APPROVER" ], "description": "Required. The role assigned to the client. Each role implies a set of permissions granted to the client.", "enumDescriptions": [ "A placeholder for an undefined client role. This value should never be specified in user input for create or update method, otherwise an error will be returned.", "Users associated with this client role can only view proposals and deals in the Marketplace UI. They cannot negotiate or approve proposals and deals sent from publishers or send RFP to publishers.", "Users associated with this client role can view and negotiate on the proposals and deals in the Marketplace UI sent from publishers and send RFP to publishers, but cannot approve the proposals and deals by themselves. The buyer can approve the proposals and deals on behalf of the client.", "Users associated with this client role can view, negotiate and approve proposals and deals in the Marketplace UI and send RFP to publishers." ], "type": "string" }, "name": { "readOnly": true, "type": "string", "description": "Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`" }, "sellerVisible": { "type": "boolean", "description": "Whether the client will be visible to sellers." }, "state": { "description": "Output only. The state of the client.", "enumDescriptions": [ "A placeholder for an undefined client state. Should not be used.", "A client that is currently active and allowed to access the Authorized Buyers UI.", "A client that is currently inactive and not allowed to access the Authorized Buyers UI." ], "type": "string", "readOnly": true, "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "INACTIVE" ] }, "displayName": { "description": "Required. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed.", "type": "string" } }, "id": "Client" }, "MobileApplicationTargeting": { "description": "Mobile application targeting settings.", "properties": { "firstPartyTargeting": { "description": "Publisher owned apps to be targeted or excluded by the publisher to display the ads in.", "$ref": "FirstPartyMobileApplicationTargeting" } }, "type": "object", "id": "MobileApplicationTargeting" }, "AddCreativeRequest": { "id": "AddCreativeRequest", "type": "object", "description": "Request message for adding creative to be used in the bidding process for the finalized deal.", "properties": { "creative": { "description": "Name of the creative to add to the finalized deal, in the format `buyers/{buyerAccountId}/creatives/{creativeId}`. See creative.name.", "type": "string" } } }, "ClientUser": { "description": "A user of a client who has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client.", "properties": { "state": { "enum": [ "STATE_UNSPECIFIED", "INVITED", "ACTIVE", "INACTIVE" ], "readOnly": true, "type": "string", "description": "Output only. The state of the client user.", "enumDescriptions": [ "A placeholder for an undefined user state.", "A user who was created but hasn't accepted the invitation yet, not allowed to access the Authorized Buyers UI.", "A user that is currently active and allowed to access the Authorized Buyers UI.", "A user that is currently inactive and not allowed to access the Authorized Buyers UI." ] }, "name": { "description": "Output only. The resource name of the client user. Format: `buyers/{accountId}/clients/{clientAccountId}/users/{userId}`", "type": "string", "readOnly": true }, "email": { "type": "string", "description": "Required. The client user's email address that has to be unique across all users for the same client." } }, "type": "object", "id": "ClientUser" }, "Price": { "type": "object", "description": "Represents a price and a pricing type for a deal.", "properties": { "type": { "enum": [ "TYPE_UNSPECIFIED", "CPM", "CPD" ], "type": "string", "description": "The pricing type for the deal.", "enumDescriptions": [ "A placeholder for an undefined pricing type. If the pricing type is unspecified, CPM will be used instead.", "Cost per thousand impressions.", "Cost per day." ] }, "amount": { "description": "The actual price with currency specified.", "$ref": "Money" } }, "id": "Price" }, "FrequencyCap": { "id": "FrequencyCap", "type": "object", "description": "Message contains details about publisher-set frequency caps of the delivery.", "properties": { "timeUnitType": { "enum": [ "TIME_UNIT_TYPE_UNSPECIFIED", "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "LIFETIME", "POD", "STREAM" ], "type": "string", "description": "The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.", "enumDescriptions": [ "A placeholder for an undefined time unit type. This just indicates the variable with this value hasn't been initialized.", "Minute unit.", "Hour unit.", "Day unit.", "Week unit.", "Month unit.", "Lifecycle/Lifetime unit.", "Pod unit.", "Stream unit." ] }, "maxImpressions": { "type": "integer", "description": "The maximum number of impressions that can be served to a user within the specified time period.", "format": "int32" }, "timeUnitsCount": { "format": "int32", "type": "integer", "description": "The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped." } } }, "ListAuctionPackagesResponse": { "description": "Response message for listing auction packages.", "properties": { "nextPageToken": { "type": "string", "description": "Continuation token for fetching the next page of results. Pass this value in the ListAuctionPackagesRequest.pageToken field in the subsequent call to the `ListAuctionPackages` method to retrieve the next page of results." }, "auctionPackages": { "type": "array", "description": "The list of auction packages.", "items": { "$ref": "AuctionPackage" } } }, "type": "object", "id": "ListAuctionPackagesResponse" }, "RtbMetrics": { "id": "RtbMetrics", "description": "Real-time bidding metrics. For what each metric means refer to [Report metrics](https://support.google.com/adxbuyer/answer/6115195#report-metrics)", "properties": { "bidRate7Days": { "type": "number", "description": "Bid rate in last 7 days, calculated by (bids / bid requests).", "format": "double" }, "mustBidRateCurrentMonth": { "type": "number", "description": "Must bid rate for current month.", "format": "double" }, "filteredBidRate7Days": { "type": "number", "description": "Filtered bid rate in last 7 days, calculated by (filtered bids / bids).", "format": "double" }, "adImpressions7Days": { "type": "string", "description": "Ad impressions in last 7 days.", "format": "int64" }, "bidRequests7Days": { "description": "Bid requests in last 7 days.", "type": "string", "format": "int64" }, "bids7Days": { "description": "Bids in last 7 days.", "type": "string", "format": "int64" } }, "type": "object" }, "ProgrammaticGuaranteedTerms": { "type": "object", "description": "Pricing terms for Programmatic Guaranteed Deals.", "properties": { "minimumDailyLooks": { "format": "int64", "description": "Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.", "type": "string" }, "reservationType": { "description": "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.", "enumDescriptions": [ "An unspecified reservation type.", "Non-sponsorship deal.", "Sponsorship deals don't have impression goal (guaranteed_looks) and they are served based on the flight dates. For CPM Sponsorship deals, impression_cap is the lifetime impression limit." ], "type": "string", "enum": [ "RESERVATION_TYPE_UNSPECIFIED", "STANDARD", "SPONSORSHIP" ] }, "impressionCap": { "format": "int64", "description": "The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.", "type": "string" }, "percentShareOfVoice": { "format": "int64", "description": "For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.", "type": "string" }, "guaranteedLooks": { "format": "int64", "type": "string", "description": "Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored." }, "fixedPrice": { "description": "Fixed price for the deal.", "$ref": "Price" } }, "id": "ProgrammaticGuaranteedTerms" }, "UnsubscribeAuctionPackageRequest": { "id": "UnsubscribeAuctionPackageRequest", "description": "Request message for UnsubscribeAuctionPackage.", "properties": {}, "type": "object" }, "FirstPartyMobileApplicationTargeting": { "type": "object", "description": "Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded.", "properties": { "targetedAppIds": { "type": "array", "description": "A list of application IDs to be included.", "items": { "type": "string" } }, "excludedAppIds": { "description": "A list of application IDs to be excluded.", "items": { "type": "string" }, "type": "array" } }, "id": "FirstPartyMobileApplicationTargeting" }, "ListProposalsResponse": { "type": "object", "description": "Response message for listing proposals.", "properties": { "nextPageToken": { "description": "Continuation token for fetching the next page of results.", "type": "string" }, "proposals": { "description": "The list of proposals.", "items": { "$ref": "Proposal" }, "type": "array" } }, "id": "ListProposalsResponse" }, "PreferredDealTerms": { "id": "PreferredDealTerms", "description": "Pricing terms for Preferred Deals.", "properties": { "fixedPrice": { "description": "Fixed price for the deal.", "$ref": "Price" } }, "type": "object" } }, "resources": { "buyers": { "resources": { "proposals": { "resources": { "deals": { "methods": { "get": { "response": { "$ref": "Deal" }, "id": "authorizedbuyersmarketplace.buyers.proposals.deals.get", "parameterOrder": [ "name" ], "flatPath": "v1/buyers/{buyersId}/proposals/{proposalsId}/deals/{dealsId}", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "parameters": { "name": { "pattern": "^buyers/[^/]+/proposals/[^/]+/deals/[^/]+$", "location": "path", "description": "Required. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}", "required": true, "type": "string" } }, "path": "v1/{+name}", "httpMethod": "GET", "description": "Gets a deal given its name. The deal is returned at its head revision." }, "patch": { "httpMethod": "PATCH", "description": "Updates the given deal at the buyer known revision number. If the server revision has advanced since the passed-in proposal.proposal_revision an ABORTED error message will be returned. The revision number is incremented by the server whenever the proposal or its constituent deals are updated. Note: The revision number is kept at a proposal level. The buyer of the API is expected to keep track of the revision number after the last update operation and send it in as part of the next update request. This way, if there are further changes on the server (for example, seller making new updates), then the server can detect conflicts and reject the proposed changes.", "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "parameters": { "name": { "description": "Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}", "required": true, "type": "string", "pattern": "^buyers/[^/]+/proposals/[^/]+/deals/[^/]+$", "location": "path" }, "updateMask": { "description": "List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path \"*\" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "flatPath": "v1/buyers/{buyersId}/proposals/{proposalsId}/deals/{dealsId}", "request": { "$ref": "Deal" }, "response": { "$ref": "Deal" }, "id": "authorizedbuyersmarketplace.buyers.proposals.deals.patch", "parameterOrder": [ "name" ] }, "batchUpdate": { "parameters": { "parent": { "pattern": "^buyers/[^/]+/proposals/[^/]+$", "location": "path", "type": "string", "description": "Required. The name of the proposal containing the deals to batch update. Format: buyers/{accountId}/proposals/{proposalId}", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "path": "v1/{+parent}/deals:batchUpdate", "id": "authorizedbuyersmarketplace.buyers.proposals.deals.batchUpdate", "parameterOrder": [ "parent" ], "request": { "$ref": "BatchUpdateDealsRequest" }, "response": { "$ref": "BatchUpdateDealsResponse" }, "flatPath": "v1/buyers/{buyersId}/proposals/{proposalsId}/deals:batchUpdate", "httpMethod": "POST", "description": "Batch updates multiple deals in the same proposal." }, "list": { "path": "v1/{+parent}/deals", "parameters": { "pageSize": { "type": "integer", "description": "Requested page size. The server may return fewer results than requested. If requested more than 500, the server will return 500 results per page. If unspecified, the server will pick a default page size of 100.", "location": "query", "format": "int32" }, "parent": { "type": "string", "description": "Required. The name of the proposal containing the deals to retrieve. Format: buyers/{accountId}/proposals/{proposalId}", "required": true, "pattern": "^buyers/[^/]+/proposals/[^/]+$", "location": "path" }, "pageToken": { "description": "The page token as returned from ListDealsResponse.", "location": "query", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "flatPath": "v1/buyers/{buyersId}/proposals/{proposalsId}/deals", "id": "authorizedbuyersmarketplace.buyers.proposals.deals.list", "parameterOrder": [ "parent" ], "response": { "$ref": "ListDealsResponse" }, "httpMethod": "GET", "description": "Lists all deals in a proposal. To retrieve only the finalized revision deals regardless if a deal is being renegotiated, see the FinalizedDeals resource." } } } }, "methods": { "get": { "parameters": { "name": { "pattern": "^buyers/[^/]+/proposals/[^/]+$", "location": "path", "description": "Required. Name of the proposal. Format: `buyers/{accountId}/proposals/{proposalId}`", "required": true, "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "path": "v1/{+name}", "id": "authorizedbuyersmarketplace.buyers.proposals.get", "parameterOrder": [ "name" ], "response": { "$ref": "Proposal" }, "flatPath": "v1/buyers/{buyersId}/proposals/{proposalsId}", "httpMethod": "GET", "description": "Gets a proposal using its resource name. The proposal is returned at the latest revision." }, "sendRfp": { "path": "v1/{+buyer}/proposals:sendRfp", "parameters": { "buyer": { "type": "string", "description": "Required. The current buyer who is sending the RFP in the format: `buyers/{accountId}`.", "required": true, "pattern": "^buyers/[^/]+$", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "flatPath": "v1/buyers/{buyersId}/proposals:sendRfp", "id": "authorizedbuyersmarketplace.buyers.proposals.sendRfp", "parameterOrder": [ "buyer" ], "request": { "$ref": "SendRfpRequest" }, "response": { "$ref": "Proposal" }, "httpMethod": "POST", "description": "Sends a request for proposal (RFP) to a publisher to initiate the negotiation regarding certain inventory. In the RFP, buyers can specify the deal type, deal terms, start and end dates, targeting, and a message to the publisher. Once the RFP is sent, a proposal in `SELLER_REVIEW_REQUESTED` state will be created and returned in the response. The publisher may review your request and respond with detailed deals in the proposal." }, "cancelNegotiation": { "flatPath": "v1/buyers/{buyersId}/proposals/{proposalsId}:cancelNegotiation", "request": { "$ref": "CancelNegotiationRequest" }, "response": { "$ref": "Proposal" }, "id": "authorizedbuyersmarketplace.buyers.proposals.cancelNegotiation", "parameterOrder": [ "proposal" ], "path": "v1/{+proposal}:cancelNegotiation", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "parameters": { "proposal": { "type": "string", "description": "Name of the proposal. Format: `buyers/{accountId}/proposals/{proposalId}`", "required": true, "pattern": "^buyers/[^/]+/proposals/[^/]+$", "location": "path" } }, "httpMethod": "POST", "description": "Cancels an ongoing negotiation on a proposal. This does not cancel or end serving for the deals if the proposal has been finalized. If the proposal has not been finalized before, calling this method will set the Proposal.state to `TERMINATED` and increment the Proposal.proposal_revision. If the proposal has been finalized before and is under renegotiation now, calling this method will reset the Proposal.state to `FINALIZED` and increment the Proposal.proposal_revision. This method does not support private auction proposals whose Proposal.deal_type is 'PRIVATE_AUCTION'." }, "addNote": { "flatPath": "v1/buyers/{buyersId}/proposals/{proposalsId}:addNote", "request": { "$ref": "AddNoteRequest" }, "response": { "$ref": "Proposal" }, "id": "authorizedbuyersmarketplace.buyers.proposals.addNote", "parameterOrder": [ "proposal" ], "path": "v1/{+proposal}:addNote", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "parameters": { "proposal": { "type": "string", "description": "Name of the proposal. Format: `buyers/{accountId}/proposals/{proposalId}`", "required": true, "pattern": "^buyers/[^/]+/proposals/[^/]+$", "location": "path" } }, "httpMethod": "POST", "description": "Creates a note for this proposal and sends to the seller. This method is not supported for proposals with DealType set to 'PRIVATE_AUCTION'." }, "accept": { "flatPath": "v1/buyers/{buyersId}/proposals/{proposalsId}:accept", "id": "authorizedbuyersmarketplace.buyers.proposals.accept", "parameterOrder": [ "name" ], "request": { "$ref": "AcceptProposalRequest" }, "response": { "$ref": "Proposal" }, "path": "v1/{+name}:accept", "parameters": { "name": { "type": "string", "description": "Name of the proposal. Format: `buyers/{accountId}/proposals/{proposalId}`", "required": true, "pattern": "^buyers/[^/]+/proposals/[^/]+$", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "httpMethod": "POST", "description": "Accepts the proposal at the given revision number. If the revision number in the request is behind the latest from the server, an error message will be returned. This call updates the Proposal.state from `BUYER_ACCEPTANCE_REQUESTED` to `FINALIZED`; it has no side effect if the Proposal.state is already `FINALIZED` and throws exception if the Proposal.state is not either `BUYER_ACCEPTANCE_REQUESTED` or `FINALIZED`. Accepting a proposal means the buyer understands and accepts the Proposal.terms_and_conditions proposed by the seller." }, "patch": { "parameters": { "name": { "pattern": "^buyers/[^/]+/proposals/[^/]+$", "location": "path", "type": "string", "description": "Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId}", "required": true }, "updateMask": { "format": "google-fieldmask", "type": "string", "description": "List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path \"*\" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "path": "v1/{+name}", "id": "authorizedbuyersmarketplace.buyers.proposals.patch", "parameterOrder": [ "name" ], "request": { "$ref": "Proposal" }, "response": { "$ref": "Proposal" }, "flatPath": "v1/buyers/{buyersId}/proposals/{proposalsId}", "httpMethod": "PATCH", "description": "Updates the proposal at the given revision number. If the revision number in the request is behind the latest one kept in the server, an error message will be returned. See FieldMask for how to use FieldMask. Only fields specified in the UpdateProposalRequest.update_mask will be updated; Fields noted as 'Immutable' or 'Output only' yet specified in the UpdateProposalRequest.update_mask will be ignored and left unchanged. Updating a private auction proposal is only allowed for buyer private data, all other fields are immutable." }, "list": { "path": "v1/{+parent}/proposals", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "parameters": { "filter": { "type": "string", "description": "Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * displayName * dealType * updateTime * state", "location": "query" }, "pageToken": { "type": "string", "description": "The page token as returned from ListProposalsResponse.", "location": "query" }, "parent": { "pattern": "^buyers/[^/]+$", "location": "path", "type": "string", "description": "Required. Parent that owns the collection of proposals Format: `buyers/{accountId}`", "required": true }, "pageSize": { "type": "integer", "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will put a size of 500.", "location": "query", "format": "int32" } }, "flatPath": "v1/buyers/{buyersId}/proposals", "response": { "$ref": "ListProposalsResponse" }, "id": "authorizedbuyersmarketplace.buyers.proposals.list", "parameterOrder": [ "parent" ], "httpMethod": "GET", "description": "Lists proposals. A filter expression using [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) may be specified to filter the results." } } }, "publisherProfiles": { "methods": { "get": { "httpMethod": "GET", "description": "Gets the requested publisher profile by name.", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "parameters": { "name": { "type": "string", "description": "Required. Name of the publisher profile. Format: `buyers/{buyerId}/publisherProfiles/{publisherProfileId}`", "required": true, "pattern": "^buyers/[^/]+/publisherProfiles/[^/]+$", "location": "path" } }, "path": "v1/{+name}", "response": { "$ref": "PublisherProfile" }, "id": "authorizedbuyersmarketplace.buyers.publisherProfiles.get", "parameterOrder": [ "name" ], "flatPath": "v1/buyers/{buyersId}/publisherProfiles/{publisherProfilesId}" }, "list": { "path": "v1/{+parent}/publisherProfiles", "parameters": { "pageSize": { "format": "int32", "description": "Requested page size. The server may return fewer results than requested. If requested more than 500, the server will return 500 results per page. If unspecified, the server will pick a default page size of 100.", "location": "query", "type": "integer" }, "parent": { "type": "string", "description": "Required. Parent that owns the collection of publisher profiles Format: `buyers/{buyerId}`", "required": true, "pattern": "^buyers/[^/]+$", "location": "path" }, "pageToken": { "description": "The page token as returned from a previous ListPublisherProfilesResponse.", "location": "query", "type": "string" }, "filter": { "description": "Optional query string using the [Cloud API list filtering] (https://developers.google.com/authorized-buyers/apis/guides/list-filters) syntax.", "location": "query", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "flatPath": "v1/buyers/{buyersId}/publisherProfiles", "id": "authorizedbuyersmarketplace.buyers.publisherProfiles.list", "parameterOrder": [ "parent" ], "response": { "$ref": "ListPublisherProfilesResponse" }, "httpMethod": "GET", "description": "Lists publisher profiles. The returned publisher profiles aren't in any defined order. The order of the results might change. A new publisher profile can appear in any place in the list of returned results." } } }, "auctionPackages": { "methods": { "list": { "httpMethod": "GET", "description": "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.", "response": { "$ref": "ListAuctionPackagesResponse" }, "id": "authorizedbuyersmarketplace.buyers.auctionPackages.list", "parameterOrder": [ "parent" ], "flatPath": "v1/buyers/{buyersId}/auctionPackages", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "parameters": { "parent": { "pattern": "^buyers/[^/]+$", "location": "path", "description": "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}`.", "required": true, "type": "string" }, "pageSize": { "format": "int32", "type": "integer", "description": "Requested page size. The server may return fewer results than requested. Max allowed page size is 500.", "location": "query" }, "orderBy": { "description": "Optional. An optional query string to sort auction packages using the [Cloud API sorting syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order). If no sort order is specified, results will be returned in an arbitrary order. Only supported when parent is bidder. Supported columns for sorting are: * displayName * createTime * updateTime", "location": "query", "type": "string" }, "filter": { "description": "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", "location": "query", "type": "string" }, "pageToken": { "type": "string", "description": "The page token as returned. ListAuctionPackagesResponse.nextPageToken", "location": "query" } }, "path": "v1/{+parent}/auctionPackages" }, "unsubscribe": { "httpMethod": "POST", "description": "Unsubscribe from the auction package for the specified buyer. Once unsubscribed, the bidder will no longer receive a call out for the auction package deal ID and the specified buyer.", "request": { "$ref": "UnsubscribeAuctionPackageRequest" }, "response": { "$ref": "AuctionPackage" }, "id": "authorizedbuyersmarketplace.buyers.auctionPackages.unsubscribe", "parameterOrder": [ "name" ], "flatPath": "v1/buyers/{buyersId}/auctionPackages/{auctionPackagesId}:unsubscribe", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "parameters": { "name": { "description": "Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}`", "required": true, "type": "string", "pattern": "^buyers/[^/]+/auctionPackages/[^/]+$", "location": "path" } }, "path": "v1/{+name}:unsubscribe" }, "subscribeClients": { "httpMethod": "POST", "description": "Subscribe the specified clients of the buyer to the auction package. If a client in the list does not belong to the buyer, an error response will be returned, and all of the following clients in the list will not be subscribed. Subscribing an already subscribed client will have no effect.", "id": "authorizedbuyersmarketplace.buyers.auctionPackages.subscribeClients", "parameterOrder": [ "auctionPackage" ], "request": { "$ref": "SubscribeClientsRequest" }, "response": { "$ref": "AuctionPackage" }, "flatPath": "v1/buyers/{buyersId}/auctionPackages/{auctionPackagesId}:subscribeClients", "parameters": { "auctionPackage": { "description": "Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}`", "required": true, "type": "string", "pattern": "^buyers/[^/]+/auctionPackages/[^/]+$", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "path": "v1/{+auctionPackage}:subscribeClients" }, "unsubscribeClients": { "path": "v1/{+auctionPackage}:unsubscribeClients", "parameters": { "auctionPackage": { "pattern": "^buyers/[^/]+/auctionPackages/[^/]+$", "location": "path", "type": "string", "description": "Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}`", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "flatPath": "v1/buyers/{buyersId}/auctionPackages/{auctionPackagesId}:unsubscribeClients", "id": "authorizedbuyersmarketplace.buyers.auctionPackages.unsubscribeClients", "parameterOrder": [ "auctionPackage" ], "request": { "$ref": "UnsubscribeClientsRequest" }, "response": { "$ref": "AuctionPackage" }, "httpMethod": "POST", "description": "Unsubscribe from the auction package for the specified clients of the buyer. Unsubscribing a client that is not subscribed will have no effect." }, "get": { "flatPath": "v1/buyers/{buyersId}/auctionPackages/{auctionPackagesId}", "response": { "$ref": "AuctionPackage" }, "id": "authorizedbuyersmarketplace.buyers.auctionPackages.get", "parameterOrder": [ "name" ], "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "parameters": { "name": { "pattern": "^buyers/[^/]+/auctionPackages/[^/]+$", "location": "path", "type": "string", "description": "Required. Name of auction package to get. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}`", "required": true } }, "httpMethod": "GET", "description": "Gets an auction package given its name." }, "subscribe": { "httpMethod": "POST", "description": "Subscribe to the auction package for the specified buyer. Once subscribed, the bidder will receive a call out for inventory matching the auction package targeting criteria with the auction package deal ID and the specified buyer.", "flatPath": "v1/buyers/{buyersId}/auctionPackages/{auctionPackagesId}:subscribe", "request": { "$ref": "SubscribeAuctionPackageRequest" }, "response": { "$ref": "AuctionPackage" }, "id": "authorizedbuyersmarketplace.buyers.auctionPackages.subscribe", "parameterOrder": [ "name" ], "path": "v1/{+name}:subscribe", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "parameters": { "name": { "pattern": "^buyers/[^/]+/auctionPackages/[^/]+$", "location": "path", "description": "Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}`", "required": true, "type": "string" } } } } }, "clients": { "resources": { "users": { "methods": { "delete": { "httpMethod": "DELETE", "description": "Deletes an existing client user. The client user will lose access to the Authorized Buyers UI. Note that if a client user is deleted, the user's access to the UI can't be restored unless a new client user is created and activated.", "response": { "$ref": "Empty" }, "id": "authorizedbuyersmarketplace.buyers.clients.users.delete", "parameterOrder": [ "name" ], "flatPath": "v1/buyers/{buyersId}/clients/{clientsId}/users/{usersId}", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "parameters": { "name": { "description": "Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}`", "required": true, "type": "string", "pattern": "^buyers/[^/]+/clients/[^/]+/users/[^/]+$", "location": "path" } }, "path": "v1/{+name}" }, "list": { "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "parameters": { "pageToken": { "type": "string", "description": "A token identifying a page of results the server should return. Typically, this is the value of ListClientUsersResponse.nextPageToken returned from the previous call to the list method.", "location": "query" }, "pageSize": { "format": "int32", "type": "integer", "description": "Requested page size. If left blank, a default page size of 500 will be applied.", "location": "query" }, "parent": { "pattern": "^buyers/[^/]+/clients/[^/]+$", "location": "path", "type": "string", "description": "Required. The name of the client. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}`", "required": true } }, "path": "v1/{+parent}/users", "response": { "$ref": "ListClientUsersResponse" }, "id": "authorizedbuyersmarketplace.buyers.clients.users.list", "parameterOrder": [ "parent" ], "flatPath": "v1/buyers/{buyersId}/clients/{clientsId}/users", "httpMethod": "GET", "description": "Lists all client users for a specified client." }, "get": { "path": "v1/{+name}", "parameters": { "name": { "description": "Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}`", "required": true, "type": "string", "pattern": "^buyers/[^/]+/clients/[^/]+/users/[^/]+$", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "flatPath": "v1/buyers/{buyersId}/clients/{clientsId}/users/{usersId}", "id": "authorizedbuyersmarketplace.buyers.clients.users.get", "parameterOrder": [ "name" ], "response": { "$ref": "ClientUser" }, "httpMethod": "GET", "description": "Retrieves an existing client user." }, "deactivate": { "httpMethod": "POST", "description": "Deactivates an existing client user. The state of the client user will be updated from \"ACTIVE\" to \"INACTIVE\". This method has no effect if the client user is already in \"INACTIVE\" state. An error will be returned if the client user to deactivate is still in \"INVITED\" state.", "parameters": { "name": { "pattern": "^buyers/[^/]+/clients/[^/]+/users/[^/]+$", "location": "path", "type": "string", "description": "Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}`", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "path": "v1/{+name}:deactivate", "id": "authorizedbuyersmarketplace.buyers.clients.users.deactivate", "parameterOrder": [ "name" ], "request": { "$ref": "DeactivateClientUserRequest" }, "response": { "$ref": "ClientUser" }, "flatPath": "v1/buyers/{buyersId}/clients/{clientsId}/users/{usersId}:deactivate" }, "create": { "id": "authorizedbuyersmarketplace.buyers.clients.users.create", "parameterOrder": [ "parent" ], "request": { "$ref": "ClientUser" }, "response": { "$ref": "ClientUser" }, "flatPath": "v1/buyers/{buyersId}/clients/{clientsId}/users", "parameters": { "parent": { "pattern": "^buyers/[^/]+/clients/[^/]+$", "location": "path", "type": "string", "description": "Required. The name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "path": "v1/{+parent}/users", "httpMethod": "POST", "description": "Creates a new client user in \"INVITED\" state. An email invitation will be sent to the new user, once accepted the user will become active." }, "activate": { "httpMethod": "POST", "description": "Activates an existing client user. The state of the client user will be updated from \"INACTIVE\" to \"ACTIVE\". This method has no effect if the client user is already in \"ACTIVE\" state. An error will be returned if the client user to activate is still in \"INVITED\" state.", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "parameters": { "name": { "description": "Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}`", "required": true, "type": "string", "pattern": "^buyers/[^/]+/clients/[^/]+/users/[^/]+$", "location": "path" } }, "path": "v1/{+name}:activate", "request": { "$ref": "ActivateClientUserRequest" }, "response": { "$ref": "ClientUser" }, "id": "authorizedbuyersmarketplace.buyers.clients.users.activate", "parameterOrder": [ "name" ], "flatPath": "v1/buyers/{buyersId}/clients/{clientsId}/users/{usersId}:activate" } } } }, "methods": { "patch": { "flatPath": "v1/buyers/{buyersId}/clients/{clientsId}", "request": { "$ref": "Client" }, "response": { "$ref": "Client" }, "id": "authorizedbuyersmarketplace.buyers.clients.patch", "parameterOrder": [ "name" ], "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "parameters": { "name": { "type": "string", "description": "Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`", "required": true, "pattern": "^buyers/[^/]+/clients/[^/]+$", "location": "path" }, "updateMask": { "type": "string", "description": "List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path \"*\" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.", "location": "query", "format": "google-fieldmask" } }, "httpMethod": "PATCH", "description": "Updates an existing client." }, "list": { "httpMethod": "GET", "description": "Lists all the clients for the current buyer.", "path": "v1/{+parent}/clients", "parameters": { "filter": { "description": "Query string using the [Filtering Syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported fields for filtering are: * partnerClientId Use this field to filter the clients by the partnerClientId. For example, if the partnerClientId of the client is \"1234\", the value of this field should be `partnerClientId = \"1234\"`, in order to get only the client whose partnerClientId is \"1234\" in the response.", "location": "query", "type": "string" }, "pageToken": { "type": "string", "description": "A token identifying a page of results the server should return. Typically, this is the value of ListClientsResponse.nextPageToken returned from the previous call to the list method.", "location": "query" }, "parent": { "pattern": "^buyers/[^/]+$", "location": "path", "description": "Required. The name of the buyer. Format: `buyers/{accountId}`", "required": true, "type": "string" }, "pageSize": { "format": "int32", "type": "integer", "description": "Requested page size. If left blank, a default page size of 500 will be applied.", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "flatPath": "v1/buyers/{buyersId}/clients", "id": "authorizedbuyersmarketplace.buyers.clients.list", "parameterOrder": [ "parent" ], "response": { "$ref": "ListClientsResponse" } }, "get": { "httpMethod": "GET", "description": "Gets a client with a given resource name.", "id": "authorizedbuyersmarketplace.buyers.clients.get", "parameterOrder": [ "name" ], "response": { "$ref": "Client" }, "flatPath": "v1/buyers/{buyersId}/clients/{clientsId}", "parameters": { "name": { "pattern": "^buyers/[^/]+/clients/[^/]+$", "location": "path", "type": "string", "description": "Required. Format: `buyers/{accountId}/clients/{clientAccountId}`", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "path": "v1/{+name}" }, "deactivate": { "httpMethod": "POST", "description": "Deactivates an existing client. The state of the client will be updated to \"INACTIVE\". This method has no effect if the client is already in \"INACTIVE\" state.", "parameters": { "name": { "type": "string", "description": "Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}`", "required": true, "pattern": "^buyers/[^/]+/clients/[^/]+$", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "path": "v1/{+name}:deactivate", "id": "authorizedbuyersmarketplace.buyers.clients.deactivate", "parameterOrder": [ "name" ], "request": { "$ref": "DeactivateClientRequest" }, "response": { "$ref": "Client" }, "flatPath": "v1/buyers/{buyersId}/clients/{clientsId}:deactivate" }, "create": { "parameters": { "parent": { "pattern": "^buyers/[^/]+$", "location": "path", "type": "string", "description": "Required. The name of the buyer. Format: `buyers/{accountId}`", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "path": "v1/{+parent}/clients", "id": "authorizedbuyersmarketplace.buyers.clients.create", "parameterOrder": [ "parent" ], "request": { "$ref": "Client" }, "response": { "$ref": "Client" }, "flatPath": "v1/buyers/{buyersId}/clients", "httpMethod": "POST", "description": "Creates a new client." }, "activate": { "httpMethod": "POST", "description": "Activates an existing client. The state of the client will be updated to \"ACTIVE\". This method has no effect if the client is already in \"ACTIVE\" state.", "id": "authorizedbuyersmarketplace.buyers.clients.activate", "parameterOrder": [ "name" ], "request": { "$ref": "ActivateClientRequest" }, "response": { "$ref": "Client" }, "flatPath": "v1/buyers/{buyersId}/clients/{clientsId}:activate", "parameters": { "name": { "type": "string", "description": "Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}`", "required": true, "pattern": "^buyers/[^/]+/clients/[^/]+$", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "path": "v1/{+name}:activate" } } }, "finalizedDeals": { "methods": { "pause": { "path": "v1/{+name}:pause", "parameters": { "name": { "type": "string", "description": "Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}`", "required": true, "pattern": "^buyers/[^/]+/finalizedDeals/[^/]+$", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "flatPath": "v1/buyers/{buyersId}/finalizedDeals/{finalizedDealsId}:pause", "id": "authorizedbuyersmarketplace.buyers.finalizedDeals.pause", "parameterOrder": [ "name" ], "request": { "$ref": "PauseFinalizedDealRequest" }, "response": { "$ref": "FinalizedDeal" }, "httpMethod": "POST", "description": "Pauses serving of the given finalized deal. This call only pauses the serving status, and does not affect other fields of the finalized deal. Calling this method for an already paused deal has no effect. This method only applies to programmatic guaranteed deals and preferred deals." }, "list": { "httpMethod": "GET", "description": "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 deals for the bidder, its buyers and all their clients.", "flatPath": "v1/buyers/{buyersId}/finalizedDeals", "id": "authorizedbuyersmarketplace.buyers.finalizedDeals.list", "parameterOrder": [ "parent" ], "response": { "$ref": "ListFinalizedDealsResponse" }, "path": "v1/{+parent}/finalizedDeals", "parameters": { "orderBy": { "type": "string", "description": "An optional query string to sort finalized deals using the [Cloud API sorting syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order). If no sort order is specified, results will be returned in an arbitrary order. Supported columns for sorting are: * deal.displayName * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * rtbMetrics.bidRequests7Days * rtbMetrics.bids7Days * rtbMetrics.adImpressions7Days * rtbMetrics.bidRate7Days * rtbMetrics.filteredBidRate7Days * rtbMetrics.mustBidRateCurrentMonth", "location": "query" }, "pageSize": { "format": "int32", "description": "Requested page size. The server may return fewer results than requested. If requested more than 500, the server will return 500 results per page. If unspecified, the server will pick a default page size of 100.", "location": "query", "type": "integer" }, "parent": { "pattern": "^buyers/[^/]+$", "location": "path", "description": "Required. The buyer to list the finalized deals for, in the format: `buyers/{accountId}`. When used to list finalized deals for a bidder, its buyers and clients, in the format `bidders/{accountId}`.", "required": true, "type": "string" }, "pageToken": { "type": "string", "description": "The page token as returned from ListFinalizedDealsResponse.", "location": "query" }, "filter": { "type": "string", "description": "Optional query string using the [Cloud API list filtering syntax](https://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 * deal.eligibleSeatIds * dealServingStatus * readyToServe", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ] }, "setReadyToServe": { "httpMethod": "POST", "description": "Sets the given finalized deal as ready to serve. By default, deals are set as ready to serve as soon as they're finalized. If you want to opt out of the default behavior, and manually indicate that deals are ready to serve, ask your Technical Account Manager to add you to the allowlist. If you choose to use this method, finalized deals belonging to the bidder and its child seats don't start serving until after you call `setReadyToServe`, and after the deals become active. For example, you can use this method to delay receiving bid requests until your creative is ready. In addition, bidders can use the URL path \"/v1/bidders/{accountId}/finalizedDeals/{dealId}\" to set ready to serve for the finalized deals belong to itself, its child seats and all their clients. This method only applies to programmatic guaranteed deals.", "request": { "$ref": "SetReadyToServeRequest" }, "response": { "$ref": "FinalizedDeal" }, "id": "authorizedbuyersmarketplace.buyers.finalizedDeals.setReadyToServe", "parameterOrder": [ "deal" ], "flatPath": "v1/buyers/{buyersId}/finalizedDeals/{finalizedDealsId}:setReadyToServe", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "parameters": { "deal": { "description": "Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}` or `bidders/{accountId}/finalizedDeals/{dealId}`", "required": true, "type": "string", "pattern": "^buyers/[^/]+/finalizedDeals/[^/]+$", "location": "path" } }, "path": "v1/{+deal}:setReadyToServe" }, "resume": { "httpMethod": "POST", "description": "Resumes serving of the given finalized deal. Calling this method for an running deal has no effect. If a deal is initially paused by the seller, calling this method will not resume serving of the deal until the seller also resumes the deal. This method only applies to programmatic guaranteed deals and preferred deals.", "flatPath": "v1/buyers/{buyersId}/finalizedDeals/{finalizedDealsId}:resume", "request": { "$ref": "ResumeFinalizedDealRequest" }, "response": { "$ref": "FinalizedDeal" }, "id": "authorizedbuyersmarketplace.buyers.finalizedDeals.resume", "parameterOrder": [ "name" ], "path": "v1/{+name}:resume", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "parameters": { "name": { "pattern": "^buyers/[^/]+/finalizedDeals/[^/]+$", "location": "path", "description": "Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}`", "required": true, "type": "string" } } }, "addCreative": { "parameters": { "deal": { "type": "string", "description": "Required. Name of the finalized deal in the format of: `buyers/{accountId}/finalizedDeals/{dealId}`", "required": true, "pattern": "^buyers/[^/]+/finalizedDeals/[^/]+$", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "path": "v1/{+deal}:addCreative", "id": "authorizedbuyersmarketplace.buyers.finalizedDeals.addCreative", "parameterOrder": [ "deal" ], "request": { "$ref": "AddCreativeRequest" }, "response": { "$ref": "FinalizedDeal" }, "flatPath": "v1/buyers/{buyersId}/finalizedDeals/{finalizedDealsId}:addCreative", "httpMethod": "POST", "description": "Add creative to be used in the bidding process for a finalized deal. For programmatic guaranteed deals, it's recommended that you associate at least one approved creative with the deal before calling SetReadyToServe, to help reduce the number of bid responses filtered because they don't contain approved creatives. Creatives successfully added to a deal can be found in the Realtime-bidding Creatives API creative.deal_ids. This method only applies to programmatic guaranteed deals. Maximum number of 1000 creatives can be added to a finalized deal." }, "get": { "parameters": { "name": { "description": "Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}`", "required": true, "type": "string", "pattern": "^buyers/[^/]+/finalizedDeals/[^/]+$", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "path": "v1/{+name}", "id": "authorizedbuyersmarketplace.buyers.finalizedDeals.get", "parameterOrder": [ "name" ], "response": { "$ref": "FinalizedDeal" }, "flatPath": "v1/buyers/{buyersId}/finalizedDeals/{finalizedDealsId}", "httpMethod": "GET", "description": "Gets a finalized deal given its name." } } } } }, "bidders": { "resources": { "auctionPackages": { "methods": { "list": { "httpMethod": "GET", "description": "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.", "flatPath": "v1/bidders/{biddersId}/auctionPackages", "response": { "$ref": "ListAuctionPackagesResponse" }, "id": "authorizedbuyersmarketplace.bidders.auctionPackages.list", "parameterOrder": [ "parent" ], "path": "v1/{+parent}/auctionPackages", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "parameters": { "filter": { "type": "string", "description": "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", "location": "query" }, "pageToken": { "type": "string", "description": "The page token as returned. ListAuctionPackagesResponse.nextPageToken", "location": "query" }, "parent": { "pattern": "^bidders/[^/]+$", "location": "path", "description": "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}`.", "required": true, "type": "string" }, "pageSize": { "type": "integer", "description": "Requested page size. The server may return fewer results than requested. Max allowed page size is 500.", "location": "query", "format": "int32" }, "orderBy": { "type": "string", "description": "Optional. An optional query string to sort auction packages using the [Cloud API sorting syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order). If no sort order is specified, results will be returned in an arbitrary order. Only supported when parent is bidder. Supported columns for sorting are: * displayName * createTime * updateTime", "location": "query" } } } } }, "finalizedDeals": { "methods": { "list": { "path": "v1/{+parent}/finalizedDeals", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "parameters": { "filter": { "type": "string", "description": "Optional query string using the [Cloud API list filtering syntax](https://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 * deal.eligibleSeatIds * dealServingStatus * readyToServe", "location": "query" }, "pageToken": { "description": "The page token as returned from ListFinalizedDealsResponse.", "location": "query", "type": "string" }, "parent": { "pattern": "^bidders/[^/]+$", "location": "path", "description": "Required. The buyer to list the finalized deals for, in the format: `buyers/{accountId}`. When used to list finalized deals for a bidder, its buyers and clients, in the format `bidders/{accountId}`.", "required": true, "type": "string" }, "orderBy": { "description": "An optional query string to sort finalized deals using the [Cloud API sorting syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order). If no sort order is specified, results will be returned in an arbitrary order. Supported columns for sorting are: * deal.displayName * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * rtbMetrics.bidRequests7Days * rtbMetrics.bids7Days * rtbMetrics.adImpressions7Days * rtbMetrics.bidRate7Days * rtbMetrics.filteredBidRate7Days * rtbMetrics.mustBidRateCurrentMonth", "location": "query", "type": "string" }, "pageSize": { "type": "integer", "description": "Requested page size. The server may return fewer results than requested. If requested more than 500, the server will return 500 results per page. If unspecified, the server will pick a default page size of 100.", "location": "query", "format": "int32" } }, "flatPath": "v1/bidders/{biddersId}/finalizedDeals", "response": { "$ref": "ListFinalizedDealsResponse" }, "id": "authorizedbuyersmarketplace.bidders.finalizedDeals.list", "parameterOrder": [ "parent" ], "httpMethod": "GET", "description": "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 deals for the bidder, its buyers and all their clients." }, "setReadyToServe": { "path": "v1/{+deal}:setReadyToServe", "parameters": { "deal": { "pattern": "^bidders/[^/]+/finalizedDeals/[^/]+$", "location": "path", "description": "Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}` or `bidders/{accountId}/finalizedDeals/{dealId}`", "required": true, "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "flatPath": "v1/bidders/{biddersId}/finalizedDeals/{finalizedDealsId}:setReadyToServe", "id": "authorizedbuyersmarketplace.bidders.finalizedDeals.setReadyToServe", "parameterOrder": [ "deal" ], "request": { "$ref": "SetReadyToServeRequest" }, "response": { "$ref": "FinalizedDeal" }, "httpMethod": "POST", "description": "Sets the given finalized deal as ready to serve. By default, deals are set as ready to serve as soon as they're finalized. If you want to opt out of the default behavior, and manually indicate that deals are ready to serve, ask your Technical Account Manager to add you to the allowlist. If you choose to use this method, finalized deals belonging to the bidder and its child seats don't start serving until after you call `setReadyToServe`, and after the deals become active. For example, you can use this method to delay receiving bid requests until your creative is ready. In addition, bidders can use the URL path \"/v1/bidders/{accountId}/finalizedDeals/{dealId}\" to set ready to serve for the finalized deals belong to itself, its child seats and all their clients. This method only applies to programmatic guaranteed deals." } } } } } }, "revision": "20260414" }