{ "protocol": "rest", "documentationLink": "https://developers.google.com/authorized-buyers/apis/reference/rest/", "name": "adexchangebuyer2", "description": "Access the latest features for managing Authorized Buyers accounts, Real-Time Bidding configurations and auction metrics, and Marketplace programmatic deals.", "ownerName": "Google", "schemas": { "Note": { "type": "object", "properties": { "createTime": { "format": "google-datetime", "description": "Output only. The timestamp for when this note was created.", "type": "string", "readOnly": true }, "creatorRole": { "readOnly": true, "description": "Output only. The role of the person (buyer/seller) creating the note.", "type": "string", "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." ] }, "note": { "description": "The actual note to attach. (max-length: 1024 unicode code units) Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.", "type": "string" }, "proposalRevision": { "description": "Output only. The revision number of the proposal when the note is created.", "format": "int64", "readOnly": true, "type": "string" }, "noteId": { "readOnly": true, "type": "string", "description": "Output only. The unique ID for the note." } }, "description": "A proposal may be associated to several notes.", "id": "Note" }, "PlacementTargeting": { "type": "object", "properties": { "urlTargeting": { "description": "URLs to be included/excluded.", "$ref": "UrlTargeting" }, "mobileApplicationTargeting": { "description": "Mobile application targeting information in a deal. This doesn't apply to Auction Packages.", "$ref": "MobileApplicationTargeting" } }, "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.", "id": "PlacementTargeting" }, "Money": { "description": "Represents an amount of money with its currency type.", "id": "Money", "type": "object", "properties": { "units": { "format": "int64", "description": "The whole units of the amount. For example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.", "type": "string" }, "currencyCode": { "description": "The three-letter currency code defined in ISO 4217.", "type": "string" }, "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." } } }, "PublisherProfile": { "description": "Represents a publisher profile (https://support.google.com/admanager/answer/6035806) in Marketplace. All fields are read only. All string fields are free-form text entered by the publisher unless noted otherwise.", "id": "PublisherProfile", "type": "object", "properties": { "displayName": { "description": "Name of the publisher profile.", "type": "string" }, "topHeadlines": { "type": "array", "items": { "type": "string" }, "description": "Up to three key metrics and rankings. Max 100 characters each. For example \"#1 Mobile News Site for 20 Straight Months\"." }, "seller": { "description": "Seller of the publisher profile.", "$ref": "Seller" }, "domains": { "type": "array", "items": { "type": "string" }, "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\"." }, "mobileApps": { "type": "array", "items": { "$ref": "PublisherProfileMobileApplication" }, "description": "The list of apps represented in this publisher profile. Empty if this is a parent profile." }, "mediaKitUrl": { "description": "URL to additional marketing and sales materials.", "type": "string" }, "audienceDescription": { "type": "string", "description": "Description on the publisher's audience." }, "rateCardInfoUrl": { "type": "string", "description": "URL to a publisher rate card." }, "overview": { "description": "Overview of the publisher.", "type": "string" }, "googlePlusUrl": { "description": "URL to publisher's Google+ page.", "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." }, "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." }, "directDealsContact": { "type": "string", "description": "Contact information for direct reservation deals. This is free text entered by the publisher and may include information like names, phone numbers and email addresses." }, "buyerPitchStatement": { "description": "Statement explaining what's unique about publisher's business, and why buyers should partner with the publisher.", "type": "string" }, "samplePageUrl": { "type": "string", "description": "URL to a sample content page." }, "publisherProfileId": { "type": "string", "description": "Unique ID for publisher profile." }, "isParent": { "type": "boolean", "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 should have only one parent publisher profile, and can have multiple child profiles. Publisher profiles for the same seller will have same value of field google.ads.adexchange.buyer.v2beta1.PublisherProfile.seller. See https://support.google.com/admanager/answer/6035806 for details." } } }, "Creative": { "type": "object", "properties": { "declaredClickThroughUrls": { "type": "array", "items": { "type": "string" }, "description": "The set of declared destination URLs for the creative." }, "detectedSensitiveCategories": { "description": "Output only. Detected sensitive categories, if any. See the ad-sensitive-categories.txt file in the technical documentation for a list of IDs. You should use these IDs along with the excluded-sensitive-category field in the bid request to filter your bids.", "items": { "type": "integer", "format": "int32" }, "type": "array" }, "agencyId": { "description": "The agency ID for this creative.", "format": "int64", "type": "string" }, "detectedLanguages": { "description": "Output only. The detected languages for this creative. The order is arbitrary. The codes are 2 or 5 characters and are documented at https://developers.google.com/adwords/api/docs/appendix/languagecodes.", "type": "array", "items": { "type": "string" } }, "version": { "type": "integer", "format": "int32", "description": "Output only. The version of this creative." }, "creativeId": { "type": "string", "description": "The buyer-defined creative ID of this creative. Can be used to filter the response of the creatives.list method." }, "attributes": { "description": "All attributes for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method.", "type": "array", "items": { "enumDescriptions": [ "Do not use. This is a placeholder value only.", "The creative is of type image/rich media. For pretargeting.", "The creative is of video type Adobe Flash FLV. For pretargeting.", "The creative is tagged.", "The creative is cookie targeted.", "The creative is user interest targeted.", "The creative does not expand.", "The creative expands up.", "The creative expands down.", "The creative expands left.", "The creative expands right.", "The creative expands up and left.", "The creative expands up and right.", "The creative expands down and left.", "The creative expands down and right.", "The creative type is HTML.", "The creative type is VAST video.", "The creative expands up or down.", "The creative expands left or right.", "The creative expands on any diagonal.", "The creative expands when rolled over.", "The instream vast video type is vpaid flash.", "The creative is MRAID.", "The creative is Flash.", "The creative is HTML5.", "The creative has an instream VAST video type of skippable instream video. For pretargeting.", "The creative is SSL.", "The creative is non-SSL.", "The creative is an interstitial.", "The creative has an instream VAST video type of non-skippable instream video. For pretargeting.", "The creative is eligible for native.", "The creative has an instream VAST video type of non-VPAID. For pretargeting.", "The creative is not eligible for native.", "The creative has an interstitial size of any interstitial. For pretargeting.", "The creative has an interstitial size of non interstitial. For pretargeting.", "The video type is in-banner video.", "The creative can dynamically resize to fill a variety of slot sizes.", "The open measurement SDK is supported.", "The creative is considered a playable display creative." ], "type": "string", "enum": [ "ATTRIBUTE_UNSPECIFIED", "IMAGE_RICH_MEDIA", "ADOBE_FLASH_FLV", "IS_TAGGED", "IS_COOKIE_TARGETED", "IS_USER_INTEREST_TARGETED", "EXPANDING_DIRECTION_NONE", "EXPANDING_DIRECTION_UP", "EXPANDING_DIRECTION_DOWN", "EXPANDING_DIRECTION_LEFT", "EXPANDING_DIRECTION_RIGHT", "EXPANDING_DIRECTION_UP_LEFT", "EXPANDING_DIRECTION_UP_RIGHT", "EXPANDING_DIRECTION_DOWN_LEFT", "EXPANDING_DIRECTION_DOWN_RIGHT", "CREATIVE_TYPE_HTML", "CREATIVE_TYPE_VAST_VIDEO", "EXPANDING_DIRECTION_UP_OR_DOWN", "EXPANDING_DIRECTION_LEFT_OR_RIGHT", "EXPANDING_DIRECTION_ANY_DIAGONAL", "EXPANDING_ACTION_ROLLOVER_TO_EXPAND", "INSTREAM_VAST_VIDEO_TYPE_VPAID_FLASH", "RICH_MEDIA_CAPABILITY_TYPE_MRAID", "RICH_MEDIA_CAPABILITY_TYPE_FLASH", "RICH_MEDIA_CAPABILITY_TYPE_HTML5", "SKIPPABLE_INSTREAM_VIDEO", "RICH_MEDIA_CAPABILITY_TYPE_SSL", "RICH_MEDIA_CAPABILITY_TYPE_NON_SSL", "RICH_MEDIA_CAPABILITY_TYPE_INTERSTITIAL", "NON_SKIPPABLE_INSTREAM_VIDEO", "NATIVE_ELIGIBILITY_ELIGIBLE", "NON_VPAID", "NATIVE_ELIGIBILITY_NOT_ELIGIBLE", "ANY_INTERSTITIAL", "NON_INTERSTITIAL", "IN_BANNER_VIDEO", "RENDERING_SIZELESS_ADX", "OMSDK_1_0", "RENDERING_PLAYABLE" ] } }, "apiUpdateTime": { "type": "string", "format": "google-datetime", "description": "Output only. The last update timestamp of the creative through the API." }, "clickThroughUrls": { "description": "The set of destination URLs for the creative.", "type": "array", "items": { "type": "string" } }, "detectedProductCategories": { "description": "Output only. Detected product categories, if any. See the ad-product-categories.txt file in the technical documentation for a list of IDs.", "type": "array", "items": { "type": "integer", "format": "int32" } }, "detectedAdvertiserIds": { "description": "Output only. Detected advertiser IDs, if any.", "items": { "type": "string", "format": "int64" }, "type": "array" }, "dealsStatus": { "type": "string", "enum": [ "STATUS_UNSPECIFIED", "NOT_CHECKED", "CONDITIONALLY_APPROVED", "APPROVED", "DISAPPROVED", "PENDING_REVIEW", "STATUS_TYPE_UNSPECIFIED" ], "description": "Output only. The top-level deals status of this creative. If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in serving_restrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the creatives.list method.", "enumDescriptions": [ "The status is unknown.", "The creative has not been checked.", "The creative has been conditionally approved. See serving_restrictions for details.", "The creative has been approved.", "The creative has been disapproved.", "Placeholder for transition to v1beta1. Currently not used.", "Placeholder for transition to v1beta1. Currently not used." ] }, "servingRestrictions": { "type": "array", "items": { "$ref": "ServingRestriction" }, "description": "Output only. The granular status of this ad in specific contexts. A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS versus HTTP request, or the type of auction)." }, "adChoicesDestinationUrl": { "type": "string", "description": "The link to AdChoices destination page." }, "openAuctionStatus": { "description": "Output only. The top-level open auction status of this creative. If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in serving_restrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the creatives.list method.", "enumDescriptions": [ "The status is unknown.", "The creative has not been checked.", "The creative has been conditionally approved. See serving_restrictions for details.", "The creative has been approved.", "The creative has been disapproved.", "Placeholder for transition to v1beta1. Currently not used.", "Placeholder for transition to v1beta1. Currently not used." ], "type": "string", "enum": [ "STATUS_UNSPECIFIED", "NOT_CHECKED", "CONDITIONALLY_APPROVED", "APPROVED", "DISAPPROVED", "PENDING_REVIEW", "STATUS_TYPE_UNSPECIFIED" ] }, "advertiserName": { "type": "string", "description": "The name of the company being advertised in the creative." }, "native": { "description": "A native creative.", "$ref": "NativeContent" }, "detectedDomains": { "description": "Output only. The detected domains for this creative.", "items": { "type": "string" }, "type": "array" }, "adTechnologyProviders": { "description": "Output only. The detected ad technology providers.", "$ref": "AdTechnologyProviders" }, "html": { "description": "An HTML creative.", "$ref": "HtmlContent" }, "video": { "description": "A video creative.", "$ref": "VideoContent" }, "impressionTrackingUrls": { "items": { "type": "string" }, "type": "array", "description": "The set of URLs to be called to record an impression." }, "vendorIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "All vendor IDs for the ads that may be shown from this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for possible values." }, "accountId": { "description": "The account that this creative belongs to. Can be used to filter the response of the creatives.list method.", "type": "string" }, "restrictedCategories": { "type": "array", "items": { "type": "string", "enum": [ "NO_RESTRICTED_CATEGORIES", "ALCOHOL" ], "enumDescriptions": [ "The ad has no restricted categories", "The alcohol restricted category." ] }, "description": "All restricted categories for the ads that may be shown from this creative." }, "corrections": { "description": "Output only. Shows any corrections that were applied to this creative.", "items": { "$ref": "Correction" }, "deprecated": true, "type": "array" } }, "id": "Creative", "description": "A creative and its classification data." }, "DayPartTargeting": { "type": "object", "properties": { "timeZoneType": { "description": "The timezone to use for interpreting the day part targeting.", "enumDescriptions": [ "A placeholder for an undefined time zone source.", "Use publisher's time zone setting.", "Use the user's time zone setting." ], "type": "string", "enum": [ "TIME_ZONE_SOURCE_UNSPECIFIED", "PUBLISHER", "USER" ] }, "dayParts": { "type": "array", "items": { "$ref": "DayPart" }, "description": "A list of day part targeting criterion." } }, "id": "DayPartTargeting", "description": "Specifies the day part targeting criteria." }, "Empty": { "id": "Empty", "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); }", "type": "object", "properties": {} }, "NonGuaranteedFixedPriceTerms": { "type": "object", "properties": { "fixedPrices": { "description": "Fixed price for the specified buyer.", "items": { "$ref": "PricePerBuyer" }, "type": "array" } }, "id": "NonGuaranteedFixedPriceTerms", "description": "Terms for Preferred Deals." }, "FilterSet": { "type": "object", "properties": { "absoluteDateRange": { "description": "An absolute date range, defined by a start date and an end date. Interpreted relative to Pacific time zone.", "$ref": "AbsoluteDateRange" }, "publisherIdentifiers": { "items": { "type": "string" }, "type": "array", "description": "For Open Bidding partners only. The list of publisher identifiers on which to filter; may be empty. The filters represented by multiple publisher identifiers are ORed together." }, "formats": { "description": "Creative formats bidded on or allowed to bid on, can be empty. Although this field is a list, it can only be populated with a single item. A HTTP 400 bad request error will be returned in the response if you specify multiple items.", "items": { "type": "string", "enum": [ "FORMAT_UNSPECIFIED", "NATIVE_DISPLAY", "NATIVE_VIDEO", "NON_NATIVE_DISPLAY", "NON_NATIVE_VIDEO" ], "enumDescriptions": [ "A placeholder for an undefined format; indicates that no format filter will be applied.", "The ad impression is a native ad, and display (for example, image) format.", "The ad impression is a native ad, and video format.", "The ad impression is not a native ad, and display (for example, image) format.", "The ad impression is not a native ad, and video format." ] }, "deprecated": true, "type": "array" }, "sellerNetworkIds": { "description": "For Authorized Buyers only. The list of IDs of the seller (publisher) networks on which to filter; may be empty. The filters represented by multiple seller network IDs are ORed together (for example, if non-empty, results must match any one of the publisher networks). See [seller-network-ids](https://developers.google.com/authorized-buyers/rtb/downloads/seller-network-ids) file for the set of existing seller network IDs.", "type": "array", "items": { "type": "integer", "format": "int32" } }, "relativeDateRange": { "description": "A relative date range, defined by an offset from today and a duration. Interpreted relative to Pacific time zone.", "$ref": "RelativeDateRange" }, "format": { "description": "Creative format bidded on or allowed to bid on, can be empty.", "enumDescriptions": [ "A placeholder for an undefined format; indicates that no format filter will be applied.", "The ad impression is a native ad, and display (for example, image) format.", "The ad impression is a native ad, and video format.", "The ad impression is not a native ad, and display (for example, image) format.", "The ad impression is not a native ad, and video format." ], "type": "string", "enum": [ "FORMAT_UNSPECIFIED", "NATIVE_DISPLAY", "NATIVE_VIDEO", "NON_NATIVE_DISPLAY", "NON_NATIVE_VIDEO" ] }, "timeSeriesGranularity": { "type": "string", "enum": [ "TIME_SERIES_GRANULARITY_UNSPECIFIED", "HOURLY", "DAILY" ], "description": "The granularity of time intervals if a time series breakdown is preferred; optional.", "enumDescriptions": [ "A placeholder for an unspecified interval; no time series is applied. All rows in response will contain data for the entire requested time range.", "Indicates that data will be broken down by the hour.", "Indicates that data will be broken down by the day." ] }, "creativeId": { "type": "string", "description": "The ID of the creative on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, for example, one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern." }, "realtimeTimeRange": { "description": "An open-ended realtime time range, defined by the aggregation start timestamp.", "$ref": "RealtimeTimeRange" }, "breakdownDimensions": { "description": "The set of dimensions along which to break down the response; may be empty. If multiple dimensions are requested, the breakdown is along the Cartesian product of the requested dimensions.", "items": { "enumDescriptions": [ "A placeholder for an unspecified dimension; should not be used.", "The response should be broken down by publisher identifier. This option is available only for Open Bidding buyers." ], "type": "string", "enum": [ "BREAKDOWN_DIMENSION_UNSPECIFIED", "PUBLISHER_IDENTIFIER" ] }, "type": "array" }, "platforms": { "description": "The list of platforms on which to filter; may be empty. The filters represented by multiple platforms are ORed together (for example, if non-empty, results must match any one of the platforms).", "type": "array", "items": { "type": "string", "enum": [ "PLATFORM_UNSPECIFIED", "DESKTOP", "TABLET", "MOBILE" ], "enumDescriptions": [ "A placeholder for an undefined platform; indicates that no platform filter will be applied.", "The ad impression appears on a desktop.", "The ad impression appears on a tablet.", "The ad impression appears on a mobile device." ] } }, "name": { "type": "string", "description": "A user-defined name of the filter set. Filter set names must be unique globally and match one of the patterns: - `bidders/*/filterSets/*` (for accessing bidder-level troubleshooting data) - `bidders/*/accounts/*/filterSets/*` (for accessing account-level troubleshooting data) This field is required in create operations." }, "dealId": { "description": "The ID of the deal on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, for example, one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern.", "format": "int64", "type": "string" }, "environment": { "type": "string", "enum": [ "ENVIRONMENT_UNSPECIFIED", "WEB", "APP" ], "description": "The environment on which to filter; optional.", "enumDescriptions": [ "A placeholder for an undefined environment; indicates that no environment filter will be applied.", "The ad impression appears on the web.", "The ad impression appears in an app." ] } }, "id": "FilterSet", "description": "A set of filters that is applied to a request for data. Within a filter set, an AND operation is performed across the filters represented by each field. An OR operation is performed across the filters represented by the multiple values of a repeated field, for example, \"format=VIDEO AND deal_id=12 AND (seller_network_id=34 OR seller_network_id=56)\"." }, "PublisherProfileMobileApplication": { "type": "object", "properties": { "appStore": { "description": "The app store the app belongs to.", "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" ], "type": "string", "enum": [ "APP_STORE_TYPE_UNSPECIFIED", "APPLE_ITUNES", "GOOGLE_PLAY", "ROKU", "AMAZON_FIRETV", "PLAYSTATION", "XBOX", "SAMSUNG_TV", "AMAZON", "OPPO", "SAMSUNG", "VIVO", "XIAOMI", "LG_TV" ] }, "externalAppId": { "description": "The external ID for the app from its app store.", "type": "string" }, "name": { "type": "string", "description": "The name of the app." } }, "description": "A mobile application that contains a external app ID, name, and app store.", "id": "PublisherProfileMobileApplication" }, "FilteredBidCreativeRow": { "type": "object", "properties": { "bidCount": { "description": "The number of bids with the specified creative.", "$ref": "MetricValue" }, "creativeId": { "description": "The ID of the creative.", "type": "string" }, "rowDimensions": { "description": "The values of all dimensions associated with metric values in this row.", "$ref": "RowDimensions" } }, "description": "The number of filtered bids with the specified dimension values that have the specified creative.", "id": "FilteredBidCreativeRow" }, "ServingRestriction": { "type": "object", "properties": { "disapprovalReasons": { "description": "Any disapprovals bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method. Deprecated; use disapproval field instead.", "deprecated": true, "type": "array", "items": { "$ref": "Disapproval" } }, "disapproval": { "description": "Disapproval bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method.", "$ref": "Disapproval" }, "status": { "description": "The status of the creative in this context (for example, it has been explicitly disapproved or is pending review).", "enumDescriptions": [ "The status is not known.", "The ad was disapproved in this context.", "The ad is pending review in this context." ], "type": "string", "enum": [ "STATUS_UNSPECIFIED", "DISAPPROVAL", "PENDING_REVIEW" ] }, "contexts": { "description": "The contexts for the restriction.", "items": { "$ref": "ServingContext" }, "type": "array" } }, "description": "Output only. A representation of the status of an ad in a specific context. A context here relates to where something ultimately serves (for example, a user or publisher geo, a platform, an HTTPS versus HTTP request, or the type of auction).", "id": "ServingRestriction" }, "NonBillableWinningBidStatusRow": { "type": "object", "properties": { "bidCount": { "description": "The number of bids with the specified status.", "$ref": "MetricValue" }, "status": { "description": "The status specifying why the winning bids were not billed.", "enumDescriptions": [ "A placeholder for an undefined status. This value will never be returned in responses.", "The buyer was not billed because the ad was not rendered by the publisher.", "The buyer was not billed because the impression won by the bid was determined to be invalid.", "A video impression was served but a fatal error was reported from the client during playback.", "The buyer was not billed because the ad was outplaced in the mediation waterfall.", "The impression was not billed because it exceeded a guaranteed deal delivery goal." ], "type": "string", "enum": [ "STATUS_UNSPECIFIED", "AD_NOT_RENDERED", "INVALID_IMPRESSION", "FATAL_VAST_ERROR", "LOST_IN_MEDIATION", "OVERDELIVERED_IMPRESSION" ] }, "rowDimensions": { "description": "The values of all dimensions associated with metric values in this row.", "$ref": "RowDimensions" } }, "description": "The number of winning bids with the specified dimension values for which the buyer was not billed, as described by the specified status.", "id": "NonBillableWinningBidStatusRow" }, "MobileApplicationTargeting": { "description": "Mobile application targeting settings.", "id": "MobileApplicationTargeting", "type": "object", "properties": { "firstPartyTargeting": { "description": "Publisher owned apps to be targeted or excluded by the publisher to display the ads in.", "$ref": "FirstPartyMobileApplicationTargeting" } } }, "Correction": { "type": "object", "properties": { "contexts": { "description": "The contexts for the correction.", "type": "array", "items": { "$ref": "ServingContext" } }, "type": { "type": "string", "enum": [ "CORRECTION_TYPE_UNSPECIFIED", "VENDOR_IDS_ADDED", "SSL_ATTRIBUTE_REMOVED", "FLASH_FREE_ATTRIBUTE_REMOVED", "FLASH_FREE_ATTRIBUTE_ADDED", "REQUIRED_ATTRIBUTE_ADDED", "REQUIRED_VENDOR_ADDED", "SSL_ATTRIBUTE_ADDED", "IN_BANNER_VIDEO_ATTRIBUTE_ADDED", "MRAID_ATTRIBUTE_ADDED", "FLASH_ATTRIBUTE_REMOVED", "VIDEO_IN_SNIPPET_ATTRIBUTE_ADDED" ], "description": "The type of correction that was applied to the creative.", "enumDescriptions": [ "The correction type is unknown. Refer to the details for more information.", "The ad's declared vendors did not match the vendors that were detected. The detected vendors were added.", "The ad had the SSL attribute declared but was not SSL-compliant. The SSL attribute was removed.", "The ad was declared as Flash-free but contained Flash, so the Flash-free attribute was removed.", "The ad was not declared as Flash-free but it did not reference any flash content, so the Flash-free attribute was added.", "The ad did not declare a required creative attribute. The attribute was added.", "The ad did not declare a required technology vendor. The technology vendor was added.", "The ad did not declare the SSL attribute but was SSL-compliant, so the SSL attribute was added.", "Properties consistent with In-banner video were found, so an In-Banner Video attribute was added.", "The ad makes calls to the MRAID API so the MRAID attribute was added.", "The ad unnecessarily declared the Flash attribute, so the Flash attribute was removed.", "The ad contains video content." ] }, "details": { "description": "Additional details about what was corrected.", "type": "array", "items": { "type": "string" } } }, "id": "Correction", "description": "Output only. Shows any corrections that were applied to this creative." }, "BidResponseWithoutBidsStatusRow": { "type": "object", "properties": { "impressionCount": { "description": "The number of impressions for which there was a bid response with the specified status.", "$ref": "MetricValue" }, "rowDimensions": { "description": "The values of all dimensions associated with metric values in this row.", "$ref": "RowDimensions" }, "status": { "description": "The status specifying why the bid responses were considered to have no applicable bids.", "enumDescriptions": [ "A placeholder for an undefined status. This value will never be returned in responses.", "The response had no bids.", "The response had no bids for the specified account, though it may have included bids on behalf of other accounts. Applies if: 1. Request is on behalf of a bidder and an account filter is present. 2. Request is on behalf of a child seat.", "The response had no bids for the specified deal, though it may have included bids on other deals on behalf of the account to which the deal belongs. If request is on behalf of a bidder and an account filter is not present, this also includes responses that have bids on behalf of accounts other than the account to which the deal belongs." ], "type": "string", "enum": [ "STATUS_UNSPECIFIED", "RESPONSES_WITHOUT_BIDS", "RESPONSES_WITHOUT_BIDS_FOR_ACCOUNT", "RESPONSES_WITHOUT_BIDS_FOR_DEAL" ] } }, "id": "BidResponseWithoutBidsStatusRow", "description": "The number of impressions with the specified dimension values that were considered to have no applicable bids, as described by the specified status." }, "ServingContext": { "description": "The serving context for this restriction.", "id": "ServingContext", "type": "object", "properties": { "auctionType": { "description": "Matches impressions for a particular auction type.", "$ref": "AuctionContext" }, "location": { "description": "Matches impressions coming from users *or* publishers in a specific location.", "$ref": "LocationContext" }, "securityType": { "deprecated": true, "description": "Matches impressions for a particular security type.", "$ref": "SecurityContext" }, "platform": { "description": "Matches impressions coming from a particular platform.", "$ref": "PlatformContext" }, "all": { "type": "string", "enum": [ "SIMPLE_CONTEXT" ], "description": "Matches all contexts.", "enumDescriptions": [ "A simple context." ] }, "appType": { "description": "Matches impressions for a particular app type.", "$ref": "AppContext" } } }, "CreativeSpecification": { "description": "Represents information for a creative that is associated with a Programmatic Guaranteed/Preferred Deal in Ad Manager.", "id": "CreativeSpecification", "type": "object", "properties": { "creativeSize": { "description": "The size of the creative.", "$ref": "AdSize" }, "creativeCompanionSizes": { "type": "array", "items": { "$ref": "AdSize" }, "description": "Companion sizes may be filled in only when this is a video creative." } } }, "CompleteSetupRequest": { "description": "Request message for indicating that the proposal's setup step is complete.", "id": "CompleteSetupRequest", "type": "object", "properties": {} }, "PlatformContext": { "description": "Output only. The type of platform the restriction applies to.", "id": "PlatformContext", "type": "object", "properties": { "platforms": { "description": "The platforms this restriction applies to.", "type": "array", "items": { "enumDescriptions": [ "Desktop platform.", "Android platform.", "iOS platform." ], "type": "string", "enum": [ "DESKTOP", "ANDROID", "IOS" ] } } } }, "ListCreativeStatusBreakdownByCreativeResponse": { "type": "object", "properties": { "filteredBidCreativeRows": { "type": "array", "items": { "$ref": "FilteredBidCreativeRow" }, "description": "List of rows, with counts of bids with a given creative status aggregated by creative." }, "nextPageToken": { "type": "string", "description": "A token to retrieve the next page of results. Pass this value in the ListCreativeStatusBreakdownByCreativeRequest.pageToken field in the subsequent call to the filteredBids.creatives.list method to retrieve the next page of results." } }, "description": "Response message for listing all creatives associated with a given filtered bid reason.", "id": "ListCreativeStatusBreakdownByCreativeResponse" }, "Deal": { "type": "object", "properties": { "proposalId": { "type": "string", "readOnly": true, "description": "Output only. ID of the proposal that this deal is part of." }, "programmaticCreativeSource": { "type": "string", "enum": [ "PROGRAMMATIC_CREATIVE_SOURCE_UNSPECIFIED", "ADVERTISER", "PUBLISHER" ], "enumDescriptions": [ "A placeholder for an undefined programmatic creative source.", "The advertiser provides the creatives.", "The publisher provides the creatives to be served." ], "readOnly": true, "description": "Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by buyer." }, "displayName": { "type": "string", "description": "The name of the deal." }, "targeting": { "description": "Output only. Specifies the subset of inventory targeted by the deal.", "$ref": "MarketplaceTargeting", "readOnly": true }, "availableStartTime": { "description": "Optional. 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.", "format": "google-datetime", "type": "string" }, "dealId": { "type": "string", "readOnly": true, "description": "Output only. A unique deal ID for the deal (server-assigned)." }, "syndicationProduct": { "description": "The syndication product associated with the deal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.", "enumDescriptions": [ "A placeholder for an undefined syndication product.", "This typically represents a web page.", "This represents a mobile property.", "This represents video ad formats.", "This represents ads shown within games." ], "type": "string", "enum": [ "SYNDICATION_PRODUCT_UNSPECIFIED", "CONTENT", "MOBILE", "VIDEO", "GAMES" ] }, "creativeSafeFrameCompatibility": { "readOnly": true, "description": "Output only. Specifies whether the creative is safeFrame compatible.", "type": "string", "enum": [ "CREATIVE_SAFE_FRAME_COMPATIBILITY_UNSPECIFIED", "COMPATIBLE", "INCOMPATIBLE" ], "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." ] }, "webPropertyCode": { "description": "The web property code for the seller copied over from the product.", "type": "string" }, "createProductId": { "type": "string", "description": "The product ID from which this deal was created. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error." }, "updateTime": { "type": "string", "readOnly": true, "format": "google-datetime", "description": "Output only. The time when the deal was last updated." }, "createProductRevision": { "description": "Optional. Revision number of the product that the deal was created from. If present on create, and the server `product_revision` has advanced since the passed-in `create_product_revision`, an `ABORTED` error will be returned. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.", "format": "int64", "type": "string" }, "creativePreApprovalPolicy": { "type": "string", "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." ], "readOnly": true, "description": "Output only. Specifies the creative pre-approval policy." }, "createTime": { "format": "google-datetime", "description": "Output only. The time of the deal creation.", "type": "string", "readOnly": true }, "description": { "description": "Description for the deal terms.", "type": "string" }, "targetingCriterion": { "description": "The shared targeting visible to buyers and sellers. Each shared targeting entity is AND'd together.", "items": { "$ref": "TargetingCriteria" }, "type": "array" }, "dealServingMetadata": { "description": "Output only. Metadata about the serving status of this deal.", "$ref": "DealServingMetadata", "readOnly": true }, "isSetupComplete": { "description": "Output only. True, if the buyside inventory setup is complete for this deal.", "type": "boolean", "readOnly": true }, "dealTerms": { "description": "The negotiable terms of the deal.", "$ref": "DealTerms" }, "deliveryControl": { "description": "The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher.", "$ref": "DeliveryControl" }, "sellerContacts": { "description": "Output only. Seller contact information for the deal.", "type": "array", "readOnly": true, "items": { "$ref": "ContactInformation" } }, "buyerPrivateData": { "description": "Buyer private data (hidden from seller).", "$ref": "PrivateData" }, "availableEndTime": { "type": "string", "description": "Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not required for Private Auction deals or Preferred Deals.", "format": "google-datetime" }, "creativeRestrictions": { "description": "Output only. Restricitions about the creatives associated with the deal (for example, size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager.", "$ref": "CreativeRestrictions", "readOnly": true }, "externalDealId": { "description": "Output only. The external deal ID assigned to this deal once the deal is finalized. This is the deal ID that shows up in serving/reporting etc.", "type": "string", "readOnly": true } }, "description": "A deal represents a segment of inventory for displaying ads on. A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving.", "id": "Deal" }, "AuctionContext": { "type": "object", "properties": { "auctionTypes": { "type": "array", "items": { "type": "string", "enum": [ "OPEN_AUCTION", "DIRECT_DEALS" ], "enumDescriptions": [ "The restriction applies to open auction.", "The restriction applies to direct deals." ] }, "description": "The auction types this restriction applies to." } }, "description": "Output only. The auction type the restriction applies to.", "id": "AuctionContext" }, "FrequencyCap": { "description": "Frequency cap.", "id": "FrequencyCap", "type": "object", "properties": { "maxImpressions": { "type": "integer", "format": "int32", "description": "The maximum number of impressions that can be served to a user within the specified time period." }, "timeUnitType": { "type": "string", "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.", "enumDescriptions": [ "A placeholder for an undefined time unit type. This just indicates the variable with this value hasn't been initialized.", "Minute", "Hour", "Day", "Week", "Month", "Lifetime", "Pod", "Stream" ] }, "numTimeUnits": { "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.", "format": "int32", "type": "integer" } } }, "NonGuaranteedAuctionTerms": { "id": "NonGuaranteedAuctionTerms", "description": "Terms for Private Auctions. Note that Private Auctions can be created only by the seller, but they can be returned in a get or list request.", "type": "object", "properties": { "reservePricesPerBuyer": { "items": { "$ref": "PricePerBuyer" }, "type": "array", "description": "Reserve price for the specified buyer." }, "autoOptimizePrivateAuction": { "type": "boolean", "description": "True if open auction buyers are allowed to compete with invited buyers in this private auction." } } }, "Product": { "type": "object", "properties": { "publisherProfileId": { "description": "An ID which can be used by the Publisher Profile API to get more information about the seller that created this product.", "type": "string" }, "availableStartTime": { "type": "string", "format": "google-datetime", "description": "Inventory availability dates. The start time will be truncated to seconds during serving. Thus, a field specified as 3:23:34.456 (HH:mm:ss.SSS) will be truncated to 3:23:34 when serving." }, "targetingCriterion": { "description": "Targeting that is shared between the buyer and the seller. Each targeting criterion has a specified key and for each key there is a list of inclusion value or exclusion values.", "type": "array", "items": { "$ref": "TargetingCriteria" } }, "productRevision": { "format": "int64", "description": "The revision number of the product (auto-assigned by Marketplace).", "type": "string" }, "availableEndTime": { "type": "string", "format": "google-datetime", "description": "The proposed end time for the deal. The field will be truncated to the order of seconds during serving." }, "webPropertyCode": { "type": "string", "description": "The web-property code for the seller. This needs to be copied as is when adding a new deal to a proposal." }, "productId": { "description": "The unique ID for the product.", "type": "string" }, "syndicationProduct": { "type": "string", "enum": [ "SYNDICATION_PRODUCT_UNSPECIFIED", "CONTENT", "MOBILE", "VIDEO", "GAMES" ], "description": "The syndication product associated with the deal.", "enumDescriptions": [ "A placeholder for an undefined syndication product.", "This typically represents a web page.", "This represents a mobile property.", "This represents video ad formats.", "This represents ads shown within games." ] }, "terms": { "description": "The negotiable terms of the deal.", "$ref": "DealTerms" }, "creatorContacts": { "description": "Optional contact information for the creator of this product.", "items": { "$ref": "ContactInformation" }, "type": "array" }, "hasCreatorSignedOff": { "type": "boolean", "description": "If the creator has already signed off on the product, then the buyer can finalize the deal by accepting the product as is. When copying to a proposal, if any of the terms are changed, then auto_finalize is automatically set to false." }, "createTime": { "description": "Creation time.", "format": "google-datetime", "type": "string" }, "updateTime": { "description": "Time of last update.", "format": "google-datetime", "type": "string" }, "displayName": { "type": "string", "description": "The display name for this product as set by the seller." }, "seller": { "description": "Information about the seller that created this product.", "$ref": "Seller" } }, "description": "A product is a segment of inventory that a seller wants to sell. It is associated with certain terms and targeting information which helps the buyer know more about the inventory.", "id": "Product" }, "CancelNegotiationRequest": { "type": "object", "properties": {}, "description": "Request to cancel an ongoing negotiation.", "id": "CancelNegotiationRequest" }, "InventorySizeTargeting": { "description": "Represents the size of an ad unit that can be targeted on an ad request. It only applies to Private Auction, AdX Preferred Deals and Auction Packages. This targeting does not apply to Programmatic Guaranteed and Preferred Deals in Ad Manager.", "id": "InventorySizeTargeting", "type": "object", "properties": { "excludedInventorySizes": { "description": "A list of inventory sizes to be excluded.", "items": { "$ref": "AdSize" }, "type": "array" }, "targetedInventorySizes": { "items": { "$ref": "AdSize" }, "type": "array", "description": "A list of inventory sizes to be included." } } }, "ListClientsResponse": { "id": "ListClientsResponse", "type": "object", "properties": { "clients": { "items": { "$ref": "Client" }, "type": "array", "description": "The returned list of clients." }, "nextPageToken": { "type": "string", "description": "A token to retrieve the next page of results. Pass this value in the ListClientsRequest.pageToken field in the subsequent call to the accounts.clients.list method to retrieve the next page of results." } } }, "TimeInterval": { "description": "An interval of time, with an absolute start and end.", "id": "TimeInterval", "type": "object", "properties": { "startTime": { "format": "google-datetime", "description": "The timestamp marking the start of the range (inclusive) for which data is included.", "type": "string" }, "endTime": { "type": "string", "format": "google-datetime", "description": "The timestamp marking the end of the range (exclusive) for which data is included." } } }, "TechnologyTargeting": { "type": "object", "properties": { "deviceCategoryTargeting": { "description": "IDs of device categories to be included/excluded.", "$ref": "CriteriaTargeting" }, "operatingSystemTargeting": { "description": "Operating system related targeting information.", "$ref": "OperatingSystemTargeting" }, "deviceCapabilityTargeting": { "description": "IDs of device capabilities to be included/excluded.", "$ref": "CriteriaTargeting" } }, "description": "Represents targeting about various types of technology.", "id": "TechnologyTargeting" }, "RealtimeTimeRange": { "description": "An open-ended realtime time range specified by the start timestamp. For filter sets that specify a realtime time range RTB metrics continue to be aggregated throughout the lifetime of the filter set.", "id": "RealtimeTimeRange", "type": "object", "properties": { "startTimestamp": { "format": "google-datetime", "description": "The start timestamp of the real-time RTB metrics aggregation.", "type": "string" } } }, "ResumeProposalDealsRequest": { "type": "object", "properties": { "externalDealIds": { "items": { "type": "string" }, "type": "array", "description": "The external_deal_id's of the deals to resume. If empty, all the deals in the proposal will be resumed." } }, "id": "ResumeProposalDealsRequest", "description": "Request message to resume (unpause) serving for already-finalized deals." }, "BidMetricsRow": { "type": "object", "properties": { "billedImpressions": { "description": "The number of bids for which the buyer was billed. Also called valid impressions as invalid impressions are not billed.", "$ref": "MetricValue" }, "bids": { "description": "The number of bids that Ad Exchange received from the buyer.", "$ref": "MetricValue" }, "impressionsWon": { "description": "The number of bids that won the auction.", "$ref": "MetricValue" }, "reachedQueries": { "description": "The number of bids that won the auction and also won the mediation waterfall (if any).", "$ref": "MetricValue" }, "bidsInAuction": { "description": "The number of bids that were permitted to compete in the auction.", "$ref": "MetricValue" }, "viewableImpressions": { "description": "The number of bids for which the corresponding impression was viewable (as defined by Active View).", "$ref": "MetricValue" }, "measurableImpressions": { "description": "The number of bids for which the corresponding impression was measurable for viewability (as defined by Active View).", "$ref": "MetricValue" }, "rowDimensions": { "description": "The values of all dimensions associated with metric values in this row.", "$ref": "RowDimensions" } }, "description": "The set of metrics that are measured in numbers of bids, representing how many bids with the specified dimension values were considered eligible at each stage of the bidding funnel;", "id": "BidMetricsRow" }, "OperatingSystemTargeting": { "description": "Represents targeting information for operating systems.", "id": "OperatingSystemTargeting", "type": "object", "properties": { "operatingSystemVersionCriteria": { "description": "IDs of operating system versions to be included/excluded.", "$ref": "CriteriaTargeting" }, "operatingSystemCriteria": { "description": "IDs of operating systems to be included/excluded.", "$ref": "CriteriaTargeting" } } }, "VideoContent": { "type": "object", "properties": { "videoVastXml": { "description": "The contents of a VAST document for a video ad. This document should conform to the VAST 2.0 or 3.0 standard.", "type": "string" }, "videoUrl": { "description": "The URL to fetch a video ad.", "type": "string" } }, "id": "VideoContent", "description": "Video content for a creative." }, "CreativeDealAssociation": { "id": "CreativeDealAssociation", "description": "The association between a creative and a deal.", "type": "object", "properties": { "dealsId": { "description": "The externalDealId for the deal associated with the creative.", "type": "string" }, "accountId": { "type": "string", "description": "The account the creative belongs to." }, "creativeId": { "description": "The ID of the creative associated with the deal.", "type": "string" } } }, "PrivateData": { "description": "Buyers are allowed to store certain types of private data in a proposal/deal.", "id": "PrivateData", "type": "object", "properties": { "referenceId": { "type": "string", "description": "A buyer or seller specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units)." } } }, "ListCreativeStatusBreakdownByDetailResponse": { "type": "object", "properties": { "nextPageToken": { "type": "string", "description": "A token to retrieve the next page of results. Pass this value in the ListCreativeStatusBreakdownByDetailRequest.pageToken field in the subsequent call to the filteredBids.details.list method to retrieve the next page of results." }, "filteredBidDetailRows": { "type": "array", "items": { "$ref": "FilteredBidDetailRow" }, "description": "List of rows, with counts of bids with a given creative status aggregated by detail." }, "detailType": { "type": "string", "enum": [ "DETAIL_TYPE_UNSPECIFIED", "CREATIVE_ATTRIBUTE", "VENDOR", "SENSITIVE_CATEGORY", "PRODUCT_CATEGORY", "DISAPPROVAL_REASON", "POLICY_TOPIC", "ATP_VENDOR", "VENDOR_DOMAIN", "GVL_ID" ], "description": "The type of detail that the detail IDs represent.", "enumDescriptions": [ "A placeholder for an undefined status. This value will never be returned in responses.", "Indicates that the detail ID refers to a creative attribute; see [publisher-excludable-creative-attributes](https://developers.google.com/authorized-buyers/rtb/downloads/publisher-excludable-creative-attributes).", "Indicates that the detail ID refers to a vendor; see [vendors](https://developers.google.com/authorized-buyers/rtb/downloads/vendors). This namespace is different from that of the `ATP_VENDOR` detail type.", "Indicates that the detail ID refers to a sensitive category; see [ad-sensitive-categories](https://developers.google.com/authorized-buyers/rtb/downloads/ad-sensitive-categories).", "Indicates that the detail ID refers to a product category; see [ad-product-categories](https://developers.google.com/authorized-buyers/rtb/downloads/ad-product-categories).", "Indicates that the detail ID refers to a disapproval reason; see DisapprovalReason enum in [snippet-status-report-proto](https://developers.google.com/authorized-buyers/rtb/downloads/snippet-status-report-proto).", "Indicates that the detail ID refers to a policy topic.", "Indicates that the detail ID refers to an ad technology provider (ATP); see [providers] (https://storage.googleapis.com/adx-rtb-dictionaries/providers.csv). This namespace is different from the `VENDOR` detail type; see [ad technology providers](https://support.google.com/admanager/answer/9012903) for more information.", "Indicates that the detail string refers the domain of an unknown vendor.", "Indicates that the detail ID refers an IAB GVL ID which Google did not detect in the latest TCF Vendor List. See [Global Vendor List] (https://vendor-list.consensu.org/v2/vendor-list.json)" ] } }, "description": "Response message for listing all details associated with a given filtered bid reason.", "id": "ListCreativeStatusBreakdownByDetailResponse" }, "Date": { "type": "object", "properties": { "day": { "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", "format": "int32", "type": "integer" }, "year": { "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", "format": "int32", "type": "integer" }, "month": { "format": "int32", "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", "type": "integer" } }, "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp", "id": "Date" }, "Image": { "type": "object", "properties": { "url": { "description": "The URL of the image.", "type": "string" }, "width": { "description": "Image width in pixels.", "format": "int32", "type": "integer" }, "height": { "format": "int32", "description": "Image height in pixels.", "type": "integer" } }, "id": "Image", "description": "An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved." }, "Proposal": { "id": "Proposal", "description": "Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer and contains deals which are served. Note: You can't update, create, or otherwise modify Private Auction deals through the API. Fields are updatable unless noted otherwise.", "type": "object", "properties": { "originatorRole": { "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." ], "type": "string", "enum": [ "BUYER_SELLER_ROLE_UNSPECIFIED", "BUYER", "SELLER" ] }, "isSetupComplete": { "description": "Output only. True, if the buyside inventory setup is complete for this proposal.", "readOnly": true, "deprecated": true, "type": "boolean" }, "sellerContacts": { "readOnly": true, "items": { "$ref": "ContactInformation" }, "type": "array", "description": "Output only. Contact information for the seller." }, "buyerPrivateData": { "description": "Private data for buyer. (hidden from seller).", "$ref": "PrivateData" }, "lastUpdaterOrCommentorRole": { "readOnly": true, "description": "Output only. The role of the last user that either updated the proposal or left a comment.", "type": "string", "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." ] }, "termsAndConditions": { "type": "string", "readOnly": true, "description": "Output only. The terms and conditions set by the publisher for this proposal." }, "buyer": { "description": "Reference to the buyer on the proposal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.", "$ref": "Buyer" }, "billedBuyer": { "readOnly": true, "description": "Output only. Reference to the buyer that will get billed for this proposal.", "$ref": "Buyer" }, "notes": { "description": "Output only. The notes associated with this proposal.", "type": "array", "readOnly": true, "items": { "$ref": "Note" } }, "deals": { "items": { "$ref": "Deal" }, "type": "array", "description": "The deals associated with this proposal. For Private Auction proposals (whose deals have NonGuaranteedAuctionTerms), there will only be one deal." }, "buyerContacts": { "type": "array", "items": { "$ref": "ContactInformation" }, "description": "Contact information for the buyer." }, "proposalRevision": { "readOnly": true, "type": "string", "description": "Output only. The revision number for the proposal. Each update to the proposal or the 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.", "format": "int64" }, "proposalId": { "description": "Output only. The unique ID of the proposal.", "type": "string", "readOnly": true }, "seller": { "description": "Reference to the seller on the proposal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.", "$ref": "Seller" }, "privateAuctionId": { "description": "Output only. Private auction ID if this proposal is a private auction proposal.", "readOnly": true, "type": "string" }, "proposalState": { "enumDescriptions": [ "A placeholder for an undefined proposal state.", "The proposal is under negotiation or renegotiation.", "The proposal has been accepted by the buyer.", "The proposal has been accepted by the seller.", "The negotiations on the proposal were canceled and the proposal was never finalized.", "The proposal is finalized. During renegotiation, the proposal may not be in this state." ], "type": "string", "enum": [ "PROPOSAL_STATE_UNSPECIFIED", "PROPOSED", "BUYER_ACCEPTED", "SELLER_ACCEPTED", "CANCELED", "FINALIZED" ], "description": "Output only. The current state of the proposal.", "readOnly": true }, "isRenegotiating": { "description": "Output only. True if the proposal is being renegotiated.", "type": "boolean", "readOnly": true }, "updateTime": { "description": "Output only. The time when the proposal was last revised.", "format": "google-datetime", "readOnly": true, "type": "string" }, "displayName": { "type": "string", "description": "The name for the proposal." } } }, "AdTechnologyProviders": { "description": "Detected ad technology provider information.", "id": "AdTechnologyProviders", "type": "object", "properties": { "detectedProviderIds": { "items": { "type": "string", "format": "int64" }, "type": "array", "description": "The detected ad technology provider IDs for this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/providers.csv for mapping of provider ID to provided name, a privacy policy URL, and a list of domains which can be attributed to the provider. If the creative contains provider IDs that are outside of those listed in the `BidRequest.adslot.consented_providers_settings.consented_providers` field on the (Google bid protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto] and the `BidRequest.user.ext.consented_providers_settings.consented_providers` field on the (OpenRTB protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto], and a bid is submitted with that creative for an impression that will serve to an EEA user, the bid will be filtered before the auction." }, "hasUnidentifiedProvider": { "type": "boolean", "description": "Whether the creative contains an unidentified ad technology provider. If true for a given creative, any bid submitted with that creative for an impression that will serve to an EEA user will be filtered before the auction." } } }, "AddNoteRequest": { "description": "Request message for adding a note to a given proposal.", "id": "AddNoteRequest", "type": "object", "properties": { "note": { "description": "Details of the note to add.", "$ref": "Note" } } }, "ListDealAssociationsResponse": { "type": "object", "properties": { "associations": { "type": "array", "items": { "$ref": "CreativeDealAssociation" }, "description": "The list of associations." }, "nextPageToken": { "description": "A token to retrieve the next page of results. Pass this value in the ListDealAssociationsRequest.page_token field in the subsequent call to 'ListDealAssociation' method to retrieve the next page of results.", "type": "string" } }, "id": "ListDealAssociationsResponse", "description": "A response for listing creative and deal associations" }, "ListClientUsersResponse": { "id": "ListClientUsersResponse", "type": "object", "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 clients.invitations.list method to retrieve the next page of results.", "type": "string" }, "users": { "type": "array", "items": { "$ref": "ClientUser" }, "description": "The returned list of client users." } } }, "ListProductsResponse": { "description": "Response message for listing products visible to the buyer.", "id": "ListProductsResponse", "type": "object", "properties": { "products": { "type": "array", "items": { "$ref": "Product" }, "description": "The list of matching products at their head revision number." }, "nextPageToken": { "type": "string", "description": "List pagination support." } } }, "ListBidResponsesWithoutBidsResponse": { "description": "Response message for listing all reasons that bid responses were considered to have no applicable bids.", "id": "ListBidResponsesWithoutBidsResponse", "type": "object", "properties": { "bidResponseWithoutBidsStatusRows": { "items": { "$ref": "BidResponseWithoutBidsStatusRow" }, "type": "array", "description": "List of rows, with counts of bid responses without bids aggregated by status." }, "nextPageToken": { "description": "A token to retrieve the next page of results. Pass this value in the ListBidResponsesWithoutBidsRequest.pageToken field in the subsequent call to the bidResponsesWithoutBids.list method to retrieve the next page of results.", "type": "string" } } }, "AcceptProposalRequest": { "id": "AcceptProposalRequest", "description": "Request to accept a proposal.", "type": "object", "properties": { "proposalRevision": { "format": "int64", "description": "The last known client revision number of the proposal.", "type": "string" } } }, "DeliveryControl": { "id": "DeliveryControl", "description": "Message contains details about how the deals will be paced.", "type": "object", "properties": { "frequencyCaps": { "readOnly": true, "items": { "$ref": "FrequencyCap" }, "type": "array", "description": "Output only. Specifies any frequency caps." }, "creativeBlockingLevel": { "enumDescriptions": [ "A placeholder for an undefined creative blocking level.", "Publisher blocking rules will be applied.", "The Ad Exchange policy blocking rules will be applied." ], "type": "string", "enum": [ "CREATIVE_BLOCKING_LEVEL_UNSPECIFIED", "PUBLISHER_BLOCKING_RULES", "ADX_POLICY_BLOCKING_ONLY" ], "description": "Output only. Specified the creative blocking levels to be applied.", "readOnly": true }, "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." ], "type": "string", "enum": [ "DELIVERY_RATE_TYPE_UNSPECIFIED", "EVENLY", "FRONT_LOADED", "AS_FAST_AS_POSSIBLE" ], "description": "Output only. Specifies how the impression delivery will be paced.", "readOnly": true } } }, "AppContext": { "description": "Output only. The app type the restriction applies to for mobile device.", "id": "AppContext", "type": "object", "properties": { "appTypes": { "type": "array", "items": { "type": "string", "enum": [ "NATIVE", "WEB" ], "enumDescriptions": [ "Native app context.", "Mobile web app context." ] }, "description": "The app types this restriction applies to." } } }, "ListBidMetricsResponse": { "id": "ListBidMetricsResponse", "description": "Response message for listing the metrics that are measured in number of bids.", "type": "object", "properties": { "bidMetricsRows": { "items": { "$ref": "BidMetricsRow" }, "type": "array", "description": "List of rows, each containing a set of bid metrics." }, "nextPageToken": { "description": "A token to retrieve the next page of results. Pass this value in the ListBidMetricsRequest.pageToken field in the subsequent call to the bidMetrics.list method to retrieve the next page of results.", "type": "string" } } }, "PricePerBuyer": { "type": "object", "properties": { "advertiserIds": { "description": "The list of advertisers for this price when associated with this buyer. If empty, all advertisers with this buyer pay this price.", "type": "array", "items": { "type": "string" } }, "price": { "description": "The specified price.", "$ref": "Price" }, "buyer": { "description": "The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).", "$ref": "Buyer" } }, "id": "PricePerBuyer", "description": "Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in a product can become 0 or 1 deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set." }, "FirstPartyMobileApplicationTargeting": { "type": "object", "properties": { "excludedAppIds": { "description": "A list of application IDs to be excluded.", "type": "array", "items": { "type": "string" } }, "targetedAppIds": { "items": { "type": "string" }, "type": "array", "description": "A list of application IDs to be included." } }, "id": "FirstPartyMobileApplicationTargeting", "description": "Represents a list of targeted and excluded mobile application IDs that publishers own. Mobile application IDs are from App Store and Google Play Store. 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." }, "TargetingValue": { "description": "A polymorphic targeting value used as part of Shared Targeting.", "id": "TargetingValue", "type": "object", "properties": { "dayPartTargetingValue": { "description": "The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING. The definition of this targeting is derived from the structure used by Ad Manager.", "$ref": "DayPartTargeting" }, "creativeSizeValue": { "description": "The creative size value to include/exclude. Filled in when key = GOOG_CREATIVE_SIZE", "$ref": "CreativeSize" }, "longValue": { "description": "The long value to include/exclude.", "format": "int64", "type": "string" }, "stringValue": { "description": "The string value to include/exclude.", "type": "string" } } }, "Seller": { "id": "Seller", "description": "Represents a seller of inventory. Each seller is identified by a unique Ad Manager account ID.", "type": "object", "properties": { "accountId": { "type": "string", "description": "The unique ID for the seller. The seller fills in this field. The seller account ID is then available to buyer in the product." }, "subAccountId": { "type": "string", "readOnly": true, "description": "Output only. Ad manager network code for the seller." } } }, "VideoTargeting": { "description": "Represents targeting information about video.", "id": "VideoTargeting", "type": "object", "properties": { "targetedPositionTypes": { "description": "A list of video positions to be included. When the included list is present, the excluded list must be empty. When the excluded list is present, the included list must be empty.", "items": { "type": "string", "enum": [ "POSITION_TYPE_UNSPECIFIED", "PREROLL", "MIDROLL", "POSTROLL" ], "enumDescriptions": [ "A placeholder for an undefined video position.", "Ad is played before the video.", "Ad is played during the video.", "Ad is played after the video." ] }, "type": "array" }, "excludedPositionTypes": { "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." ], "type": "string", "enum": [ "POSITION_TYPE_UNSPECIFIED", "PREROLL", "MIDROLL", "POSTROLL" ] }, "type": "array", "description": "A list of video positions to be excluded. Position types can either be included or excluded (XOR)." } } }, "CreativeRestrictions": { "type": "object", "properties": { "creativeSpecifications": { "items": { "$ref": "CreativeSpecification" }, "type": "array" }, "creativeFormat": { "type": "string", "enum": [ "CREATIVE_FORMAT_UNSPECIFIED", "DISPLAY", "VIDEO" ], "description": "The format of the environment that the creatives will be displayed in.", "enumDescriptions": [ "A placeholder for an undefined creative format.", "A creative that will be displayed in environments such as a browser.", "A video creative that will be displayed in environments such as a video player." ] }, "skippableAdType": { "type": "string", "enum": [ "SKIPPABLE_AD_TYPE_UNSPECIFIED", "SKIPPABLE", "INSTREAM_SELECT", "NOT_SKIPPABLE" ], "description": "Skippable video ads allow viewers to skip ads after 5 seconds.", "enumDescriptions": [ "A placeholder for an undefined skippable ad type.", "This video ad can be skipped after 5 seconds.", "This video ad 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 video ad is not skippable." ] } }, "id": "CreativeRestrictions", "description": "Represents creative restrictions associated to Programmatic Guaranteed/ Preferred Deal in Ad Manager. This doesn't apply to Private Auction and AdX Preferred Deals." }, "ListNonBillableWinningBidsResponse": { "id": "ListNonBillableWinningBidsResponse", "description": "Response message for listing all reasons for which a buyer was not billed for a winning bid.", "type": "object", "properties": { "nextPageToken": { "description": "A token to retrieve the next page of results. Pass this value in the ListNonBillableWinningBidsRequest.pageToken field in the subsequent call to the nonBillableWinningBids.list method to retrieve the next page of results.", "type": "string" }, "nonBillableWinningBidStatusRows": { "type": "array", "items": { "$ref": "NonBillableWinningBidStatusRow" }, "description": "List of rows, with counts of bids not billed aggregated by reason." } } }, "ImpressionMetricsRow": { "type": "object", "properties": { "availableImpressions": { "description": "The number of impressions available to the buyer on Ad Exchange. In some cases this value may be unavailable.", "$ref": "MetricValue" }, "responsesWithBids": { "description": "The number of impressions for which Ad Exchange received a response from the buyer that contained at least one applicable bid.", "$ref": "MetricValue" }, "inventoryMatches": { "description": "The number of impressions that match the buyer's inventory pretargeting.", "$ref": "MetricValue" }, "bidRequests": { "description": "The number of impressions for which Ad Exchange sent the buyer a bid request.", "$ref": "MetricValue" }, "rowDimensions": { "description": "The values of all dimensions associated with metric values in this row.", "$ref": "RowDimensions" }, "successfulResponses": { "description": "The number of impressions for which the buyer successfully sent a response to Ad Exchange.", "$ref": "MetricValue" } }, "description": "The set of metrics that are measured in numbers of impressions, representing how many impressions with the specified dimension values were considered eligible at each stage of the bidding funnel.", "id": "ImpressionMetricsRow" }, "ListProposalsResponse": { "type": "object", "properties": { "nextPageToken": { "description": "Continuation token for fetching the next page of results.", "type": "string" }, "proposals": { "type": "array", "items": { "$ref": "Proposal" }, "description": "The list of proposals." } }, "id": "ListProposalsResponse", "description": "Response message for listing proposals." }, "MarketplaceTargeting": { "type": "object", "properties": { "technologyTargeting": { "description": "Technology targeting information, for example, operating system, device category.", "$ref": "TechnologyTargeting" }, "geoTargeting": { "description": "Geo criteria IDs to be included/excluded.", "$ref": "CriteriaTargeting" }, "inventorySizeTargeting": { "description": "Inventory sizes to be included/excluded.", "$ref": "InventorySizeTargeting" }, "videoTargeting": { "description": "Video targeting information.", "$ref": "VideoTargeting" }, "placementTargeting": { "description": "Placement targeting information, for example, URL, mobile applications.", "$ref": "PlacementTargeting" } }, "id": "MarketplaceTargeting", "description": "Targeting represents different criteria that can be used by advertisers to target ad inventory. For example, they can choose to target ad requests only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise." }, "ListBidResponseErrorsResponse": { "id": "ListBidResponseErrorsResponse", "description": "Response message for listing all reasons that bid responses resulted in an error.", "type": "object", "properties": { "calloutStatusRows": { "description": "List of rows, with counts of bid responses aggregated by callout status.", "items": { "$ref": "CalloutStatusRow" }, "type": "array" }, "nextPageToken": { "description": "A token to retrieve the next page of results. Pass this value in the ListBidResponseErrorsRequest.pageToken field in the subsequent call to the bidResponseErrors.list method to retrieve the next page of results.", "type": "string" } } }, "ListFilteredBidsResponse": { "type": "object", "properties": { "nextPageToken": { "type": "string", "description": "A token to retrieve the next page of results. Pass this value in the ListFilteredBidsRequest.pageToken field in the subsequent call to the filteredBids.list method to retrieve the next page of results." }, "creativeStatusRows": { "type": "array", "items": { "$ref": "CreativeStatusRow" }, "description": "List of rows, with counts of filtered bids aggregated by filtering reason (for example, creative status)." } }, "id": "ListFilteredBidsResponse", "description": "Response message for listing all reasons that bids were filtered from the auction." }, "PauseProposalDealsRequest": { "type": "object", "properties": { "externalDealIds": { "description": "The external_deal_id's of the deals to be paused. If empty, all the deals in the proposal will be paused.", "items": { "type": "string" }, "type": "array" }, "reason": { "type": "string", "description": "The reason why the deals are being paused. This human readable message will be displayed in the seller's UI. (Max length: 1000 unicode code units.)" } }, "description": "Request message to pause serving for finalized deals.", "id": "PauseProposalDealsRequest" }, "AddDealAssociationRequest": { "description": "A request for associating a deal and a creative.", "id": "AddDealAssociationRequest", "type": "object", "properties": { "association": { "description": "The association between a creative and a deal that should be added.", "$ref": "CreativeDealAssociation" } } }, "CreativeStatusRow": { "description": "The number of bids with the specified dimension values that did not win the auction (either were filtered pre-auction or lost the auction), as described by the specified creative status.", "id": "CreativeStatusRow", "type": "object", "properties": { "bidCount": { "description": "The number of bids with the specified status.", "$ref": "MetricValue" }, "creativeStatusId": { "type": "integer", "format": "int32", "description": "The ID of the creative status. See [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes)." }, "rowDimensions": { "description": "The values of all dimensions associated with metric values in this row.", "$ref": "RowDimensions" } } }, "RelativeDateRange": { "type": "object", "properties": { "offsetDays": { "format": "int32", "description": "The end date of the filter set, specified as the number of days before today, for example, for a range where the last date is today: 0.", "type": "integer" }, "durationDays": { "type": "integer", "description": "The number of days in the requested date range, for example, for a range spanning today: 1. For a range spanning the last 7 days: 7.", "format": "int32" } }, "description": "A relative date range, specified by an offset and a duration. The supported range of dates begins 30 days before today and ends today, for example, the limits for these values are: offset_days \u003e= 0 duration_days \u003e= 1 offset_days + duration_days \u003c= 30", "id": "RelativeDateRange" }, "DealServingMetadata": { "type": "object", "properties": { "dealPauseStatus": { "readOnly": true, "description": "Output only. Tracks which parties (if any) have paused a deal.", "$ref": "DealPauseStatus" } }, "id": "DealServingMetadata", "description": "Message captures metadata about the serving status of a deal." }, "ListImpressionMetricsResponse": { "description": "Response message for listing the metrics that are measured in number of impressions.", "id": "ListImpressionMetricsResponse", "type": "object", "properties": { "impressionMetricsRows": { "items": { "$ref": "ImpressionMetricsRow" }, "type": "array", "description": "List of rows, each containing a set of impression metrics." }, "nextPageToken": { "description": "A token to retrieve the next page of results. Pass this value in the ListImpressionMetricsRequest.pageToken field in the subsequent call to the impressionMetrics.list method to retrieve the next page of results.", "type": "string" } } }, "CriteriaTargeting": { "type": "object", "properties": { "targetedCriteriaIds": { "description": "A list of numeric IDs to be included.", "items": { "type": "string", "format": "int64" }, "type": "array" }, "excludedCriteriaIds": { "description": "A list of numeric IDs to be excluded.", "type": "array", "items": { "type": "string", "format": "int64" } } }, "description": "Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs.", "id": "CriteriaTargeting" }, "ListPublisherProfilesResponse": { "description": "Response message for profiles visible to the buyer.", "id": "ListPublisherProfilesResponse", "type": "object", "properties": { "publisherProfiles": { "description": "The list of matching publisher profiles.", "type": "array", "items": { "$ref": "PublisherProfile" } }, "nextPageToken": { "type": "string", "description": "List pagination support" } } }, "DayPart": { "id": "DayPart", "description": "Daypart targeting message that specifies if the ad can be shown only during certain parts of a day/week.", "type": "object", "properties": { "endTime": { "description": "The ending time of the day for the ad to show (minute level granularity). The end time is exclusive. This field is not available for filtering in PQL queries.", "$ref": "TimeOfDay" }, "dayOfWeek": { "type": "string", "enum": [ "DAY_OF_WEEK_UNSPECIFIED", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ], "description": "The day of the week to target. If unspecified, applicable to all days.", "enumDescriptions": [ "A placeholder for when the day of the week is not specified.", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ] }, "startTime": { "description": "The starting time of day for the ad to show (minute level granularity). The start time is inclusive. This field is not available for filtering in PQL queries.", "$ref": "TimeOfDay" } } }, "AbsoluteDateRange": { "id": "AbsoluteDateRange", "description": "An absolute date range, specified by its start date and end date. The supported range of dates begins 30 days before today and ends today. Validity checked upon filter set creation. If a filter set with an absolute date range is run at a later date more than 30 days after start_date, it will fail.", "type": "object", "properties": { "startDate": { "description": "The start date of the range (inclusive). Must be within the 30 days leading up to current date, and must be equal to or before end_date.", "$ref": "Date" }, "endDate": { "description": "The end date of the range (inclusive). Must be within the 30 days leading up to current date, and must be equal to or after start_date.", "$ref": "Date" } } }, "Client": { "id": "Client", "description": "A client resource represents a client buyer—an agency, a brand, or an advertiser customer of the sponsor buyer. Users associated with the client buyer have restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the client buyer. All fields are required unless otherwise specified.", "type": "object", "properties": { "partnerClientId": { "description": "Optional arbitrary unique identifier of this client buyer from the standpoint of its Ad Exchange sponsor buyer. This field can be used to associate a client buyer with the identifier in the namespace of its sponsor buyer, lookup client buyers by that identifier and verify whether an Ad Exchange counterpart of a given client buyer already exists. If present, must be unique among all the client buyers for its Ad Exchange sponsor buyer.", "type": "string" }, "entityName": { "description": "The name of the entity. This field is automatically fetched based on the type and ID. The value of this field is ignored in create and update operations.", "type": "string" }, "role": { "description": "The role which is assigned to the client buyer. Each role implies a set of permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`, `CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.", "enumDescriptions": [ "A placeholder for an undefined client role.", "Users associated with this client can see publisher deal offers in the Marketplace. They can neither negotiate proposals nor approve deals. If this client is visible to publishers, they can send deal proposals to this client.", "Users associated with this client can respond to deal proposals sent to them by publishers. They can also initiate deal proposals of their own.", "Users associated with this client can approve eligible deals on your behalf. Some deals may still explicitly require publisher finalization. If this role is not selected, the sponsor buyer will need to manually approve each of their deals." ], "type": "string", "enum": [ "CLIENT_ROLE_UNSPECIFIED", "CLIENT_DEAL_VIEWER", "CLIENT_DEAL_NEGOTIATOR", "CLIENT_DEAL_APPROVER" ] }, "status": { "type": "string", "enum": [ "CLIENT_STATUS_UNSPECIFIED", "DISABLED", "ACTIVE" ], "description": "The status of the client buyer.", "enumDescriptions": [ "A placeholder for an undefined client status.", "A client that is currently disabled.", "A client that is currently active." ] }, "clientAccountId": { "type": "string", "description": "The globally-unique numerical ID of the client. The value of this field is ignored in create and update operations.", "format": "int64" }, "entityId": { "description": "Numerical identifier of the client entity. The entity can be an advertiser, a brand, or an agency. This identifier is unique among all the entities with the same type. The value of this field is ignored if the entity type is not provided. A list of all known advertisers with their identifiers is available in the [advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt) file. A list of all known brands with their identifiers is available in the [brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt) file. A list of all known agencies with their identifiers is available in the [agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt) file.", "format": "int64", "type": "string" }, "entityType": { "description": "An optional field for specifying the type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.", "enumDescriptions": [ "A placeholder for an undefined client entity type. Should not be used.", "An advertiser.", "A brand.", "An advertising agency.", "An explicit value for a client that was not yet classified as any particular entity." ], "type": "string", "enum": [ "ENTITY_TYPE_UNSPECIFIED", "ADVERTISER", "BRAND", "AGENCY", "ENTITY_TYPE_UNCLASSIFIED" ] }, "clientName": { "type": "string", "description": "Name used to represent this client to publishers. You may have multiple clients that map to the same entity, but for each client the combination of `clientName` and entity must be unique. You can specify this field as empty. Maximum length of 255 characters is allowed." }, "visibleToSeller": { "type": "boolean", "description": "Whether the client buyer will be visible to sellers." } } }, "Disapproval": { "type": "object", "properties": { "details": { "items": { "type": "string" }, "type": "array", "description": "Additional details about the reason for disapproval." }, "reason": { "description": "The categorized reason for disapproval.", "enumDescriptions": [ "The length of the image animation is longer than allowed.", "The click through URL doesn't work properly.", "Something is wrong with the creative itself.", "The ad makes a fourth party call to an unapproved vendor.", "The ad targets consumers using remarketing lists and/or collects data for subsequent use in retargeting, but does not correctly declare that use.", "Clicking on the ad leads to an error page.", "The ad size when rendered does not match the declaration.", "Ads with a white background require a border, which was missing.", "The creative attempts to set cookies from a fourth party that is not certified.", "The creative sets an LSO object.", "The ad serves a blank.", "The ad uses rotation, but not all destination URLs were declared.", "There is a problem with the way the click macro is used.", "The ad technology declaration is not accurate.", "The actual destination URL does not match the declared destination URL.", "The declared expanding direction does not match the actual direction.", "The ad does not expand in a supported direction.", "The ad uses an expandable vendor that is not supported.", "There was an issue with the expandable ad.", "The ad uses a video vendor that is not supported.", "The length of the video ad is not supported.", "The format of the video ad is not supported.", "There was an issue with the video ad.", "The landing page does not conform to Ad Exchange policy.", "The ad or the landing page may contain malware.", "The ad contains adult images or video content.", "The ad contains text that is unclear or inaccurate.", "The ad promotes counterfeit designer goods.", "The ad causes a popup window to appear.", "The creative does not follow policies set for the RTB protocol.", "The ad contains a URL that uses a numeric IP address for the domain.", "The ad or landing page contains unacceptable content because it initiated a software or executable download.", "The ad set an unauthorized cookie on a Google domain.", "Flash content found when no flash was declared.", "SSL support declared but not working correctly.", "Rich Media - Direct Download in Ad (ex. PDF download).", "Maximum download size exceeded.", "Bad Destination URL: Site Not Crawlable.", "Bad URL: Legal disapproval.", "Pharmaceuticals, Gambling, Alcohol not allowed and at least one was detected.", "Dynamic DNS at Destination URL.", "Poor Image / Video Quality.", "For example, Image Trick to Click.", "Incorrect Image Layout.", "Irrelevant Image / Video.", "Broken back button.", "Misleading/Inaccurate claims in ads.", "Restricted Products.", "Unacceptable content. For example, malware.", "The ad automatically redirects to the destination site without a click, or reports a click when none were made.", "The ad uses URL protocols that do not exist or are not allowed on AdX.", "Restricted content (for example, alcohol) was found in the ad but not declared.", "Violation of the remarketing list policy.", "The destination site's robot.txt file prevents it from being crawled.", "Click to download must link to an app.", "A review extension must be an accurate review.", "Sexually explicit content.", "The ad tries to gain an unfair traffic advantage.", "The ad tries to circumvent Google's advertising systems.", "The ad promotes dangerous knives.", "The ad promotes explosives.", "The ad promotes guns & parts.", "The ad promotes recreational drugs/services & related equipment.", "The ad promotes tobacco products/services & related equipment.", "The ad promotes weapons.", "The ad is unclear or irrelevant to the destination site.", "The ad does not meet professional standards.", "The promotion is unnecessarily difficult to navigate.", "Violation of Google's policy for interest-based ads.", "Misuse of personal information.", "Omission of relevant information.", "Unavailable promotions.", "Misleading or unrealistic promotions.", "Offensive or inappropriate content.", "Capitalizing on sensitive events.", "Shocking content.", "Products & Services that enable dishonest behavior.", "The ad does not meet technical requirements.", "Restricted political content.", "Unsupported content.", "Invalid bidding method.", "Video length exceeds limits.", "Unacceptable content: Japanese healthcare.", "Online pharmacy ID required.", "Unacceptable content: Abortion.", "Unacceptable content: Birth control.", "Restricted in China.", "Unacceptable content: Korean healthcare.", "Non-family safe or adult content.", "Clinical trial recruitment.", "Maximum number of HTTP calls exceeded.", "Maximum number of cookies exceeded.", "Financial service ad does not adhere to specifications.", "Flash content was found in an unsupported context.", "Misuse by an Open Measurement SDK script.", "Use of an Open Measurement SDK vendor not on approved vendor list.", "Unacceptable landing page.", "Unsupported language.", "Non-SSL compliant.", "Temporary pausing of creative.", "Promotes services related to bail bonds.", "Promotes speculative and/or experimental medical treatments." ], "type": "string", "enum": [ "LENGTH_OF_IMAGE_ANIMATION", "BROKEN_URL", "MEDIA_NOT_FUNCTIONAL", "INVALID_FOURTH_PARTY_CALL", "INCORRECT_REMARKETING_DECLARATION", "LANDING_PAGE_ERROR", "AD_SIZE_DOES_NOT_MATCH_AD_SLOT", "NO_BORDER", "FOURTH_PARTY_BROWSER_COOKIES", "LSO_OBJECTS", "BLANK_CREATIVE", "DESTINATION_URLS_UNDECLARED", "PROBLEM_WITH_CLICK_MACRO", "INCORRECT_AD_TECHNOLOGY_DECLARATION", "INCORRECT_DESTINATION_URL_DECLARATION", "EXPANDABLE_INCORRECT_DIRECTION", "EXPANDABLE_DIRECTION_NOT_SUPPORTED", "EXPANDABLE_INVALID_VENDOR", "EXPANDABLE_FUNCTIONALITY", "VIDEO_INVALID_VENDOR", "VIDEO_UNSUPPORTED_LENGTH", "VIDEO_UNSUPPORTED_FORMAT", "VIDEO_FUNCTIONALITY", "LANDING_PAGE_DISABLED", "MALWARE_SUSPECTED", "ADULT_IMAGE_OR_VIDEO", "INACCURATE_AD_TEXT", "COUNTERFEIT_DESIGNER_GOODS", "POP_UP", "INVALID_RTB_PROTOCOL_USAGE", "RAW_IP_ADDRESS_IN_SNIPPET", "UNACCEPTABLE_CONTENT_SOFTWARE", "UNAUTHORIZED_COOKIE_ON_GOOGLE_DOMAIN", "UNDECLARED_FLASH_OBJECTS", "INVALID_SSL_DECLARATION", "DIRECT_DOWNLOAD_IN_AD", "MAXIMUM_DOWNLOAD_SIZE_EXCEEDED", "DESTINATION_URL_SITE_NOT_CRAWLABLE", "BAD_URL_LEGAL_DISAPPROVAL", "PHARMA_GAMBLING_ALCOHOL_NOT_ALLOWED", "DYNAMIC_DNS_AT_DESTINATION_URL", "POOR_IMAGE_OR_VIDEO_QUALITY", "UNACCEPTABLE_IMAGE_CONTENT", "INCORRECT_IMAGE_LAYOUT", "IRRELEVANT_IMAGE_OR_VIDEO", "DESTINATION_SITE_DOES_NOT_ALLOW_GOING_BACK", "MISLEADING_CLAIMS_IN_AD", "RESTRICTED_PRODUCTS", "UNACCEPTABLE_CONTENT", "AUTOMATED_AD_CLICKING", "INVALID_URL_PROTOCOL", "UNDECLARED_RESTRICTED_CONTENT", "INVALID_REMARKETING_LIST_USAGE", "DESTINATION_SITE_NOT_CRAWLABLE_ROBOTS_TXT", "CLICK_TO_DOWNLOAD_NOT_AN_APP", "INACCURATE_REVIEW_EXTENSION", "SEXUALLY_EXPLICIT_CONTENT", "GAINING_AN_UNFAIR_ADVANTAGE", "GAMING_THE_GOOGLE_NETWORK", "DANGEROUS_PRODUCTS_KNIVES", "DANGEROUS_PRODUCTS_EXPLOSIVES", "DANGEROUS_PRODUCTS_GUNS", "DANGEROUS_PRODUCTS_DRUGS", "DANGEROUS_PRODUCTS_TOBACCO", "DANGEROUS_PRODUCTS_WEAPONS", "UNCLEAR_OR_IRRELEVANT_AD", "PROFESSIONAL_STANDARDS", "DYSFUNCTIONAL_PROMOTION", "INVALID_INTEREST_BASED_AD", "MISUSE_OF_PERSONAL_INFORMATION", "OMISSION_OF_RELEVANT_INFORMATION", "UNAVAILABLE_PROMOTIONS", "MISLEADING_PROMOTIONS", "INAPPROPRIATE_CONTENT", "SENSITIVE_EVENTS", "SHOCKING_CONTENT", "ENABLING_DISHONEST_BEHAVIOR", "TECHNICAL_REQUIREMENTS", "RESTRICTED_POLITICAL_CONTENT", "UNSUPPORTED_CONTENT", "INVALID_BIDDING_METHOD", "VIDEO_TOO_LONG", "VIOLATES_JAPANESE_PHARMACY_LAW", "UNACCREDITED_PET_PHARMACY", "ABORTION", "CONTRACEPTIVES", "NEED_CERTIFICATES_TO_ADVERTISE_IN_CHINA", "KCDSP_REGISTRATION", "NOT_FAMILY_SAFE", "CLINICAL_TRIAL_RECRUITMENT", "MAXIMUM_NUMBER_OF_HTTP_CALLS_EXCEEDED", "MAXIMUM_NUMBER_OF_COOKIES_EXCEEDED", "PERSONAL_LOANS", "UNSUPPORTED_FLASH_CONTENT", "MISUSE_BY_OMID_SCRIPT", "NON_WHITELISTED_OMID_VENDOR", "DESTINATION_EXPERIENCE", "UNSUPPORTED_LANGUAGE", "NON_SSL_COMPLIANT", "TEMPORARY_PAUSE", "BAIL_BONDS", "EXPERIMENTAL_MEDICAL_TREATMENT" ] } }, "description": "Output only. The reason and details for a disapproval.", "id": "Disapproval" }, "ClientUser": { "id": "ClientUser", "description": "A client user is created under a client buyer and has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client buyer. The only way a new client user can be created is through accepting an email invitation (see the accounts.clients.invitations.create method). All fields are required unless otherwise specified.", "type": "object", "properties": { "clientAccountId": { "type": "string", "description": "Numerical account ID of the client buyer with which the user is associated; the buyer must be a client of the current sponsor buyer. The value of this field is ignored in an update operation.", "format": "int64" }, "userId": { "type": "string", "format": "int64", "description": "The unique numerical ID of the client user that has accepted an invitation. The value of this field is ignored in an update operation." }, "status": { "type": "string", "enum": [ "USER_STATUS_UNSPECIFIED", "PENDING", "ACTIVE", "DISABLED" ], "description": "The status of the client user.", "enumDescriptions": [ "A placeholder for an undefined user status.", "A user who was already created but hasn't accepted the invitation yet.", "A user that is currently active.", "A user that is currently disabled." ] }, "email": { "type": "string", "description": "User's email address. The value of this field is ignored in an update operation." } } }, "TargetingCriteria": { "type": "object", "properties": { "key": { "type": "string", "description": "The key representing the shared targeting criterion. Targeting criteria defined by Google ad servers will begin with GOOG_. Third parties may define their own keys. A list of permissible keys along with the acceptable values will be provided as part of the external documentation." }, "exclusions": { "description": "The list of values to exclude from targeting. Each value is AND'd together.", "type": "array", "items": { "$ref": "TargetingValue" } }, "inclusions": { "description": "The list of value to include as part of the targeting. Each value is OR'd together.", "type": "array", "items": { "$ref": "TargetingValue" } } }, "id": "TargetingCriteria", "description": "Advertisers can target different attributes of an ad slot. For example, they can choose to show ads only if the user is in the U.S. Such targeting criteria can be specified as part of Shared Targeting." }, "ClientUserInvitation": { "id": "ClientUserInvitation", "description": "An invitation for a new client user to get access to the Authorized Buyers UI. All fields are required unless otherwise specified.", "type": "object", "properties": { "invitationId": { "format": "int64", "description": "The unique numerical ID of the invitation that is sent to the user. The value of this field is ignored in create operations.", "type": "string" }, "clientAccountId": { "type": "string", "format": "int64", "description": "Numerical account ID of the client buyer that the invited user is associated with. The value of this field is ignored in create operations." }, "email": { "description": "The email address to which the invitation is sent. Email addresses should be unique among all client users under each sponsor buyer.", "type": "string" } } }, "NativeContent": { "description": "Native content for a creative.", "id": "NativeContent", "type": "object", "properties": { "starRating": { "format": "double", "description": "The app rating in the app store. Must be in the range [0-5].", "type": "number" }, "callToAction": { "description": "A label for the button that the user is supposed to click.", "type": "string" }, "advertiserName": { "type": "string", "description": "The name of the advertiser or sponsor, to be displayed in the ad creative." }, "clickTrackingUrl": { "description": "The URL to use for click tracking.", "type": "string" }, "videoUrl": { "description": "The URL to fetch a native video ad.", "type": "string" }, "priceDisplayText": { "description": "The price of the promoted app including currency info.", "type": "string" }, "logo": { "description": "A smaller image, for the advertiser's logo.", "$ref": "Image" }, "image": { "description": "A large image.", "$ref": "Image" }, "headline": { "description": "A short title for the ad.", "type": "string" }, "appIcon": { "description": "The app icon, for app download ads.", "$ref": "Image" }, "clickLinkUrl": { "type": "string", "description": "The URL that the browser/SDK will load when the user clicks the ad." }, "body": { "description": "A long description of the ad.", "type": "string" }, "storeUrl": { "description": "The URL to the app store to purchase/download the promoted app.", "deprecated": true, "type": "string" } } }, "GuaranteedFixedPriceTerms": { "id": "GuaranteedFixedPriceTerms", "description": "Terms for Programmatic Guaranteed Deals.", "type": "object", "properties": { "reservationType": { "type": "string", "enum": [ "RESERVATION_TYPE_UNSPECIFIED", "STANDARD", "SPONSORSHIP" ], "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." ] }, "minimumDailyLooks": { "description": "Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.", "format": "int64", "type": "string" }, "impressionCap": { "format": "int64", "description": "The lifetime impression cap for CPM sponsorship deals. The deal will stop serving when the cap is reached.", "type": "string" }, "fixedPrices": { "description": "Fixed price for the specified buyer.", "type": "array", "items": { "$ref": "PricePerBuyer" } }, "percentShareOfVoice": { "format": "int64", "description": "For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached.", "type": "string" }, "guaranteedLooks": { "description": "Count of guaranteed looks. Required for deal, optional for product. For CPD deals, buyer changes to guaranteed_looks will be ignored.", "format": "int64", "type": "string" }, "guaranteedImpressions": { "type": "string", "format": "int64", "description": "Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy." } } }, "CalloutStatusRow": { "id": "CalloutStatusRow", "description": "The number of impressions with the specified dimension values where the corresponding bid request or bid response was not successful, as described by the specified callout status.", "type": "object", "properties": { "calloutStatusId": { "type": "integer", "format": "int32", "description": "The ID of the callout status. See [callout-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/callout-status-codes)." }, "rowDimensions": { "description": "The values of all dimensions associated with metric values in this row.", "$ref": "RowDimensions" }, "impressionCount": { "description": "The number of impressions for which there was a bid request or bid response with the specified callout status.", "$ref": "MetricValue" } } }, "Size": { "type": "object", "properties": { "height": { "format": "int32", "description": "The height of the creative.", "type": "integer" }, "width": { "type": "integer", "description": "The width of the creative", "format": "int32" } }, "id": "Size", "description": "Message depicting the size of the creative. The units of width and height depend on the type of the targeting." }, "StopWatchingCreativeRequest": { "description": "A request for stopping notifications for changes to creative Status.", "id": "StopWatchingCreativeRequest", "type": "object", "properties": {} }, "ListFilteredBidRequestsResponse": { "id": "ListFilteredBidRequestsResponse", "description": "Response message for listing all reasons that bid requests were filtered and not sent to the buyer.", "type": "object", "properties": { "calloutStatusRows": { "description": "List of rows, with counts of filtered bid requests aggregated by callout status.", "type": "array", "items": { "$ref": "CalloutStatusRow" } }, "nextPageToken": { "description": "A token to retrieve the next page of results. Pass this value in the ListFilteredBidRequestsRequest.pageToken field in the subsequent call to the filteredBidRequests.list method to retrieve the next page of results.", "type": "string" } } }, "DealTerms": { "type": "object", "properties": { "nonGuaranteedFixedPriceTerms": { "description": "The terms for non-guaranteed fixed price deals.", "$ref": "NonGuaranteedFixedPriceTerms" }, "brandingType": { "description": "Visibility of the URL in bid requests. (default: BRANDED)", "enumDescriptions": [ "A placeholder for an undefined branding type.", "Full URL is included in bid requests.", "A TopLevelDomain or masked URL is sent in bid requests rather than the full one." ], "type": "string", "enum": [ "BRANDING_TYPE_UNSPECIFIED", "BRANDED", "SEMI_TRANSPARENT" ] }, "estimatedGrossSpend": { "description": "Non-binding estimate of the estimated gross spend for this deal. Can be set by buyer or seller.", "$ref": "Price" }, "guaranteedFixedPriceTerms": { "description": "The terms for guaranteed fixed price deals.", "$ref": "GuaranteedFixedPriceTerms" }, "description": { "description": "Publisher provided description for the terms.", "type": "string" }, "estimatedImpressionsPerDay": { "type": "string", "description": "Non-binding estimate of the impressions served per day. Can be set by buyer or seller.", "format": "int64" }, "sellerTimeZone": { "type": "string", "description": "The time zone name. For deals with Cost Per Day billing, defines the time zone used to mark the boundaries of a day. It should be an IANA TZ name, such as \"America/Los_Angeles\". For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones." }, "nonGuaranteedAuctionTerms": { "description": "The terms for non-guaranteed auction deals.", "$ref": "NonGuaranteedAuctionTerms" } }, "description": "The deal terms specify the details of a Product/deal. They specify things like price per buyer, the type of pricing model (for example, fixed price, auction) and expected impressions from the publisher.", "id": "DealTerms" }, "Buyer": { "type": "object", "properties": { "accountId": { "type": "string", "description": "Authorized Buyers account ID of the buyer." } }, "description": "Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID.", "id": "Buyer" }, "DealPauseStatus": { "description": "Tracks which parties (if any) have paused a deal. The deal is considered paused if either hasBuyerPaused or hasSellPaused is true.", "id": "DealPauseStatus", "type": "object", "properties": { "hasBuyerPaused": { "type": "boolean", "description": "True, if the buyer has paused the deal unilaterally." }, "firstPausedBy": { "description": "The role of the person who first paused this deal.", "enumDescriptions": [ "A placeholder for an undefined buyer/seller role.", "Specifies the role as buyer.", "Specifies the role as seller." ], "type": "string", "enum": [ "BUYER_SELLER_ROLE_UNSPECIFIED", "BUYER", "SELLER" ] }, "sellerPauseReason": { "type": "string", "description": "The seller's reason for pausing, if the seller paused the deal." }, "hasSellerPaused": { "type": "boolean", "description": "True, if the seller has paused the deal unilaterally." }, "buyerPauseReason": { "description": "The buyer's reason for pausing, if the buyer paused the deal.", "type": "string" } } }, "ResumeProposalRequest": { "type": "object", "properties": {}, "description": "Request message to resume (unpause) serving for an already-finalized proposal.", "id": "ResumeProposalRequest" }, "ListCreativesResponse": { "type": "object", "properties": { "creatives": { "description": "The list of creatives.", "type": "array", "items": { "$ref": "Creative" } }, "nextPageToken": { "type": "string", "description": "A token to retrieve the next page of results. Pass this value in the ListCreativesRequest.page_token field in the subsequent call to `ListCreatives` method to retrieve the next page of results." } }, "description": "A response for listing creatives.", "id": "ListCreativesResponse" }, "ContactInformation": { "id": "ContactInformation", "description": "Contains information on how a buyer or seller can be reached.", "type": "object", "properties": { "email": { "type": "string", "description": "Email address for the contact." }, "name": { "type": "string", "description": "The name of the contact." } } }, "CreativeSize": { "id": "CreativeSize", "description": "Specifies the size of the creative.", "type": "object", "properties": { "allowedFormats": { "items": { "enumDescriptions": [ "A placeholder for an undefined allowed format.", "An audio-only ad (without any video)." ], "type": "string", "enum": [ "UNKNOWN", "AUDIO" ] }, "type": "array", "description": "What formats are allowed by the publisher. If this repeated field is empty then all formats are allowed. For example, if this field contains AllowedFormatType.AUDIO then the publisher only allows an audio ad (without any video)." }, "nativeTemplate": { "description": "Output only. The native template for this creative. It will have a value only if creative_size_type = CreativeSizeType.NATIVE.", "enumDescriptions": [ "A placeholder for an undefined native template.", "The creative is linked to native content ad.", "The creative is linked to native app install ad.", "The creative is linked to native video content ad.", "The creative is linked to native video app install ad." ], "type": "string", "enum": [ "UNKNOWN_NATIVE_TEMPLATE", "NATIVE_CONTENT_AD", "NATIVE_APP_INSTALL_AD", "NATIVE_VIDEO_CONTENT_AD", "NATIVE_VIDEO_APP_INSTALL_AD" ] }, "companionSizes": { "type": "array", "items": { "$ref": "Size" }, "description": "For video creatives specifies the sizes of companion ads (if present). Companion sizes may be filled in only when creative_size_type = VIDEO" }, "skippableAdType": { "type": "string", "enum": [ "SKIPPABLE_AD_TYPE_UNSPECIFIED", "GENERIC", "INSTREAM_SELECT", "NOT_SKIPPABLE" ], "description": "The type of skippable ad for this creative. It will have a value only if creative_size_type = CreativeSizeType.VIDEO.", "enumDescriptions": [ "A placeholder for an undefined skippable ad type.", "This video ad can be skipped after 5 seconds.", "This video ad can be skipped after 5 seconds, and count 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 video ad is not skippable." ] }, "size": { "description": "For regular or video creative size type, specifies the size of the creative", "$ref": "Size" }, "creativeSizeType": { "description": "The creative size type.", "enumDescriptions": [ "A placeholder for an undefined creative size type.", "The creative is a regular desktop creative.", "The creative is an interstitial creative.", "The creative is a video creative.", "The creative is a native (mobile) creative." ], "type": "string", "enum": [ "CREATIVE_SIZE_TYPE_UNSPECIFIED", "REGULAR", "INTERSTITIAL", "VIDEO", "NATIVE" ] } } }, "HtmlContent": { "id": "HtmlContent", "description": "HTML content for a creative.", "type": "object", "properties": { "width": { "type": "integer", "format": "int32", "description": "The width of the HTML snippet in pixels." }, "snippet": { "type": "string", "description": "The HTML snippet that displays the ad when inserted in the web page." }, "height": { "type": "integer", "format": "int32", "description": "The height of the HTML snippet in pixels." } } }, "LocationContext": { "type": "object", "properties": { "geoCriteriaIds": { "description": "IDs representing the geo location for this context. Refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs.", "type": "array", "items": { "type": "integer", "format": "int32" } } }, "description": "Output only. The Geo criteria the restriction applies to.", "id": "LocationContext" }, "MetricValue": { "type": "object", "properties": { "value": { "type": "string", "description": "The expected value of the metric.", "format": "int64" }, "variance": { "type": "string", "description": "The variance (for example, square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the preferred size of the confidence interval (for example, for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value", "format": "int64" } }, "description": "A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (for example, when sampled).", "id": "MetricValue" }, "TimeOfDay": { "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`.", "id": "TimeOfDay", "type": "object", "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." }, "nanos": { "format": "int32", "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" }, "hours": { "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.", "type": "integer" }, "minutes": { "type": "integer", "format": "int32", "description": "Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59." } } }, "ListClientUserInvitationsResponse": { "id": "ListClientUserInvitationsResponse", "type": "object", "properties": { "invitations": { "type": "array", "items": { "$ref": "ClientUserInvitation" }, "description": "The returned list of client users." }, "nextPageToken": { "type": "string", "description": "A token to retrieve the next page of results. Pass this value in the ListClientUserInvitationsRequest.pageToken field in the subsequent call to the clients.invitations.list method to retrieve the next page of results." } } }, "FilteredBidDetailRow": { "type": "object", "properties": { "rowDimensions": { "description": "The values of all dimensions associated with metric values in this row.", "$ref": "RowDimensions" }, "detail": { "description": "The ID of the detail, can be numeric or text. The associated value can be looked up in the dictionary file corresponding to the DetailType in the response message.", "type": "string" }, "bidCount": { "description": "The number of bids with the specified detail.", "$ref": "MetricValue" }, "detailId": { "description": "Note: this field will be deprecated, use \"detail\" field instead. When \"detail\" field represents an integer value, this field is populated as the same integer value \"detail\" field represents, otherwise this field will be 0. The ID of the detail. The associated value can be looked up in the dictionary file corresponding to the DetailType in the response message.", "format": "int32", "deprecated": true, "type": "integer" } }, "description": "The number of filtered bids with the specified dimension values, among those filtered due to the requested filtering reason (for example, creative status), that have the specified detail.", "id": "FilteredBidDetailRow" }, "SecurityContext": { "deprecated": true, "type": "object", "properties": { "securities": { "items": { "enumDescriptions": [ "Matches impressions that require insecure compatibility.", "Matches impressions that require SSL compatibility." ], "type": "string", "enum": [ "INSECURE", "SSL" ] }, "type": "array", "description": "The security types in this context." } }, "id": "SecurityContext", "description": "Output only. A security context." }, "RowDimensions": { "type": "object", "properties": { "timeInterval": { "description": "The time interval that this row represents.", "$ref": "TimeInterval" }, "publisherIdentifier": { "type": "string", "description": "The publisher identifier for this row, if a breakdown by [BreakdownDimension.PUBLISHER_IDENTIFIER](https://developers.google.com/authorized-buyers/apis/reference/rest/v2beta1/bidders.accounts.filterSets#FilterSet.BreakdownDimension) was requested." } }, "description": "A response may include multiple rows, breaking down along various dimensions. Encapsulates the values of all dimensions for a given row.", "id": "RowDimensions" }, "Price": { "id": "Price", "description": "Represents a price and a pricing type for a product / deal.", "type": "object", "properties": { "pricingType": { "description": "The pricing type for the deal/product. (default: CPM)", "enumDescriptions": [ "A placeholder for an undefined pricing type. If the pricing type is unspecified, `COST_PER_MILLE` will be used instead.", "Cost per thousand impressions.", "Cost per day" ], "type": "string", "enum": [ "PRICING_TYPE_UNSPECIFIED", "COST_PER_MILLE", "COST_PER_DAY" ] }, "amount": { "description": "The actual price with currency specified.", "$ref": "Money" } } }, "UrlTargeting": { "type": "object", "properties": { "targetedUrls": { "type": "array", "items": { "type": "string" }, "description": "A list of URLs to be included." }, "excludedUrls": { "description": "A list of URLs to be excluded.", "type": "array", "items": { "type": "string" } } }, "id": "UrlTargeting", "description": "Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction and AdX Preferred Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply." }, "RemoveDealAssociationRequest": { "type": "object", "properties": { "association": { "description": "The association between a creative and a deal that should be removed.", "$ref": "CreativeDealAssociation" } }, "id": "RemoveDealAssociationRequest", "description": "A request for removing the association between a deal and a creative." }, "PauseProposalRequest": { "type": "object", "properties": { "reason": { "type": "string", "description": "The reason why the proposal is being paused. This human readable message will be displayed in the seller's UI. (Max length: 1000 unicode code units.)" } }, "description": "Request message to pause serving for an already-finalized proposal.", "id": "PauseProposalRequest" }, "ListLosingBidsResponse": { "id": "ListLosingBidsResponse", "description": "Response message for listing all reasons that bids lost in the auction.", "type": "object", "properties": { "nextPageToken": { "description": "A token to retrieve the next page of results. Pass this value in the ListLosingBidsRequest.pageToken field in the subsequent call to the losingBids.list method to retrieve the next page of results.", "type": "string" }, "creativeStatusRows": { "description": "List of rows, with counts of losing bids aggregated by loss reason (for example, creative status).", "type": "array", "items": { "$ref": "CreativeStatusRow" } } } }, "AdSize": { "type": "object", "properties": { "height": { "type": "string", "description": "The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.", "format": "int64" }, "width": { "type": "string", "format": "int64", "description": "The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`." }, "sizeType": { "description": "The size type of the ad slot.", "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 (for example, responsive size) can be resized automatically with the change of outside environment." ], "type": "string", "enum": [ "SIZE_TYPE_UNSPECIFIED", "PIXEL", "INTERSTITIAL", "NATIVE", "FLUID" ] } }, "description": "Represents size of a single ad slot, or a creative.", "id": "AdSize" }, "WatchCreativeRequest": { "type": "object", "properties": { "topic": { "description": "The Pub/Sub topic to publish notifications to. This topic must already exist and must give permission to ad-exchange-buyside-reports@google.com to write to the topic. This should be the full resource name in \"projects/{project_id}/topics/{topic_id}\" format.", "type": "string" } }, "description": "A request for watching changes to creative Status.", "id": "WatchCreativeRequest" }, "ListFilterSetsResponse": { "id": "ListFilterSetsResponse", "description": "Response message for listing filter sets.", "type": "object", "properties": { "nextPageToken": { "description": "A token to retrieve the next page of results. Pass this value in the ListFilterSetsRequest.pageToken field in the subsequent call to the accounts.filterSets.list method to retrieve the next page of results.", "type": "string" }, "filterSets": { "description": "The filter sets belonging to the buyer.", "type": "array", "items": { "$ref": "FilterSet" } } } } }, "rootUrl": "https://adexchangebuyer.googleapis.com/", "basePath": "", "canonicalName": "AdExchangeBuyerII", "revision": "20260429", "id": "adexchangebuyer2:v2beta1", "ownerDomain": "google.com", "baseUrl": "https://adexchangebuyer.googleapis.com/", "parameters": { "callback": { "description": "JSONP", "location": "query", "type": "string" }, "uploadType": { "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query", "type": "string" }, "key": { "location": "query", "type": "string", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, "oauth_token": { "type": "string", "location": "query", "description": "OAuth 2.0 token for the current user." }, "prettyPrint": { "description": "Returns response with indentations and line breaks.", "type": "boolean", "default": "true", "location": "query" }, "fields": { "type": "string", "location": "query", "description": "Selector specifying which fields to include in a partial response." }, "$.xgafv": { "description": "V1 error format.", "enumDescriptions": [ "v1 error format", "v2 error format" ], "location": "query", "type": "string", "enum": [ "1", "2" ] }, "alt": { "location": "query", "type": "string", "enum": [ "json", "media", "proto" ], "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "default": "json", "description": "Data format for response." }, "access_token": { "description": "OAuth access token.", "type": "string", "location": "query" }, "quotaUser": { "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "location": "query", "type": "string" }, "upload_protocol": { "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "type": "string", "location": "query" } }, "resources": { "accounts": { "resources": { "clients": { "methods": { "create": { "parameterOrder": [ "accountId" ], "id": "adexchangebuyer2.accounts.clients.create", "description": "Creates a new client buyer.", "request": { "$ref": "Client" }, "response": { "$ref": "Client" }, "flatPath": "v2beta1/accounts/{accountId}/clients", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "parameters": { "accountId": { "format": "int64", "description": "Unique numerical account ID for the buyer of which the client buyer is a customer; the sponsor buyer to create a client for. (required)", "type": "string", "location": "path", "required": true } }, "httpMethod": "POST", "path": "v2beta1/accounts/{accountId}/clients" }, "get": { "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}", "parameters": { "accountId": { "description": "Numerical account ID of the client's sponsor buyer. (required)", "format": "int64", "location": "path", "required": true, "type": "string" }, "clientAccountId": { "description": "Numerical account ID of the client buyer to retrieve. (required)", "format": "int64", "location": "path", "required": true, "type": "string" } }, "httpMethod": "GET", "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "description": "Gets a client buyer with a given client account ID.", "response": { "$ref": "Client" }, "parameterOrder": [ "accountId", "clientAccountId" ], "id": "adexchangebuyer2.accounts.clients.get" }, "update": { "request": { "$ref": "Client" }, "response": { "$ref": "Client" }, "description": "Updates an existing client buyer.", "id": "adexchangebuyer2.accounts.clients.update", "parameterOrder": [ "accountId", "clientAccountId" ], "httpMethod": "PUT", "parameters": { "clientAccountId": { "type": "string", "location": "path", "required": true, "format": "int64", "description": "Unique numerical account ID of the client to update. (required)" }, "accountId": { "description": "Unique numerical account ID for the buyer of which the client buyer is a customer; the sponsor buyer to update a client for. (required)", "format": "int64", "location": "path", "required": true, "type": "string" } }, "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}" }, "list": { "id": "adexchangebuyer2.accounts.clients.list", "parameterOrder": [ "accountId" ], "response": { "$ref": "ListClientsResponse" }, "description": "Lists all the clients for the current sponsor buyer.", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "flatPath": "v2beta1/accounts/{accountId}/clients", "httpMethod": "GET", "parameters": { "accountId": { "format": "int64", "description": "Unique numerical account ID of the sponsor buyer to list the clients for.", "type": "string", "location": "path", "required": true }, "partnerClientId": { "type": "string", "location": "query", "description": "Optional unique identifier (from the standpoint of an Ad Exchange sponsor buyer partner) of the client to return. If specified, at most one client will be returned in the response." }, "pageToken": { "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 accounts.clients.list method.", "type": "string", "location": "query" }, "pageSize": { "type": "integer", "location": "query", "format": "int32", "description": "Requested page size. The server may return fewer clients than requested. If unspecified, the server will pick an appropriate default." } }, "path": "v2beta1/accounts/{accountId}/clients" } }, "resources": { "invitations": { "methods": { "get": { "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations/{invitationId}", "httpMethod": "GET", "parameters": { "accountId": { "location": "path", "required": true, "type": "string", "description": "Numerical account ID of the client's sponsor buyer. (required)", "format": "int64" }, "clientAccountId": { "format": "int64", "description": "Numerical account ID of the client buyer that the user invitation to be retrieved is associated with. (required)", "type": "string", "location": "path", "required": true }, "invitationId": { "description": "Numerical identifier of the user invitation to retrieve. (required)", "format": "int64", "location": "path", "required": true, "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations/{invitationId}", "response": { "$ref": "ClientUserInvitation" }, "description": "Retrieves an existing client user invitation.", "id": "adexchangebuyer2.accounts.clients.invitations.get", "parameterOrder": [ "accountId", "clientAccountId", "invitationId" ] }, "create": { "description": "Creates and sends out an email invitation to access an Ad Exchange client buyer account.", "request": { "$ref": "ClientUserInvitation" }, "response": { "$ref": "ClientUserInvitation" }, "parameterOrder": [ "accountId", "clientAccountId" ], "id": "adexchangebuyer2.accounts.clients.invitations.create", "parameters": { "accountId": { "description": "Numerical account ID of the client's sponsor buyer. (required)", "format": "int64", "location": "path", "required": true, "type": "string" }, "clientAccountId": { "description": "Numerical account ID of the client buyer that the user should be associated with. (required)", "format": "int64", "location": "path", "required": true, "type": "string" } }, "httpMethod": "POST", "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations", "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ] }, "list": { "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations", "parameters": { "clientAccountId": { "type": "string", "location": "path", "required": true, "description": "Numerical account ID of the client buyer to list invitations for. (required) You must either specify a string representation of a numerical account identifier or the `-` character to list all the invitations for all the clients of a given sponsor buyer." }, "pageSize": { "format": "int32", "description": "Requested page size. Server may return fewer clients than requested. If unspecified, server will pick an appropriate default.", "type": "integer", "location": "query" }, "accountId": { "format": "int64", "description": "Numerical account ID of the client's sponsor buyer. (required)", "type": "string", "location": "path", "required": true }, "pageToken": { "description": "A token identifying a page of results the server should return. Typically, this is the value of ListClientUserInvitationsResponse.nextPageToken returned from the previous call to the clients.invitations.list method.", "type": "string", "location": "query" } }, "httpMethod": "GET", "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "description": "Lists all the client users invitations for a client with a given account ID.", "response": { "$ref": "ListClientUserInvitationsResponse" }, "parameterOrder": [ "accountId", "clientAccountId" ], "id": "adexchangebuyer2.accounts.clients.invitations.list" } } }, "users": { "methods": { "update": { "httpMethod": "PUT", "parameters": { "accountId": { "description": "Numerical account ID of the client's sponsor buyer. (required)", "format": "int64", "location": "path", "required": true, "type": "string" }, "userId": { "type": "string", "location": "path", "required": true, "format": "int64", "description": "Numerical identifier of the user to retrieve. (required)" }, "clientAccountId": { "location": "path", "required": true, "type": "string", "description": "Numerical account ID of the client buyer that the user to be retrieved is associated with. (required)", "format": "int64" } }, "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}", "request": { "$ref": "ClientUser" }, "response": { "$ref": "ClientUser" }, "description": "Updates an existing client user. Only the user status can be changed on update.", "id": "adexchangebuyer2.accounts.clients.users.update", "parameterOrder": [ "accountId", "clientAccountId", "userId" ] }, "get": { "id": "adexchangebuyer2.accounts.clients.users.get", "parameterOrder": [ "accountId", "clientAccountId", "userId" ], "response": { "$ref": "ClientUser" }, "description": "Retrieves an existing client user.", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}", "httpMethod": "GET", "parameters": { "accountId": { "location": "path", "required": true, "type": "string", "description": "Numerical account ID of the client's sponsor buyer. (required)", "format": "int64" }, "userId": { "type": "string", "location": "path", "required": true, "format": "int64", "description": "Numerical identifier of the user to retrieve. (required)" }, "clientAccountId": { "format": "int64", "description": "Numerical account ID of the client buyer that the user to be retrieved is associated with. (required)", "type": "string", "location": "path", "required": true } }, "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}" }, "list": { "parameterOrder": [ "accountId", "clientAccountId" ], "id": "adexchangebuyer2.accounts.clients.users.list", "description": "Lists all the known client users for a specified sponsor buyer account ID.", "response": { "$ref": "ListClientUsersResponse" }, "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users", "parameters": { "pageToken": { "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 accounts.clients.users.list method.", "location": "query", "type": "string" }, "accountId": { "format": "int64", "description": "Numerical account ID of the sponsor buyer of the client to list users for. (required)", "type": "string", "location": "path", "required": true }, "clientAccountId": { "description": "The account ID of the client buyer to list users for. (required) You must specify either a string representation of a numerical account identifier or the `-` character to list all the client users for all the clients of a given sponsor buyer.", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Requested page size. The server may return fewer clients than requested. If unspecified, the server will pick an appropriate default.", "format": "int32", "location": "query", "type": "integer" } }, "httpMethod": "GET" } } } } }, "creatives": { "methods": { "watch": { "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}:watch", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}:watch", "parameters": { "accountId": { "description": "The account of the creative to watch.", "location": "path", "required": true, "type": "string" }, "creativeId": { "description": "The creative ID to watch for status changes. Specify \"-\" to watch all creatives under the above account. If both creative-level and account-level notifications are sent, only a single notification will be sent to the creative-level notification topic.", "type": "string", "location": "path", "required": true } }, "httpMethod": "POST", "parameterOrder": [ "accountId", "creativeId" ], "id": "adexchangebuyer2.accounts.creatives.watch", "description": "Watches a creative. Will result in push notifications being sent to the topic when the creative changes status.", "request": { "$ref": "WatchCreativeRequest" }, "response": { "$ref": "Empty" } }, "list": { "response": { "$ref": "ListCreativesResponse" }, "description": "Lists creatives.", "id": "adexchangebuyer2.accounts.creatives.list", "parameterOrder": [ "accountId" ], "httpMethod": "GET", "parameters": { "pageSize": { "location": "query", "type": "integer", "description": "Requested page size. The server may return fewer creatives than requested (due to timeout constraint) even if more are available through another call. If unspecified, server will pick an appropriate default. Acceptable values are 1 to 1000, inclusive.", "format": "int32" }, "pageToken": { "description": "A token identifying a page of results the server should return. Typically, this is the value of ListCreativesResponse.next_page_token returned from the previous call to 'ListCreatives' method.", "type": "string", "location": "query" }, "query": { "location": "query", "type": "string", "description": "An optional query string to filter creatives. If no filter is specified, all active creatives will be returned. Supported queries are: - accountId=*account_id_string* - creativeId=*creative_id_string* - dealsStatus: {approved, conditionally_approved, disapproved, not_checked} - openAuctionStatus: {approved, conditionally_approved, disapproved, not_checked} - attribute: {a numeric attribute from the list of attributes} - disapprovalReason: {a reason from DisapprovalReason} Example: 'accountId=12345 AND (dealsStatus:disapproved AND disapprovalReason:unacceptable_content) OR attribute:47'" }, "accountId": { "description": "The account to list the creatives from. Specify \"-\" to list all creatives the current user has access to.", "location": "path", "required": true, "type": "string" } }, "path": "v2beta1/accounts/{accountId}/creatives", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "flatPath": "v2beta1/accounts/{accountId}/creatives" }, "update": { "httpMethod": "PUT", "parameters": { "accountId": { "description": "The account that this creative belongs to. Can be used to filter the response of the creatives.list method.", "location": "path", "required": true, "type": "string" }, "creativeId": { "description": "The buyer-defined creative ID of this creative. Can be used to filter the response of the creatives.list method.", "type": "string", "location": "path", "required": true } }, "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}", "request": { "$ref": "Creative" }, "response": { "$ref": "Creative" }, "description": "Updates a creative.", "id": "adexchangebuyer2.accounts.creatives.update", "parameterOrder": [ "accountId", "creativeId" ] }, "get": { "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}", "parameters": { "accountId": { "location": "path", "required": true, "type": "string", "description": "The account the creative belongs to." }, "creativeId": { "description": "The ID of the creative to retrieve.", "location": "path", "required": true, "type": "string" } }, "httpMethod": "GET", "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "description": "Gets a creative.", "response": { "$ref": "Creative" }, "parameterOrder": [ "accountId", "creativeId" ], "id": "adexchangebuyer2.accounts.creatives.get" }, "stopWatching": { "parameterOrder": [ "accountId", "creativeId" ], "id": "adexchangebuyer2.accounts.creatives.stopWatching", "description": "Stops watching a creative. Will stop push notifications being sent to the topics when the creative changes status.", "request": { "$ref": "StopWatchingCreativeRequest" }, "response": { "$ref": "Empty" }, "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}:stopWatching", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "parameters": { "accountId": { "description": "The account of the creative to stop notifications for.", "location": "path", "required": true, "type": "string" }, "creativeId": { "type": "string", "location": "path", "required": true, "description": "The creative ID of the creative to stop notifications for. Specify \"-\" to specify stopping account level notifications." } }, "httpMethod": "POST", "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}:stopWatching" }, "create": { "httpMethod": "POST", "parameters": { "accountId": { "description": "The account that this creative belongs to. Can be used to filter the response of the creatives.list method.", "location": "path", "required": true, "type": "string" }, "duplicateIdMode": { "location": "query", "type": "string", "enum": [ "NO_DUPLICATES", "FORCE_ENABLE_DUPLICATE_IDS" ], "enumDescriptions": [ "Recommended. This means that an ID will be unique to a single creative. Multiple creatives will not share an ID.", "Not recommended. Using this option will allow multiple creatives to share the same ID. Get and Update requests will not be possible for any ID that has more than one creative associated. (List will still function.) This is only intended for backwards compatibility in cases where a single ID is already shared by multiple creatives from previous APIs." ], "description": "Indicates if multiple creatives can share an ID or not. Default is NO_DUPLICATES (one ID per creative)." } }, "path": "v2beta1/accounts/{accountId}/creatives", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "flatPath": "v2beta1/accounts/{accountId}/creatives", "request": { "$ref": "Creative" }, "response": { "$ref": "Creative" }, "description": "Creates a creative.", "id": "adexchangebuyer2.accounts.creatives.create", "parameterOrder": [ "accountId" ] } }, "resources": { "dealAssociations": { "methods": { "add": { "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:add", "httpMethod": "POST", "parameters": { "accountId": { "location": "path", "required": true, "type": "string", "description": "The account the creative belongs to." }, "creativeId": { "description": "The ID of the creative associated with the deal.", "location": "path", "required": true, "type": "string" } }, "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:add", "id": "adexchangebuyer2.accounts.creatives.dealAssociations.add", "parameterOrder": [ "accountId", "creativeId" ], "request": { "$ref": "AddDealAssociationRequest" }, "response": { "$ref": "Empty" }, "description": "Associate an existing deal with a creative." }, "list": { "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations", "httpMethod": "GET", "parameters": { "pageSize": { "format": "int32", "description": "Requested page size. Server may return fewer associations than requested. If unspecified, server will pick an appropriate default.", "type": "integer", "location": "query" }, "accountId": { "description": "The account to list the associations from. Specify \"-\" to list all creatives the current user has access to.", "type": "string", "location": "path", "required": true }, "creativeId": { "type": "string", "location": "path", "required": true, "description": "The creative ID to list the associations from. Specify \"-\" to list all creatives under the above account." }, "query": { "type": "string", "location": "query", "description": "An optional query string to filter deal associations. If no filter is specified, all associations will be returned. Supported queries are: - accountId=*account_id_string* - creativeId=*creative_id_string* - dealsId=*deals_id_string* - dealsStatus:{approved, conditionally_approved, disapproved, not_checked} - openAuctionStatus:{approved, conditionally_approved, disapproved, not_checked} Example: 'dealsId=12345 AND dealsStatus:disapproved'" }, "pageToken": { "location": "query", "type": "string", "description": "A token identifying a page of results the server should return. Typically, this is the value of ListDealAssociationsResponse.next_page_token returned from the previous call to 'ListDealAssociations' method." } }, "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations", "response": { "$ref": "ListDealAssociationsResponse" }, "description": "List all creative-deal associations.", "id": "adexchangebuyer2.accounts.creatives.dealAssociations.list", "parameterOrder": [ "accountId", "creativeId" ] }, "remove": { "description": "Remove the association between a deal and a creative.", "request": { "$ref": "RemoveDealAssociationRequest" }, "response": { "$ref": "Empty" }, "parameterOrder": [ "accountId", "creativeId" ], "id": "adexchangebuyer2.accounts.creatives.dealAssociations.remove", "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:remove", "parameters": { "accountId": { "description": "The account the creative belongs to.", "location": "path", "required": true, "type": "string" }, "creativeId": { "location": "path", "required": true, "type": "string", "description": "The ID of the creative associated with the deal." } }, "httpMethod": "POST", "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:remove", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ] } } } } }, "finalizedProposals": { "methods": { "list": { "flatPath": "v2beta1/accounts/{accountId}/finalizedProposals", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "path": "v2beta1/accounts/{accountId}/finalizedProposals", "parameters": { "accountId": { "description": "Account ID of the buyer.", "type": "string", "location": "path", "required": true }, "filter": { "type": "string", "location": "query", "description": "An optional PQL filter query used to query for proposals. Nested repeated fields, such as proposal.deals.targetingCriterion, cannot be filtered." }, "pageSize": { "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { "description": "The page token as returned from ListProposalsResponse.", "location": "query", "type": "string" }, "filterSyntax": { "location": "query", "type": "string", "enum": [ "FILTER_SYNTAX_UNSPECIFIED", "PQL", "LIST_FILTER" ], "enumDescriptions": [ "A placeholder for an undefined filter syntax.", "PQL query syntax. Visit https://developers.google.com/ad-manager/api/pqlreference for PQL documentation and examples.", "API list filtering syntax. Read about syntax and usage at https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters." ], "description": "Syntax the filter is written in. Current implementation defaults to PQL but in the future it will be LIST_FILTER." } }, "httpMethod": "GET", "parameterOrder": [ "accountId" ], "id": "adexchangebuyer2.accounts.finalizedProposals.list", "description": "List finalized proposals, regardless if a proposal is being renegotiated. A filter expression (PQL query) may be specified to filter the results. The notes will not be returned.", "response": { "$ref": "ListProposalsResponse" } }, "pause": { "parameterOrder": [ "accountId", "proposalId" ], "id": "adexchangebuyer2.accounts.finalizedProposals.pause", "description": "Update given deals to pause serving. This method will set the `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to true for all listed deals in the request. Currently, this method only applies to PG and PD deals. For PA deals, call accounts.proposals.pause endpoint. It is a no-op to pause already-paused deals. It is an error to call PauseProposalDeals for deals which are not part of the proposal of proposal_id or which are not finalized or renegotiating.", "request": { "$ref": "PauseProposalDealsRequest" }, "response": { "$ref": "Proposal" }, "flatPath": "v2beta1/accounts/{accountId}/finalizedProposals/{proposalId}:pause", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "parameters": { "proposalId": { "type": "string", "location": "path", "required": true, "description": "The proposal_id of the proposal containing the deals." }, "accountId": { "description": "Account ID of the buyer.", "location": "path", "required": true, "type": "string" } }, "httpMethod": "POST", "path": "v2beta1/accounts/{accountId}/finalizedProposals/{proposalId}:pause" }, "resume": { "parameterOrder": [ "accountId", "proposalId" ], "id": "adexchangebuyer2.accounts.finalizedProposals.resume", "description": "Update given deals to resume serving. This method will set the `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to false for all listed deals in the request. Currently, this method only applies to PG and PD deals. For PA deals, call accounts.proposals.resume endpoint. It is a no-op to resume running deals or deals paused by the other party. It is an error to call ResumeProposalDeals for deals which are not part of the proposal of proposal_id or which are not finalized or renegotiating.", "request": { "$ref": "ResumeProposalDealsRequest" }, "response": { "$ref": "Proposal" }, "flatPath": "v2beta1/accounts/{accountId}/finalizedProposals/{proposalId}:resume", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "path": "v2beta1/accounts/{accountId}/finalizedProposals/{proposalId}:resume", "parameters": { "proposalId": { "location": "path", "required": true, "type": "string", "description": "The proposal_id of the proposal containing the deals." }, "accountId": { "location": "path", "required": true, "type": "string", "description": "Account ID of the buyer." } }, "httpMethod": "POST" } } }, "proposals": { "methods": { "cancelNegotiation": { "flatPath": "v2beta1/accounts/{accountId}/proposals/{proposalId}:cancelNegotiation", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "parameters": { "proposalId": { "type": "string", "location": "path", "required": true, "description": "The ID of the proposal to cancel negotiation for." }, "accountId": { "description": "Account ID of the buyer.", "location": "path", "required": true, "type": "string" } }, "httpMethod": "POST", "path": "v2beta1/accounts/{accountId}/proposals/{proposalId}:cancelNegotiation", "parameterOrder": [ "accountId", "proposalId" ], "id": "adexchangebuyer2.accounts.proposals.cancelNegotiation", "description": "Cancel an ongoing negotiation on a proposal. This does not cancel or end serving for the deals if the proposal has been finalized, but only cancels a negotiation unilaterally.", "request": { "$ref": "CancelNegotiationRequest" }, "response": { "$ref": "Proposal" } }, "list": { "path": "v2beta1/accounts/{accountId}/proposals", "httpMethod": "GET", "parameters": { "pageToken": { "description": "The page token as returned from ListProposalsResponse.", "location": "query", "type": "string" }, "filterSyntax": { "description": "Syntax the filter is written in. Current implementation defaults to PQL but in the future it will be LIST_FILTER.", "location": "query", "type": "string", "enum": [ "FILTER_SYNTAX_UNSPECIFIED", "PQL", "LIST_FILTER" ], "enumDescriptions": [ "A placeholder for an undefined filter syntax.", "PQL query syntax. Visit https://developers.google.com/ad-manager/api/pqlreference for PQL documentation and examples.", "API list filtering syntax. Read about syntax and usage at https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters." ] }, "accountId": { "location": "path", "required": true, "type": "string", "description": "Account ID of the buyer." }, "filter": { "type": "string", "location": "query", "description": "An optional PQL filter query used to query for proposals. Nested repeated fields, such as proposal.deals.targetingCriterion, cannot be filtered." }, "pageSize": { "format": "int32", "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.", "type": "integer", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "flatPath": "v2beta1/accounts/{accountId}/proposals", "response": { "$ref": "ListProposalsResponse" }, "description": "List proposals. A filter expression (PQL query) may be specified to filter the results. To retrieve all finalized proposals, regardless if a proposal is being renegotiated, see the FinalizedProposals resource. Note that Bidder/ChildSeat relationships differ from the usual behavior. A Bidder account can only see its child seats' proposals by specifying the ChildSeat's accountId in the request path.", "id": "adexchangebuyer2.accounts.proposals.list", "parameterOrder": [ "accountId" ] }, "addNote": { "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "flatPath": "v2beta1/accounts/{accountId}/proposals/{proposalId}:addNote", "httpMethod": "POST", "parameters": { "proposalId": { "description": "The ID of the proposal to attach the note to.", "location": "path", "required": true, "type": "string" }, "accountId": { "description": "Account ID of the buyer.", "type": "string", "location": "path", "required": true } }, "path": "v2beta1/accounts/{accountId}/proposals/{proposalId}:addNote", "id": "adexchangebuyer2.accounts.proposals.addNote", "parameterOrder": [ "accountId", "proposalId" ], "request": { "$ref": "AddNoteRequest" }, "response": { "$ref": "Note" }, "description": "Create a new note and attach it to the proposal. The note is assigned a unique ID by the server. The proposal revision number will not increase when associated with a new note." }, "create": { "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "flatPath": "v2beta1/accounts/{accountId}/proposals", "path": "v2beta1/accounts/{accountId}/proposals", "httpMethod": "POST", "parameters": { "accountId": { "description": "Account ID of the buyer.", "location": "path", "required": true, "type": "string" } }, "id": "adexchangebuyer2.accounts.proposals.create", "parameterOrder": [ "accountId" ], "request": { "$ref": "Proposal" }, "response": { "$ref": "Proposal" }, "description": "Create the given proposal. Each created proposal and any deals it contains are assigned a unique ID by the server." }, "update": { "parameters": { "proposalId": { "description": "The unique ID of the proposal.", "location": "path", "required": true, "type": "string" }, "accountId": { "description": "Account ID of the buyer.", "type": "string", "location": "path", "required": true } }, "httpMethod": "PUT", "path": "v2beta1/accounts/{accountId}/proposals/{proposalId}", "flatPath": "v2beta1/accounts/{accountId}/proposals/{proposalId}", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "description": "Update the given proposal at the client known revision number. If the server revision has advanced since the passed-in `proposal.proposal_revision`, an `ABORTED` error message will be returned. Only the buyer-modifiable fields of the proposal will be updated. Note that the deals in the proposal will be updated to match the passed-in copy. If a passed-in deal does not have a `deal_id`, the server will assign a new unique ID and create the deal. If passed-in deal has a `deal_id`, it will be updated to match the passed-in copy. Any existing deals not present in the passed-in proposal will be deleted. It is an error to pass in a deal with a `deal_id` not present at head.", "request": { "$ref": "Proposal" }, "response": { "$ref": "Proposal" }, "parameterOrder": [ "accountId", "proposalId" ], "id": "adexchangebuyer2.accounts.proposals.update" }, "resume": { "description": "Update the given proposal to resume serving. This method will set the `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to false for all deals in the proposal. Note that if the `has_seller_paused` bit is also set, serving will not resume until the seller also resumes. It is a no-op to resume an already-running proposal. It is an error to call ResumeProposal for a proposal that is not finalized or renegotiating.", "request": { "$ref": "ResumeProposalRequest" }, "response": { "$ref": "Proposal" }, "parameterOrder": [ "accountId", "proposalId" ], "id": "adexchangebuyer2.accounts.proposals.resume", "path": "v2beta1/accounts/{accountId}/proposals/{proposalId}:resume", "parameters": { "proposalId": { "description": "The ID of the proposal to resume.", "location": "path", "required": true, "type": "string" }, "accountId": { "location": "path", "required": true, "type": "string", "description": "Account ID of the buyer." } }, "httpMethod": "POST", "flatPath": "v2beta1/accounts/{accountId}/proposals/{proposalId}:resume", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ] }, "pause": { "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "flatPath": "v2beta1/accounts/{accountId}/proposals/{proposalId}:pause", "path": "v2beta1/accounts/{accountId}/proposals/{proposalId}:pause", "httpMethod": "POST", "parameters": { "accountId": { "type": "string", "location": "path", "required": true, "description": "Account ID of the buyer." }, "proposalId": { "location": "path", "required": true, "type": "string", "description": "The ID of the proposal to pause." } }, "id": "adexchangebuyer2.accounts.proposals.pause", "parameterOrder": [ "accountId", "proposalId" ], "request": { "$ref": "PauseProposalRequest" }, "response": { "$ref": "Proposal" }, "description": "Update the given proposal to pause serving. This method will set the `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to true for all deals in the proposal. It is a no-op to pause an already-paused proposal. It is an error to call PauseProposal for a proposal that is not finalized or renegotiating." }, "accept": { "id": "adexchangebuyer2.accounts.proposals.accept", "parameterOrder": [ "accountId", "proposalId" ], "request": { "$ref": "AcceptProposalRequest" }, "response": { "$ref": "Proposal" }, "description": "Mark the proposal as accepted at the given revision number. If the number does not match the server's revision number an `ABORTED` error message will be returned. This call updates the proposal_state from `PROPOSED` to `BUYER_ACCEPTED`, or from `SELLER_ACCEPTED` to `FINALIZED`. Upon calling this endpoint, the buyer implicitly agrees to the terms and conditions optionally set within the proposal by the publisher.", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "flatPath": "v2beta1/accounts/{accountId}/proposals/{proposalId}:accept", "path": "v2beta1/accounts/{accountId}/proposals/{proposalId}:accept", "httpMethod": "POST", "parameters": { "proposalId": { "description": "The ID of the proposal to accept.", "location": "path", "required": true, "type": "string" }, "accountId": { "description": "Account ID of the buyer.", "location": "path", "required": true, "type": "string" } } }, "completeSetup": { "request": { "$ref": "CompleteSetupRequest" }, "response": { "$ref": "Proposal" }, "description": "You can opt-in to manually update proposals to indicate that setup is complete. By default, proposal setup is automatically completed after their deals are finalized. Contact your Technical Account Manager to opt in. Buyers can call this method when the proposal has been finalized, and all the required creatives have been uploaded using the Creatives API. This call updates the `is_setup_completed` field on the deals in the proposal, and notifies the seller. The server then advances the revision number of the most recent proposal. To mark an individual deal as ready to serve, call `buyers.finalizedDeals.setReadyToServe` in the Marketplace API.", "id": "adexchangebuyer2.accounts.proposals.completeSetup", "parameterOrder": [ "accountId", "proposalId" ], "path": "v2beta1/accounts/{accountId}/proposals/{proposalId}:completeSetup", "httpMethod": "POST", "parameters": { "accountId": { "type": "string", "location": "path", "required": true, "description": "Account ID of the buyer." }, "proposalId": { "description": "The ID of the proposal to mark as setup completed.", "type": "string", "location": "path", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "flatPath": "v2beta1/accounts/{accountId}/proposals/{proposalId}:completeSetup" }, "get": { "parameterOrder": [ "accountId", "proposalId" ], "id": "adexchangebuyer2.accounts.proposals.get", "description": "Gets a proposal given its ID. The proposal is returned at its head revision.", "response": { "$ref": "Proposal" }, "flatPath": "v2beta1/accounts/{accountId}/proposals/{proposalId}", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "path": "v2beta1/accounts/{accountId}/proposals/{proposalId}", "parameters": { "proposalId": { "description": "The unique ID of the proposal", "location": "path", "required": true, "type": "string" }, "accountId": { "description": "Account ID of the buyer.", "location": "path", "required": true, "type": "string" } }, "httpMethod": "GET" } } }, "products": { "methods": { "get": { "parameters": { "accountId": { "type": "string", "location": "path", "required": true, "description": "Account ID of the buyer." }, "productId": { "description": "The ID for the product to get the head revision for.", "location": "path", "required": true, "type": "string" } }, "httpMethod": "GET", "path": "v2beta1/accounts/{accountId}/products/{productId}", "flatPath": "v2beta1/accounts/{accountId}/products/{productId}", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "description": "Gets the requested product by ID.", "response": { "$ref": "Product" }, "parameterOrder": [ "accountId", "productId" ], "id": "adexchangebuyer2.accounts.products.get" }, "list": { "parameters": { "pageSize": { "format": "int32", "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.", "type": "integer", "location": "query" }, "accountId": { "location": "path", "required": true, "type": "string", "description": "Account ID of the buyer." }, "filter": { "description": "An optional PQL query used to query for products. See https://developers.google.com/ad-manager/docs/pqlreference for documentation about PQL and examples. Nested repeated fields, such as product.targetingCriterion.inclusions, cannot be filtered.", "location": "query", "type": "string" }, "pageToken": { "type": "string", "location": "query", "description": "The page token as returned from ListProductsResponse." } }, "httpMethod": "GET", "path": "v2beta1/accounts/{accountId}/products", "flatPath": "v2beta1/accounts/{accountId}/products", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "description": "List all products visible to the buyer (optionally filtered by the specified PQL query).", "response": { "$ref": "ListProductsResponse" }, "parameterOrder": [ "accountId" ], "id": "adexchangebuyer2.accounts.products.list" } } }, "publisherProfiles": { "methods": { "get": { "id": "adexchangebuyer2.accounts.publisherProfiles.get", "parameterOrder": [ "accountId", "publisherProfileId" ], "response": { "$ref": "PublisherProfile" }, "description": "Gets the requested publisher profile by id.", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "flatPath": "v2beta1/accounts/{accountId}/publisherProfiles/{publisherProfileId}", "httpMethod": "GET", "parameters": { "accountId": { "location": "path", "required": true, "type": "string", "description": "Account ID of the buyer." }, "publisherProfileId": { "type": "string", "location": "path", "required": true, "description": "The id for the publisher profile to get." } }, "path": "v2beta1/accounts/{accountId}/publisherProfiles/{publisherProfileId}" }, "list": { "parameterOrder": [ "accountId" ], "id": "adexchangebuyer2.accounts.publisherProfiles.list", "description": "List all publisher profiles visible to the buyer", "response": { "$ref": "ListPublisherProfilesResponse" }, "flatPath": "v2beta1/accounts/{accountId}/publisherProfiles", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "path": "v2beta1/accounts/{accountId}/publisherProfiles", "parameters": { "pageToken": { "type": "string", "location": "query", "description": "The page token as return from ListPublisherProfilesResponse." }, "accountId": { "type": "string", "location": "path", "required": true, "description": "Account ID of the buyer." }, "pageSize": { "description": "Specify the number of results to include per page.", "format": "int32", "location": "query", "type": "integer" } }, "httpMethod": "GET" } } } } }, "buyers": { "resources": { "filterSets": { "methods": { "get": { "path": "v2beta1/buyers/{buyersId}/filterSets/{filterSetsId}", "parameters": { "buyersId": { "location": "path", "required": true, "type": "string", "description": "Part of `name`. Full name of the resource being requested. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`" }, "filterSetsId": { "location": "path", "required": true, "type": "string", "description": "Part of `name`. See documentation of `buyersId`." } }, "httpMethod": "GET", "flatPath": "v2beta1/buyers/{buyersId}/filterSets/{filterSetsId}", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "description": "Retrieves the requested filter set for the account with the given account ID.", "response": { "$ref": "FilterSet" }, "parameterOrder": [ "buyersId", "filterSetsId" ], "id": "adexchangebuyer2.buyers.filterSets.get" }, "create": { "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "flatPath": "v2beta1/buyers/{buyersId}/filterSets", "httpMethod": "POST", "parameters": { "isTransient": { "description": "Whether the filter set is transient, or should be persisted indefinitely. By default, filter sets are not transient. If transient, it will be available for at least 1 hour after creation.", "location": "query", "type": "boolean" }, "buyersId": { "description": "Part of `ownerName`. Name of the owner (bidder or account) of the filter set to be created. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456`", "type": "string", "location": "path", "required": true } }, "path": "v2beta1/buyers/{buyersId}/filterSets", "id": "adexchangebuyer2.buyers.filterSets.create", "parameterOrder": [ "buyersId" ], "request": { "$ref": "FilterSet" }, "response": { "$ref": "FilterSet" }, "description": "Creates the specified filter set for the account with the given account ID." }, "list": { "path": "v2beta1/buyers/{buyersId}/filterSets", "httpMethod": "GET", "parameters": { "buyersId": { "description": "Part of `ownerName`. Name of the owner (bidder or account) of the filter sets to be listed. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456`", "location": "path", "required": true, "type": "string" }, "pageToken": { "location": "query", "type": "string", "description": "A token identifying a page of results the server should return. Typically, this is the value of ListFilterSetsResponse.nextPageToken returned from the previous call to the accounts.filterSets.list method." }, "pageSize": { "format": "int32", "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.", "type": "integer", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "flatPath": "v2beta1/buyers/{buyersId}/filterSets", "response": { "$ref": "ListFilterSetsResponse" }, "description": "Lists all filter sets for the account with the given account ID.", "id": "adexchangebuyer2.buyers.filterSets.list", "parameterOrder": [ "buyersId" ] }, "delete": { "parameterOrder": [ "buyersId", "filterSetsId" ], "id": "adexchangebuyer2.buyers.filterSets.delete", "description": "Deletes the requested filter set from the account with the given account ID.", "response": { "$ref": "Empty" }, "flatPath": "v2beta1/buyers/{buyersId}/filterSets/{filterSetsId}", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "parameters": { "buyersId": { "description": "Part of `name`. Full name of the resource to delete. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", "location": "path", "required": true, "type": "string" }, "filterSetsId": { "location": "path", "required": true, "type": "string", "description": "Part of `name`. See documentation of `buyersId`." } }, "httpMethod": "DELETE", "path": "v2beta1/buyers/{buyersId}/filterSets/{filterSetsId}" } }, "resources": { "losingBids": { "methods": { "list": { "path": "v2beta1/buyers/{buyersId}/filterSets/{filterSetsId}/losingBids", "parameters": { "pageSize": { "location": "query", "type": "integer", "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.", "format": "int32" }, "buyersId": { "description": "Part of `filterSetName`. Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", "location": "path", "required": true, "type": "string" }, "pageToken": { "description": "A token identifying a page of results the server should return. Typically, this is the value of ListLosingBidsResponse.nextPageToken returned from the previous call to the losingBids.list method.", "type": "string", "location": "query" }, "filterSetsId": { "description": "Part of `filterSetName`. See documentation of `buyersId`.", "type": "string", "location": "path", "required": true } }, "httpMethod": "GET", "flatPath": "v2beta1/buyers/{buyersId}/filterSets/{filterSetsId}/losingBids", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "description": "List all reasons for which bids lost in the auction, with the number of bids that lost for each reason.", "response": { "$ref": "ListLosingBidsResponse" }, "parameterOrder": [ "buyersId", "filterSetsId" ], "id": "adexchangebuyer2.buyers.filterSets.losingBids.list" } } }, "filteredBids": { "methods": { "list": { "flatPath": "v2beta1/buyers/{buyersId}/filterSets/{filterSetsId}/filteredBids", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "path": "v2beta1/buyers/{buyersId}/filterSets/{filterSetsId}/filteredBids", "parameters": { "pageSize": { "format": "int32", "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.", "type": "integer", "location": "query" }, "filterSetsId": { "location": "path", "required": true, "type": "string", "description": "Part of `filterSetName`. See documentation of `buyersId`." }, "buyersId": { "description": "Part of `filterSetName`. Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", "location": "path", "required": true, "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 ListFilteredBidsResponse.nextPageToken returned from the previous call to the filteredBids.list method." } }, "httpMethod": "GET", "parameterOrder": [ "buyersId", "filterSetsId" ], "id": "adexchangebuyer2.buyers.filterSets.filteredBids.list", "description": "List all reasons for which bids were filtered, with the number of bids filtered for each reason.", "response": { "$ref": "ListFilteredBidsResponse" } } }, "resources": { "creatives": { "methods": { "list": { "parameterOrder": [ "buyersId", "filterSetsId", "creativeStatusId" ], "id": "adexchangebuyer2.buyers.filterSets.filteredBids.creatives.list", "description": "List all creatives associated with a specific reason for which bids were filtered, with the number of bids filtered for each creative.", "response": { "$ref": "ListCreativeStatusBreakdownByCreativeResponse" }, "flatPath": "v2beta1/buyers/{buyersId}/filterSets/{filterSetsId}/filteredBids/{creativeStatusId}/creatives", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "path": "v2beta1/buyers/{buyersId}/filterSets/{filterSetsId}/filteredBids/{creativeStatusId}/creatives", "parameters": { "buyersId": { "description": "Part of `filterSetName`. Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", "type": "string", "location": "path", "required": true }, "filterSetsId": { "location": "path", "required": true, "type": "string", "description": "Part of `filterSetName`. See documentation of `buyersId`." }, "pageSize": { "location": "query", "type": "integer", "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.", "format": "int32" }, "pageToken": { "location": "query", "type": "string", "description": "A token identifying a page of results the server should return. Typically, this is the value of ListCreativeStatusBreakdownByCreativeResponse.nextPageToken returned from the previous call to the filteredBids.creatives.list method." }, "creativeStatusId": { "type": "integer", "location": "path", "required": true, "format": "int32", "description": "The ID of the creative status for which to retrieve a breakdown by creative. See [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes)." } }, "httpMethod": "GET" } } }, "details": { "methods": { "list": { "response": { "$ref": "ListCreativeStatusBreakdownByDetailResponse" }, "description": "List all details associated with a specific reason for which bids were filtered, with the number of bids filtered for each detail.", "id": "adexchangebuyer2.buyers.filterSets.filteredBids.details.list", "parameterOrder": [ "buyersId", "filterSetsId", "creativeStatusId" ], "httpMethod": "GET", "parameters": { "pageToken": { "type": "string", "location": "query", "description": "A token identifying a page of results the server should return. Typically, this is the value of ListCreativeStatusBreakdownByDetailResponse.nextPageToken returned from the previous call to the filteredBids.details.list method." }, "creativeStatusId": { "type": "integer", "location": "path", "required": true, "format": "int32", "description": "The ID of the creative status for which to retrieve a breakdown by detail. See [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes). Details are only available for statuses 10, 14, 15, 17, 18, 19, 86, and 87." }, "buyersId": { "type": "string", "location": "path", "required": true, "description": "Part of `filterSetName`. Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`" }, "filterSetsId": { "description": "Part of `filterSetName`. See documentation of `buyersId`.", "type": "string", "location": "path", "required": true }, "pageSize": { "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.", "format": "int32", "location": "query", "type": "integer" } }, "path": "v2beta1/buyers/{buyersId}/filterSets/{filterSetsId}/filteredBids/{creativeStatusId}/details", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "flatPath": "v2beta1/buyers/{buyersId}/filterSets/{filterSetsId}/filteredBids/{creativeStatusId}/details" } } } } }, "bidMetrics": { "methods": { "list": { "response": { "$ref": "ListBidMetricsResponse" }, "description": "Lists all metrics that are measured in terms of number of bids.", "id": "adexchangebuyer2.buyers.filterSets.bidMetrics.list", "parameterOrder": [ "buyersId", "filterSetsId" ], "path": "v2beta1/buyers/{buyersId}/filterSets/{filterSetsId}/bidMetrics", "httpMethod": "GET", "parameters": { "buyersId": { "description": "Part of `filterSetName`. Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", "type": "string", "location": "path", "required": true }, "pageToken": { "location": "query", "type": "string", "description": "A token identifying a page of results the server should return. Typically, this is the value of ListBidMetricsResponse.nextPageToken returned from the previous call to the bidMetrics.list method." }, "filterSetsId": { "type": "string", "location": "path", "required": true, "description": "Part of `filterSetName`. See documentation of `buyersId`." }, "pageSize": { "type": "integer", "location": "query", "format": "int32", "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default." } }, "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "flatPath": "v2beta1/buyers/{buyersId}/filterSets/{filterSetsId}/bidMetrics" } } }, "bidResponsesWithoutBids": { "methods": { "list": { "path": "v2beta1/buyers/{buyersId}/filterSets/{filterSetsId}/bidResponsesWithoutBids", "parameters": { "pageSize": { "format": "int32", "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.", "type": "integer", "location": "query" }, "buyersId": { "description": "Part of `filterSetName`. Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", "location": "path", "required": true, "type": "string" }, "pageToken": { "location": "query", "type": "string", "description": "A token identifying a page of results the server should return. Typically, this is the value of ListBidResponsesWithoutBidsResponse.nextPageToken returned from the previous call to the bidResponsesWithoutBids.list method." }, "filterSetsId": { "description": "Part of `filterSetName`. See documentation of `buyersId`.", "type": "string", "location": "path", "required": true } }, "httpMethod": "GET", "flatPath": "v2beta1/buyers/{buyersId}/filterSets/{filterSetsId}/bidResponsesWithoutBids", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "description": "List all reasons for which bid responses were considered to have no applicable bids, with the number of bid responses affected for each reason.", "response": { "$ref": "ListBidResponsesWithoutBidsResponse" }, "parameterOrder": [ "buyersId", "filterSetsId" ], "id": "adexchangebuyer2.buyers.filterSets.bidResponsesWithoutBids.list" } } }, "filteredBidRequests": { "methods": { "list": { "id": "adexchangebuyer2.buyers.filterSets.filteredBidRequests.list", "parameterOrder": [ "buyersId", "filterSetsId" ], "response": { "$ref": "ListFilteredBidRequestsResponse" }, "description": "List all reasons that caused a bid request not to be sent for an impression, with the number of bid requests not sent for each reason.", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "flatPath": "v2beta1/buyers/{buyersId}/filterSets/{filterSetsId}/filteredBidRequests", "path": "v2beta1/buyers/{buyersId}/filterSets/{filterSetsId}/filteredBidRequests", "httpMethod": "GET", "parameters": { "buyersId": { "description": "Part of `filterSetName`. Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", "location": "path", "required": true, "type": "string" }, "pageToken": { "location": "query", "type": "string", "description": "A token identifying a page of results the server should return. Typically, this is the value of ListFilteredBidRequestsResponse.nextPageToken returned from the previous call to the filteredBidRequests.list method." }, "filterSetsId": { "location": "path", "required": true, "type": "string", "description": "Part of `filterSetName`. See documentation of `buyersId`." }, "pageSize": { "location": "query", "type": "integer", "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.", "format": "int32" } } } } }, "nonBillableWinningBids": { "methods": { "list": { "parameterOrder": [ "buyersId", "filterSetsId" ], "id": "adexchangebuyer2.buyers.filterSets.nonBillableWinningBids.list", "description": "List all reasons for which winning bids were not billable, with the number of bids not billed for each reason.", "response": { "$ref": "ListNonBillableWinningBidsResponse" }, "flatPath": "v2beta1/buyers/{buyersId}/filterSets/{filterSetsId}/nonBillableWinningBids", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "parameters": { "pageSize": { "format": "int32", "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.", "type": "integer", "location": "query" }, "buyersId": { "description": "Part of `filterSetName`. Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", "type": "string", "location": "path", "required": true }, "pageToken": { "location": "query", "type": "string", "description": "A token identifying a page of results the server should return. Typically, this is the value of ListNonBillableWinningBidsResponse.nextPageToken returned from the previous call to the nonBillableWinningBids.list method." }, "filterSetsId": { "description": "Part of `filterSetName`. See documentation of `buyersId`.", "type": "string", "location": "path", "required": true } }, "httpMethod": "GET", "path": "v2beta1/buyers/{buyersId}/filterSets/{filterSetsId}/nonBillableWinningBids" } } }, "impressionMetrics": { "methods": { "list": { "response": { "$ref": "ListImpressionMetricsResponse" }, "description": "Lists all metrics that are measured in terms of number of impressions.", "id": "adexchangebuyer2.buyers.filterSets.impressionMetrics.list", "parameterOrder": [ "buyersId", "filterSetsId" ], "httpMethod": "GET", "parameters": { "pageSize": { "type": "integer", "location": "query", "format": "int32", "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default." }, "filterSetsId": { "type": "string", "location": "path", "required": true, "description": "Part of `filterSetName`. See documentation of `buyersId`." }, "buyersId": { "description": "Part of `filterSetName`. Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", "location": "path", "required": true, "type": "string" }, "pageToken": { "description": "A token identifying a page of results the server should return. Typically, this is the value of ListImpressionMetricsResponse.nextPageToken returned from the previous call to the impressionMetrics.list method.", "location": "query", "type": "string" } }, "path": "v2beta1/buyers/{buyersId}/filterSets/{filterSetsId}/impressionMetrics", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "flatPath": "v2beta1/buyers/{buyersId}/filterSets/{filterSetsId}/impressionMetrics" } } }, "bidResponseErrors": { "methods": { "list": { "description": "List all errors that occurred in bid responses, with the number of bid responses affected for each reason.", "response": { "$ref": "ListBidResponseErrorsResponse" }, "parameterOrder": [ "buyersId", "filterSetsId" ], "id": "adexchangebuyer2.buyers.filterSets.bidResponseErrors.list", "path": "v2beta1/buyers/{buyersId}/filterSets/{filterSetsId}/bidResponseErrors", "parameters": { "pageSize": { "type": "integer", "location": "query", "format": "int32", "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default." }, "filterSetsId": { "type": "string", "location": "path", "required": true, "description": "Part of `filterSetName`. See documentation of `buyersId`." }, "buyersId": { "description": "Part of `filterSetName`. Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", "type": "string", "location": "path", "required": true }, "pageToken": { "description": "A token identifying a page of results the server should return. Typically, this is the value of ListBidResponseErrorsResponse.nextPageToken returned from the previous call to the bidResponseErrors.list method.", "type": "string", "location": "query" } }, "httpMethod": "GET", "flatPath": "v2beta1/buyers/{buyersId}/filterSets/{filterSetsId}/bidResponseErrors", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ] } } } } } } }, "bidders": { "resources": { "accounts": { "resources": { "filterSets": { "methods": { "delete": { "parameterOrder": [ "biddersId", "accountsId", "filterSetsId" ], "id": "adexchangebuyer2.bidders.accounts.filterSets.delete", "description": "Deletes the requested filter set from the account with the given account ID.", "response": { "$ref": "Empty" }, "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "path": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}", "parameters": { "biddersId": { "description": "Part of `name`. Full name of the resource to delete. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", "type": "string", "location": "path", "required": true }, "filterSetsId": { "description": "Part of `name`. See documentation of `biddersId`.", "type": "string", "location": "path", "required": true }, "accountsId": { "description": "Part of `name`. See documentation of `biddersId`.", "location": "path", "required": true, "type": "string" } }, "httpMethod": "DELETE" }, "list": { "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "parameters": { "biddersId": { "type": "string", "location": "path", "required": true, "description": "Part of `ownerName`. Name of the owner (bidder or account) of the filter sets to be listed. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456`" }, "pageToken": { "description": "A token identifying a page of results the server should return. Typically, this is the value of ListFilterSetsResponse.nextPageToken returned from the previous call to the accounts.filterSets.list method.", "type": "string", "location": "query" }, "accountsId": { "description": "Part of `ownerName`. See documentation of `biddersId`.", "type": "string", "location": "path", "required": true }, "pageSize": { "location": "query", "type": "integer", "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.", "format": "int32" } }, "httpMethod": "GET", "path": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets", "parameterOrder": [ "biddersId", "accountsId" ], "id": "adexchangebuyer2.bidders.accounts.filterSets.list", "description": "Lists all filter sets for the account with the given account ID.", "response": { "$ref": "ListFilterSetsResponse" } }, "create": { "path": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets", "httpMethod": "POST", "parameters": { "accountsId": { "description": "Part of `ownerName`. See documentation of `biddersId`.", "type": "string", "location": "path", "required": true }, "isTransient": { "type": "boolean", "location": "query", "description": "Whether the filter set is transient, or should be persisted indefinitely. By default, filter sets are not transient. If transient, it will be available for at least 1 hour after creation." }, "biddersId": { "location": "path", "required": true, "type": "string", "description": "Part of `ownerName`. Name of the owner (bidder or account) of the filter set to be created. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456`" } }, "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets", "request": { "$ref": "FilterSet" }, "response": { "$ref": "FilterSet" }, "description": "Creates the specified filter set for the account with the given account ID.", "id": "adexchangebuyer2.bidders.accounts.filterSets.create", "parameterOrder": [ "biddersId", "accountsId" ] }, "get": { "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "parameters": { "biddersId": { "description": "Part of `name`. Full name of the resource being requested. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", "type": "string", "location": "path", "required": true }, "filterSetsId": { "type": "string", "location": "path", "required": true, "description": "Part of `name`. See documentation of `biddersId`." }, "accountsId": { "description": "Part of `name`. See documentation of `biddersId`.", "location": "path", "required": true, "type": "string" } }, "httpMethod": "GET", "path": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}", "parameterOrder": [ "biddersId", "accountsId", "filterSetsId" ], "id": "adexchangebuyer2.bidders.accounts.filterSets.get", "description": "Retrieves the requested filter set for the account with the given account ID.", "response": { "$ref": "FilterSet" } } }, "resources": { "losingBids": { "methods": { "list": { "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/losingBids", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "parameters": { "biddersId": { "location": "path", "required": true, "type": "string", "description": "Part of `filterSetName`. Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`" }, "pageToken": { "description": "A token identifying a page of results the server should return. Typically, this is the value of ListLosingBidsResponse.nextPageToken returned from the previous call to the losingBids.list method.", "type": "string", "location": "query" }, "accountsId": { "description": "Part of `filterSetName`. See documentation of `biddersId`.", "type": "string", "location": "path", "required": true }, "pageSize": { "location": "query", "type": "integer", "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.", "format": "int32" }, "filterSetsId": { "description": "Part of `filterSetName`. See documentation of `biddersId`.", "location": "path", "required": true, "type": "string" } }, "httpMethod": "GET", "path": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/losingBids", "parameterOrder": [ "biddersId", "accountsId", "filterSetsId" ], "id": "adexchangebuyer2.bidders.accounts.filterSets.losingBids.list", "description": "List all reasons for which bids lost in the auction, with the number of bids that lost for each reason.", "response": { "$ref": "ListLosingBidsResponse" } } } }, "filteredBids": { "methods": { "list": { "description": "List all reasons for which bids were filtered, with the number of bids filtered for each reason.", "response": { "$ref": "ListFilteredBidsResponse" }, "parameterOrder": [ "biddersId", "accountsId", "filterSetsId" ], "id": "adexchangebuyer2.bidders.accounts.filterSets.filteredBids.list", "parameters": { "filterSetsId": { "description": "Part of `filterSetName`. See documentation of `biddersId`.", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.", "format": "int32", "location": "query", "type": "integer" }, "accountsId": { "description": "Part of `filterSetName`. See documentation of `biddersId`.", "type": "string", "location": "path", "required": true }, "biddersId": { "description": "Part of `filterSetName`. Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", "type": "string", "location": "path", "required": true }, "pageToken": { "description": "A token identifying a page of results the server should return. Typically, this is the value of ListFilteredBidsResponse.nextPageToken returned from the previous call to the filteredBids.list method.", "type": "string", "location": "query" } }, "httpMethod": "GET", "path": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/filteredBids", "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/filteredBids", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ] } }, "resources": { "details": { "methods": { "list": { "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/filteredBids/{creativeStatusId}/details", "path": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/filteredBids/{creativeStatusId}/details", "httpMethod": "GET", "parameters": { "biddersId": { "type": "string", "location": "path", "required": true, "description": "Part of `filterSetName`. Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`" }, "pageToken": { "type": "string", "location": "query", "description": "A token identifying a page of results the server should return. Typically, this is the value of ListCreativeStatusBreakdownByDetailResponse.nextPageToken returned from the previous call to the filteredBids.details.list method." }, "creativeStatusId": { "type": "integer", "location": "path", "required": true, "format": "int32", "description": "The ID of the creative status for which to retrieve a breakdown by detail. See [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes). Details are only available for statuses 10, 14, 15, 17, 18, 19, 86, and 87." }, "pageSize": { "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.", "format": "int32", "location": "query", "type": "integer" }, "accountsId": { "type": "string", "location": "path", "required": true, "description": "Part of `filterSetName`. See documentation of `biddersId`." }, "filterSetsId": { "location": "path", "required": true, "type": "string", "description": "Part of `filterSetName`. See documentation of `biddersId`." } }, "id": "adexchangebuyer2.bidders.accounts.filterSets.filteredBids.details.list", "parameterOrder": [ "biddersId", "accountsId", "filterSetsId", "creativeStatusId" ], "response": { "$ref": "ListCreativeStatusBreakdownByDetailResponse" }, "description": "List all details associated with a specific reason for which bids were filtered, with the number of bids filtered for each detail." } } }, "creatives": { "methods": { "list": { "parameters": { "filterSetsId": { "type": "string", "location": "path", "required": true, "description": "Part of `filterSetName`. See documentation of `biddersId`." }, "accountsId": { "description": "Part of `filterSetName`. See documentation of `biddersId`.", "type": "string", "location": "path", "required": true }, "pageSize": { "format": "int32", "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.", "type": "integer", "location": "query" }, "creativeStatusId": { "type": "integer", "location": "path", "required": true, "format": "int32", "description": "The ID of the creative status for which to retrieve a breakdown by creative. See [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes)." }, "biddersId": { "description": "Part of `filterSetName`. Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", "type": "string", "location": "path", "required": true }, "pageToken": { "type": "string", "location": "query", "description": "A token identifying a page of results the server should return. Typically, this is the value of ListCreativeStatusBreakdownByCreativeResponse.nextPageToken returned from the previous call to the filteredBids.creatives.list method." } }, "httpMethod": "GET", "path": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/filteredBids/{creativeStatusId}/creatives", "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/filteredBids/{creativeStatusId}/creatives", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "description": "List all creatives associated with a specific reason for which bids were filtered, with the number of bids filtered for each creative.", "response": { "$ref": "ListCreativeStatusBreakdownByCreativeResponse" }, "parameterOrder": [ "biddersId", "accountsId", "filterSetsId", "creativeStatusId" ], "id": "adexchangebuyer2.bidders.accounts.filterSets.filteredBids.creatives.list" } } } } }, "bidMetrics": { "methods": { "list": { "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/bidMetrics", "path": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/bidMetrics", "httpMethod": "GET", "parameters": { "biddersId": { "type": "string", "location": "path", "required": true, "description": "Part of `filterSetName`. Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`" }, "pageToken": { "location": "query", "type": "string", "description": "A token identifying a page of results the server should return. Typically, this is the value of ListBidMetricsResponse.nextPageToken returned from the previous call to the bidMetrics.list method." }, "filterSetsId": { "location": "path", "required": true, "type": "string", "description": "Part of `filterSetName`. See documentation of `biddersId`." }, "accountsId": { "description": "Part of `filterSetName`. See documentation of `biddersId`.", "location": "path", "required": true, "type": "string" }, "pageSize": { "type": "integer", "location": "query", "format": "int32", "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default." } }, "id": "adexchangebuyer2.bidders.accounts.filterSets.bidMetrics.list", "parameterOrder": [ "biddersId", "accountsId", "filterSetsId" ], "response": { "$ref": "ListBidMetricsResponse" }, "description": "Lists all metrics that are measured in terms of number of bids." } } }, "bidResponsesWithoutBids": { "methods": { "list": { "parameterOrder": [ "biddersId", "accountsId", "filterSetsId" ], "id": "adexchangebuyer2.bidders.accounts.filterSets.bidResponsesWithoutBids.list", "description": "List all reasons for which bid responses were considered to have no applicable bids, with the number of bid responses affected for each reason.", "response": { "$ref": "ListBidResponsesWithoutBidsResponse" }, "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/bidResponsesWithoutBids", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "path": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/bidResponsesWithoutBids", "parameters": { "biddersId": { "description": "Part of `filterSetName`. Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", "type": "string", "location": "path", "required": true }, "pageToken": { "description": "A token identifying a page of results the server should return. Typically, this is the value of ListBidResponsesWithoutBidsResponse.nextPageToken returned from the previous call to the bidResponsesWithoutBids.list method.", "location": "query", "type": "string" }, "accountsId": { "type": "string", "location": "path", "required": true, "description": "Part of `filterSetName`. See documentation of `biddersId`." }, "pageSize": { "type": "integer", "location": "query", "format": "int32", "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default." }, "filterSetsId": { "description": "Part of `filterSetName`. See documentation of `biddersId`.", "type": "string", "location": "path", "required": true } }, "httpMethod": "GET" } } }, "filteredBidRequests": { "methods": { "list": { "id": "adexchangebuyer2.bidders.accounts.filterSets.filteredBidRequests.list", "parameterOrder": [ "biddersId", "accountsId", "filterSetsId" ], "response": { "$ref": "ListFilteredBidRequestsResponse" }, "description": "List all reasons that caused a bid request not to be sent for an impression, with the number of bid requests not sent for each reason.", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/filteredBidRequests", "path": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/filteredBidRequests", "httpMethod": "GET", "parameters": { "biddersId": { "location": "path", "required": true, "type": "string", "description": "Part of `filterSetName`. Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`" }, "pageToken": { "location": "query", "type": "string", "description": "A token identifying a page of results the server should return. Typically, this is the value of ListFilteredBidRequestsResponse.nextPageToken returned from the previous call to the filteredBidRequests.list method." }, "filterSetsId": { "type": "string", "location": "path", "required": true, "description": "Part of `filterSetName`. See documentation of `biddersId`." }, "pageSize": { "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.", "format": "int32", "location": "query", "type": "integer" }, "accountsId": { "description": "Part of `filterSetName`. See documentation of `biddersId`.", "location": "path", "required": true, "type": "string" } } } } }, "nonBillableWinningBids": { "methods": { "list": { "response": { "$ref": "ListNonBillableWinningBidsResponse" }, "description": "List all reasons for which winning bids were not billable, with the number of bids not billed for each reason.", "id": "adexchangebuyer2.bidders.accounts.filterSets.nonBillableWinningBids.list", "parameterOrder": [ "biddersId", "accountsId", "filterSetsId" ], "httpMethod": "GET", "parameters": { "biddersId": { "location": "path", "required": true, "type": "string", "description": "Part of `filterSetName`. Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`" }, "pageToken": { "type": "string", "location": "query", "description": "A token identifying a page of results the server should return. Typically, this is the value of ListNonBillableWinningBidsResponse.nextPageToken returned from the previous call to the nonBillableWinningBids.list method." }, "filterSetsId": { "location": "path", "required": true, "type": "string", "description": "Part of `filterSetName`. See documentation of `biddersId`." }, "pageSize": { "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.", "format": "int32", "location": "query", "type": "integer" }, "accountsId": { "location": "path", "required": true, "type": "string", "description": "Part of `filterSetName`. See documentation of `biddersId`." } }, "path": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/nonBillableWinningBids", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/nonBillableWinningBids" } } }, "impressionMetrics": { "methods": { "list": { "path": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/impressionMetrics", "httpMethod": "GET", "parameters": { "biddersId": { "description": "Part of `filterSetName`. Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", "type": "string", "location": "path", "required": true }, "pageToken": { "location": "query", "type": "string", "description": "A token identifying a page of results the server should return. Typically, this is the value of ListImpressionMetricsResponse.nextPageToken returned from the previous call to the impressionMetrics.list method." }, "pageSize": { "type": "integer", "location": "query", "format": "int32", "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default." }, "accountsId": { "description": "Part of `filterSetName`. See documentation of `biddersId`.", "location": "path", "required": true, "type": "string" }, "filterSetsId": { "location": "path", "required": true, "type": "string", "description": "Part of `filterSetName`. See documentation of `biddersId`." } }, "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/impressionMetrics", "response": { "$ref": "ListImpressionMetricsResponse" }, "description": "Lists all metrics that are measured in terms of number of impressions.", "id": "adexchangebuyer2.bidders.accounts.filterSets.impressionMetrics.list", "parameterOrder": [ "biddersId", "accountsId", "filterSetsId" ] } } }, "bidResponseErrors": { "methods": { "list": { "id": "adexchangebuyer2.bidders.accounts.filterSets.bidResponseErrors.list", "parameterOrder": [ "biddersId", "accountsId", "filterSetsId" ], "response": { "$ref": "ListBidResponseErrorsResponse" }, "description": "List all errors that occurred in bid responses, with the number of bid responses affected for each reason.", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/bidResponseErrors", "path": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/bidResponseErrors", "httpMethod": "GET", "parameters": { "biddersId": { "location": "path", "required": true, "type": "string", "description": "Part of `filterSetName`. Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`" }, "pageToken": { "description": "A token identifying a page of results the server should return. Typically, this is the value of ListBidResponseErrorsResponse.nextPageToken returned from the previous call to the bidResponseErrors.list method.", "type": "string", "location": "query" }, "pageSize": { "location": "query", "type": "integer", "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.", "format": "int32" }, "accountsId": { "description": "Part of `filterSetName`. See documentation of `biddersId`.", "location": "path", "required": true, "type": "string" }, "filterSetsId": { "description": "Part of `filterSetName`. See documentation of `biddersId`.", "location": "path", "required": true, "type": "string" } } } } } } } } }, "filterSets": { "methods": { "list": { "flatPath": "v2beta1/bidders/{biddersId}/filterSets", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "path": "v2beta1/bidders/{biddersId}/filterSets", "parameters": { "biddersId": { "type": "string", "location": "path", "required": true, "description": "Part of `ownerName`. Name of the owner (bidder or account) of the filter sets to be listed. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456`" }, "pageToken": { "location": "query", "type": "string", "description": "A token identifying a page of results the server should return. Typically, this is the value of ListFilterSetsResponse.nextPageToken returned from the previous call to the accounts.filterSets.list method." }, "pageSize": { "location": "query", "type": "integer", "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.", "format": "int32" } }, "httpMethod": "GET", "parameterOrder": [ "biddersId" ], "id": "adexchangebuyer2.bidders.filterSets.list", "description": "Lists all filter sets for the account with the given account ID.", "response": { "$ref": "ListFilterSetsResponse" } }, "delete": { "parameters": { "biddersId": { "description": "Part of `name`. Full name of the resource to delete. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", "location": "path", "required": true, "type": "string" }, "filterSetsId": { "description": "Part of `name`. See documentation of `biddersId`.", "type": "string", "location": "path", "required": true } }, "httpMethod": "DELETE", "path": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}", "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "description": "Deletes the requested filter set from the account with the given account ID.", "response": { "$ref": "Empty" }, "parameterOrder": [ "biddersId", "filterSetsId" ], "id": "adexchangebuyer2.bidders.filterSets.delete" }, "get": { "description": "Retrieves the requested filter set for the account with the given account ID.", "response": { "$ref": "FilterSet" }, "parameterOrder": [ "biddersId", "filterSetsId" ], "id": "adexchangebuyer2.bidders.filterSets.get", "parameters": { "filterSetsId": { "description": "Part of `name`. See documentation of `biddersId`.", "type": "string", "location": "path", "required": true }, "biddersId": { "location": "path", "required": true, "type": "string", "description": "Part of `name`. Full name of the resource being requested. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`" } }, "httpMethod": "GET", "path": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}", "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ] }, "create": { "path": "v2beta1/bidders/{biddersId}/filterSets", "httpMethod": "POST", "parameters": { "biddersId": { "description": "Part of `ownerName`. Name of the owner (bidder or account) of the filter set to be created. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456`", "location": "path", "required": true, "type": "string" }, "isTransient": { "description": "Whether the filter set is transient, or should be persisted indefinitely. By default, filter sets are not transient. If transient, it will be available for at least 1 hour after creation.", "type": "boolean", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "flatPath": "v2beta1/bidders/{biddersId}/filterSets", "request": { "$ref": "FilterSet" }, "response": { "$ref": "FilterSet" }, "description": "Creates the specified filter set for the account with the given account ID.", "id": "adexchangebuyer2.bidders.filterSets.create", "parameterOrder": [ "biddersId" ] } }, "resources": { "bidMetrics": { "methods": { "list": { "description": "Lists all metrics that are measured in terms of number of bids.", "response": { "$ref": "ListBidMetricsResponse" }, "parameterOrder": [ "biddersId", "filterSetsId" ], "id": "adexchangebuyer2.bidders.filterSets.bidMetrics.list", "parameters": { "pageSize": { "location": "query", "type": "integer", "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.", "format": "int32" }, "biddersId": { "type": "string", "location": "path", "required": true, "description": "Part of `filterSetName`. Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`" }, "pageToken": { "location": "query", "type": "string", "description": "A token identifying a page of results the server should return. Typically, this is the value of ListBidMetricsResponse.nextPageToken returned from the previous call to the bidMetrics.list method." }, "filterSetsId": { "location": "path", "required": true, "type": "string", "description": "Part of `filterSetName`. See documentation of `biddersId`." } }, "httpMethod": "GET", "path": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/bidMetrics", "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/bidMetrics", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ] } } }, "bidResponsesWithoutBids": { "methods": { "list": { "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/bidResponsesWithoutBids", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "path": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/bidResponsesWithoutBids", "parameters": { "filterSetsId": { "type": "string", "location": "path", "required": true, "description": "Part of `filterSetName`. See documentation of `biddersId`." }, "biddersId": { "description": "Part of `filterSetName`. Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", "location": "path", "required": true, "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 ListBidResponsesWithoutBidsResponse.nextPageToken returned from the previous call to the bidResponsesWithoutBids.list method." }, "pageSize": { "location": "query", "type": "integer", "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.", "format": "int32" } }, "httpMethod": "GET", "parameterOrder": [ "biddersId", "filterSetsId" ], "id": "adexchangebuyer2.bidders.filterSets.bidResponsesWithoutBids.list", "description": "List all reasons for which bid responses were considered to have no applicable bids, with the number of bid responses affected for each reason.", "response": { "$ref": "ListBidResponsesWithoutBidsResponse" } } } }, "filteredBids": { "methods": { "list": { "description": "List all reasons for which bids were filtered, with the number of bids filtered for each reason.", "response": { "$ref": "ListFilteredBidsResponse" }, "parameterOrder": [ "biddersId", "filterSetsId" ], "id": "adexchangebuyer2.bidders.filterSets.filteredBids.list", "parameters": { "filterSetsId": { "location": "path", "required": true, "type": "string", "description": "Part of `filterSetName`. See documentation of `biddersId`." }, "biddersId": { "location": "path", "required": true, "type": "string", "description": "Part of `filterSetName`. Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`" }, "pageToken": { "description": "A token identifying a page of results the server should return. Typically, this is the value of ListFilteredBidsResponse.nextPageToken returned from the previous call to the filteredBids.list method.", "type": "string", "location": "query" }, "pageSize": { "location": "query", "type": "integer", "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.", "format": "int32" } }, "httpMethod": "GET", "path": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/filteredBids", "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/filteredBids", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ] } }, "resources": { "creatives": { "methods": { "list": { "description": "List all creatives associated with a specific reason for which bids were filtered, with the number of bids filtered for each creative.", "response": { "$ref": "ListCreativeStatusBreakdownByCreativeResponse" }, "parameterOrder": [ "biddersId", "filterSetsId", "creativeStatusId" ], "id": "adexchangebuyer2.bidders.filterSets.filteredBids.creatives.list", "path": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/filteredBids/{creativeStatusId}/creatives", "parameters": { "creativeStatusId": { "location": "path", "required": true, "type": "integer", "description": "The ID of the creative status for which to retrieve a breakdown by creative. See [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes).", "format": "int32" }, "biddersId": { "description": "Part of `filterSetName`. Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", "location": "path", "required": true, "type": "string" }, "pageToken": { "location": "query", "type": "string", "description": "A token identifying a page of results the server should return. Typically, this is the value of ListCreativeStatusBreakdownByCreativeResponse.nextPageToken returned from the previous call to the filteredBids.creatives.list method." }, "filterSetsId": { "type": "string", "location": "path", "required": true, "description": "Part of `filterSetName`. See documentation of `biddersId`." }, "pageSize": { "location": "query", "type": "integer", "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.", "format": "int32" } }, "httpMethod": "GET", "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/filteredBids/{creativeStatusId}/creatives", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ] } } }, "details": { "methods": { "list": { "id": "adexchangebuyer2.bidders.filterSets.filteredBids.details.list", "parameterOrder": [ "biddersId", "filterSetsId", "creativeStatusId" ], "response": { "$ref": "ListCreativeStatusBreakdownByDetailResponse" }, "description": "List all details associated with a specific reason for which bids were filtered, with the number of bids filtered for each detail.", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/filteredBids/{creativeStatusId}/details", "path": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/filteredBids/{creativeStatusId}/details", "httpMethod": "GET", "parameters": { "pageSize": { "location": "query", "type": "integer", "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.", "format": "int32" }, "filterSetsId": { "description": "Part of `filterSetName`. See documentation of `biddersId`.", "type": "string", "location": "path", "required": true }, "biddersId": { "description": "Part of `filterSetName`. Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", "location": "path", "required": true, "type": "string" }, "pageToken": { "location": "query", "type": "string", "description": "A token identifying a page of results the server should return. Typically, this is the value of ListCreativeStatusBreakdownByDetailResponse.nextPageToken returned from the previous call to the filteredBids.details.list method." }, "creativeStatusId": { "location": "path", "required": true, "type": "integer", "description": "The ID of the creative status for which to retrieve a breakdown by detail. See [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes). Details are only available for statuses 10, 14, 15, 17, 18, 19, 86, and 87.", "format": "int32" } } } } } } }, "losingBids": { "methods": { "list": { "id": "adexchangebuyer2.bidders.filterSets.losingBids.list", "parameterOrder": [ "biddersId", "filterSetsId" ], "response": { "$ref": "ListLosingBidsResponse" }, "description": "List all reasons for which bids lost in the auction, with the number of bids that lost for each reason.", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/losingBids", "httpMethod": "GET", "parameters": { "biddersId": { "description": "Part of `filterSetName`. Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", "location": "path", "required": true, "type": "string" }, "pageToken": { "location": "query", "type": "string", "description": "A token identifying a page of results the server should return. Typically, this is the value of ListLosingBidsResponse.nextPageToken returned from the previous call to the losingBids.list method." }, "filterSetsId": { "description": "Part of `filterSetName`. See documentation of `biddersId`.", "type": "string", "location": "path", "required": true }, "pageSize": { "format": "int32", "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.", "type": "integer", "location": "query" } }, "path": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/losingBids" } } }, "bidResponseErrors": { "methods": { "list": { "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/bidResponseErrors", "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "path": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/bidResponseErrors", "parameters": { "pageSize": { "location": "query", "type": "integer", "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.", "format": "int32" }, "biddersId": { "location": "path", "required": true, "type": "string", "description": "Part of `filterSetName`. Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`" }, "pageToken": { "description": "A token identifying a page of results the server should return. Typically, this is the value of ListBidResponseErrorsResponse.nextPageToken returned from the previous call to the bidResponseErrors.list method.", "location": "query", "type": "string" }, "filterSetsId": { "description": "Part of `filterSetName`. See documentation of `biddersId`.", "location": "path", "required": true, "type": "string" } }, "httpMethod": "GET", "parameterOrder": [ "biddersId", "filterSetsId" ], "id": "adexchangebuyer2.bidders.filterSets.bidResponseErrors.list", "description": "List all errors that occurred in bid responses, with the number of bid responses affected for each reason.", "response": { "$ref": "ListBidResponseErrorsResponse" } } } }, "impressionMetrics": { "methods": { "list": { "path": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/impressionMetrics", "httpMethod": "GET", "parameters": { "pageSize": { "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.", "format": "int32", "location": "query", "type": "integer" }, "biddersId": { "type": "string", "location": "path", "required": true, "description": "Part of `filterSetName`. Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`" }, "pageToken": { "type": "string", "location": "query", "description": "A token identifying a page of results the server should return. Typically, this is the value of ListImpressionMetricsResponse.nextPageToken returned from the previous call to the impressionMetrics.list method." }, "filterSetsId": { "type": "string", "location": "path", "required": true, "description": "Part of `filterSetName`. See documentation of `biddersId`." } }, "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/impressionMetrics", "response": { "$ref": "ListImpressionMetricsResponse" }, "description": "Lists all metrics that are measured in terms of number of impressions.", "id": "adexchangebuyer2.bidders.filterSets.impressionMetrics.list", "parameterOrder": [ "biddersId", "filterSetsId" ] } } }, "filteredBidRequests": { "methods": { "list": { "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/filteredBidRequests", "httpMethod": "GET", "parameters": { "filterSetsId": { "description": "Part of `filterSetName`. See documentation of `biddersId`.", "type": "string", "location": "path", "required": true }, "biddersId": { "description": "Part of `filterSetName`. Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", "location": "path", "required": true, "type": "string" }, "pageToken": { "description": "A token identifying a page of results the server should return. Typically, this is the value of ListFilteredBidRequestsResponse.nextPageToken returned from the previous call to the filteredBidRequests.list method.", "type": "string", "location": "query" }, "pageSize": { "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.", "format": "int32", "location": "query", "type": "integer" } }, "path": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/filteredBidRequests", "id": "adexchangebuyer2.bidders.filterSets.filteredBidRequests.list", "parameterOrder": [ "biddersId", "filterSetsId" ], "response": { "$ref": "ListFilteredBidRequestsResponse" }, "description": "List all reasons that caused a bid request not to be sent for an impression, with the number of bid requests not sent for each reason." } } }, "nonBillableWinningBids": { "methods": { "list": { "scopes": [ "https://www.googleapis.com/auth/adexchange.buyer" ], "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/nonBillableWinningBids", "path": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/nonBillableWinningBids", "httpMethod": "GET", "parameters": { "pageSize": { "type": "integer", "location": "query", "format": "int32", "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default." }, "biddersId": { "description": "Part of `filterSetName`. Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", "location": "path", "required": true, "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 ListNonBillableWinningBidsResponse.nextPageToken returned from the previous call to the nonBillableWinningBids.list method." }, "filterSetsId": { "description": "Part of `filterSetName`. See documentation of `biddersId`.", "location": "path", "required": true, "type": "string" } }, "id": "adexchangebuyer2.bidders.filterSets.nonBillableWinningBids.list", "parameterOrder": [ "biddersId", "filterSetsId" ], "response": { "$ref": "ListNonBillableWinningBidsResponse" }, "description": "List all reasons for which winning bids were not billable, with the number of bids not billed for each reason." } } } } } } } }, "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/adexchange.buyer": { "description": "Manage your Ad Exchange buyer account configuration" } } } }, "version": "v2beta1", "batchPath": "batch", "kind": "discovery#restDescription", "title": "Ad Exchange Buyer API II", "version_module": true, "discoveryVersion": "v1", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "mtlsRootUrl": "https://adexchangebuyer.mtls.googleapis.com/", "servicePath": "" }