{ "rootUrl": "https://authorizedbuyersmarketplace.googleapis.com/", "schemas": { "PlacementTargeting": { "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": { "$ref": "UriTargeting", "description": "URLs to be included/excluded." }, "mobileApplicationTargeting": { "description": "Mobile application targeting information in a deal. This doesn't apply to Auction Packages.", "$ref": "MobileApplicationTargeting" } }, "id": "PlacementTargeting", "type": "object" }, "MediaPlanner": { "description": "Represents a media planner account.", "properties": { "accountId": { "type": "string", "description": "Output only. Account ID of the media planner.", "readOnly": true, "deprecated": true }, "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." }, "displayName": { "type": "string", "description": "Output only. The display name of the media planner. Can be used to filter the response of the mediaPlanners.list method.", "readOnly": true }, "ancestorNames": { "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.", "readOnly": true, "type": "array", "items": { "type": "string" } } }, "id": "MediaPlanner", "type": "object" }, "PauseFinalizedDealRequest": { "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", "type": "object" }, "SubscribeAuctionPackageRequest": { "id": "SubscribeAuctionPackageRequest", "type": "object", "description": "Request message for SubscribeAuctionPackage.", "properties": {} }, "MarketplaceTargeting": { "id": "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": { "inventorySizeTargeting": { "$ref": "InventorySizeTargeting", "description": "Output only. Inventory sizes to be included/excluded.", "readOnly": true }, "placementTargeting": { "description": "Output only. Placement targeting information, for example, URL, mobile applications.", "readOnly": true, "$ref": "PlacementTargeting" }, "geoTargeting": { "description": "Output only. Geo criteria IDs to be included/excluded.", "readOnly": true, "$ref": "CriteriaTargeting" }, "verticalTargeting": { "description": "Output only. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals", "readOnly": true, "$ref": "CriteriaTargeting" }, "inventoryTypeTargeting": { "description": "Output only. Inventory type targeting information.", "readOnly": true, "$ref": "InventoryTypeTargeting" }, "daypartTargeting": { "description": "Daypart targeting information.", "$ref": "DayPartTargeting" }, "technologyTargeting": { "$ref": "TechnologyTargeting", "description": "Output only. Technology targeting information, for example, operating system, device category.", "readOnly": true }, "userListTargeting": { "$ref": "CriteriaTargeting", "description": "Buyer user list targeting information. User lists can be uploaded using https://developers.google.com/authorized-buyers/rtb/bulk-uploader." }, "excludedSensitiveCategoryIds": { "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.", "readOnly": true, "items": { "type": "string", "format": "int64" }, "type": "array" }, "videoTargeting": { "$ref": "VideoTargeting", "description": "Output only. Video targeting information.", "readOnly": true } } }, "DeactivateClientUserRequest": { "id": "DeactivateClientUserRequest", "type": "object", "description": "Request message for deactivating a client user.", "properties": {} }, "ActivateCuratedPackageRequest": { "id": "ActivateCuratedPackageRequest", "type": "object", "description": "Request message for ActivateCuratedPackage.", "properties": {} }, "Empty": { "id": "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": {} }, "ListDealsResponse": { "description": "Response message for listing deals in a proposal.", "properties": { "nextPageToken": { "type": "string", "description": "Token to fetch the next page of results." }, "deals": { "items": { "$ref": "Deal" }, "type": "array", "description": "The list of deals." } }, "id": "ListDealsResponse", "type": "object" }, "Price": { "description": "Represents a price and a pricing type for a deal.", "properties": { "type": { "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." ], "enum": [ "TYPE_UNSPECIFIED", "CPM", "CPD" ], "type": "string" }, "amount": { "$ref": "Money", "description": "The actual price with currency specified." } }, "id": "Price", "type": "object" }, "PublisherProfile": { "id": "PublisherProfile", "type": "object", "description": "The values in the publisher profile are supplied by the publisher. All fields are not filterable unless stated otherwise.", "properties": { "publisherCode": { "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.", "type": "string" }, "overview": { "type": "string", "description": "Overview of the publisher." }, "samplePageUrl": { "description": "URL to a sample content page.", "type": "string" }, "mediaKitUrl": { "description": "URL to additional marketing and sales materials.", "type": "string" }, "displayName": { "description": "Display name of the publisher profile. Can be used to filter the response of the publisherProfiles.list method.", "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" }, "audienceDescription": { "type": "string", "description": "Description on the publisher's audience." }, "pitchStatement": { "type": "string", "description": "Statement explaining what's unique about publisher's business, and why buyers should partner with the publisher." }, "mobileApps": { "items": { "$ref": "PublisherProfileMobileApplication" }, "type": "array", "description": "The list of apps represented in this publisher profile. Empty if this is a parent profile." }, "topHeadlines": { "description": "Up to three key metrics and rankings. For example, \"#1 Mobile News Site for 20 Straight Months\".", "type": "array", "items": { "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." }, "name": { "description": "Name of the publisher profile. Format: `buyers/{buyer}/publisherProfiles/{publisher_profile}`", "type": "string" }, "directDealsContact": { "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.", "type": "string" }, "domains": { "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" }, "type": "array" }, "logoUrl": { "type": "string", "description": "A Google public URL to the logo for this publisher profile. The logo is stored as a PNG, JPG, or GIF image." } } }, "ListPublisherProfilesResponse": { "description": "Response message for profiles visible to the buyer.", "properties": { "publisherProfiles": { "type": "array", "items": { "$ref": "PublisherProfile" }, "description": "The list of matching publisher profiles." }, "nextPageToken": { "type": "string", "description": "Token to fetch the next page of results." } }, "id": "ListPublisherProfilesResponse", "type": "object" }, "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": { "description": "Optional. IANA Time Zone Database version number. For example \"2019a\".", "type": "string" } } }, "InventoryTypeTargeting": { "description": "Targeting of the inventory types a bid request can originate from.", "properties": { "inventoryTypes": { "items": { "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": "string" }, "type": "array", "description": "The list of targeted inventory types for the bid request." } }, "id": "InventoryTypeTargeting", "type": "object" }, "AcceptProposalRequest": { "description": "Request to accept a proposal. Accepting a proposal implies acceptance of the publisher terms_and_conditions, if any.", "properties": { "proposalRevision": { "type": "string", "format": "int64", "description": "The last known client revision number of the proposal." } }, "id": "AcceptProposalRequest", "type": "object" }, "ListAuctionPackagesResponse": { "description": "Response message for listing auction packages.", "properties": { "nextPageToken": { "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.", "type": "string" }, "auctionPackages": { "description": "The list of auction packages.", "type": "array", "items": { "$ref": "AuctionPackage" } } }, "id": "ListAuctionPackagesResponse", "type": "object" }, "CuratedPackage": { "description": "Represents a curated package of inventory created and managed by a Curator.", "properties": { "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. The timestamp when the curated package was created. Can be used to filter the response of the curatedPackages.list method.", "readOnly": true }, "name": { "description": "Identifier. The unique resource name for the curated package. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}`", "type": "string" }, "curationFeeVisibility": { "type": "string", "description": "Optional. Immutable. The visibility of the combined curation package fee and data segment fees (the total curation fee).", "enumDescriptions": [ "The total curation fee visibility is unspecified.", "The total curation fee is visible to all buyers. This is the default value if not set.", "The total curation fee is not visible to all buyers." ], "enum": [ "CURATION_FEE_VISIBILITY_UNSPECIFIED", "DISCLOSED", "NON_DISCLOSED" ] }, "displayName": { "description": "Required. The display name assigned to the curated package by the curator. Can be used to filter the response of the curatedPackages.list method.", "type": "string" }, "description": { "type": "string", "description": "Optional. A description of the curated package, provided by the curator." }, "millipercentOfMediaFee": { "type": "string", "format": "int64", "description": "Optional. The fee will be charged as a percentage of the impression cost, represented in millipercent. For example, 1% is represented as 1000." }, "accessSettings": { "$ref": "AccessControlSettings", "description": "Required. Settings for controlling access to the curated package. Access to this curated package is limited to the allowlisted media planners and the creator. Buyers and bidders can not be allowlisted for or have direct access to this resource." }, "state": { "type": "string", "enumDescriptions": [ "Default value.", "The curated package is active.", "The curated package is inactive." ], "description": "Output only. The state of the curated package. Can be used to filter the response of the curatedPackages.list method.", "readOnly": true, "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "INACTIVE" ] }, "feeCpm": { "description": "Optional. The CPM fee charged by the curator to buyers using this curated package. Can be used to filter the response of the curatedPackages.list method.", "$ref": "Money" }, "updateTime": { "type": "string", "format": "google-datetime", "description": "Output only. The timestamp when the curated package was last updated. Can be used to filter the response of the curatedPackages.list method.", "readOnly": true }, "floorPriceCpm": { "description": "Optional. The minimum CPM a buyer has to bid to participate in auctions for inventory in this curated package. Can be used to filter the response of the curatedPackages.list method.", "$ref": "Money" }, "targeting": { "description": "Optional. Targeting criteria for the curated package.", "$ref": "PackageTargeting" } }, "id": "CuratedPackage", "type": "object" }, "TaxonomyTargeting": { "id": "TaxonomyTargeting", "type": "object", "description": "Defines targeting criteria for handling the IAB audience and content Taxonomy ID space.", "properties": { "excludedTaxonomyIds": { "type": "array", "items": { "type": "string" }, "description": "Optional. The list of excluded content taxonomy IDs." }, "targetedTaxonomyIds": { "type": "array", "items": { "type": "string" }, "description": "Optional. The list of targeted content taxonomy IDs." } } }, "Note": { "description": "A text note attached to the proposal to facilitate the communication between buyers and sellers.", "properties": { "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. When this note was created.", "readOnly": true }, "creatorRole": { "type": "string", "description": "Output only. The role who created the note.", "readOnly": true, "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" ] }, "note": { "description": "The text of the note. Maximum length is 1024 characters.", "type": "string" } }, "id": "Note", "type": "object" }, "ListClientUsersResponse": { "id": "ListClientUsersResponse", "type": "object", "description": "Response message for the list method.", "properties": { "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" }, "clientUsers": { "type": "array", "items": { "$ref": "ClientUser" }, "description": "The returned list of client users." } } }, "BatchUpdateDealsResponse": { "description": "Response message for batch updating deals.", "properties": { "deals": { "description": "Deals updated.", "type": "array", "items": { "$ref": "Deal" } } }, "id": "BatchUpdateDealsResponse", "type": "object" }, "SubscribeClientsRequest": { "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.", "type": "array", "items": { "type": "string" } } }, "id": "SubscribeClientsRequest", "type": "object" }, "AddNoteRequest": { "description": "Request to add a note.", "properties": { "note": { "$ref": "Note", "description": "The note to add." } }, "id": "AddNoteRequest", "type": "object" }, "OperatingSystemTargeting": { "id": "OperatingSystemTargeting", "type": "object", "description": "Represents targeting information for operating systems.", "properties": { "operatingSystemCriteria": { "description": "IDs of operating systems to be included/excluded.", "$ref": "CriteriaTargeting" }, "operatingSystemVersionCriteria": { "$ref": "CriteriaTargeting", "description": "IDs of operating system versions to be included/excluded." } } }, "ListProposalsResponse": { "id": "ListProposalsResponse", "type": "object", "description": "Response message for listing proposals.", "properties": { "proposals": { "description": "The list of proposals.", "items": { "$ref": "Proposal" }, "type": "array" }, "nextPageToken": { "description": "Continuation token for fetching the next page of results.", "type": "string" } } }, "PackageTargeting": { "description": "Targeting criteria for curated and auction packages.", "properties": { "includedCreativeFormat": { "description": "Optional. The creative format to target. If unset, all creative markup types are targeted.", "enumDescriptions": [ "Default value. Should not be used in targeting specifications.", "Targets ad slots intended for HTML display creatives.", "Targets ad slots intended for video creatives.", "Targets ad slots intended for audio creatives." ], "enum": [ "CREATIVE_FORMAT_UNSPECIFIED", "CREATIVE_FORMAT_DISPLAY", "CREATIVE_FORMAT_VIDEO", "CREATIVE_FORMAT_AUDIO" ], "type": "string" }, "includedRewardedType": { "type": "string", "description": "Optional. The targeted rewarded type. If unset, inventory will be targeted regardless of rewarded type.", "enumDescriptions": [ "Default value. Should not be used in targeting specifications.", "Targets inventory that does NOT offer an explicit reward to the user for watching or interacting with the ad.", "Targets inventory that offers a reward to the user in exchange for watching or engaging with the ad." ], "enum": [ "REWARDED_TYPE_UNSPECIFIED", "REWARDED_TYPE_NON_REWARDED", "REWARDED_TYPE_REWARDED" ] }, "minimumPredictedClickThroughRatePercentageMillis": { "description": "Optional. The targeted minimum predicted click through rate, ranging in values [10, 10000] (0.01% - 10%). A value of 50 means that the configuration will only match adslots for which we predict at least 0.05% click through rate. An unset value indicates inventory will be targeted regardless of predicted click through rate.", "type": "string", "format": "int64" }, "includedAcceleratedMobilePageType": { "type": "string", "description": "Optional. The targeted accelerated mobile page type. If unset, inventory will be targeted regardless of AMP status.", "enumDescriptions": [ "Default value. Should not be used in targeting specifications.", "Targets inventory on standard web pages not using any AMP framework.", "Targets inventory on pages built using the core AMP HTML framework.", "Targets inventory on pages using the AMP Story (STAMP) format, which is optimized for visual storytelling (e.g., tappable full-screen experiences)." ], "enum": [ "ACCELERATED_MOBILE_PAGE_TYPE_UNSPECIFIED", "ACCELERATED_MOBILE_PAGE_TYPE_NON_AMP", "ACCELERATED_MOBILE_PAGE_TYPE_AMP", "ACCELERATED_MOBILE_PAGE_TYPE_AMP_STORY" ] }, "publisherTargeting": { "description": "Optional. The targeted publishers. If unset, inventory will be targeted regardless of publisher. Publishers are identified by their publisher ID from ads.txt / app-ads.txt. See https://iabtechlab.com/ads-txt/ and https://iabtechlab.com/app-ads-txt/ for more details.", "$ref": "StringTargetingDimension" }, "includedAdSizes": { "items": { "$ref": "AdSize" }, "type": "array", "description": "Optional. The list of ad sizes to target. If unset, inventory will be targeted regardless of ad size. Curated packages supports `PIXEL` and `INTERSTITIAL` ad sizes." }, "publisherProvidedSignalsTargeting": { "description": "Optional. The publisher provided signals to target. If unset, inventory will be targeted regardless of publisher provided signals.", "$ref": "PackagePublisherProvidedSignalsTargeting" }, "includedRestrictedCategories": { "description": "Optional. The list of targeted restricted categories. If empty, inventory will be targeted regardless of restricted categories.", "type": "array", "items": { "enumDescriptions": [ "Default value. Should not be used in targeting specifications.", "Targets inventory where alcohol ads are allowed by the publisher.", "Targets inventory where gambling ads are allowed by the publisher." ], "enum": [ "RESTRICTED_CATEGORY_UNSPECIFIED", "RESTRICTED_CATEGORY_ALCOHOL", "RESTRICTED_CATEGORY_GAMBLING" ], "type": "string" } }, "includedNativeInventoryTypes": { "description": "Optional. The targeted native inventory types. If empty, inventory will be targeted regardless of native inventory type.", "type": "array", "items": { "enumDescriptions": [ "Default value. Should not be used in targeting specifications.", "Targets ad slots that *only* accept and render native ads.", "Targets ad slots that accept and render either native or banner ads." ], "enum": [ "NATIVE_INVENTORY_TYPE_UNSPECIFIED", "NATIVE_INVENTORY_TYPE_NATIVE_ONLY", "NATIVE_INVENTORY_TYPE_NATIVE_OR_BANNER" ], "type": "string" } }, "minimumPredictedViewabilityPercentage": { "type": "string", "format": "int64", "description": "Optional. The targeted minimum predicted viewability percentage. This value must be a multiple of 10 between 10 and 90 (inclusive). For example, 10 is valid, but 0, 15, and 100 are not. A value of 10 means that the configuration will only match adslots for which we predict at least 10% viewability. An unset value indicates inventory will be targeted regardless of predicted viewability." }, "includedDataSegments": { "type": "array", "items": { "type": "string" }, "description": "Optional. The active data segments to be targeted. If unset, inventory will be targeted regardless of data segments. Format: `curators/{account_id}/dataSegments/{data_segment_id}`" }, "includedEnvironment": { "type": "string", "enumDescriptions": [ "Default value. Should not be used in targeting specifications.", "Targets inventory rendered within an ad-supported website.", "Targets inventory within a mobile application." ], "enum": [ "ENVIRONMENT_UNSPECIFIED", "ENVIRONMENT_SITE", "ENVIRONMENT_APP" ], "description": "Optional. The environment to target. If unspecified, all environments are targeted." }, "languageTargeting": { "description": "Optional. The languages to target. If unset, inventory will be targeted regardless of language. See https://developers.google.com/google-ads/api/data/codes-formats#languages for the list of supported language codes.", "$ref": "StringTargetingDimension" }, "includedAuthorizedSellerStatuses": { "description": "Optional. The included list of targeted authorized seller statuses. If empty, inventory will be targeted regardless of seller status.", "type": "array", "items": { "type": "string", "enumDescriptions": [ "Default value. Should not be used in targeting specifications.", "Targets inventory where the seller is declared as 'DIRECT'. This indicates the publisher (content owner) directly controls the seller account and has a direct business contract with the advertising system for this account.", "Targets inventory where the seller is declared as 'RESELLER'. This indicates the publisher has authorized another entity to operate the listed seller account and resell their ad space." ], "enum": [ "AUTHORIZED_SELLER_STATUS_UNSPECIFIED", "AUTHORIZED_SELLER_STATUS_DIRECT", "AUTHORIZED_SELLER_STATUS_RESELLER" ] } }, "includedOpenMeasurementTypes": { "type": "array", "items": { "enumDescriptions": [ "Default value. Should not be used in targeting specifications.", "Targets inventory that supports the v1 Open Measurement Interface Definition (OMID)." ], "enum": [ "OPEN_MEASUREMENT_TYPE_UNSPECIFIED", "OPEN_MEASUREMENT_TYPE_OMID_V1" ], "type": "string" }, "description": "Optional. The list of targeted open measurement types. If empty, inventory will be targeted regardless of Open Measurement support." }, "videoTargeting": { "description": "Optional. Video specific targeting criteria.", "$ref": "PackageVideoTargeting" }, "placementTargeting": { "$ref": "PackagePlacementTargeting", "description": "Optional. Placement targeting information, for example, URL, mobile applications." }, "geoTargeting": { "$ref": "CriteriaTargeting", "description": "Optional. The geo criteria IDs to be included or excluded as defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv. If unset, inventory will be targeted regardless of geo." }, "includedDeviceTypes": { "type": "array", "items": { "type": "string", "enumDescriptions": [ "Default value. Should not be used in targeting specifications.", "Targets desktop or laptop computers.", "Targets connected TVs: devices that stream TV content, including smart TVs, gaming consoles, and streaming boxes/sticks.", "Targets high-end mobile devices.", "Targets tablet devices." ], "enum": [ "DEVICE_TYPE_UNSPECIFIED", "DEVICE_TYPE_PERSONAL_COMPUTER", "DEVICE_TYPE_CONNECTED_TV", "DEVICE_TYPE_PHONE", "DEVICE_TYPE_TABLET" ] }, "description": "Optional. The list of included device types to target. If empty, all device types are targeted." }, "verticalTargeting": { "$ref": "CriteriaTargeting", "description": "Optional. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals. If unset, inventory will be targeted regardless of vertical." } }, "id": "PackageTargeting", "type": "object" }, "VideoPlcmtTargeting": { "id": "VideoPlcmtTargeting", "type": "object", "description": "Defines targeting criteria based on the video placement type, often corresponding to the IAB OpenRTB 'plcmt' field.", "properties": { "videoPlcmtTypes": { "items": { "type": "string", "enumDescriptions": [ "Default value. Should not be used in targeting specifications.", "Pre-roll, mid-roll, and post-roll ads that are played before, during or after the streaming video content that the consumer has requested. Instream video must be set to “sound on” by default at player start, or have explicitly clear user intent to watch the video content. While there may be other content surrounding the player, the video content must be the focus of the user’s visit. It should remain the primary content on the page and the only video player in-view capable of audio when playing. If the player converts to floating/sticky, subsequent ad calls should accurately convey the updated player size.", "Pre-roll, mid-roll, and post-roll ads that are played before, during, or after streaming video content. The video player loads and plays before, between, or after paragraphs of text or graphical content, and starts playing only when it enters the viewport. Accompanying content should only start playback upon entering the viewport. It may convert to a floating/sticky player as it scrolls off the page.", "Video ads that are played without video content. During playback, it must be the primary focus of the page and take up the majority of the viewport and cannot be scrolled out of view. This can be in placements like in-app video or slideshows.", "Video ads that are played without streaming video content. This can be in placements like slideshows, native feeds, in-content or sticky/floating." ], "enum": [ "VIDEO_PLCMT_TYPE_UNSPECIFIED", "INSTREAM", "ACCOMPANYING_CONTENT", "INTERSTITIAL", "NO_CONTENT" ] }, "type": "array", "description": "Required. The list of targeted video plcmts types. If empty, inventory will be targeted regardless of video plcmt type." }, "selectionType": { "type": "string", "description": "Required. The selection type for the list of video plcmts.", "enumDescriptions": [ "Unspecified selection type. Should not be used.", "The values in the targeting dimension are included.", "The values in the targeting dimension are excluded." ], "enum": [ "SELECTION_TYPE_UNSPECIFIED", "SELECTION_TYPE_INCLUDE", "SELECTION_TYPE_EXCLUDE" ] } } }, "PrivateAuctionTerms": { "description": "Pricing terms for Private Auctions.", "properties": { "floorPrice": { "description": "The minimum price buyer has to bid to compete in the private auction.", "$ref": "Price" }, "openAuctionAllowed": { "type": "boolean", "description": "Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.", "readOnly": true } }, "id": "PrivateAuctionTerms", "type": "object" }, "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": { "excludedUris": { "description": "A list of URLs to be excluded.", "type": "array", "items": { "type": "string" } }, "targetedUris": { "description": "A list of URLs to be included.", "type": "array", "items": { "type": "string" } } }, "id": "UriTargeting", "type": "object" }, "PackagePlacementTargeting": { "id": "PackagePlacementTargeting", "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": { "mobileAppTargeting": { "$ref": "StringTargetingDimension", "description": "Optional. The list of targeted or excluded mobile application IDs that publishers own. Currently, only Android and Apple apps are supported. 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." }, "includedMobileAppCategoryTargeting": { "description": "Optional. The list of targeted mobile app categories.", "type": "array", "items": { "type": "string", "format": "int64" } }, "uriTargeting": { "description": "Optional. The list of targeted or excluded URLs. The domains should have the http/https stripped (for example, google.com), and can contain a max of 5 paths per url.", "$ref": "StringTargetingDimension" } } }, "ResumeFinalizedDealRequest": { "description": "Request message for resuming a finalized deal.", "properties": {}, "id": "ResumeFinalizedDealRequest", "type": "object" }, "ActivateDataSegmentRequest": { "id": "ActivateDataSegmentRequest", "type": "object", "description": "Request message for activating a data segment", "properties": {} }, "ActivateClientRequest": { "description": "Request message for activating a client.", "properties": {}, "id": "ActivateClientRequest", "type": "object" }, "ListFinalizedDealsResponse": { "description": "Response message for listing finalized deals.", "properties": { "finalizedDeals": { "description": "The list of finalized deals.", "items": { "$ref": "FinalizedDeal" }, "type": "array" }, "nextPageToken": { "description": "Token to fetch the next page of results.", "type": "string" } }, "id": "ListFinalizedDealsResponse", "type": "object" }, "ListClientsResponse": { "description": "Response message for the list method.", "properties": { "clients": { "description": "The returned list of clients.", "items": { "$ref": "Client" }, "type": "array" }, "nextPageToken": { "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.", "type": "string" } }, "id": "ListClientsResponse", "type": "object" }, "ListMediaPlannersResponse": { "description": "A response containing media planner account information.", "properties": { "mediaPlanners": { "type": "array", "items": { "$ref": "MediaPlanner" }, "description": "List of media planners." }, "nextPageToken": { "description": "A token which can be passed to a subsequent call to the `ListMediaPlanners` method to retrieve the next page of results in ListMediaPlannersRequest.pageToken.", "type": "string" } }, "id": "ListMediaPlannersResponse", "type": "object" }, "AccessControlSettings": { "description": "Settings for controlling access to a curated package.", "properties": { "allowlistedMediaPlanners": { "type": "array", "items": { "type": "string" }, "description": "Required. Immutable. The list of media planners that are explicitly granted access to the curated package. Eligible media planners can be found in the mediaPlanners.list method. Only a single media planner may be allowlisted at this time. Format: `mediaPlanners/{mediaPlannerAccountId}`" } }, "id": "AccessControlSettings", "type": "object" }, "MobileApplicationTargeting": { "id": "MobileApplicationTargeting", "type": "object", "description": "Mobile application targeting settings.", "properties": { "firstPartyTargeting": { "$ref": "FirstPartyMobileApplicationTargeting", "description": "Publisher owned apps to be targeted or excluded by the publisher to display the ads in." } } }, "FinalizedDeal": { "id": "FinalizedDeal", "type": "object", "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": { "deal": { "$ref": "Deal", "description": "A copy of the Deal made upon finalization. During renegotiation, this will reflect the last finalized deal before renegotiation was initiated." }, "dealServingStatus": { "type": "string", "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." ], "enum": [ "DEAL_SERVING_STATUS_UNSPECIFIED", "ACTIVE", "ENDED", "PAUSED_BY_BUYER", "PAUSED_BY_SELLER" ] }, "name": { "type": "string", "description": "The resource name of the finalized deal. Format: `buyers/{accountId}/finalizedDeals/{finalizedDealId}`" }, "dealPausingInfo": { "$ref": "DealPausingInfo", "description": "Information related to deal pausing for the deal." }, "readyToServe": { "type": "boolean", "description": "Whether the Programmatic Guaranteed deal is ready for serving." }, "rtbMetrics": { "description": "Real-time bidding metrics for this deal.", "$ref": "RtbMetrics" } } }, "ClientUser": { "id": "ClientUser", "type": "object", "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": { "name": { "type": "string", "description": "Output only. The resource name of the client user. Format: `buyers/{accountId}/clients/{clientAccountId}/users/{userId}`", "readOnly": true }, "state": { "enum": [ "STATE_UNSPECIFIED", "INVITED", "ACTIVE", "INACTIVE" ], "description": "Output only. The state of the client user.", "readOnly": true, "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." ], "type": "string" }, "email": { "description": "Required. The client user's email address that has to be unique across all users for the same client.", "type": "string" } } }, "ActivateClientUserRequest": { "description": "Request message for activating a client user.", "properties": {}, "id": "ActivateClientUserRequest", "type": "object" }, "UpdateDealRequest": { "id": "UpdateDealRequest", "type": "object", "description": "Request message for updating the deal at the given revision number.", "properties": { "deal": { "$ref": "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}" }, "updateMask": { "type": "string", "format": "google-fieldmask", "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." } } }, "ProgrammaticGuaranteedTerms": { "description": "Pricing terms for Programmatic Guaranteed Deals.", "properties": { "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." ], "enum": [ "RESERVATION_TYPE_UNSPECIFIED", "STANDARD", "SPONSORSHIP" ], "type": "string" }, "impressionCap": { "description": "The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.", "type": "string", "format": "int64" }, "fixedPrice": { "$ref": "Price", "description": "Fixed price for the deal." }, "guaranteedLooks": { "type": "string", "format": "int64", "description": "Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored." }, "percentShareOfVoice": { "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", "format": "int64" }, "minimumDailyLooks": { "type": "string", "format": "int64", "description": "Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks." } }, "id": "ProgrammaticGuaranteedTerms", "type": "object" }, "PreferredDealTerms": { "id": "PreferredDealTerms", "type": "object", "description": "Pricing terms for Preferred Deals.", "properties": { "fixedPrice": { "$ref": "Price", "description": "Fixed price for the deal." } } }, "UnsubscribeAuctionPackageRequest": { "description": "Request message for UnsubscribeAuctionPackage.", "properties": {}, "id": "UnsubscribeAuctionPackageRequest", "type": "object" }, "StringTargetingDimension": { "id": "StringTargetingDimension", "type": "object", "description": "Generic targeting with string values.", "properties": { "selectionType": { "enumDescriptions": [ "Unspecified selection type. Should not be used.", "The values in the targeting dimension are included.", "The values in the targeting dimension are excluded." ], "enum": [ "SELECTION_TYPE_UNSPECIFIED", "SELECTION_TYPE_INCLUDE", "SELECTION_TYPE_EXCLUDE" ], "description": "Required. How the items in this list should be targeted.", "type": "string" }, "values": { "description": "Required. The values specified.", "type": "array", "items": { "type": "string" } } } }, "DeliveryControl": { "description": "Message contains details about how the deal will be paced.", "properties": { "companionDeliveryType": { "enum": [ "COMPANION_DELIVERY_TYPE_UNSPECIFIED", "DELIVERY_OPTIONAL", "DELIVERY_AT_LEAST_ONE", "DELIVERY_ALL" ], "type": "string", "description": "Output only. Specifies roadblocking in a main companion lineitem.", "readOnly": true, "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." ] }, "roadblockingType": { "type": "string", "description": "Output only. Specifies the roadblocking type in display creatives.", "readOnly": true, "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" ] }, "deliveryRateType": { "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." ], "description": "Output only. Specifies how the impression delivery will be paced.", "readOnly": true, "type": "string", "enum": [ "DELIVERY_RATE_TYPE_UNSPECIFIED", "EVENLY", "FRONT_LOADED", "AS_FAST_AS_POSSIBLE" ] }, "frequencyCap": { "items": { "$ref": "FrequencyCap" }, "type": "array", "description": "Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.", "readOnly": true }, "creativeRotationType": { "enum": [ "CREATIVE_ROTATION_TYPE_UNSPECIFIED", "ROTATION_EVEN", "ROTATION_OPTIMIZED", "ROTATION_MANUAL", "ROTATION_SEQUENTIAL" ], "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." ], "description": "Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.", "readOnly": true, "type": "string" } }, "id": "DeliveryControl", "type": "object" }, "DayPart": { "id": "DayPart", "type": "object", "description": "Defines targeting for a period of time on a specific week day.", "properties": { "dayOfWeek": { "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" ], "type": "string" }, "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" }, "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" } } }, "ListCuratedPackagesResponse": { "id": "ListCuratedPackagesResponse", "type": "object", "description": "Response message for ListCuratedPackages.", "properties": { "curatedPackages": { "items": { "$ref": "CuratedPackage" }, "type": "array", "description": "The list of curated packages." }, "nextPageToken": { "type": "string", "description": "A token to retrieve the next page of results. Pass this value in the ListCuratedPackagesRequest.pageToken field in the subsequent call to `ListCuratedPackages` method to retrieve the next page of results. If empty, then there are no more results." } } }, "TechnologyTargeting": { "description": "Represents targeting about various types of technology.", "properties": { "deviceCategoryTargeting": { "$ref": "CriteriaTargeting", "description": "IDs of device categories to be included/excluded." }, "deviceCapabilityTargeting": { "$ref": "CriteriaTargeting", "description": "IDs of device capabilities to be included/excluded." }, "operatingSystemTargeting": { "$ref": "OperatingSystemTargeting", "description": "Operating system related targeting information." } }, "id": "TechnologyTargeting", "type": "object" }, "DayPartTargeting": { "description": "Represents Daypart targeting.", "properties": { "timeZoneType": { "enumDescriptions": [ "Default value. This field is unused.", "The publisher's time zone", "The user's time zone" ], "enum": [ "TIME_ZONE_TYPE_UNSPECIFIED", "SELLER", "USER" ], "description": "The time zone type of the day parts", "type": "string" }, "dayParts": { "type": "array", "items": { "$ref": "DayPart" }, "description": "The targeted weekdays and times" } }, "id": "DayPartTargeting", "type": "object" }, "DeactivateClientRequest": { "id": "DeactivateClientRequest", "type": "object", "description": "Request message for disabling a client.", "properties": {} }, "DeactivateCuratedPackageRequest": { "description": "Request message for DeactivateCuratedPackage.", "properties": {}, "id": "DeactivateCuratedPackageRequest", "type": "object" }, "DealPausingInfo": { "description": "Information related to deal pausing.", "properties": { "pausingConsented": { "description": "Whether pausing is consented between buyer and seller for the deal.", "type": "boolean" }, "pauseRole": { "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" ], "description": "The party that first paused the deal; unspecified for active deals.", "type": "string" }, "pauseReason": { "type": "string", "description": "The reason for the pausing of the deal; empty for active deals." } }, "id": "DealPausingInfo", "type": "object" }, "UnsubscribeClientsRequest": { "id": "UnsubscribeClientsRequest", "type": "object", "description": "Request message for UnsubscribeAuctionPackage.", "properties": { "clients": { "type": "array", "items": { "type": "string" }, "description": "Optional. A list of client buyers to unsubscribe from the auction package, with client buyer in the format `buyers/{accountId}/clients/{clientAccountId}`." } } }, "FrequencyCap": { "description": "Message contains details about publisher-set frequency caps of the delivery.", "properties": { "maxImpressions": { "description": "The maximum number of impressions that can be served to a user within the specified time period.", "type": "integer", "format": "int32" }, "timeUnitType": { "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." ], "enum": [ "TIME_UNIT_TYPE_UNSPECIFIED", "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "LIFETIME", "POD", "STREAM" ], "description": "The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.", "type": "string" }, "timeUnitsCount": { "type": "integer", "format": "int32", "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." } }, "id": "FrequencyCap", "type": "object" }, "AuctionPackage": { "description": "Defines a segment of inventory that buyer wants to buy. It's created by buyer and could be shared with multiple buyers.", "properties": { "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. Time the auction package was created.", "readOnly": true }, "subscribedMediaPlanners": { "type": "array", "items": { "$ref": "MediaPlanner" }, "description": "Output only. The list of media planners that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder.", "readOnly": true }, "name": { "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.", "type": "string" }, "creator": { "type": "string", "description": "Output only. The buyer that created this auction package. Format: `buyers/{buyerAccountId}`", "readOnly": true }, "eligibleSeatIds": { "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.", "readOnly": true, "type": "array", "items": { "type": "string" } }, "displayName": { "type": "string", "description": "The display_name assigned to the auction package." }, "description": { "description": "Output only. A description of the auction package.", "readOnly": true, "type": "string" }, "subscribedBuyers": { "items": { "type": "string" }, "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}`", "readOnly": true }, "updateTime": { "type": "string", "format": "google-datetime", "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.", "readOnly": true }, "floorPriceCpm": { "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.", "readOnly": true, "$ref": "Money" }, "subscribedClients": { "type": "array", "items": { "type": "string" }, "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}`", "readOnly": true }, "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.", "readOnly": true, "type": "string" } }, "id": "AuctionPackage", "type": "object" }, "FirstPartyMobileApplicationTargeting": { "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": { "excludedAppIds": { "type": "array", "items": { "type": "string" }, "description": "A list of application IDs to be excluded." }, "targetedAppIds": { "description": "A list of application IDs to be included.", "type": "array", "items": { "type": "string" } } }, "id": "FirstPartyMobileApplicationTargeting", "type": "object" }, "VideoTargeting": { "id": "VideoTargeting", "type": "object", "description": "Represents targeting information about video.", "properties": { "targetedPositionTypes": { "items": { "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." ], "enum": [ "POSITION_TYPE_UNSPECIFIED", "PREROLL", "MIDROLL", "POSTROLL" ], "type": "string" }, "type": "array", "description": "A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty." }, "excludedPositionTypes": { "description": "A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.", "type": "array", "items": { "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." ], "enum": [ "POSITION_TYPE_UNSPECIFIED", "PREROLL", "MIDROLL", "POSTROLL" ], "type": "string" } } } }, "DataSegment": { "description": "Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms. -- Next ID: 9 --", "properties": { "updateTime": { "type": "string", "format": "google-datetime", "description": "Output only. Time the data segment was last updated.", "readOnly": true }, "state": { "type": "string", "description": "Output only. The state of the data segment.", "readOnly": true, "enumDescriptions": [ "Default value.", "The data segment is active.", "The data segment is inactive.", "The data segment is suspended and cannot be activated." ], "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "INACTIVE", "SUSPENDED" ] }, "name": { "type": "string", "description": "Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. v1alpha format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}` v1beta format: `curators/{curatorAccountId}/dataSegments/{curatorDataSegmentId}`" }, "createTime": { "description": "Output only. Time the data segment was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "cpmFee": { "$ref": "Money", "description": "Optional. A fixed fee charged per thousand impressions. Once set, the currency code cannot be changed." }, "millipercentOfMediaFee": { "type": "string", "format": "int64", "description": "Optional. The fee will be charged as a percentage of the impression cost, represented in millipercent. For example, 1% is represented as 1000." } }, "id": "DataSegment", "type": "object" }, "CreativeRequirements": { "description": "Message captures data about the creatives in the deal.", "properties": { "skippableAdType": { "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." ], "description": "Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.", "readOnly": true, "type": "string", "enum": [ "SKIPPABLE_AD_TYPE_UNSPECIFIED", "SKIPPABLE", "INSTREAM_SELECT", "NOT_SKIPPABLE", "ANY" ] }, "programmaticCreativeSource": { "type": "string", "enumDescriptions": [ "A placeholder for an undefined programmatic creative source.", "The advertiser provides the creatives.", "The publisher provides the creatives to be served." ], "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.", "readOnly": true, "enum": [ "PROGRAMMATIC_CREATIVE_SOURCE_UNSPECIFIED", "ADVERTISER", "PUBLISHER" ] }, "maxAdDurationMs": { "type": "string", "format": "int64", "description": "Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.", "readOnly": true }, "creativeSafeFrameCompatibility": { "enum": [ "CREATIVE_SAFE_FRAME_COMPATIBILITY_UNSPECIFIED", "COMPATIBLE", "INCOMPATIBLE" ], "description": "Output only. Specifies whether the creative is safeFrame compatible.", "readOnly": true, "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." ], "type": "string" }, "creativePreApprovalPolicy": { "enum": [ "CREATIVE_PRE_APPROVAL_POLICY_UNSPECIFIED", "SELLER_PRE_APPROVAL_REQUIRED", "SELLER_PRE_APPROVAL_NOT_REQUIRED" ], "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." ], "description": "Output only. Specifies the creative pre-approval policy.", "readOnly": true, "type": "string" }, "creativeFormat": { "enum": [ "CREATIVE_FORMAT_UNSPECIFIED", "DISPLAY", "VIDEO", "AUDIO" ], "description": "Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.", "readOnly": true, "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" } }, "id": "CreativeRequirements", "type": "object" }, "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": { "bidRequests7Days": { "description": "Bid requests in last 7 days.", "type": "string", "format": "int64" }, "bidRate7Days": { "description": "Bid rate in last 7 days, calculated by (bids / bid requests).", "type": "number", "format": "double" }, "adImpressions7Days": { "type": "string", "format": "int64", "description": "Ad impressions in last 7 days." }, "filteredBidRate7Days": { "description": "Filtered bid rate in last 7 days, calculated by (filtered bids / bids).", "type": "number", "format": "double" }, "mustBidRateCurrentMonth": { "description": "Must bid rate for current month.", "type": "number", "format": "double" }, "bids7Days": { "type": "string", "format": "int64", "description": "Bids in last 7 days." } }, "id": "RtbMetrics", "type": "object" }, "PublisherProfileMobileApplication": { "description": "A mobile application that contains a external app ID, name, and app store.", "properties": { "name": { "description": "The name of the app.", "type": "string" }, "appStore": { "type": "string", "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" ], "enum": [ "APP_STORE_TYPE_UNSPECIFIED", "APPLE_ITUNES", "GOOGLE_PLAY", "ROKU", "AMAZON_FIRE_TV", "PLAYSTATION", "XBOX", "SAMSUNG_TV", "AMAZON", "OPPO", "SAMSUNG", "VIVO", "XIAOMI", "LG_TV" ], "description": "The app store the app belongs to. Can be used to filter the response of the publisherProfiles.list method." }, "externalAppId": { "description": "The external ID for the app from its app store. Can be used to filter the response of the publisherProfiles.list method.", "type": "string" } }, "id": "PublisherProfileMobileApplication", "type": "object" }, "CriteriaTargeting": { "id": "CriteriaTargeting", "type": "object", "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": { "targetedCriteriaIds": { "description": "A list of numeric IDs to be included.", "items": { "type": "string", "format": "int64" }, "type": "array" }, "excludedCriteriaIds": { "items": { "type": "string", "format": "int64" }, "type": "array", "description": "A list of numeric IDs to be excluded." } } }, "BatchUpdateDealsRequest": { "description": "Request message for batch updating deals.", "properties": { "requests": { "description": "Required. List of request messages to update deals.", "type": "array", "items": { "$ref": "UpdateDealRequest" } } }, "id": "BatchUpdateDealsRequest", "type": "object" }, "InventorySizeTargeting": { "id": "InventorySizeTargeting", "type": "object", "description": "Represents the size of an ad unit that can be targeted on a bid request.", "properties": { "excludedInventorySizes": { "items": { "$ref": "AdSize" }, "type": "array", "description": "A list of inventory sizes to be excluded." }, "targetedInventorySizes": { "type": "array", "items": { "$ref": "AdSize" }, "description": "A list of inventory sizes to be included." } } }, "ListDataSegmentsResponse": { "id": "ListDataSegmentsResponse", "type": "object", "description": "Response message for listing data segments.", "properties": { "dataSegments": { "description": "The list of data segments.", "type": "array", "items": { "$ref": "DataSegment" } }, "nextPageToken": { "type": "string", "description": "Continuation token for fetching the next page of results. Pass this value in the ListDataSegmentsRequest.pageToken field in the subsequent call to the `ListDataSegments` method to retrieve the next page of results." } } }, "TimeOfDay": { "id": "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": { "type": "integer", "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." }, "hours": { "type": "integer", "format": "int32", "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." }, "minutes": { "description": "Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.", "type": "integer", "format": "int32" }, "nanos": { "description": "Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.", "type": "integer", "format": "int32" } } }, "Money": { "description": "Represents an amount of money with its currency type.", "properties": { "nanos": { "type": "integer", "format": "int32", "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." }, "currencyCode": { "description": "The three-letter currency code defined in ISO 4217.", "type": "string" }, "units": { "type": "string", "format": "int64", "description": "The whole units of the amount. For example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar." } }, "id": "Money", "type": "object" }, "SendRfpRequest": { "id": "SendRfpRequest", "type": "object", "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": { "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" }, "flightEndTime": { "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", "format": "google-datetime" }, "displayName": { "description": "Required. The display name of the proposal being created by this RFP.", "type": "string" }, "preferredDealTerms": { "description": "The terms for preferred deals.", "$ref": "PreferredDealTerms" }, "publisherProfile": { "description": "Required. The profile of the publisher who will receive this RFP in the format: `buyers/{accountId}/publisherProfiles/{publisherProfileId}`.", "type": "string" }, "note": { "type": "string", "description": "A message that is sent to the publisher. Maximum length is 1024 characters." }, "programmaticGuaranteedTerms": { "$ref": "ProgrammaticGuaranteedTerms", "description": "The terms for programmatic guaranteed deals." }, "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" }, "client": { "type": "string", "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}`." }, "buyerContacts": { "type": "array", "items": { "$ref": "Contact" }, "description": "Contact information for the buyer." }, "inventorySizeTargeting": { "description": "Inventory sizes to be targeted. Only PIXEL inventory size type is supported.", "$ref": "InventorySizeTargeting" }, "geoTargeting": { "$ref": "CriteriaTargeting", "description": "Geo criteria IDs to be targeted. Refer to Geo tables." } } }, "AdSize": { "description": "Represents size of a single ad slot, or a creative.", "properties": { "height": { "description": "The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.", "type": "string", "format": "int64" }, "type": { "type": "string", "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." ], "enum": [ "TYPE_UNSPECIFIED", "PIXEL", "INTERSTITIAL", "NATIVE", "FLUID" ], "description": "The type of the ad slot size." }, "width": { "description": "The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.", "type": "string", "format": "int64" } }, "id": "AdSize", "type": "object" }, "PackagePublisherProvidedSignalsTargeting": { "id": "PackagePublisherProvidedSignalsTargeting", "type": "object", "description": "Represents targeting about publisher provided signals. Different publisher provided signals types will be logically OR'ed.", "properties": { "videoAndAudioSignalsTargeting": { "description": "Optional. The list of targeted and excluded video and audio signals IDs. These are additional signals supported by publisher provided signals.", "$ref": "StringTargetingDimension" }, "contentTargeting": { "$ref": "TaxonomyTargeting", "description": "Optional. The list of targeted or excluded content IDs. Based off of IAB Content Taxonomy version 2.2 (https://github.com/InteractiveAdvertisingBureau/Taxonomies/blob/main/Content%20Taxonomies/Content%20Taxonomy%202.2.tsv)" }, "audienceTargeting": { "description": "Optional. The list of targeted or excluded audience IDs. Based off of IAB Audience Taxonomy version 1.1 (https://github.com/InteractiveAdvertisingBureau/Taxonomies/blob/main/Audience%20Taxonomies/Audience%20Taxonomy%201.1.tsv)", "$ref": "TaxonomyTargeting" } } }, "Contact": { "id": "Contact", "type": "object", "description": "Contains information on how a buyer or seller can be reached.", "properties": { "email": { "description": "Email address for the contact.", "type": "string" }, "displayName": { "description": "The display_name of the contact.", "type": "string" } } }, "CancelNegotiationRequest": { "id": "CancelNegotiationRequest", "type": "object", "description": "Request to cancel an ongoing negotiation.", "properties": {} }, "Client": { "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": { "type": "string", "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." }, "name": { "type": "string", "description": "Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`", "readOnly": true }, "state": { "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "INACTIVE" ], "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." ], "description": "Output only. The state of the client.", "readOnly": true, "type": "string" }, "role": { "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." ], "enum": [ "CLIENT_ROLE_UNSPECIFIED", "CLIENT_DEAL_VIEWER", "CLIENT_DEAL_NEGOTIATOR", "CLIENT_DEAL_APPROVER" ], "type": "string" }, "sellerVisible": { "description": "Whether the client will be visible to sellers.", "type": "boolean" }, "displayName": { "type": "string", "description": "Required. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed." } }, "id": "Client", "type": "object" }, "SetReadyToServeRequest": { "description": "Request message for setting ready to serve for a finalized deal.", "properties": {}, "id": "SetReadyToServeRequest", "type": "object" }, "PrivateData": { "id": "PrivateData", "type": "object", "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)." } } }, "VideoPlayerSizeTargeting": { "id": "VideoPlayerSizeTargeting", "type": "object", "description": "Represents the size of the video player that can be targeted. Both width and height are required to be set to non-zero values.", "properties": { "minimumWidth": { "type": "string", "format": "int64", "description": "Required. The minimum width of the video player in pixels." }, "minimumHeight": { "description": "Required. The minimum height of the video player in pixels.", "type": "string", "format": "int64" } } }, "DeactivateDataSegmentRequest": { "description": "Request message for deactivating a data segment", "properties": {}, "id": "DeactivateDataSegmentRequest", "type": "object" }, "Proposal": { "description": "Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer.", "properties": { "state": { "enum": [ "STATE_UNSPECIFIED", "BUYER_REVIEW_REQUESTED", "SELLER_REVIEW_REQUESTED", "BUYER_ACCEPTANCE_REQUESTED", "FINALIZED", "TERMINATED" ], "type": "string", "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" ], "description": "Output only. Indicates the state of the proposal.", "readOnly": true }, "updateTime": { "description": "Output only. The time when the proposal was last revised.", "readOnly": true, "type": "string", "format": "google-datetime" }, "pausingConsented": { "description": "Whether pausing is allowed for the proposal. This is a negotiable term between buyers and publishers.", "type": "boolean" }, "notes": { "type": "array", "items": { "$ref": "Note" }, "description": "A list of notes from the buyer and the seller attached to this proposal." }, "billedBuyer": { "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}`", "readOnly": true }, "lastUpdaterOrCommentorRole": { "enum": [ "BUYER_SELLER_ROLE_UNSPECIFIED", "BUYER", "SELLER" ], "enumDescriptions": [ "A placeholder for an undefined buyer/seller role.", "Specifies the role as buyer.", "Specifies the role as seller." ], "description": "Output only. The role of the last user that either updated the proposal or left a comment.", "readOnly": true, "type": "string" }, "dealType": { "enum": [ "DEAL_TYPE_UNSPECIFIED", "PREFERRED_DEAL", "PRIVATE_AUCTION", "PROGRAMMATIC_GUARANTEED" ], "description": "Output only. Type of deal the proposal contains.", "readOnly": true, "enumDescriptions": [ "Default, unspecified deal type.", "Preferred deals.", "Private auction deals.", "Programmatic guaranteed deals." ], "type": "string" }, "publisherProfile": { "type": "string", "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." }, "displayName": { "type": "string", "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.", "readOnly": true }, "isRenegotiating": { "type": "boolean", "description": "Output only. True if the proposal was previously finalized and is now being renegotiated.", "readOnly": true }, "buyer": { "type": "string", "description": "Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}`", "readOnly": true }, "name": { "description": "Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId}", "type": "string" }, "proposalRevision": { "type": "string", "format": "int64", "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.", "readOnly": true }, "client": { "type": "string", "description": "Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`", "readOnly": true }, "buyerPrivateData": { "$ref": "PrivateData", "description": "Buyer private data (hidden from seller)." }, "sellerContacts": { "items": { "$ref": "Contact" }, "type": "array", "description": "Output only. Contact information for the seller.", "readOnly": true }, "buyerContacts": { "type": "array", "items": { "$ref": "Contact" }, "description": "Contact information for the buyer." }, "termsAndConditions": { "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, "type": "string" }, "originatorRole": { "enum": [ "BUYER_SELLER_ROLE_UNSPECIFIED", "BUYER", "SELLER" ], "type": "string", "description": "Output only. Indicates whether the buyer/seller created the proposal.", "readOnly": true, "enumDescriptions": [ "A placeholder for an undefined buyer/seller role.", "Specifies the role as buyer.", "Specifies the role as seller." ] } }, "id": "Proposal", "type": "object" }, "PackageVideoTargeting": { "id": "PackageVideoTargeting", "type": "object", "description": "Video specific targeting criteria.", "properties": { "includedContentDeliveryMethod": { "type": "string", "description": "Optional. The targeted video delivery method. If unset, inventory will be targeted regardless of video delivery method.", "enumDescriptions": [ "Default value. Should not be used in targeting specifications.", "Targets video content that is being broadcast live.", "Targets video content that is transferred incrementally as client's playback requires." ], "enum": [ "CONTENT_DELIVERY_METHOD_UNSPECIFIED", "CONTENT_DELIVERY_METHOD_STREAMING", "CONTENT_DELIVERY_METHOD_PROGRESSIVE" ] }, "minimumPredictedCompletionRatePercentage": { "type": "string", "format": "int64", "description": "Optional. The targeted minimum predicted completion rate percentage. This value must be a multiple of 10 between 10 and 90 (inclusive). For example, 10 is valid, but 0, 15, and 100 are not. A value of 10 means that the configuration will only match adslots for which we predict at least 10% completion rate. An unset value indicates inventory will be targeted regardless of predicted completion rate." }, "includedPlaybackMethods": { "description": "Optional. The list of targeted video playback methods. If empty, inventory will be targeted regardless of video playback method.", "type": "array", "items": { "type": "string", "enumDescriptions": [ "Unspecified video playback method. Should not be used.", "Playback starts automatically when the page/content loads.", "Playback starts automatically when the page/content loads, but with sound off.", "Playback is initiated by a user action (e.g., clicking a play button)." ], "enum": [ "PLAYBACK_METHOD_UNSPECIFIED", "PLAYBACK_METHOD_AUTO_PLAY_SOUND_ON", "PLAYBACK_METHOD_AUTO_PLAY_SOUND_OFF", "PLAYBACK_METHOD_CLICK_TO_PLAY" ] } }, "includedMaximumAdDurationTargeting": { "type": "string", "enumDescriptions": [ "Default value. Should not be used in targeting specifications.", "Applies to video ads with a duration up to 15 seconds (0 \u003c duration \u003c= 15s).", "Applies to video ads with a duration up to 20 seconds (0 \u003c duration \u003c= 20s).", "Applies to video ads with a duration up to 30 seconds (0 \u003c duration \u003c= 30s).", "Applies to video ads with a duration up to 60 seconds (0 \u003c duration \u003c= 60s).", "Applies to video ads with a duration up to 90 seconds (0 \u003c duration \u003c= 90s).", "Applies to video ads with a duration up to 120 seconds (0 \u003c duration \u003c= 120s)." ], "enum": [ "MAXIMUM_VIDEO_AD_DURATION_UNSPECIFIED", "MAXIMUM_VIDEO_AD_DURATION_FIFTEEN_SECONDS", "MAXIMUM_VIDEO_AD_DURATION_TWENTY_SECONDS", "MAXIMUM_VIDEO_AD_DURATION_THIRTY_SECONDS", "MAXIMUM_VIDEO_AD_DURATION_SIXTY_SECONDS", "MAXIMUM_VIDEO_AD_DURATION_NINETY_SECONDS", "MAXIMUM_VIDEO_AD_DURATION_ONE_HUNDRED_TWENTY_SECONDS" ], "description": "Optional. The targeted maximum video ad duration. If unset, inventory will be targeted regardless of maximum video ad duration." }, "plcmtTargeting": { "$ref": "VideoPlcmtTargeting", "description": "Optional. The targeted video plcmt types. If unset, inventory will be targeted regardless of video plcmt type." }, "includedMimeTypes": { "description": "Optional. The list of targeted video mime types using the IANA published MIME type strings (https://www.iana.org/assignments/media-types/media-types.xhtml). If empty, inventory will be targeted regardless of video mime type.", "type": "array", "items": { "enumDescriptions": [ "Default value. Should not be used in targeting specifications.", "3GPP container format used on 3G phones.", "HLS/M3U8", "MPEG-4 container typically with H.264 codec.", "DASH.", "JavaScript (used for VPAID ads).", "WebM container assuming VP9 codec." ], "enum": [ "VIDEO_MIME_TYPE_UNSPECIFIED", "VIDEO_MIME_TYPE_THREEGPP", "VIDEO_MIME_TYPE_APPLICATION_MPEGURL", "VIDEO_MIME_TYPE_MP4", "VIDEO_MIME_TYPE_APPLICATION_MPEGDASH", "VIDEO_MIME_TYPE_APPLICATION_JAVASCRIPT", "VIDEO_MIME_TYPE_WEBM" ], "type": "string" } }, "includedPlayerSizeTargeting": { "description": "Optional. The targeted video player size. If unset, inventory will be targeted regardless of video player size.", "$ref": "VideoPlayerSizeTargeting" }, "includedPositionTypes": { "items": { "enumDescriptions": [ "Default value. Should not be used in targeting specifications.", "The ad is played in the middle of the video content.", "The ad is played after the video content.", "The ad is played before the video content." ], "enum": [ "POSITION_TYPE_UNSPECIFIED", "POSITION_TYPE_MIDROLL", "POSITION_TYPE_POSTROLL", "POSITION_TYPE_PREROLL" ], "type": "string" }, "type": "array", "description": "Optional. The targeted video ad position types. If empty, inventory will be targeted regardless of video ad position type." } } }, "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": { "buyerPermissionType": { "enum": [ "BUYER_PERMISSION_TYPE_UNSPECIFIED", "NEGOTIATOR_ONLY", "BIDDER" ], "type": "string", "description": "Output only. The buyer permission type of the deal.", "readOnly": true, "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." ] }, "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" }, "createTime": { "description": "Output only. The time of the deal creation.", "readOnly": true, "type": "string", "format": "google-datetime" }, "billedBuyer": { "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; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId}`", "readOnly": true }, "sellerTimeZone": { "$ref": "TimeZone", "description": "Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.", "readOnly": true }, "updateTime": { "description": "Output only. The time when the deal was last updated.", "readOnly": true, "type": "string", "format": "google-datetime" }, "mediaPlanner": { "$ref": "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).", "readOnly": true }, "flightEndTime": { "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.", "type": "string", "format": "google-datetime" }, "creativeRequirements": { "$ref": "CreativeRequirements", "description": "Output only. Metadata about the creatives of this deal.", "readOnly": true }, "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}", "type": "string" }, "proposalRevision": { "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.", "readOnly": true, "type": "string", "format": "int64" }, "eligibleSeatIds": { "items": { "type": "string" }, "type": "array", "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.", "readOnly": true }, "buyer": { "description": "Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId}`", "readOnly": true, "type": "string" }, "programmaticGuaranteedTerms": { "description": "The terms for programmatic guaranteed deals.", "$ref": "ProgrammaticGuaranteedTerms" }, "client": { "description": "Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`", "readOnly": true, "type": "string" }, "deliveryControl": { "description": "Output only. Specifies the pacing set by the publisher.", "readOnly": true, "$ref": "DeliveryControl" }, "targeting": { "description": "Specifies the subset of inventory targeted by the deal. Can be updated by the buyer before the deal is finalized.", "$ref": "MarketplaceTargeting" }, "flightStartTime": { "type": "string", "format": "google-datetime", "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." }, "dealType": { "enum": [ "DEAL_TYPE_UNSPECIFIED", "PREFERRED_DEAL", "PRIVATE_AUCTION", "PROGRAMMATIC_GUARANTEED" ], "type": "string", "enumDescriptions": [ "Default, unspecified deal type.", "Preferred deals.", "Private auction deals.", "Programmatic guaranteed deals." ], "description": "Output only. Type of deal.", "readOnly": true }, "privateAuctionTerms": { "$ref": "PrivateAuctionTerms", "description": "The terms for private auction deals." }, "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 }, "description": { "type": "string", "description": "Output only. Free text description for the deal terms.", "readOnly": true }, "preferredDealTerms": { "$ref": "PreferredDealTerms", "description": "The terms for preferred deals." }, "publisherProfile": { "type": "string", "description": "Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`" } } }, "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" } } } }, "parameters": { "callback": { "description": "JSONP", "location": "query", "type": "string" }, "$.xgafv": { "enum": [ "1", "2" ], "location": "query", "enumDescriptions": [ "v1 error format", "v2 error format" ], "description": "V1 error format.", "type": "string" }, "alt": { "enum": [ "json", "media", "proto" ], "location": "query", "type": "string", "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" ], "description": "Data format for response." }, "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" }, "prettyPrint": { "type": "boolean", "default": "true", "location": "query", "description": "Returns response with indentations and line breaks." }, "oauth_token": { "location": "query", "description": "OAuth 2.0 token for the current user.", "type": "string" }, "upload_protocol": { "location": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "type": "string" }, "key": { "location": "query", "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.", "type": "string" }, "uploadType": { "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query", "type": "string" }, "fields": { "description": "Selector specifying which fields to include in a partial response.", "location": "query", "type": "string" }, "access_token": { "type": "string", "description": "OAuth access token.", "location": "query" } }, "fullyEncodeReservedExpansion": true, "resources": { "mediaPlanners": { "methods": { "list": { "id": "authorizedbuyersmarketplace.mediaPlanners.list", "parameters": { "pageSize": { "type": "integer", "format": "int32", "description": "The maximum number of media planners to return. If unspecified, at most 100 media planners will be returned. The maximum value is 500; values above 500 will be coerced to 500.", "location": "query" }, "filter": { "type": "string", "description": "Optional query string using the [Cloud API list filtering syntax](/authorized-buyers/apis/guides/list-filters). Supported columns for filtering are: * `name` * `displayName` * `ancestorNames`", "location": "query" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return. This value is received from a previous `ListMediaPlanners` call in ListMediaPlannersResponse.nextPageToken.", "location": "query", "type": "string" } }, "response": { "$ref": "ListMediaPlannersResponse" }, "path": "v1alpha/mediaPlanners", "flatPath": "v1alpha/mediaPlanners", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "parameterOrder": [], "description": "Lists all media planner accounts that the caller has access to. For curators, this will return all media planners that have accepted curator terms. For other accounts, attempting to list media planners will return an error.", "httpMethod": "GET" } } }, "buyers": { "resources": { "auctionPackages": { "methods": { "unsubscribe": { "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "parameterOrder": [ "name" ], "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.", "httpMethod": "POST", "id": "authorizedbuyersmarketplace.buyers.auctionPackages.unsubscribe", "parameters": { "name": { "type": "string", "description": "Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}`", "required": true, "pattern": "^buyers/[^/]+/auctionPackages/[^/]+$", "location": "path" } }, "request": { "$ref": "UnsubscribeAuctionPackageRequest" }, "response": { "$ref": "AuctionPackage" }, "path": "v1alpha/{+name}:unsubscribe", "flatPath": "v1alpha/buyers/{buyersId}/auctionPackages/{auctionPackagesId}:unsubscribe" }, "list": { "parameters": { "parent": { "pattern": "^buyers/[^/]+$", "location": "path", "required": true, "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}`.", "type": "string" }, "pageToken": { "type": "string", "description": "The page token as returned. ListAuctionPackagesResponse.nextPageToken", "location": "query" }, "pageSize": { "type": "integer", "format": "int32", "description": "Requested page size. The server may return fewer results than requested. Max allowed page size is 500.", "location": "query" }, "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" }, "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" } }, "id": "authorizedbuyersmarketplace.buyers.auctionPackages.list", "path": "v1alpha/{+parent}/auctionPackages", "flatPath": "v1alpha/buyers/{buyersId}/auctionPackages", "response": { "$ref": "ListAuctionPackagesResponse" }, "parameterOrder": [ "parent" ], "description": "List the auction packages. Buyers can use the URL path \"/v1alpha/buyers/{accountId}/auctionPackages\" to list auction packages for the current buyer and its clients. Bidders can use the URL path \"/v1alpha/bidders/{accountId}/auctionPackages\" to list auction packages for the bidder, its media planners, its buyers, and all their clients.", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "httpMethod": "GET" }, "subscribe": { "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "parameterOrder": [ "name" ], "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.", "httpMethod": "POST", "id": "authorizedbuyersmarketplace.buyers.auctionPackages.subscribe", "parameters": { "name": { "type": "string", "description": "Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}`", "required": true, "pattern": "^buyers/[^/]+/auctionPackages/[^/]+$", "location": "path" } }, "request": { "$ref": "SubscribeAuctionPackageRequest" }, "response": { "$ref": "AuctionPackage" }, "path": "v1alpha/{+name}:subscribe", "flatPath": "v1alpha/buyers/{buyersId}/auctionPackages/{auctionPackagesId}:subscribe" }, "get": { "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "parameterOrder": [ "name" ], "description": "Gets an auction package given its name.", "httpMethod": "GET", "id": "authorizedbuyersmarketplace.buyers.auctionPackages.get", "parameters": { "name": { "pattern": "^buyers/[^/]+/auctionPackages/[^/]+$", "location": "path", "required": true, "description": "Required. Name of auction package to get. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}`", "type": "string" } }, "response": { "$ref": "AuctionPackage" }, "path": "v1alpha/{+name}", "flatPath": "v1alpha/buyers/{buyersId}/auctionPackages/{auctionPackagesId}" }, "unsubscribeClients": { "id": "authorizedbuyersmarketplace.buyers.auctionPackages.unsubscribeClients", "parameters": { "auctionPackage": { "pattern": "^buyers/[^/]+/auctionPackages/[^/]+$", "location": "path", "required": true, "description": "Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}`", "type": "string" } }, "request": { "$ref": "UnsubscribeClientsRequest" }, "response": { "$ref": "AuctionPackage" }, "path": "v1alpha/{+auctionPackage}:unsubscribeClients", "flatPath": "v1alpha/buyers/{buyersId}/auctionPackages/{auctionPackagesId}:unsubscribeClients", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "parameterOrder": [ "auctionPackage" ], "description": "Unsubscribe from the auction package for the specified clients of the buyer. Unsubscribing a client that is not subscribed will have no effect.", "httpMethod": "POST" }, "subscribeClients": { "httpMethod": "POST", "parameterOrder": [ "auctionPackage" ], "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.", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "path": "v1alpha/{+auctionPackage}:subscribeClients", "flatPath": "v1alpha/buyers/{buyersId}/auctionPackages/{auctionPackagesId}:subscribeClients", "request": { "$ref": "SubscribeClientsRequest" }, "response": { "$ref": "AuctionPackage" }, "parameters": { "auctionPackage": { "required": true, "pattern": "^buyers/[^/]+/auctionPackages/[^/]+$", "location": "path", "type": "string", "description": "Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}`" } }, "id": "authorizedbuyersmarketplace.buyers.auctionPackages.subscribeClients" } } }, "finalizedDeals": { "methods": { "get": { "httpMethod": "GET", "parameterOrder": [ "name" ], "description": "Gets a finalized deal given its name.", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "path": "v1alpha/{+name}", "flatPath": "v1alpha/buyers/{buyersId}/finalizedDeals/{finalizedDealsId}", "response": { "$ref": "FinalizedDeal" }, "parameters": { "name": { "description": "Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}`", "type": "string", "pattern": "^buyers/[^/]+/finalizedDeals/[^/]+$", "location": "path", "required": true } }, "id": "authorizedbuyersmarketplace.buyers.finalizedDeals.get" }, "resume": { "httpMethod": "POST", "parameterOrder": [ "name" ], "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.", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "path": "v1alpha/{+name}:resume", "flatPath": "v1alpha/buyers/{buyersId}/finalizedDeals/{finalizedDealsId}:resume", "request": { "$ref": "ResumeFinalizedDealRequest" }, "response": { "$ref": "FinalizedDeal" }, "parameters": { "name": { "pattern": "^buyers/[^/]+/finalizedDeals/[^/]+$", "location": "path", "required": true, "description": "Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}`", "type": "string" } }, "id": "authorizedbuyersmarketplace.buyers.finalizedDeals.resume" }, "pause": { "parameters": { "name": { "required": true, "pattern": "^buyers/[^/]+/finalizedDeals/[^/]+$", "location": "path", "type": "string", "description": "Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}`" } }, "id": "authorizedbuyersmarketplace.buyers.finalizedDeals.pause", "path": "v1alpha/{+name}:pause", "flatPath": "v1alpha/buyers/{buyersId}/finalizedDeals/{finalizedDealsId}:pause", "request": { "$ref": "PauseFinalizedDealRequest" }, "response": { "$ref": "FinalizedDeal" }, "parameterOrder": [ "name" ], "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.", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "httpMethod": "POST" }, "addCreative": { "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "parameterOrder": [ "deal" ], "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.", "httpMethod": "POST", "id": "authorizedbuyersmarketplace.buyers.finalizedDeals.addCreative", "parameters": { "deal": { "required": true, "pattern": "^buyers/[^/]+/finalizedDeals/[^/]+$", "location": "path", "type": "string", "description": "Required. Name of the finalized deal in the format of: `buyers/{accountId}/finalizedDeals/{dealId}`" } }, "request": { "$ref": "AddCreativeRequest" }, "response": { "$ref": "FinalizedDeal" }, "path": "v1alpha/{+deal}:addCreative", "flatPath": "v1alpha/buyers/{buyersId}/finalizedDeals/{finalizedDealsId}:addCreative" }, "list": { "parameters": { "parent": { "required": true, "pattern": "^buyers/[^/]+$", "location": "path", "type": "string", "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}`." }, "pageToken": { "type": "string", "location": "query", "description": "The page token as returned from ListFinalizedDealsResponse." }, "filter": { "type": "string", "location": "query", "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" }, "pageSize": { "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", "format": "int32" }, "orderBy": { "type": "string", "location": "query", "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" } }, "id": "authorizedbuyersmarketplace.buyers.finalizedDeals.list", "path": "v1alpha/{+parent}/finalizedDeals", "flatPath": "v1alpha/buyers/{buyersId}/finalizedDeals", "response": { "$ref": "ListFinalizedDealsResponse" }, "parameterOrder": [ "parent" ], "description": "Lists finalized deals. Use the URL path \"/v1alpha/buyers/{accountId}/finalizedDeals\" to list finalized deals for the current buyer and its clients. Bidders can use the URL path \"/v1alpha/bidders/{accountId}/finalizedDeals\" to list finalized deals for the bidder, its buyers and all their clients.", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "httpMethod": "GET" }, "setReadyToServe": { "parameterOrder": [ "deal" ], "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 \"/v1alpha/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.", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "httpMethod": "POST", "parameters": { "deal": { "required": true, "pattern": "^buyers/[^/]+/finalizedDeals/[^/]+$", "location": "path", "type": "string", "description": "Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}` or `bidders/{accountId}/finalizedDeals/{dealId}`" } }, "id": "authorizedbuyersmarketplace.buyers.finalizedDeals.setReadyToServe", "path": "v1alpha/{+deal}:setReadyToServe", "flatPath": "v1alpha/buyers/{buyersId}/finalizedDeals/{finalizedDealsId}:setReadyToServe", "request": { "$ref": "SetReadyToServeRequest" }, "response": { "$ref": "FinalizedDeal" } } } }, "proposals": { "methods": { "get": { "response": { "$ref": "Proposal" }, "path": "v1alpha/{+name}", "flatPath": "v1alpha/buyers/{buyersId}/proposals/{proposalsId}", "id": "authorizedbuyersmarketplace.buyers.proposals.get", "parameters": { "name": { "type": "string", "description": "Required. Name of the proposal. Format: `buyers/{accountId}/proposals/{proposalId}`", "required": true, "pattern": "^buyers/[^/]+/proposals/[^/]+$", "location": "path" } }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "parameterOrder": [ "name" ], "description": "Gets a proposal using its resource name. The proposal is returned at the latest revision." }, "patch": { "parameters": { "name": { "description": "Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId}", "type": "string", "pattern": "^buyers/[^/]+/proposals/[^/]+$", "location": "path", "required": true }, "updateMask": { "location": "query", "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": "string", "format": "google-fieldmask" } }, "id": "authorizedbuyersmarketplace.buyers.proposals.patch", "path": "v1alpha/{+name}", "flatPath": "v1alpha/buyers/{buyersId}/proposals/{proposalsId}", "request": { "$ref": "Proposal" }, "response": { "$ref": "Proposal" }, "parameterOrder": [ "name" ], "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.", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "httpMethod": "PATCH" }, "addNote": { "request": { "$ref": "AddNoteRequest" }, "response": { "$ref": "Proposal" }, "path": "v1alpha/{+proposal}:addNote", "flatPath": "v1alpha/buyers/{buyersId}/proposals/{proposalsId}:addNote", "id": "authorizedbuyersmarketplace.buyers.proposals.addNote", "parameters": { "proposal": { "required": true, "pattern": "^buyers/[^/]+/proposals/[^/]+$", "location": "path", "type": "string", "description": "Name of the proposal. Format: `buyers/{accountId}/proposals/{proposalId}`" } }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "parameterOrder": [ "proposal" ], "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'." }, "list": { "response": { "$ref": "ListProposalsResponse" }, "path": "v1alpha/{+parent}/proposals", "flatPath": "v1alpha/buyers/{buyersId}/proposals", "id": "authorizedbuyersmarketplace.buyers.proposals.list", "parameters": { "filter": { "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", "type": "string" }, "pageSize": { "type": "integer", "format": "int32", "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will put a size of 500.", "location": "query" }, "parent": { "description": "Required. Parent that owns the collection of proposals Format: `buyers/{accountId}`", "type": "string", "pattern": "^buyers/[^/]+$", "location": "path", "required": true }, "pageToken": { "location": "query", "description": "The page token as returned from ListProposalsResponse.", "type": "string" } }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "parameterOrder": [ "parent" ], "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." }, "cancelNegotiation": { "parameters": { "proposal": { "required": true, "pattern": "^buyers/[^/]+/proposals/[^/]+$", "location": "path", "type": "string", "description": "Name of the proposal. Format: `buyers/{accountId}/proposals/{proposalId}`" } }, "id": "authorizedbuyersmarketplace.buyers.proposals.cancelNegotiation", "path": "v1alpha/{+proposal}:cancelNegotiation", "flatPath": "v1alpha/buyers/{buyersId}/proposals/{proposalsId}:cancelNegotiation", "request": { "$ref": "CancelNegotiationRequest" }, "response": { "$ref": "Proposal" }, "parameterOrder": [ "proposal" ], "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'.", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "httpMethod": "POST" }, "accept": { "parameters": { "name": { "description": "Name of the proposal. Format: `buyers/{accountId}/proposals/{proposalId}`", "type": "string", "pattern": "^buyers/[^/]+/proposals/[^/]+$", "location": "path", "required": true } }, "id": "authorizedbuyersmarketplace.buyers.proposals.accept", "path": "v1alpha/{+name}:accept", "flatPath": "v1alpha/buyers/{buyersId}/proposals/{proposalsId}:accept", "request": { "$ref": "AcceptProposalRequest" }, "response": { "$ref": "Proposal" }, "parameterOrder": [ "name" ], "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.", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "httpMethod": "POST" }, "sendRfp": { "path": "v1alpha/{+buyer}/proposals:sendRfp", "flatPath": "v1alpha/buyers/{buyersId}/proposals:sendRfp", "request": { "$ref": "SendRfpRequest" }, "response": { "$ref": "Proposal" }, "parameters": { "buyer": { "description": "Required. The current buyer who is sending the RFP in the format: `buyers/{accountId}`.", "type": "string", "pattern": "^buyers/[^/]+$", "location": "path", "required": true } }, "id": "authorizedbuyersmarketplace.buyers.proposals.sendRfp", "httpMethod": "POST", "parameterOrder": [ "buyer" ], "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.", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ] } }, "resources": { "deals": { "methods": { "get": { "parameters": { "name": { "pattern": "^buyers/[^/]+/proposals/[^/]+/deals/[^/]+$", "location": "path", "required": true, "description": "Required. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}", "type": "string" } }, "id": "authorizedbuyersmarketplace.buyers.proposals.deals.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/buyers/{buyersId}/proposals/{proposalsId}/deals/{dealsId}", "response": { "$ref": "Deal" }, "parameterOrder": [ "name" ], "description": "Gets a deal given its name. The deal is returned at its head revision.", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "httpMethod": "GET" }, "patch": { "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "parameterOrder": [ "name" ], "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.", "request": { "$ref": "Deal" }, "response": { "$ref": "Deal" }, "path": "v1alpha/{+name}", "flatPath": "v1alpha/buyers/{buyersId}/proposals/{proposalsId}/deals/{dealsId}", "id": "authorizedbuyersmarketplace.buyers.proposals.deals.patch", "parameters": { "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}", "required": true, "pattern": "^buyers/[^/]+/proposals/[^/]+/deals/[^/]+$", "location": "path" }, "updateMask": { "type": "string", "format": "google-fieldmask", "location": "query", "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." } } }, "batchUpdate": { "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "parameterOrder": [ "parent" ], "description": "Batch updates multiple deals in the same proposal.", "httpMethod": "POST", "id": "authorizedbuyersmarketplace.buyers.proposals.deals.batchUpdate", "parameters": { "parent": { "type": "string", "description": "Required. The name of the proposal containing the deals to batch update. Format: buyers/{accountId}/proposals/{proposalId}", "required": true, "pattern": "^buyers/[^/]+/proposals/[^/]+$", "location": "path" } }, "request": { "$ref": "BatchUpdateDealsRequest" }, "response": { "$ref": "BatchUpdateDealsResponse" }, "path": "v1alpha/{+parent}/deals:batchUpdate", "flatPath": "v1alpha/buyers/{buyersId}/proposals/{proposalsId}/deals:batchUpdate" }, "list": { "parameterOrder": [ "parent" ], "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.", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "httpMethod": "GET", "parameters": { "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" }, "pageSize": { "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", "format": "int32" } }, "id": "authorizedbuyersmarketplace.buyers.proposals.deals.list", "path": "v1alpha/{+parent}/deals", "flatPath": "v1alpha/buyers/{buyersId}/proposals/{proposalsId}/deals", "response": { "$ref": "ListDealsResponse" } } } } } }, "dataSegments": { "methods": { "list": { "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "parameterOrder": [ "parent" ], "description": "List the data segments owned by a curator.", "response": { "$ref": "ListDataSegmentsResponse" }, "path": "v1alpha/{+parent}/dataSegments", "flatPath": "v1alpha/buyers/{buyersId}/dataSegments", "id": "authorizedbuyersmarketplace.buyers.dataSegments.list", "parameters": { "parent": { "required": true, "pattern": "^buyers/[^/]+$", "location": "path", "type": "string", "description": "Required. Name of the parent curator that can access the data segment. v1alpha format: `buyers/{accountId}` v1beta format: `curators/{accountId}`" }, "pageToken": { "description": "Optional. The page token as returned. ListDataSegmentsResponse.nextPageToken", "location": "query", "type": "string" }, "pageSize": { "type": "integer", "format": "int32", "description": "Optional. Requested page size. The server may return fewer results than requested. Max allowed page size is 500. If unspecified, the server will default to 500.", "location": "query" } } }, "activate": { "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "parameterOrder": [ "name" ], "description": "Activates a data segment.", "httpMethod": "POST", "id": "authorizedbuyersmarketplace.buyers.dataSegments.activate", "parameters": { "name": { "type": "string", "description": "Required. Name of data segment to activate. v1alpha format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}` v1beta format: `curators/{accountId}/dataSegments/{curatorDataSegmentId}`", "required": true, "pattern": "^buyers/[^/]+/dataSegments/[^/]+$", "location": "path" } }, "request": { "$ref": "ActivateDataSegmentRequest" }, "response": { "$ref": "DataSegment" }, "path": "v1alpha/{+name}:activate", "flatPath": "v1alpha/buyers/{buyersId}/dataSegments/{dataSegmentsId}:activate" }, "deactivate": { "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "parameterOrder": [ "name" ], "description": "Deactivates a data segment.", "httpMethod": "POST", "id": "authorizedbuyersmarketplace.buyers.dataSegments.deactivate", "parameters": { "name": { "description": "Required. Name of data segment to deactivate. v1alpha format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}` v1beta format: `curators/{accountId}/dataSegments/{curatorDataSegmentId}`", "type": "string", "pattern": "^buyers/[^/]+/dataSegments/[^/]+$", "location": "path", "required": true } }, "request": { "$ref": "DeactivateDataSegmentRequest" }, "response": { "$ref": "DataSegment" }, "path": "v1alpha/{+name}:deactivate", "flatPath": "v1alpha/buyers/{buyersId}/dataSegments/{dataSegmentsId}:deactivate" }, "get": { "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "parameterOrder": [ "name" ], "description": "Gets a data segment given its name.", "httpMethod": "GET", "id": "authorizedbuyersmarketplace.buyers.dataSegments.get", "parameters": { "name": { "required": true, "pattern": "^buyers/[^/]+/dataSegments/[^/]+$", "location": "path", "type": "string", "description": "Required. Name of data segment to get. v1alpha format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}` v1beta format: `curators/{accountId}/dataSegments/{curatorDataSegmentId}`" } }, "response": { "$ref": "DataSegment" }, "path": "v1alpha/{+name}", "flatPath": "v1alpha/buyers/{buyersId}/dataSegments/{dataSegmentsId}" }, "patch": { "id": "authorizedbuyersmarketplace.buyers.dataSegments.patch", "parameters": { "name": { "required": true, "pattern": "^buyers/[^/]+/dataSegments/[^/]+$", "location": "path", "type": "string", "description": "Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. v1alpha format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}` v1beta format: `curators/{curatorAccountId}/dataSegments/{curatorDataSegmentId}`" }, "updateMask": { "location": "query", "description": "Optional. 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": "string", "format": "google-fieldmask" } }, "request": { "$ref": "DataSegment" }, "response": { "$ref": "DataSegment" }, "path": "v1alpha/{+name}", "flatPath": "v1alpha/buyers/{buyersId}/dataSegments/{dataSegmentsId}", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "parameterOrder": [ "name" ], "description": "Updates a data segment.", "httpMethod": "PATCH" }, "create": { "parameters": { "parent": { "type": "string", "description": "Required. The parent resource where this data segment will be created. v1alpha format: `buyers/{accountId}` v1beta format: `curators/{accountId}`", "required": true, "pattern": "^buyers/[^/]+$", "location": "path" } }, "id": "authorizedbuyersmarketplace.buyers.dataSegments.create", "path": "v1alpha/{+parent}/dataSegments", "flatPath": "v1alpha/buyers/{buyersId}/dataSegments", "request": { "$ref": "DataSegment" }, "response": { "$ref": "DataSegment" }, "parameterOrder": [ "parent" ], "description": "Creates a data segment owned by the listed curator. The data segment will be created in the `ACTIVE` state, meaning it will be immediately available for buyers to use in preferred deals, private auction deals, and auction packages.", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "httpMethod": "POST" } } }, "publisherProfiles": { "methods": { "get": { "id": "authorizedbuyersmarketplace.buyers.publisherProfiles.get", "parameters": { "name": { "description": "Required. Name of the publisher profile. Format: `buyers/{buyerId}/publisherProfiles/{publisherProfileId}`", "type": "string", "pattern": "^buyers/[^/]+/publisherProfiles/[^/]+$", "location": "path", "required": true } }, "response": { "$ref": "PublisherProfile" }, "path": "v1alpha/{+name}", "flatPath": "v1alpha/buyers/{buyersId}/publisherProfiles/{publisherProfilesId}", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "parameterOrder": [ "name" ], "description": "Gets the requested publisher profile by name.", "httpMethod": "GET" }, "list": { "httpMethod": "GET", "parameterOrder": [ "parent" ], "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.", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "path": "v1alpha/{+parent}/publisherProfiles", "flatPath": "v1alpha/buyers/{buyersId}/publisherProfiles", "response": { "$ref": "ListPublisherProfilesResponse" }, "parameters": { "parent": { "required": true, "pattern": "^buyers/[^/]+$", "location": "path", "type": "string", "description": "Required. Parent that owns the collection of publisher profiles Format: `buyers/{buyerId}`" }, "pageToken": { "type": "string", "description": "The page token as returned from a previous ListPublisherProfilesResponse.", "location": "query" }, "pageSize": { "type": "integer", "format": "int32", "location": "query", "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." }, "filter": { "type": "string", "location": "query", "description": "Optional query string using the [Cloud API list filtering] (https://developers.google.com/authorized-buyers/apis/guides/list-filters) syntax." } }, "id": "authorizedbuyersmarketplace.buyers.publisherProfiles.list" } } }, "clients": { "methods": { "deactivate": { "parameterOrder": [ "name" ], "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.", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "httpMethod": "POST", "parameters": { "name": { "description": "Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}`", "type": "string", "pattern": "^buyers/[^/]+/clients/[^/]+$", "location": "path", "required": true } }, "id": "authorizedbuyersmarketplace.buyers.clients.deactivate", "path": "v1alpha/{+name}:deactivate", "flatPath": "v1alpha/buyers/{buyersId}/clients/{clientsId}:deactivate", "request": { "$ref": "DeactivateClientRequest" }, "response": { "$ref": "Client" } }, "list": { "parameters": { "pageSize": { "type": "integer", "format": "int32", "description": "Requested page size. If left blank, a default page size of 500 will be applied.", "location": "query" }, "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" }, "parent": { "pattern": "^buyers/[^/]+$", "location": "path", "required": true, "description": "Required. The name of the buyer. Format: `buyers/{accountId}`", "type": "string" }, "pageToken": { "type": "string", "location": "query", "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." } }, "id": "authorizedbuyersmarketplace.buyers.clients.list", "path": "v1alpha/{+parent}/clients", "flatPath": "v1alpha/buyers/{buyersId}/clients", "response": { "$ref": "ListClientsResponse" }, "parameterOrder": [ "parent" ], "description": "Lists all the clients for the current buyer.", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "httpMethod": "GET" }, "activate": { "parameterOrder": [ "name" ], "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.", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "httpMethod": "POST", "parameters": { "name": { "pattern": "^buyers/[^/]+/clients/[^/]+$", "location": "path", "required": true, "description": "Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}`", "type": "string" } }, "id": "authorizedbuyersmarketplace.buyers.clients.activate", "path": "v1alpha/{+name}:activate", "flatPath": "v1alpha/buyers/{buyersId}/clients/{clientsId}:activate", "request": { "$ref": "ActivateClientRequest" }, "response": { "$ref": "Client" } }, "create": { "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "parameterOrder": [ "parent" ], "description": "Creates a new client.", "request": { "$ref": "Client" }, "response": { "$ref": "Client" }, "path": "v1alpha/{+parent}/clients", "flatPath": "v1alpha/buyers/{buyersId}/clients", "id": "authorizedbuyersmarketplace.buyers.clients.create", "parameters": { "parent": { "required": true, "pattern": "^buyers/[^/]+$", "location": "path", "type": "string", "description": "Required. The name of the buyer. Format: `buyers/{accountId}`" } } }, "get": { "path": "v1alpha/{+name}", "flatPath": "v1alpha/buyers/{buyersId}/clients/{clientsId}", "response": { "$ref": "Client" }, "parameters": { "name": { "required": true, "pattern": "^buyers/[^/]+/clients/[^/]+$", "location": "path", "type": "string", "description": "Required. Format: `buyers/{accountId}/clients/{clientAccountId}`" } }, "id": "authorizedbuyersmarketplace.buyers.clients.get", "httpMethod": "GET", "parameterOrder": [ "name" ], "description": "Gets a client with a given resource name.", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ] }, "patch": { "parameters": { "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" }, "name": { "description": "Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`", "type": "string", "pattern": "^buyers/[^/]+/clients/[^/]+$", "location": "path", "required": true } }, "id": "authorizedbuyersmarketplace.buyers.clients.patch", "path": "v1alpha/{+name}", "flatPath": "v1alpha/buyers/{buyersId}/clients/{clientsId}", "request": { "$ref": "Client" }, "response": { "$ref": "Client" }, "parameterOrder": [ "name" ], "description": "Updates an existing client.", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "httpMethod": "PATCH" } }, "resources": { "users": { "methods": { "get": { "parameters": { "name": { "pattern": "^buyers/[^/]+/clients/[^/]+/users/[^/]+$", "location": "path", "required": true, "description": "Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}`", "type": "string" } }, "id": "authorizedbuyersmarketplace.buyers.clients.users.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/buyers/{buyersId}/clients/{clientsId}/users/{usersId}", "response": { "$ref": "ClientUser" }, "parameterOrder": [ "name" ], "description": "Retrieves an existing client user.", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "httpMethod": "GET" }, "create": { "httpMethod": "POST", "parameterOrder": [ "parent" ], "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.", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "path": "v1alpha/{+parent}/users", "flatPath": "v1alpha/buyers/{buyersId}/clients/{clientsId}/users", "request": { "$ref": "ClientUser" }, "response": { "$ref": "ClientUser" }, "parameters": { "parent": { "required": true, "pattern": "^buyers/[^/]+/clients/[^/]+$", "location": "path", "type": "string", "description": "Required. The name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`" } }, "id": "authorizedbuyersmarketplace.buyers.clients.users.create" }, "list": { "path": "v1alpha/{+parent}/users", "flatPath": "v1alpha/buyers/{buyersId}/clients/{clientsId}/users", "response": { "$ref": "ListClientUsersResponse" }, "parameters": { "parent": { "required": true, "pattern": "^buyers/[^/]+/clients/[^/]+$", "location": "path", "type": "string", "description": "Required. The name of the client. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}`" }, "pageToken": { "location": "query", "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.", "type": "string" }, "pageSize": { "description": "Requested page size. If left blank, a default page size of 500 will be applied.", "location": "query", "type": "integer", "format": "int32" } }, "id": "authorizedbuyersmarketplace.buyers.clients.users.list", "httpMethod": "GET", "parameterOrder": [ "parent" ], "description": "Lists all client users for a specified client.", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ] }, "delete": { "id": "authorizedbuyersmarketplace.buyers.clients.users.delete", "parameters": { "name": { "pattern": "^buyers/[^/]+/clients/[^/]+/users/[^/]+$", "location": "path", "required": true, "description": "Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}`", "type": "string" } }, "response": { "$ref": "Empty" }, "path": "v1alpha/{+name}", "flatPath": "v1alpha/buyers/{buyersId}/clients/{clientsId}/users/{usersId}", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "parameterOrder": [ "name" ], "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.", "httpMethod": "DELETE" }, "activate": { "request": { "$ref": "ActivateClientUserRequest" }, "response": { "$ref": "ClientUser" }, "path": "v1alpha/{+name}:activate", "flatPath": "v1alpha/buyers/{buyersId}/clients/{clientsId}/users/{usersId}:activate", "id": "authorizedbuyersmarketplace.buyers.clients.users.activate", "parameters": { "name": { "type": "string", "description": "Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}`", "required": true, "pattern": "^buyers/[^/]+/clients/[^/]+/users/[^/]+$", "location": "path" } }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "parameterOrder": [ "name" ], "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." }, "deactivate": { "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "parameterOrder": [ "name" ], "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.", "request": { "$ref": "DeactivateClientUserRequest" }, "response": { "$ref": "ClientUser" }, "path": "v1alpha/{+name}:deactivate", "flatPath": "v1alpha/buyers/{buyersId}/clients/{clientsId}/users/{usersId}:deactivate", "id": "authorizedbuyersmarketplace.buyers.clients.users.deactivate", "parameters": { "name": { "required": true, "pattern": "^buyers/[^/]+/clients/[^/]+/users/[^/]+$", "location": "path", "type": "string", "description": "Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}`" } } } } } } } } }, "bidders": { "resources": { "auctionPackages": { "methods": { "list": { "response": { "$ref": "ListAuctionPackagesResponse" }, "path": "v1alpha/{+parent}/auctionPackages", "flatPath": "v1alpha/bidders/{biddersId}/auctionPackages", "id": "authorizedbuyersmarketplace.bidders.auctionPackages.list", "parameters": { "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" }, "pageSize": { "description": "Requested page size. The server may return fewer results than requested. Max allowed page size is 500.", "location": "query", "type": "integer", "format": "int32" }, "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" }, "parent": { "type": "string", "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, "pattern": "^bidders/[^/]+$", "location": "path" }, "pageToken": { "type": "string", "description": "The page token as returned. ListAuctionPackagesResponse.nextPageToken", "location": "query" } }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "parameterOrder": [ "parent" ], "description": "List the auction packages. Buyers can use the URL path \"/v1alpha/buyers/{accountId}/auctionPackages\" to list auction packages for the current buyer and its clients. Bidders can use the URL path \"/v1alpha/bidders/{accountId}/auctionPackages\" to list auction packages for the bidder, its media planners, its buyers, and all their clients." } } }, "finalizedDeals": { "methods": { "list": { "parameterOrder": [ "parent" ], "description": "Lists finalized deals. Use the URL path \"/v1alpha/buyers/{accountId}/finalizedDeals\" to list finalized deals for the current buyer and its clients. Bidders can use the URL path \"/v1alpha/bidders/{accountId}/finalizedDeals\" to list finalized deals for the bidder, its buyers and all their clients.", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "httpMethod": "GET", "parameters": { "parent": { "type": "string", "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, "pattern": "^bidders/[^/]+$", "location": "path" }, "pageToken": { "description": "The page token as returned from ListFinalizedDealsResponse.", "location": "query", "type": "string" }, "filter": { "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", "type": "string" }, "pageSize": { "type": "integer", "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" }, "orderBy": { "type": "string", "location": "query", "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" } }, "id": "authorizedbuyersmarketplace.bidders.finalizedDeals.list", "path": "v1alpha/{+parent}/finalizedDeals", "flatPath": "v1alpha/bidders/{biddersId}/finalizedDeals", "response": { "$ref": "ListFinalizedDealsResponse" } }, "setReadyToServe": { "id": "authorizedbuyersmarketplace.bidders.finalizedDeals.setReadyToServe", "parameters": { "deal": { "pattern": "^bidders/[^/]+/finalizedDeals/[^/]+$", "location": "path", "required": true, "description": "Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}` or `bidders/{accountId}/finalizedDeals/{dealId}`", "type": "string" } }, "request": { "$ref": "SetReadyToServeRequest" }, "response": { "$ref": "FinalizedDeal" }, "path": "v1alpha/{+deal}:setReadyToServe", "flatPath": "v1alpha/bidders/{biddersId}/finalizedDeals/{finalizedDealsId}:setReadyToServe", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "parameterOrder": [ "deal" ], "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 \"/v1alpha/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.", "httpMethod": "POST" } } } } }, "curators": { "resources": { "curatedPackages": { "methods": { "create": { "parameters": { "parent": { "description": "Required. The parent curator account where this curated package will be created. Format: `curators/{accountId}`", "type": "string", "pattern": "^curators/[^/]+$", "location": "path", "required": true } }, "id": "authorizedbuyersmarketplace.curators.curatedPackages.create", "path": "v1alpha/{+parent}/curatedPackages", "flatPath": "v1alpha/curators/{curatorsId}/curatedPackages", "request": { "$ref": "CuratedPackage" }, "response": { "$ref": "CuratedPackage" }, "parameterOrder": [ "parent" ], "description": "Creates a new curated package.", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "httpMethod": "POST" }, "get": { "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "parameterOrder": [ "name" ], "description": "Gets a curated package given its resource name.", "httpMethod": "GET", "id": "authorizedbuyersmarketplace.curators.curatedPackages.get", "parameters": { "name": { "description": "Required. The name of the curated package to retrieve. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}`", "type": "string", "pattern": "^curators/[^/]+/curatedPackages/[^/]+$", "location": "path", "required": true } }, "response": { "$ref": "CuratedPackage" }, "path": "v1alpha/{+name}", "flatPath": "v1alpha/curators/{curatorsId}/curatedPackages/{curatedPackagesId}" }, "patch": { "path": "v1alpha/{+name}", "flatPath": "v1alpha/curators/{curatorsId}/curatedPackages/{curatedPackagesId}", "request": { "$ref": "CuratedPackage" }, "response": { "$ref": "CuratedPackage" }, "parameters": { "name": { "required": true, "pattern": "^curators/[^/]+/curatedPackages/[^/]+$", "location": "path", "type": "string", "description": "Identifier. The unique resource name for the curated package. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}`" }, "updateMask": { "description": "Optional. 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" } }, "id": "authorizedbuyersmarketplace.curators.curatedPackages.patch", "httpMethod": "PATCH", "parameterOrder": [ "name" ], "description": "Updates an existing curated package.", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ] }, "deactivate": { "httpMethod": "POST", "parameterOrder": [ "name" ], "description": "Deactivates an existing curated package.", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "path": "v1alpha/{+name}:deactivate", "flatPath": "v1alpha/curators/{curatorsId}/curatedPackages/{curatedPackagesId}:deactivate", "request": { "$ref": "DeactivateCuratedPackageRequest" }, "response": { "$ref": "CuratedPackage" }, "parameters": { "name": { "type": "string", "description": "Required. The name of the curated package to deactivate. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}`", "required": true, "pattern": "^curators/[^/]+/curatedPackages/[^/]+$", "location": "path" } }, "id": "authorizedbuyersmarketplace.curators.curatedPackages.deactivate" }, "list": { "response": { "$ref": "ListCuratedPackagesResponse" }, "path": "v1alpha/{+parent}/curatedPackages", "flatPath": "v1alpha/curators/{curatorsId}/curatedPackages", "id": "authorizedbuyersmarketplace.curators.curatedPackages.list", "parameters": { "pageSize": { "description": "Optional. Requested page size. The server may return fewer results than requested. Max allowed page size is 500. If unspecified, the server will default to 500.", "location": "query", "type": "integer", "format": "int32" }, "filter": { "location": "query", "description": "Optional. Optional query string using the [Cloud API list filtering syntax](/authorized-buyers/apis/guides/list-filters). Supported columns for filtering are: * displayName * createTime * updateTime * state * feeCpm.currencyCode * feeCpm.units * feeCpm.nanos * floorPriceCpm.currencyCode * floorPriceCpm.units * floorPriceCpm.nanos", "type": "string" }, "parent": { "required": true, "pattern": "^curators/[^/]+$", "location": "path", "type": "string", "description": "Required. The parent curator account which owns this collection of curated packages. Format: `curators/{accountId}`" }, "pageToken": { "type": "string", "location": "query", "description": "Optional. A page token, received from a previous `ListCuratedPackages` call. Provide this to retrieve the subsequent page." } }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "parameterOrder": [ "parent" ], "description": "Lists curated packages owned by the specified curator." }, "activate": { "parameters": { "name": { "required": true, "pattern": "^curators/[^/]+/curatedPackages/[^/]+$", "location": "path", "type": "string", "description": "Required. The name of the curated package to activate. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}`" } }, "id": "authorizedbuyersmarketplace.curators.curatedPackages.activate", "path": "v1alpha/{+name}:activate", "flatPath": "v1alpha/curators/{curatorsId}/curatedPackages/{curatedPackagesId}:activate", "request": { "$ref": "ActivateCuratedPackageRequest" }, "response": { "$ref": "CuratedPackage" }, "parameterOrder": [ "name" ], "description": "Activates an existing curated package.", "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ], "httpMethod": "POST" } } } } } }, "description": "The Authorized Buyers Marketplace API lets buyers programmatically discover inventory; propose, retrieve and negotiate deals with publishers.", "basePath": "", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/authorized-buyers-marketplace": { "description": "See, create, edit, and delete your Authorized Buyers Marketplace entities." } } } }, "mtlsRootUrl": "https://authorizedbuyersmarketplace.mtls.googleapis.com/", "title": "Authorized Buyers Marketplace API", "canonicalName": "Authorized Buyers Marketplace", "name": "authorizedbuyersmarketplace", "id": "authorizedbuyersmarketplace:v1alpha", "batchPath": "batch", "protocol": "rest", "documentationLink": "https://developers.google.com/authorized-buyers/apis/marketplace/reference/rest/", "revision": "20260727", "version": "v1alpha", "ownerName": "Google", "version_module": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "servicePath": "", "ownerDomain": "google.com", "discoveryVersion": "v1", "kind": "discovery#restDescription", "baseUrl": "https://authorizedbuyersmarketplace.googleapis.com/" }