"description":"The ID of the creative status.\nSee [creative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-status-codes).",
"type":"integer"
},
"bidCount":{
"$ref":"MetricValue",
"description":"The number of bids with the specified status."
},
"rowDimensions":{
"$ref":"RowDimensions",
"description":"The values of all dimensions associated with metric values in this row."
}
},
"id":"CreativeStatusRow",
"description":"The number of bids with the specified dimension values that did not win the\nauction (either were filtered pre-auction or lost the auction), as described\nby the specified creative status."
},
"RealtimeTimeRange":{
"description":"An open-ended realtime time range specified by the start timestamp.\nFor filter sets that specify a realtime time range RTB metrics continue to\nbe aggregated throughout the lifetime of the filter set.",
"type":"object",
"properties":{
"startTimestamp":{
"format":"google-datetime",
"description":"The start timestamp of the real-time RTB metrics aggregation.",
"type":"string"
}
},
"id":"RealtimeTimeRange"
},
"NonBillableWinningBidStatusRow":{
"description":"The number of winning bids with the specified dimension values for which the\nbuyer was not billed, as described by the specified status.",
"description":"The number of bids with the specified status.",
"$ref":"MetricValue"
}
},
"id":"NonBillableWinningBidStatusRow"
},
"FilteredBidDetailRow":{
"description":"The number of filtered bids with the specified dimension values, among those\nfiltered due to the requested filtering reason (i.e. creative status), that\nhave the specified detail.",
"type":"object",
"properties":{
"rowDimensions":{
"$ref":"RowDimensions",
"description":"The values of all dimensions associated with metric values in this row."
"description":"The ID of the detail. The associated value can be looked up in the\ndictionary file corresponding to the DetailType in the response message.",
"description":"The number of bids with the specified detail.",
"$ref":"MetricValue"
}
},
"id":"FilteredBidDetailRow"
},
"AbsoluteDateRange":{
"description":"An absolute date range, specified by its start date and end date.\nThe supported range of dates begins 30 days before today and ends today.\nValidity checked upon filter set creation. If a filter set with an absolute\ndate range is run at a later date more than 30 days after start_date, it will\nfail.",
"type":"object",
"properties":{
"startDate":{
"description":"The start date of the range (inclusive).\nMust be within the 30 days leading up to current date, and must be equal to\nor before end_date.",
"$ref":"Date"
},
"endDate":{
"description":"The end date of the range (inclusive).\nMust be within the 30 days leading up to current date, and must be equal to\nor after start_date.",
"$ref":"Date"
}
},
"id":"AbsoluteDateRange"
},
"AddDealAssociationRequest":{
"type":"object",
"properties":{
"association":{
"description":"The association between a creative and a deal that should be added.",
"description":"The Pub/Sub topic to publish notifications to.\nThis topic must already exist and must give permission to\nad-exchange-buyside-reports@google.com to write to the topic.\nThis should be the full resource name in\n\"projects/{project_id}/topics/{topic_id}\" format."
"description":"A relative date range, specified by an offset and a duration.\nThe supported range of dates begins 30 days before today and ends today.\nI.e. the limits for these values are:\noffset_days \u003e= 0\nduration_days \u003e= 1\noffset_days + duration_days \u003c= 30",
"description":"A token to retrieve the next page of results.\nPass this value in the\nListClientsRequest.pageToken\nfield in the subsequent call to the\naccounts.clients.list method\nto retrieve the next page of results.",
"description":"Response message for listing all reasons that bid responses were considered\nto have no applicable bids.",
"type":"object",
"properties":{
"nextPageToken":{
"description":"A token to retrieve the next page of results.\nPass this value in the\nListBidResponsesWithoutBidsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.bidResponsesWithoutBids.list\nmethod to retrieve the next page of results.",
"description":"An image resource. You may provide a larger image than was requested,\nso long as the aspect ratio is preserved."
},
"ListFilterSetsResponse":{
"description":"Response message for listing filter sets.",
"type":"object",
"properties":{
"filterSets":{
"description":"The filter sets belonging to the buyer.",
"items":{
"$ref":"FilterSet"
},
"type":"array"
},
"nextPageToken":{
"description":"A token to retrieve the next page of results.\nPass this value in the\nListFilterSetsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.list\nmethod to retrieve the next page of results.",
"type":"string"
}
},
"id":"ListFilterSetsResponse"
},
"BidResponseWithoutBidsStatusRow":{
"description":"The number of impressions with the specified dimension values that were\nconsidered to have no applicable bids, as described by the specified status.",
"type":"object",
"properties":{
"rowDimensions":{
"$ref":"RowDimensions",
"description":"The values of all dimensions associated with metric values in this row."
},
"impressionCount":{
"description":"The number of impressions for which there was a bid response with the\nspecified status.",
"$ref":"MetricValue"
},
"status":{
"description":"The status specifying why the bid responses were considered to have no\napplicable bids.",
"A placeholder for an undefined status.\nThis 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\nincluded bids on behalf of other accounts.",
"The response had no bids for the specified deal, though it may have\nincluded bids on other deals on behalf of the account to which the deal\nbelongs."
"description":"The unique numerical ID of the invitation that is sent to the user.\nThe value of this field is ignored in create operations.",
"type":"string"
},
"email":{
"description":"The email address to which the invitation is sent. Email\naddresses should be unique among all client users under each sponsor\nbuyer.",
"type":"string"
},
"clientAccountId":{
"format":"int64",
"description":"Numerical account ID of the client buyer\nthat the invited user is associated with.\nThe value of this field is ignored in create operations.",
"type":"string"
}
},
"id":"ClientUserInvitation",
"description":"An invitation for a new client user to get access to the Ad Exchange\nBuyer UI.\nAll fields are required unless otherwise specified.",
"type":"object"
},
"ListCreativeStatusBreakdownByDetailResponse":{
"properties":{
"nextPageToken":{
"description":"A token to retrieve the next page of results.\nPass this value in the\nListCreativeStatusBreakdownByDetailRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.filteredBids.details.list\nmethod to retrieve the next page of results.",
"type":"string"
},
"filteredBidDetailRows":{
"description":"List of rows, with counts of bids with a given creative status aggregated\nby detail.",
"items":{
"$ref":"FilteredBidDetailRow"
},
"type":"array"
},
"detailType":{
"type":"string",
"enumDescriptions":[
"A placeholder for an undefined status.\nThis value will never be returned in responses.",
"Indicates that the detail ID refers to a creative attribute; see\n[publisher-excludable-creative-attributes](https://developers.google.com/ad-exchange/rtb/downloads/publisher-excludable-creative-attributes).",
"Indicates that the detail ID refers to a vendor; see\n[vendors](https://developers.google.com/ad-exchange/rtb/downloads/vendors).",
"Indicates that the detail ID refers to a sensitive category; see\n[ad-sensitive-categories](https://developers.google.com/ad-exchange/rtb/downloads/ad-sensitive-categories).",
"Indicates that the detail ID refers to a product category; see\n[ad-product-categories](https://developers.google.com/ad-exchange/rtb/downloads/ad-product-categories).",
"Indicates that the detail ID refers to a disapproval reason; see\nDisapprovalReason enum in [snippet-status-report-proto](https://developers.google.com/ad-exchange/rtb/downloads/snippet-status-report-proto)."
],
"enum":[
"DETAIL_TYPE_UNSPECIFIED",
"CREATIVE_ATTRIBUTE",
"VENDOR",
"SENSITIVE_CATEGORY",
"PRODUCT_CATEGORY",
"DISAPPROVAL_REASON"
],
"description":"The type of detail that the detail IDs represent."
"description":"A token to retrieve the next page of results.\nPass this value in the\nListClientUsersRequest.pageToken\nfield in the subsequent call to the\nclients.invitations.list\nmethod to retrieve the next\npage of results.",
"description":"The returned list of client users.",
"items":{
"$ref":"ClientUser"
},
"type":"array"
}
},
"id":"ListClientUsersResponse"
},
"ListClientUserInvitationsResponse":{
"type":"object",
"properties":{
"nextPageToken":{
"description":"A token to retrieve the next page of results.\nPass this value in the\nListClientUserInvitationsRequest.pageToken\nfield in the subsequent call to the\nclients.invitations.list\nmethod to retrieve the next\npage of results.",
"description":"IDs representing the geo location for this context.\nPlease refer to the\n[geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv)\nfile for different geo criteria IDs.",
"description":"The variance (i.e. square of the standard deviation) of the metric value.\nIf value is exact, variance is 0.\nCan be used to calculate margin of error as a percentage of value, using\nthe following formula, where Z is the standard constant that depends on the\ndesired size of the confidence interval (e.g. for 90% confidence interval,\nuse Z = 1.645):\n\n marginOfError = 100 * Z * sqrt(variance) / value"
},
"value":{
"format":"int64",
"description":"The expected value of the metric.",
"description":"A client user is created under a client buyer and has restricted access to\nthe Ad Exchange Marketplace and certain other sections\nof the Ad Exchange Buyer UI based on the role\ngranted to the associated client buyer.\n\nThe only way a new client user can be created is via accepting an\nemail invitation\n(see the\naccounts.clients.invitations.create\nmethod).\n\nAll fields are required unless otherwise specified.",
"description":"User's email address. The value of this field\nis ignored in an update operation.",
"type":"string"
},
"userId":{
"format":"int64",
"description":"The unique numerical ID of the client user\nthat has accepted an invitation.\nThe value of this field is ignored in an update operation.",
"type":"string"
},
"clientAccountId":{
"format":"int64",
"description":"Numerical account ID of the client buyer\nwith which the user is associated; the\nbuyer must be a client of the current sponsor buyer.\nThe value of this field is ignored in an update operation.",
"description":"All vendor IDs for the ads that may be shown from this creative.\nSee https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt\nfor possible values.",
"description":"The set of URLs to be called to record an impression.",
"items":{
"type":"string"
},
"type":"array"
},
"html":{
"$ref":"HtmlContent",
"description":"An HTML creative."
},
"detectedProductCategories":{
"description":"@OutputOnly Detected product categories, if any.\nSee the ad-product-categories.txt file in the technical documentation\nfor a list of IDs.",
"items":{
"format":"int32",
"type":"integer"
},
"type":"array"
},
"dealsStatus":{
"enumDescriptions":[
"The status is unknown.",
"The creative has not been checked.",
"The creative has been conditionally approved.\nSee serving_restrictions for details.",
"The creative has been approved.",
"The creative has been disapproved."
],
"enum":[
"STATUS_UNSPECIFIED",
"NOT_CHECKED",
"CONDITIONALLY_APPROVED",
"APPROVED",
"DISAPPROVED"
],
"description":"@OutputOnly The top-level deals status of this creative.\nIf disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in\nserving_restrictions will also exist. Note\nthat this may be nuanced with other contextual restrictions, in which case,\nit may be preferable to read from serving_restrictions directly.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
"description":"@OutputOnly The top-level open auction status of this creative.\nIf disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in\nserving_restrictions will also exist. Note\nthat this may be nuanced with other contextual restrictions, in which case,\nit may be preferable to read from serving_restrictions directly.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
"type":"string",
"enumDescriptions":[
"The status is unknown.",
"The creative has not been checked.",
"The creative has been conditionally approved.\nSee serving_restrictions for details.",
"The creative has been approved.",
"The creative has been disapproved."
],
"enum":[
"STATUS_UNSPECIFIED",
"NOT_CHECKED",
"CONDITIONALLY_APPROVED",
"APPROVED",
"DISAPPROVED"
]
},
"advertiserName":{
"description":"The name of the company being advertised in the creative.",
"type":"string"
},
"detectedDomains":{
"description":"@OutputOnly\nThe detected domains for this creative.",
"description":"@OutputOnly The last update timestamp of the creative via API."
},
"detectedLanguages":{
"description":"@OutputOnly\nThe detected languages for this creative. The order is arbitrary. The codes\nare 2 or 5 characters and are documented at\nhttps://developers.google.com/adwords/api/docs/appendix/languagecodes.",
"description":"@OutputOnly The granular status of this ad in specific contexts.\nA context here relates to where something ultimately serves (for example,\na physical location, a platform, an HTTPS vs HTTP request, or the type\nof auction).",
"description":"@OutputOnly Detected sensitive categories, if any.\nSee the ad-sensitive-categories.txt file in the technical documentation for\na list of IDs. You should use these IDs along with the\nexcluded-sensitive-category field in the bid request to filter your bids.",
"description":"The day during which the data was collected.\nThe data is collected from 00:00:00 to 23:59:59 PT.\nDuring switches from PST to PDT and back, the day may\ncontain 23 or 25 hours of data instead of the usual 24.",
"description":"A token to retrieve the next page of results.\nPass this value in the\nListCreativeStatusBreakdownByCreativeRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.filteredBids.creatives.list\nmethod to retrieve the next page of results.",
"description":"A client resource represents a client buyer—an agency,\na brand, or an advertiser customer of the sponsor buyer.\nUsers associated with the client buyer have restricted access to\nthe Ad Exchange Marketplace and certain other sections\nof the Ad Exchange Buyer UI based on the role\ngranted to the client buyer.\nAll fields are required unless otherwise specified.",
"description":"The name of the entity. This field is automatically fetched based on\nthe type and ID.\nThe value of this field is ignored in create and update operations."
"description":"Name used to represent this client to publishers.\nYou may have multiple clients that map to the same entity,\nbut for each client the combination of `clientName` and entity\nmust be unique.\nYou can specify this field as empty.",
"description":"The role which is assigned to the client buyer. Each role implies a set of\npermissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,\n`CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.",
"type":"string",
"enumDescriptions":[
"A placeholder for an undefined client role.",
"Users associated with this client can see publisher deal offers\nin the Marketplace.\nThey can neither negotiate proposals nor approve deals.\nIf this client is visible to publishers, they can send deal proposals\nto this client.",
"Users associated with this client can respond to deal proposals\nsent to them by publishers. They can also initiate deal proposals\nof their own.",
"Users associated with this client can approve eligible deals\non your behalf. Some deals may still explicitly require publisher\nfinalization. If this role is not selected, the sponsor buyer\nwill need to manually approve each of their deals."
"description":"Numerical identifier of the client entity.\nThe entity can be an advertiser, a brand, or an agency.\nThis identifier is unique among all the entities with the same type.\n\nA list of all known advertisers with their identifiers is available in the\n[advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt)\nfile.\n\nA list of all known brands with their identifiers is available in the\n[brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)\nfile.\n\nA list of all known agencies with their identifiers is available in the\n[agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt)\nfile.",
"description":"A set of filters that is applied to a request for data.\nWithin a filter set, an AND operation is performed across the filters\nrepresented by each field. An OR operation is performed across the filters\nrepresented by the multiple values of a repeated field. E.g.\n\"format=VIDEO AND deal_id=12 AND (seller_network_id=34 OR\nseller_network_id=56)\"",
"A placeholder for an unspecified interval; no time series is applied.\nAll 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."
],
"enum":[
"TIME_SERIES_GRANULARITY_UNSPECIFIED",
"HOURLY",
"DAILY"
]
},
"filterSetId":{
"type":"string",
"format":"int64",
"description":"The ID of the filter set; unique within the account of the filter set\nowner.\nThe value of this field is ignored in create operations."
},
"realtimeTimeRange":{
"description":"An open-ended realtime time range, defined by the aggregation start\ntimestamp.",
"$ref":"RealtimeTimeRange"
},
"creativeId":{
"description":"The ID of the creative on which to filter; optional.",
"type":"string"
},
"relativeDateRange":{
"$ref":"RelativeDateRange",
"description":"A relative date range, defined by an offset from today and a duration.\nInterpreted relative to Pacific time zone."
},
"platforms":{
"description":"The list of platforms on which to filter; may be empty. The filters\nrepresented by multiple platforms are ORed together (i.e. if non-empty,\nresults must match any one of the platforms).",
"items":{
"type":"string",
"enum":[
"PLATFORM_UNSPECIFIED",
"DESKTOP",
"TABLET",
"MOBILE"
]
},
"type":"array",
"enumDescriptions":[
"A placeholder for an undefined platform; indicates that no platform\nfilter 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."
]
},
"sellerNetworkIds":{
"description":"The list of IDs of the seller (publisher) networks on which to filter;\nmay be empty. The filters represented by multiple seller network IDs are\nORed together (i.e. if non-empty, results must match any one of the\npublisher networks).\nSee [seller-network-ids](https://developers.google.com/ad-exchange/rtb/downloads/seller-network-ids)\nfile for the set of existing seller network IDs.",
"description":"A token to retrieve the next page of results.\nPass this value in the\nListDealAssociationsRequest.page_token\nfield in the subsequent call to 'ListDealAssociation' method to retrieve\nthe next page of results.",
"description":"The number of impressions with the specified dimension values where the\ncorresponding bid request or bid response was not successful, as described by\nthe specified callout status.",
"description":"The ID of the callout status.\nSee [callout-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/callout-status-codes).",
"description":"@OutputOnly A representation of the status of an ad in a\nspecific context. A context here relates to where something ultimately serves\n(for example, a user or publisher geo, a platform, an HTTPS vs HTTP request,\nor the type of auction).",
"description":"Any disapprovals bound to this restriction.\nOnly present if status=DISAPPROVED.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
"description":"Represents a whole calendar date, e.g. date of birth. The time of day and\ntime zone are either specified elsewhere or are not significant. The date\nis relative to the Proleptic Gregorian Calendar. The day may be 0 to\nrepresent a year and month where the day is not significant, e.g. credit card\nexpiration date. The year may be 0 to represent a month and day independent\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand `google.protobuf.Timestamp`.",
"description":"Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year/month where the day is not significant.",
"description":"A response may include multiple rows, breaking down along various dimensions.\nEncapsulates the values of all dimensions for a given row.",
"description":"A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
"description":"A token to retrieve the next page of results.\nPass this value in the\nListFilteredBidsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.filteredBids.list\nmethod to retrieve the next page of results.",
"description":"A token to retrieve the next page of results.\nPass this value in the\nListCreativesRequest.page_token\nfield in the subsequent call to `ListCreatives` method to retrieve the next\npage of results."
"description":"A token to retrieve the next page of results.\nPass this value in the\nListFilteredBidRequestsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.filteredBidRequests.list\nmethod to retrieve the next page of results.",
"description":"A token to retrieve the next page of results.\nPass this value in the\nListBidMetricsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.bidMetrics.list\nmethod to retrieve the next page of results.",
"description":"The filtering status code. Please refer to the\n[creative-status-codes.txt](https://storage.googleapis.com/adx-rtb-dictionaries/creative-status-codes.txt)\nfile for different statuses.",
"description":"A token to retrieve the next page of results.\nPass this value in the\nListLosingBidsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.losingBids.list\nmethod to retrieve the next page of results.",
"type":"string"
}
}
},
"ListNonBillableWinningBidsResponse":{
"description":"Response message for listing all reasons for which a buyer was not billed for\na winning bid.",
"type":"object",
"properties":{
"nonBillableWinningBidStatusRows":{
"description":"List of rows, with counts of bids not billed aggregated by reason.",
"description":"A token to retrieve the next page of results.\nPass this value in the\nListNonBillableWinningBidsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.nonBillableWinningBids.list\nmethod to retrieve the next page of results.",
"description":"The number of impressions for which the buyer successfully sent a response\nto Ad Exchange."
}
},
"id":"ImpressionMetricsRow",
"description":"The set of metrics that are measured in numbers of impressions, representing\nhow many impressions with the specified dimension values were considered\neligible at each stage of the bidding funnel."
},
"AuctionContext":{
"properties":{
"auctionTypes":{
"description":"The auction types this restriction applies to.",
"description":"A token to retrieve the next page of results.\nPass this value in the\nListImpressionMetricsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.impressionMetrics.list\nmethod to retrieve the next page of results.",
"type":"string"
}
},
"id":"ListImpressionMetricsResponse"
},
"BidMetricsRow":{
"properties":{
"bids":{
"description":"The number of bids that Ad Exchange received from the buyer.",
"description":"The set of metrics that are measured in numbers of bids, representing how\nmany bids with the specified dimension values were considered eligible at\neach stage of the bidding funnel;",
"description":"A token to retrieve the next page of results.\nPass this value in the\nListBidResponseErrorsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.bidResponseErrors.list\nmethod to retrieve the next page of results.",
"type":"string"
},
"calloutStatusRows":{
"description":"List of rows, with counts of bid responses aggregated by callout status.",
"description":"Unique numerical account ID for the buyer of which the client buyer\nis a customer; the sponsor buyer to create a client for. (required)",
"description":"Lists all the clients for the current sponsor buyer.",
"httpMethod":"GET",
"response":{
"$ref":"ListClientsResponse"
},
"parameterOrder":[
"accountId"
],
"parameters":{
"pageToken":{
"description":"A token identifying a page of results the server should return.\nTypically, this is the value of\nListClientsResponse.nextPageToken\nreturned from the previous call to the\naccounts.clients.list method.",
"type":"string",
"location":"query"
},
"pageSize":{
"format":"int32",
"description":"Requested page size. The server may return fewer clients than requested.\nIf unspecified, the server will pick an appropriate default.",
"type":"integer",
"location":"query"
},
"accountId":{
"type":"string",
"required":true,
"location":"path",
"format":"int64",
"description":"Unique numerical account ID of the sponsor buyer to list the clients for."
"description":"Updates an existing client buyer.",
"request":{
"$ref":"Client"
},
"httpMethod":"PUT",
"parameterOrder":[
"accountId",
"clientAccountId"
],
"response":{
"$ref":"Client"
},
"parameters":{
"accountId":{
"location":"path",
"format":"int64",
"description":"Unique numerical account ID for the buyer of which the client buyer\nis a customer; the sponsor buyer to update a client for. (required)",
"type":"string",
"required":true
},
"clientAccountId":{
"type":"string",
"required":true,
"location":"path",
"format":"int64",
"description":"Unique numerical account ID of the client to update. (required)"
"description":"A token identifying a page of results the server should return.\nTypically, this is the value of\nListClientUserInvitationsResponse.nextPageToken\nreturned from the previous call to the\nclients.invitations.list\nmethod.",
"type":"string"
},
"pageSize":{
"format":"int32",
"description":"Requested page size. Server may return fewer clients than requested.\nIf unspecified, server will pick an appropriate default.",
"type":"integer",
"location":"query"
},
"accountId":{
"location":"path",
"format":"int64",
"description":"Numerical account ID of the client's sponsor buyer. (required)",
"type":"string",
"required":true
},
"clientAccountId":{
"location":"path",
"description":"Numerical account ID of the client buyer to list invitations for.\n(required)\nYou must either specify a string representation of a\nnumerical account identifier or the `-` character\nto list all the invitations for all the clients\nof a given sponsor buyer.",
"description":"A token identifying a page of results the server should return.\nTypically, this is the value of\nListClientUsersResponse.nextPageToken\nreturned from the previous call to the\naccounts.clients.users.list method.",
"type":"string"
},
"pageSize":{
"location":"query",
"format":"int32",
"description":"Requested page size. The server may return fewer clients than requested.\nIf unspecified, the server will pick an appropriate default.",
"type":"integer"
},
"accountId":{
"format":"int64",
"description":"Numerical account ID of the sponsor buyer of the client to list users for.\n(required)",
"type":"string",
"required":true,
"location":"path"
},
"clientAccountId":{
"description":"The account ID of the client buyer to list users for. (required)\nYou must specify either a string representation of a\nnumerical account identifier or the `-` character\nto list all the client users for all the clients\nof a given sponsor buyer.",
"description":"Requested page size. The server may return fewer creatives than requested\n(due to timeout constraint) even if more are available via another call.\nIf unspecified, server will pick an appropriate default.\nAcceptable values are 1 to 1000, inclusive.",
"type":"integer"
},
"accountId":{
"description":"The account to list the creatives from.\nSpecify \"-\" to list all creatives the current user has access to.",
"type":"string",
"required":true,
"location":"path"
},
"query":{
"description":"An optional query string to filter creatives. If no filter is specified,\nall active creatives will be returned.\nSupported queries are:\n\u003cul\u003e\n\u003cli\u003eaccountId=\u003ci\u003eaccount_id_string\u003c/i\u003e\n\u003cli\u003ecreativeId=\u003ci\u003ecreative_id_string\u003c/i\u003e\n\u003cli\u003edealsStatus: {approved, conditionally_approved, disapproved,\n not_checked}\n\u003cli\u003eopenAuctionStatus: {approved, conditionally_approved, disapproved,\n not_checked}\n\u003cli\u003eattribute: {a numeric attribute from the list of attributes}\n\u003cli\u003edisapprovalReason: {a reason from\nDisapprovalReason\n\u003c/ul\u003e\nExample: 'accountId=12345 AND (dealsStatus:disapproved AND\ndisapprovalReason:unacceptable_content) OR attribute:47'",
"type":"string",
"location":"query"
},
"pageToken":{
"description":"A token identifying a page of results the server should return.\nTypically, this is the value of\nListCreativesResponse.next_page_token\nreturned from the previous call to 'ListCreatives' method.",
"description":"Watches a creative. Will result in push notifications being sent to the\ntopic when the creative changes status.",
"request":{
"$ref":"WatchCreativeRequest"
},
"httpMethod":"POST",
"parameterOrder":[
"accountId",
"creativeId"
],
"response":{
"$ref":"Empty"
},
"parameters":{
"accountId":{
"location":"path",
"description":"The account of the creative to watch.",
"type":"string",
"required":true
},
"creativeId":{
"location":"path",
"description":"The creative ID to watch for status changes.\nSpecify \"-\" to watch all creatives under the above account.\nIf both creative-level and account-level notifications are\nsent, only a single notification will be sent to the\ncreative-level notification topic.",
"description":"A token identifying a page of results the server should return.\nTypically, this is the value of\nListDealAssociationsResponse.next_page_token\nreturned from the previous call to 'ListDealAssociations' method."
},
"pageSize":{
"location":"query",
"format":"int32",
"description":"Requested page size. Server may return fewer associations than requested.\nIf unspecified, server will pick an appropriate default.",
"type":"integer"
},
"accountId":{
"location":"path",
"description":"The account to list the associations from.\nSpecify \"-\" to list all creatives the current user has access to.",
"type":"string",
"required":true
},
"query":{
"location":"query",
"description":"An optional query string to filter deal associations. If no filter is\nspecified, all associations will be returned.\nSupported queries are:\n\u003cul\u003e\n\u003cli\u003eaccountId=\u003ci\u003eaccount_id_string\u003c/i\u003e\n\u003cli\u003ecreativeId=\u003ci\u003ecreative_id_string\u003c/i\u003e\n\u003cli\u003edealsId=\u003ci\u003edeals_id_string\u003c/i\u003e\n\u003cli\u003edealsStatus:{approved, conditionally_approved, disapproved,\n not_checked}\n\u003cli\u003eopenAuctionStatus:{approved, conditionally_approved, disapproved,\n not_checked}\n\u003c/ul\u003e\nExample: 'dealsId=12345 AND dealsStatus:disapproved'",
"type":"string"
},
"creativeId":{
"location":"path",
"description":"The creative ID to list the associations from.\nSpecify \"-\" to list all creatives under the above account.",
"description":"A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilterSetsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.list\nmethod.",
"type":"string",
"location":"query"
},
"pageSize":{
"location":"query",
"format":"int32",
"description":"Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
"description":"Retrieves the requested filter set for the account with the given account\nID."
},
"create":{
"response":{
"$ref":"FilterSet"
},
"parameterOrder":[
"accountId"
],
"httpMethod":"POST",
"parameters":{
"isTransient":{
"location":"query",
"description":"Whether the filter set is transient, or should be persisted indefinitely.\nBy default, filter sets are not transient.\nIf transient, it will be available for at least 1 hour after creation.",
"description":"Creates the specified filter set for the account with the given account ID.",
"request":{
"$ref":"FilterSet"
}
}
},
"resources":{
"bidMetrics":{
"methods":{
"list":{
"httpMethod":"GET",
"response":{
"$ref":"ListBidMetricsResponse"
},
"parameterOrder":[
"accountId",
"filterSetId"
],
"parameters":{
"pageToken":{
"description":"A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidMetricsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.bidMetrics.list\nmethod.",
"type":"string",
"location":"query"
},
"pageSize":{
"format":"int32",
"description":"Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
"type":"integer",
"location":"query"
},
"accountId":{
"location":"path",
"format":"int64",
"description":"Account ID of the buyer.",
"type":"string",
"required":true
},
"filterSetId":{
"location":"path",
"format":"int64",
"description":"The ID of the filter set to apply.",
"description":"Lists all metrics that are measured in terms of number of bids."
}
}
},
"impressionMetrics":{
"methods":{
"list":{
"httpMethod":"GET",
"response":{
"$ref":"ListImpressionMetricsResponse"
},
"parameterOrder":[
"accountId",
"filterSetId"
],
"parameters":{
"pageToken":{
"description":"A token identifying a page of results the server should return.\nTypically, this is the value of\nListImpressionMetricsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.impressionMetrics.list\nmethod.",
"type":"string",
"location":"query"
},
"pageSize":{
"location":"query",
"format":"int32",
"description":"Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
"type":"integer"
},
"accountId":{
"location":"path",
"format":"int64",
"description":"Account ID of the buyer.",
"type":"string",
"required":true
},
"filterSetId":{
"format":"int64",
"description":"The ID of the filter set to apply.",
"description":"Lists all metrics that are measured in terms of number of impressions."
}
}
},
"bidResponseErrors":{
"methods":{
"list":{
"httpMethod":"GET",
"response":{
"$ref":"ListBidResponseErrorsResponse"
},
"parameterOrder":[
"accountId",
"filterSetId"
],
"parameters":{
"pageToken":{
"description":"A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidResponseErrorsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.bidResponseErrors.list\nmethod.",
"type":"string",
"location":"query"
},
"pageSize":{
"location":"query",
"format":"int32",
"description":"Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
"type":"integer"
},
"accountId":{
"location":"path",
"format":"int64",
"description":"Account ID of the buyer.",
"type":"string",
"required":true
},
"filterSetId":{
"location":"path",
"format":"int64",
"description":"The ID of the filter set to apply.",
"description":"List all errors that occurred in bid responses, with the number of bid\nresponses affected for each reason."
}
}
},
"bidResponsesWithoutBids":{
"methods":{
"list":{
"description":"List all reasons for which bid responses were considered to have no\napplicable bids, with the number of bid responses affected for each reason.",
"description":"A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidResponsesWithoutBidsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.bidResponsesWithoutBids.list\nmethod.",
"type":"string",
"location":"query"
},
"pageSize":{
"format":"int32",
"description":"Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
"type":"integer",
"location":"query"
},
"accountId":{
"location":"path",
"format":"int64",
"description":"Account ID of the buyer.",
"type":"string",
"required":true
},
"filterSetId":{
"location":"path",
"format":"int64",
"description":"The ID of the filter set to apply.",
"description":"A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilteredBidRequestsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.filteredBidRequests.list\nmethod.",
"type":"string"
},
"pageSize":{
"format":"int32",
"description":"Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
"type":"integer",
"location":"query"
},
"accountId":{
"format":"int64",
"description":"Account ID of the buyer.",
"type":"string",
"required":true,
"location":"path"
},
"filterSetId":{
"type":"string",
"required":true,
"location":"path",
"format":"int64",
"description":"The ID of the filter set to apply."
"description":"List all reasons that caused a bid request not to be sent for an\nimpression, with the number of bid requests not sent for each reason."
"description":"The ID of the filter set to apply."
},
"pageToken":{
"description":"A token identifying a page of results the server should return.\nTypically, this is the value of\nListNonBillableWinningBidsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.nonBillableWinningBids.list\nmethod.",
"type":"string",
"location":"query"
},
"pageSize":{
"type":"integer",
"location":"query",
"format":"int32",
"description":"Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default."
"description":"Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
"type":"integer"
},
"accountId":{
"location":"path",
"format":"int64",
"description":"Account ID of the buyer.",
"type":"string",
"required":true
},
"filterSetId":{
"format":"int64",
"description":"The ID of the filter set to apply.",
"type":"string",
"required":true,
"location":"path"
},
"pageToken":{
"description":"A token identifying a page of results the server should return.\nTypically, this is the value of\nListCreativeStatusBreakdownByCreativeResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.filteredBids.creatives.list\nmethod.",
"type":"string",
"location":"query"
},
"creativeStatusId":{
"format":"int32",
"description":"The ID of the creative status for which to retrieve a breakdown by\ncreative.\nSee\n[creative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-status-codes).",
"description":"List all creatives associated with a specific reason for which bids were\nfiltered, with the number of bids filtered for each creative."
}
}
},
"details":{
"methods":{
"list":{
"description":"List all details associated with a specific reason for which bids were\nfiltered, with the number of bids filtered for each detail.",
"description":"A token identifying a page of results the server should return.\nTypically, this is the value of\nListCreativeStatusBreakdownByDetailResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.filteredBids.details.list\nmethod.",
"type":"string"
},
"creativeStatusId":{
"location":"path",
"format":"int32",
"description":"The ID of the creative status for which to retrieve a breakdown by detail.\nSee\n[creative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-status-codes).\nDetails are only available for statuses 10, 14, 15, 17, 18, 19, 86, and 87.",
"type":"integer",
"required":true
},
"pageSize":{
"location":"query",
"format":"int32",
"description":"Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
"type":"integer"
},
"accountId":{
"location":"path",
"format":"int64",
"description":"Account ID of the buyer.",
"type":"string",
"required":true
},
"filterSetId":{
"format":"int64",
"description":"The ID of the filter set to apply.",
"description":"A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilteredBidsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.filteredBids.list\nmethod.",
"type":"string"
},
"pageSize":{
"format":"int32",
"description":"Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
"type":"integer",
"location":"query"
},
"accountId":{
"location":"path",
"format":"int64",
"description":"Account ID of the buyer.",
"type":"string",
"required":true
},
"filterSetId":{
"format":"int64",
"description":"The ID of the filter set to apply.",
"description":"A token identifying a page of results the server should return.\nTypically, this is the value of\nListLosingBidsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.losingBids.list\nmethod.",
"type":"string",
"location":"query"
},
"pageSize":{
"location":"query",
"format":"int32",
"description":"Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
"type":"integer"
},
"accountId":{
"format":"int64",
"description":"Account ID of the buyer.",
"type":"string",
"required":true,
"location":"path"
},
"filterSetId":{
"location":"path",
"format":"int64",
"description":"The ID of the filter set to apply.",
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location":"query"
},
"access_token":{
"description":"OAuth access token.",
"type":"string",
"location":"query"
},
"key":{
"description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type":"string",
"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.",
"type":"string",
"location":"query"
},
"pp":{
"location":"query",
"description":"Pretty-print response.",
"default":"true",
"type":"boolean"
},
"bearer_token":{
"type":"string",
"location":"query",
"description":"OAuth bearer token."
},
"oauth_token":{
"description":"OAuth 2.0 token for the current user.",
"type":"string",
"location":"query"
},
"upload_protocol":{
"location":"query",
"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type":"string"
},
"prettyPrint":{
"description":"Returns response with indentations and line breaks.",
"default":"true",
"type":"boolean",
"location":"query"
},
"uploadType":{
"location":"query",
"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type":"string"
},
"fields":{
"description":"Selector specifying which fields to include in a partial response.",
"description":"Accesses the latest features for managing Ad Exchange accounts, Real-Time Bidding configurations and auction metrics, and Marketplace programmatic deals.",