"description":"Accesses the latest features for managing Ad Exchange accounts, Real-Time Bidding configurations and auction metrics, and Marketplace programmatic deals.",
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location":"query",
"type":"string"
},
"bearer_token":{
"description":"OAuth bearer token.",
"location":"query",
"type":"string"
},
"callback":{
"description":"JSONP",
"location":"query",
"type":"string"
},
"fields":{
"description":"Selector specifying which fields to include in a partial response.",
"location":"query",
"type":"string"
},
"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.",
"location":"query",
"type":"string"
},
"oauth_token":{
"description":"OAuth 2.0 token for the current user.",
"location":"query",
"type":"string"
},
"pp":{
"default":"true",
"description":"Pretty-print response.",
"location":"query",
"type":"boolean"
},
"prettyPrint":{
"default":"true",
"description":"Returns response with indentations and line breaks.",
"location":"query",
"type":"boolean"
},
"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"
},
"uploadType":{
"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location":"query",
"type":"string"
},
"upload_protocol":{
"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").",
"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":"Requested page size. The server may return fewer clients than requested.\nIf unspecified, the server will pick an appropriate default.",
"format":"int32",
"location":"query",
"type":"integer"
},
"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.",
"location":"query",
"type":"string"
},
"partnerClientId":{
"description":"Optional unique identifier (from the standpoint of an Ad Exchange sponsor\nbuyer partner) of the client to return.\nIf specified, at most one client will be returned in the response.",
"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)",
"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\nListClientUserInvitationsResponse.nextPageToken\nreturned from the previous call to the\nclients.invitations.list\nmethod.",
"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 clients than requested.\nIf unspecified, the server will pick an appropriate default.",
"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.",
"description":"The account to list the creatives from.\nSpecify \"-\" to list all creatives the current user has access to.",
"location":"path",
"required":true,
"type":"string"
},
"pageSize":{
"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.",
"format":"int32",
"location":"query",
"type":"integer"
},
"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.",
"location":"query",
"type":"string"
},
"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'",
"description":"The account of the creative to watch.",
"location":"path",
"required":true,
"type":"string"
},
"creativeId":{
"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":"The account to list the associations from.\nSpecify \"-\" to list all creatives the current user has access to.",
"location":"path",
"required":true,
"type":"string"
},
"creativeId":{
"description":"The creative ID to list the associations from.\nSpecify \"-\" to list all creatives under the above account.",
"location":"path",
"required":true,
"type":"string"
},
"pageSize":{
"description":"Requested page size. Server may return fewer associations than requested.\nIf unspecified, server will pick an appropriate default.",
"format":"int32",
"location":"query",
"type":"integer"
},
"pageToken":{
"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.",
"location":"query",
"type":"string"
},
"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'",
"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.",
"location":"query",
"type":"boolean"
},
"ownerName":{
"description":"Name of the owner (bidder or account) of the filter set to be created.\nFor example:\n\n- For a bidder-level filter set for bidder 123: `bidders/123`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456`",
"description":"Full name of the resource to delete.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
"description":"Full name of the resource being requested.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
"description":"Name of the owner (bidder or account) of the filter sets to be listed.\nFor example:\n\n- For a bidder-level filter set for bidder 123: `bidders/123`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456`",
"description":"Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
"format":"int32",
"location":"query",
"type":"integer"
},
"pageToken":{
"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.",
"description":"Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
"description":"Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
"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 bidMetrics.list\nmethod.",
"description":"Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
"description":"Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
"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 bidResponseErrors.list\nmethod.",
"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":"Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
"description":"Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
"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 bidResponsesWithoutBids.list\nmethod.",
"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":"Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
"description":"Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
"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 filteredBidRequests.list\nmethod.",
"description":"Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
"description":"Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
"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 filteredBids.list\nmethod.",
"description":"List all creatives associated with a specific reason for which bids were\nfiltered, with the number of bids filtered for each creative.",
"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":"Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
"description":"Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
"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 filteredBids.creatives.list\nmethod.",
"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.",
"description":"Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
"description":"Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
"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 filteredBids.details.list\nmethod.",
"description":"Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
"description":"Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
"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 impressionMetrics.list\nmethod.",
"description":"Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
"description":"Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
"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 losingBids.list\nmethod.",
"description":"Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
"description":"Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
"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 nonBillableWinningBids.list\nmethod.",
"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":"Name of the owner (bidder or account) of the filter set to be created.\nFor example:\n\n- For a bidder-level filter set for bidder 123: `bidders/123`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456`",
"description":"Full name of the resource to delete.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
"description":"Full name of the resource being requested.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
"description":"Name of the owner (bidder or account) of the filter sets to be listed.\nFor example:\n\n- For a bidder-level filter set for bidder 123: `bidders/123`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456`",
"description":"Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
"format":"int32",
"location":"query",
"type":"integer"
},
"pageToken":{
"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.",
"description":"Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
"description":"Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
"format":"int32",
"location":"query",
"type":"integer"
},
"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 bidMetrics.list\nmethod.",
"description":"Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
"description":"Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
"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 bidResponseErrors.list\nmethod.",
"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":"Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
"description":"Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
"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 bidResponsesWithoutBids.list\nmethod.",
"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":"Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
"description":"Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
"format":"int32",
"location":"query",
"type":"integer"
},
"pageToken":{
"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 filteredBidRequests.list\nmethod.",
"description":"Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
"description":"Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
"format":"int32",
"location":"query",
"type":"integer"
},
"pageToken":{
"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 filteredBids.list\nmethod.",
"description":"List all creatives associated with a specific reason for which bids were\nfiltered, with the number of bids filtered for each creative.",
"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).",
"format":"int32",
"location":"path",
"required":true,
"type":"integer"
},
"filterSetName":{
"description":"Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
"location":"path",
"pattern":"^bidders/[^/]+/filterSets/[^/]+$",
"required":true,
"type":"string"
},
"pageSize":{
"description":"Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
"format":"int32",
"location":"query",
"type":"integer"
},
"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 filteredBids.creatives.list\nmethod.",
"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.",
"format":"int32",
"location":"path",
"required":true,
"type":"integer"
},
"filterSetName":{
"description":"Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
"location":"path",
"pattern":"^bidders/[^/]+/filterSets/[^/]+$",
"required":true,
"type":"string"
},
"pageSize":{
"description":"Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
"format":"int32",
"location":"query",
"type":"integer"
},
"pageToken":{
"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 filteredBids.details.list\nmethod.",
"description":"Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
"location":"path",
"pattern":"^bidders/[^/]+/filterSets/[^/]+$",
"required":true,
"type":"string"
},
"pageSize":{
"description":"Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
"format":"int32",
"location":"query",
"type":"integer"
},
"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 impressionMetrics.list\nmethod.",
"description":"Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
"location":"path",
"pattern":"^bidders/[^/]+/filterSets/[^/]+$",
"required":true,
"type":"string"
},
"pageSize":{
"description":"Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
"format":"int32",
"location":"query",
"type":"integer"
},
"pageToken":{
"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 losingBids.list\nmethod.",
"description":"Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
"location":"path",
"pattern":"^bidders/[^/]+/filterSets/[^/]+$",
"required":true,
"type":"string"
},
"pageSize":{
"description":"Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
"format":"int32",
"location":"query",
"type":"integer"
},
"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 nonBillableWinningBids.list\nmethod.",
"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.",
"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."
"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."
"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;",
"id":"BidMetricsRow",
"properties":{
"bids":{
"$ref":"MetricValue",
"description":"The number of bids that Ad Exchange received from the buyer."
"description":"The number of bids for which the corresponding impression was viewable (as\ndefined by Active View)."
}
},
"type":"object"
},
"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.",
"id":"BidResponseWithoutBidsStatusRow",
"properties":{
"impressionCount":{
"$ref":"MetricValue",
"description":"The number of impressions for which there was a bid response with the\nspecified status."
"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 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).",
"format":"int32",
"type":"integer"
},
"impressionCount":{
"$ref":"MetricValue",
"description":"The number of impressions for which there was a bid request or bid response\nwith the specified callout status."
},
"rowDimensions":{
"$ref":"RowDimensions",
"description":"The values of all dimensions associated with metric values in this row."
"description":"A client resource represents a client buyer\u0026mdash;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 globally-unique numerical ID of the client.\nThe value of this field is ignored in create and update operations.",
"format":"int64",
"type":"string"
},
"clientName":{
"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.",
"type":"string"
},
"entityId":{
"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.",
"format":"int64",
"type":"string"
},
"entityName":{
"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.",
"type":"string"
},
"entityType":{
"description":"The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.",
"enum":[
"ENTITY_TYPE_UNSPECIFIED",
"ADVERTISER",
"BRAND",
"AGENCY"
],
"enumDescriptions":[
"A placeholder for an undefined client entity type. Should not be used.",
"description":"Optional arbitrary unique identifier of this client buyer from the\nstandpoint of its Ad Exchange sponsor buyer.\n\nThis field can be used to associate a client buyer with the identifier\nin the namespace of its sponsor buyer, lookup client buyers by that\nidentifier and verify whether an Ad Exchange counterpart of a given client\nbuyer already exists.\n\nIf present, must be unique among all the client buyers for its\nAd Exchange sponsor buyer.",
"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`.",
"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":"Whether the client buyer will be visible to sellers.",
"type":"boolean"
}
},
"type":"object"
},
"ClientUser":{
"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.",
"id":"ClientUser",
"properties":{
"clientAccountId":{
"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":"The unique numerical ID of the client user\nthat has accepted an invitation.\nThe value of this field is ignored in an update operation.",
"format":"int64",
"type":"string"
}
},
"type":"object"
},
"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.",
"id":"ClientUserInvitation",
"properties":{
"clientAccountId":{
"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.",
"format":"int64",
"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"
},
"invitationId":{
"description":"The unique numerical ID of the invitation that is sent to the user.\nThe value of this field is ignored in create operations.",
"description":"@OutputOnly Shows any corrections that were applied to this creative.",
"items":{
"$ref":"Correction"
},
"type":"array"
},
"creativeId":{
"description":"The buyer-defined creative ID of this creative.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
"type":"string"
},
"dealsStatus":{
"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 Detected advertiser IDs, if any.",
"items":{
"format":"int64",
"type":"string"
},
"type":"array"
},
"detectedDomains":{
"description":"@OutputOnly\nThe detected domains for this creative.",
"items":{
"type":"string"
},
"type":"array"
},
"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 Detected product categories, if any.\nSee the ad-product-categories.txt file in the technical documentation\nfor a list of IDs.",
"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":"@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.",
"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).",
"items":{
"$ref":"ServingRestriction"
},
"type":"array"
},
"vendorIds":{
"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.",
"items":{
"format":"int32",
"type":"integer"
},
"type":"array"
},
"version":{
"description":"@OutputOnly The version of this creative.",
"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.",
"description":"The ID of the creative status.\nSee [creative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-status-codes).",
"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.",
"format":"int32",
"type":"integer"
},
"month":{
"description":"Month of year. Must be from 1 to 12.",
"format":"int32",
"type":"integer"
},
"year":{
"description":"Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
"format":"int32",
"type":"integer"
}
},
"type":"object"
},
"Disapproval":{
"description":"@OutputOnly The reason and details for a disapproval.",
"id":"Disapproval",
"properties":{
"details":{
"description":"Additional details about the reason for disapproval.",
"items":{
"type":"string"
},
"type":"array"
},
"reason":{
"description":"The categorized reason for disapproval.",
"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\ndata for subsequent use in retargeting, but does not correctly declare\nthat 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\ncertified.",
"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\na 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\ndetected.",
"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,\nor 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\ndeclared.",
"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 \u0026 parts.",
"The ad promotes recreational drugs/services \u0026 related equipment.",
"The ad promotes tobacco products/services \u0026 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 \u0026 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."
],
"type":"string"
}
},
"type":"object"
},
"Empty":{
"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 `{}`.",
"id":"Empty",
"properties":{},
"type":"object"
},
"FilterSet":{
"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)\"",
"id":"FilterSet",
"properties":{
"absoluteDateRange":{
"$ref":"AbsoluteDateRange",
"description":"An absolute date range, defined by a start date and an end date.\nInterpreted relative to Pacific time zone."
},
"creativeId":{
"description":"The ID of the creative on which to filter; optional. This field may be set\nonly for a filter set that accesses account-level troubleshooting data,\ni.e. one whose name matches the `bidders/*/accounts/*/filterSets/*`\npattern.",
"type":"string"
},
"dealId":{
"description":"The ID of the deal on which to filter; optional. This field may be set\nonly for a filter set that accesses account-level troubleshooting data,\ni.e. one whose name matches the `bidders/*/accounts/*/filterSets/*`\npattern.",
"format":"int64",
"type":"string"
},
"environment":{
"description":"The environment on which to filter; optional.",
"enum":[
"ENVIRONMENT_UNSPECIFIED",
"WEB",
"APP"
],
"enumDescriptions":[
"A placeholder for an undefined environment; indicates that no environment\nfilter will be applied.",
"The ad impression appears on the web.",
"The ad impression appears in an app."
],
"type":"string"
},
"format":{
"description":"DEPRECATED: use repeated formats field instead.\nThe format on which to filter; optional.",
"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\nwill be applied.",
"The ad impression is a native ad, and display (i.e. image) format.",
"The ad impression is a native ad, and video format.",
"The ad impression is not a native ad, and display (i.e. image) format.",
"The ad impression is not a native ad, and video format."
],
"type":"string"
},
"formats":{
"description":"The list of formats on which to filter; may be empty. The filters\nrepresented by multiple formats are ORed together (i.e. if non-empty,\nresults must match any one of the formats).",
"enumDescriptions":[
"A placeholder for an undefined format; indicates that no format filter\nwill be applied.",
"The ad impression is a native ad, and display (i.e. image) format.",
"The ad impression is a native ad, and video format.",
"The ad impression is not a native ad, and display (i.e. image) format.",
"The ad impression is not a native ad, and video format."
],
"items":{
"enum":[
"FORMAT_UNSPECIFIED",
"NATIVE_DISPLAY",
"NATIVE_VIDEO",
"NON_NATIVE_DISPLAY",
"NON_NATIVE_VIDEO"
],
"type":"string"
},
"type":"array"
},
"name":{
"description":"A user-defined name of the filter set. Filter set names must be unique\nglobally and match one of the patterns:\n\n- `bidders/*/filterSets/*` (for accessing bidder-level troubleshooting\ndata)\n- `bidders/*/accounts/*/filterSets/*` (for accessing account-level\ntroubleshooting data)\n\nThis field is required in create operations.",
"type":"string"
},
"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).",
"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."
],
"items":{
"enum":[
"PLATFORM_UNSPECIFIED",
"DESKTOP",
"TABLET",
"MOBILE"
],
"type":"string"
},
"type":"array"
},
"realtimeTimeRange":{
"$ref":"RealtimeTimeRange",
"description":"An open-ended realtime time range, defined by the aggregation start\ntimestamp."
},
"relativeDateRange":{
"$ref":"RelativeDateRange",
"description":"A relative date range, defined by an offset from today and a duration.\nInterpreted relative to Pacific time zone."
},
"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.",
"items":{
"format":"int32",
"type":"integer"
},
"type":"array"
},
"timeSeriesGranularity":{
"description":"The granularity of time intervals if a time series breakdown is desired;\noptional.",
"enum":[
"TIME_SERIES_GRANULARITY_UNSPECIFIED",
"HOURLY",
"DAILY"
],
"enumDescriptions":[
"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."
],
"type":"string"
}
},
"type":"object"
},
"FilteredBidCreativeRow":{
"description":"The number of filtered bids with the specified dimension values that have the\nspecified creative.",
"id":"FilteredBidCreativeRow",
"properties":{
"bidCount":{
"$ref":"MetricValue",
"description":"The number of bids with the specified creative."
},
"creativeId":{
"description":"The ID of the creative.",
"type":"string"
},
"rowDimensions":{
"$ref":"RowDimensions",
"description":"The values of all dimensions associated with metric values in this row."
}
},
"type":"object"
},
"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.",
"id":"FilteredBidDetailRow",
"properties":{
"bidCount":{
"$ref":"MetricValue",
"description":"The number of bids with the specified detail."
},
"detailId":{
"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.",
"format":"int32",
"type":"integer"
},
"rowDimensions":{
"$ref":"RowDimensions",
"description":"The values of all dimensions associated with metric values in this row."
}
},
"type":"object"
},
"FilteringStats":{
"description":"@OutputOnly Filtering reasons for this creative during a period of a single\nday (from midnight to midnight Pacific).",
"id":"FilteringStats",
"properties":{
"date":{
"$ref":"Date",
"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."
},
"reasons":{
"description":"The set of filtering reasons for this date.",
"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.",
"id":"ImpressionMetricsRow",
"properties":{
"availableImpressions":{
"$ref":"MetricValue",
"description":"The number of impressions available to the buyer on Ad Exchange.\nIn some cases this value may be unavailable."
},
"bidRequests":{
"$ref":"MetricValue",
"description":"The number of impressions for which Ad Exchange sent the buyer a bid\nrequest."
},
"inventoryMatches":{
"$ref":"MetricValue",
"description":"The number of impressions that match the buyer's inventory pretargeting."
},
"responsesWithBids":{
"$ref":"MetricValue",
"description":"The number of impressions for which Ad Exchange received a response from\nthe buyer that contained at least one applicable bid."
},
"rowDimensions":{
"$ref":"RowDimensions",
"description":"The values of all dimensions associated with metric values in this row."
},
"successfulResponses":{
"$ref":"MetricValue",
"description":"The number of impressions for which the buyer successfully sent a response\nto Ad Exchange."
}
},
"type":"object"
},
"ListBidMetricsResponse":{
"description":"Response message for listing the metrics that are measured in number of bids.",
"id":"ListBidMetricsResponse",
"properties":{
"bidMetricsRows":{
"description":"List of rows, each containing a set of bid metrics.",
"items":{
"$ref":"BidMetricsRow"
},
"type":"array"
},
"nextPageToken":{
"description":"A token to retrieve the next page of results.\nPass this value in the\nListBidMetricsRequest.pageToken\nfield in the subsequent call to the bidMetrics.list\nmethod to retrieve the next page of results.",
"type":"string"
}
},
"type":"object"
},
"ListBidResponseErrorsResponse":{
"description":"Response message for listing all reasons that bid responses resulted in an\nerror.",
"id":"ListBidResponseErrorsResponse",
"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.\nPass this value in the\nListBidResponseErrorsRequest.pageToken\nfield in the subsequent call to the bidResponseErrors.list\nmethod to retrieve the next page of results.",
"type":"string"
}
},
"type":"object"
},
"ListBidResponsesWithoutBidsResponse":{
"description":"Response message for listing all reasons that bid responses were considered\nto have no applicable bids.",
"id":"ListBidResponsesWithoutBidsResponse",
"properties":{
"bidResponseWithoutBidsStatusRows":{
"description":"List of rows, with counts of bid responses without bids aggregated by\nstatus.",
"items":{
"$ref":"BidResponseWithoutBidsStatusRow"
},
"type":"array"
},
"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 bidResponsesWithoutBids.list\nmethod to retrieve the next page of results.",
"type":"string"
}
},
"type":"object"
},
"ListClientUserInvitationsResponse":{
"id":"ListClientUserInvitationsResponse",
"properties":{
"invitations":{
"description":"The returned list of client users.",
"items":{
"$ref":"ClientUserInvitation"
},
"type":"array"
},
"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.",
"type":"string"
}
},
"type":"object"
},
"ListClientUsersResponse":{
"id":"ListClientUsersResponse",
"properties":{
"nextPageToken":{
"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.",
"type":"string"
},
"users":{
"description":"The returned list of client users.",
"items":{
"$ref":"ClientUser"
},
"type":"array"
}
},
"type":"object"
},
"ListClientsResponse":{
"id":"ListClientsResponse",
"properties":{
"clients":{
"description":"The returned list of clients.",
"items":{
"$ref":"Client"
},
"type":"array"
},
"nextPageToken":{
"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.",
"type":"string"
}
},
"type":"object"
},
"ListCreativeStatusBreakdownByCreativeResponse":{
"description":"Response message for listing all creatives associated with a given filtered\nbid reason.",
"description":"List of rows, with counts of bids with a given creative status aggregated\nby creative.",
"items":{
"$ref":"FilteredBidCreativeRow"
},
"type":"array"
},
"nextPageToken":{
"description":"A token to retrieve the next page of results.\nPass this value in the\nListCreativeStatusBreakdownByCreativeRequest.pageToken\nfield in the subsequent call to the filteredBids.creatives.list\nmethod to retrieve the next page of results.",
"type":"string"
}
},
"type":"object"
},
"ListCreativeStatusBreakdownByDetailResponse":{
"description":"Response message for listing all details associated with a given filtered bid\nreason.",
"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)."
"description":"A token to retrieve the next page of results.\nPass this value in the\nListCreativeStatusBreakdownByDetailRequest.pageToken\nfield in the subsequent call to the filteredBids.details.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\nListDealAssociationsRequest.page_token\nfield in the subsequent call to 'ListDealAssociation' method to retrieve\nthe next page of results.",
"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.",
"description":"A token to retrieve the next page of results.\nPass this value in the\nListFilteredBidRequestsRequest.pageToken\nfield in the subsequent call to the 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\nListFilteredBidsRequest.pageToken\nfield in the subsequent call to the 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\nListImpressionMetricsRequest.pageToken\nfield in the subsequent call to the impressionMetrics.list\nmethod to retrieve the next page of results.",
"description":"A token to retrieve the next page of results.\nPass this value in the\nListLosingBidsRequest.pageToken\nfield in the subsequent call to the losingBids.list\nmethod to retrieve the next page of results.",
"description":"A token to retrieve the next page of results.\nPass this value in the\nListNonBillableWinningBidsRequest.pageToken\nfield in the subsequent call to the nonBillableWinningBids.list\nmethod to retrieve the next page 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",
"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":"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.",
"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.",
"format":"int32",
"type":"integer"
}
},
"type":"object"
},
"RelativeDateRange":{
"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",
"id":"RelativeDateRange",
"properties":{
"durationDays":{
"description":"The number of days in the requested date range. E.g. for a range spanning\ntoday, 1. For a range spanning the last 7 days, 7.",
"format":"int32",
"type":"integer"
},
"offsetDays":{
"description":"The end date of the filter set, specified as the number of days before\ntoday. E.g. for a range where the last date is today, 0.",
"description":"A response may include multiple rows, breaking down along various dimensions.\nEncapsulates the values of all dimensions for a given row.",
"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.",
"items":{
"$ref":"Disapproval"
},
"type":"array"
},
"status":{
"description":"The status of the creative in this context (for example, it has been\nexplicitly disapproved or is pending review).",
"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.",
