chore: Update discovery artifacts (#1291)
* chore: update docs/dyn/index.md
* chore(abusiveexperiencereport): update the api
* chore(acceleratedmobilepageurl): update the api
* chore(accessapproval): update the api
* chore(accesscontextmanager): update the api
* chore(adexchangebuyer2): update the api
* chore(adexperiencereport): update the api
* chore(admob): update the api
* chore(analytics): update the api
* chore(analyticsreporting): update the api
* chore(androiddeviceprovisioning): update the api
* chore(androidenterprise): update the api
* chore(androidpublisher): update the api
* chore(apigateway): update the api
* chore(artifactregistry): update the api
* chore(bigqueryconnection): update the api
* chore(bigquerydatatransfer): update the api
* chore(billingbudgets): update the api
* chore(binaryauthorization): update the api
* chore(blogger): update the api
* chore(books): update the api
* chore(calendar): update the api
* chore(chat): update the api
* chore(chromeuxreport): update the api
* chore(civicinfo): update the api
* chore(classroom): update the api
* chore(cloudbilling): update the api
* chore(cloudbuild): update the api
* chore(clouddebugger): update the api
* chore(clouderrorreporting): update the api
* chore(cloudfunctions): update the api
* chore(cloudidentity): update the api
* chore(cloudiot): update the api
* chore(cloudkms): update the api
* chore(cloudprofiler): update the api
* chore(cloudresourcemanager): update the api
* chore(cloudscheduler): update the api
* chore(cloudshell): update the api
* chore(cloudtasks): update the api
* chore(cloudtrace): update the api
* chore(composer): update the api
* chore(containeranalysis): update the api
* chore(content): update the api
* chore(customsearch): update the api
* chore(datacatalog): update the api
* chore(datafusion): update the api
* chore(datamigration): update the api
* chore(datastore): update the api
* chore(deploymentmanager): update the api
* chore(digitalassetlinks): update the api
* chore(displayvideo): update the api
* chore(dlp): update the api
* chore(dns): update the api
* chore(docs): update the api
* chore(domains): update the api
* chore(domainsrdap): update the api
* chore(doubleclickbidmanager): update the api
* chore(doubleclicksearch): update the api
* chore(drive): update the api
* chore(driveactivity): update the api
* chore(eventarc): update the api
* chore(factchecktools): update the api
* chore(fcm): update the api
* chore(file): update the api
* chore(firebase): update the api
* chore(firebasedatabase): update the api
* chore(firebasedynamiclinks): update the api
* chore(firebasehosting): update the api
* chore(firebaseml): update the api
* chore(firebaserules): update the api
* chore(firestore): update the api
* chore(fitness): update the api
* chore(gamesConfiguration): update the api
* chore(gamesManagement): update the api
* chore(gameservices): update the api
* chore(genomics): update the api
* chore(gmail): update the api
* chore(gmailpostmastertools): update the api
* chore(groupsmigration): update the api
* chore(groupssettings): update the api
* chore(healthcare): update the api
* chore(iam): update the api
* chore(iamcredentials): update the api
* chore(iap): update the api
* chore(identitytoolkit): update the api
* chore(indexing): update the api
* chore(jobs): update the api
* chore(kgsearch): update the api
* chore(language): update the api
* chore(libraryagent): update the api
* chore(licensing): update the api
* chore(lifesciences): update the api
* chore(logging): update the api
* chore(managedidentities): update the api
* chore(manufacturers): update the api
* chore(memcache): update the api
* chore(ml): update the api
* chore(monitoring): update the api
* chore(networkmanagement): update the api
* chore(osconfig): update the api
* chore(pagespeedonline): update the api
* chore(playablelocations): update the api
* chore(playcustomapp): update the api
* chore(policytroubleshooter): update the api
* chore(poly): update the api
* chore(privateca): update the api
* chore(prod_tt_sasportal): update the api
* chore(pubsub): update the api
* chore(pubsublite): update the api
* chore(realtimebidding): update the api
* chore(recommendationengine): update the api
* chore(recommender): update the api
* chore(redis): update the api
* chore(remotebuildexecution): update the api
* chore(reseller): update the api
* chore(runtimeconfig): update the api
* chore(safebrowsing): update the api
* chore(sasportal): update the api
* chore(script): update the api
* chore(searchconsole): update the api
* chore(secretmanager): update the api
* chore(servicecontrol): update the api
* chore(servicedirectory): update the api
* chore(siteVerification): update the api
* chore(slides): update the api
* chore(smartdevicemanagement): update the api
* chore(sourcerepo): update the api
* chore(sqladmin): update the api
* chore(storage): update the api
* chore(storagetransfer): update the api
* chore(streetviewpublish): update the api
* chore(sts): update the api
* chore(tagmanager): update the api
* chore(tasks): update the api
* chore(testing): update the api
* chore(texttospeech): update the api
* chore(toolresults): update the api
* chore(trafficdirector): update the api
* chore(transcoder): update the api
* chore(translate): update the api
* chore(vault): update the api
* chore(vectortile): update the api
* chore(verifiedaccess): update the api
* chore(videointelligence): update the api
* chore(vision): update the api
* chore(webfonts): update the api
* chore(webmasters): update the api
* chore(websecurityscanner): update the api
* chore(workflowexecutions): update the api
* chore(workflows): update the api
* chore(youtubeAnalytics): update the api
* chore(youtubereporting): update the api
* chore(docs): Add new discovery artifacts and reference documents
diff --git a/googleapiclient/discovery_cache/documents/doubleclickbidmanager.v1.json b/googleapiclient/discovery_cache/documents/doubleclickbidmanager.v1.json
index edd0ffb..47bc9a4 100644
--- a/googleapiclient/discovery_cache/documents/doubleclickbidmanager.v1.json
+++ b/googleapiclient/discovery_cache/documents/doubleclickbidmanager.v1.json
@@ -1,154 +1,692 @@
{
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/doubleclickbidmanager": {
+ "description": "View and manage your reports in DoubleClick Bid Manager"
+ }
+ }
+ }
+ },
+ "basePath": "/doubleclickbidmanager/v1/",
+ "baseUrl": "https://doubleclickbidmanager.googleapis.com/doubleclickbidmanager/v1/",
+ "batchPath": "batch",
+ "canonicalName": "DoubleClick Bid Manager",
+ "description": "DoubleClick Bid Manager API allows users to manage and create campaigns and reports.",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://developers.google.com/bid-manager/",
+ "fullyEncodeReservedExpansion": true,
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
+ "id": "doubleclickbidmanager:v1",
+ "kind": "discovery#restDescription",
+ "mtlsRootUrl": "https://doubleclickbidmanager.mtls.googleapis.com/",
+ "name": "doubleclickbidmanager",
"ownerDomain": "google.com",
+ "ownerName": "Google",
"parameters": {
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "location": "query",
+ "type": "string"
+ },
"alt": {
+ "default": "json",
+ "description": "Data format for response.",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
- "type": "string",
"location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ]
+ "type": "string"
},
"callback": {
- "location": "query",
"description": "JSONP",
- "type": "string"
- },
- "quotaUser": {
"location": "query",
- "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"
},
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
+ "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"
},
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "upload_protocol": {
- "type": "string",
"location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
+ "type": "string"
+ },
+ "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": {
- "type": "string",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
+ "type": "string"
},
- "fields": {
- "type": "string",
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
- "description": "Selector specifying which fields to include in a partial response."
- },
- "$.xgafv": {
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "location": "query",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
"type": "string"
}
},
- "basePath": "/doubleclickbidmanager/v1/",
- "schemas": {
- "Report": {
- "type": "object",
- "description": "Represents a report.",
- "properties": {
- "metadata": {
- "$ref": "ReportMetadata",
- "description": "Report metadata."
+ "protocol": "rest",
+ "resources": {
+ "lineitems": {
+ "methods": {
+ "downloadlineitems": {
+ "description": "Retrieves line items in CSV format. YouTube & partners line items are not supported.",
+ "flatPath": "lineitems/downloadlineitems",
+ "httpMethod": "POST",
+ "id": "doubleclickbidmanager.lineitems.downloadlineitems",
+ "parameterOrder": [],
+ "parameters": {},
+ "path": "lineitems/downloadlineitems",
+ "request": {
+ "$ref": "DownloadLineItemsRequest"
+ },
+ "response": {
+ "$ref": "DownloadLineItemsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/doubleclickbidmanager"
+ ]
},
- "params": {
- "description": "Report parameters.",
- "$ref": "Parameters"
- },
- "key": {
- "description": "Key used to identify a report.",
- "$ref": "ReportKey"
- }
- },
- "id": "Report"
- },
- "RowStatus": {
- "description": "Represents the upload status of a row in the request.",
- "id": "RowStatus",
- "type": "object",
- "properties": {
- "entityName": {
- "type": "string",
- "description": "Entity name."
- },
- "persisted": {
- "description": "Whether the entity is persisted.",
- "type": "boolean"
- },
- "rowNumber": {
- "format": "int32",
- "type": "integer",
- "description": "Row number."
- },
- "changed": {
- "description": "Whether the stored entity is changed as a result of upload.",
- "type": "boolean"
- },
- "errors": {
- "description": "Reasons why the entity can't be uploaded.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "entityId": {
- "format": "int64",
- "description": "Entity Id.",
- "type": "string"
+ "uploadlineitems": {
+ "description": "Uploads line items in CSV format. YouTube & partners line items are not supported.",
+ "flatPath": "lineitems/uploadlineitems",
+ "httpMethod": "POST",
+ "id": "doubleclickbidmanager.lineitems.uploadlineitems",
+ "parameterOrder": [],
+ "parameters": {},
+ "path": "lineitems/uploadlineitems",
+ "request": {
+ "$ref": "UploadLineItemsRequest"
+ },
+ "response": {
+ "$ref": "UploadLineItemsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/doubleclickbidmanager"
+ ]
}
}
},
- "RunQueryRequest": {
- "properties": {
- "reportDataEndTimeMs": {
- "format": "int64",
- "type": "string",
- "description": "The ending time for the data that is shown in the report. Note, reportDataEndTimeMs is required if dataRange is CUSTOM_DATES and ignored otherwise."
+ "queries": {
+ "methods": {
+ "createquery": {
+ "description": "Creates a query.",
+ "flatPath": "query",
+ "httpMethod": "POST",
+ "id": "doubleclickbidmanager.queries.createquery",
+ "parameterOrder": [],
+ "parameters": {},
+ "path": "query",
+ "request": {
+ "$ref": "Query"
+ },
+ "response": {
+ "$ref": "Query"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/doubleclickbidmanager"
+ ]
},
- "timezoneCode": {
- "description": "Canonical timezone code for report data time. Defaults to America/New_York.",
+ "deletequery": {
+ "description": "Deletes a stored query as well as the associated stored reports.",
+ "flatPath": "query/{queryId}",
+ "httpMethod": "DELETE",
+ "id": "doubleclickbidmanager.queries.deletequery",
+ "parameterOrder": [
+ "queryId"
+ ],
+ "parameters": {
+ "queryId": {
+ "description": "Query ID to delete.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "query/{queryId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/doubleclickbidmanager"
+ ]
+ },
+ "getquery": {
+ "description": "Retrieves a stored query.",
+ "flatPath": "query/{queryId}",
+ "httpMethod": "GET",
+ "id": "doubleclickbidmanager.queries.getquery",
+ "parameterOrder": [
+ "queryId"
+ ],
+ "parameters": {
+ "queryId": {
+ "description": "Query ID to retrieve.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "query/{queryId}",
+ "response": {
+ "$ref": "Query"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/doubleclickbidmanager"
+ ]
+ },
+ "listqueries": {
+ "description": "Retrieves stored queries.",
+ "flatPath": "queries",
+ "httpMethod": "GET",
+ "id": "doubleclickbidmanager.queries.listqueries",
+ "parameterOrder": [],
+ "parameters": {},
+ "path": "queries",
+ "response": {
+ "$ref": "ListQueriesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/doubleclickbidmanager"
+ ]
+ },
+ "runquery": {
+ "description": "Runs a stored query to generate a report.",
+ "flatPath": "query/{queryId}",
+ "httpMethod": "POST",
+ "id": "doubleclickbidmanager.queries.runquery",
+ "parameterOrder": [
+ "queryId"
+ ],
+ "parameters": {
+ "queryId": {
+ "description": "Query ID to run.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "query/{queryId}",
+ "request": {
+ "$ref": "RunQueryRequest"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/doubleclickbidmanager"
+ ]
+ }
+ }
+ },
+ "reports": {
+ "methods": {
+ "listreports": {
+ "description": "Retrieves stored reports.",
+ "flatPath": "queries/{queryId}/reports",
+ "httpMethod": "GET",
+ "id": "doubleclickbidmanager.reports.listreports",
+ "parameterOrder": [
+ "queryId"
+ ],
+ "parameters": {
+ "queryId": {
+ "description": "Query ID with which the reports are associated.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "queries/{queryId}/reports",
+ "response": {
+ "$ref": "ListReportsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/doubleclickbidmanager"
+ ]
+ }
+ }
+ },
+ "sdf": {
+ "methods": {
+ "download": {
+ "description": "Retrieves entities in SDF format.",
+ "flatPath": "sdf/download",
+ "httpMethod": "POST",
+ "id": "doubleclickbidmanager.sdf.download",
+ "parameterOrder": [],
+ "parameters": {},
+ "path": "sdf/download",
+ "request": {
+ "$ref": "DownloadRequest"
+ },
+ "response": {
+ "$ref": "DownloadResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/doubleclickbidmanager"
+ ]
+ }
+ }
+ }
+ },
+ "revision": "20210331",
+ "rootUrl": "https://doubleclickbidmanager.googleapis.com/",
+ "schemas": {
+ "DownloadLineItemsRequest": {
+ "description": "Request to fetch stored line items.",
+ "id": "DownloadLineItemsRequest",
+ "properties": {
+ "fileSpec": {
+ "description": "File specification (column names, types, order) in which the line items will be returned. Default to EWF.",
+ "enum": [
+ "EWF"
+ ],
+ "enumDescriptions": [
+ ""
+ ],
"type": "string"
},
- "dataRange": {
+ "filterIds": {
+ "description": "Ids of the specified filter type used to filter line items to fetch. If omitted, all the line items will be returned.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "filterType": {
+ "description": "Filter type used to filter line items to fetch.",
+ "enum": [
+ "ADVERTISER_ID",
+ "INSERTION_ORDER_ID",
+ "LINE_ITEM_ID"
+ ],
"enumDescriptions": [
"",
"",
+ ""
+ ],
+ "type": "string"
+ },
+ "format": {
+ "description": "Format in which the line items will be returned. Default to CSV.",
+ "enum": [
+ "CSV"
+ ],
+ "enumDescriptions": [
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DownloadLineItemsResponse": {
+ "description": "Download line items response.",
+ "id": "DownloadLineItemsResponse",
+ "properties": {
+ "lineItems": {
+ "description": "Retrieved line items in CSV format. For more information about file formats, see Entity Write File Format.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DownloadRequest": {
+ "description": "Request to fetch stored inventory sources, campaigns, insertion orders, line items, YouTube ad groups and ads.",
+ "id": "DownloadRequest",
+ "properties": {
+ "fileTypes": {
+ "description": "File types that will be returned. If INVENTORY_SOURCE is requested, no other file types may be requested. Acceptable values are: - \"AD\" - \"AD_GROUP\" - \"CAMPAIGN\" - \"INSERTION_ORDER\" - \"INVENTORY_SOURCE\" - \"LINE_ITEM\" ",
+ "items": {
+ "enum": [
+ "INSERTION_ORDER",
+ "LINE_ITEM",
+ "AD_GROUP",
+ "AD",
+ "CAMPAIGN",
+ "INVENTORY_SOURCE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "filterIds": {
+ "description": "The IDs of the specified filter type. This is used to filter entities to fetch. At least one ID must be specified.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "filterType": {
+ "description": "Filter type used to filter entities to fetch. PARTNER_ID and INVENTORY_SOURCE_ID may only be used when downloading inventory sources.",
+ "enum": [
+ "ADVERTISER_ID",
+ "INSERTION_ORDER_ID",
+ "LINE_ITEM_ID",
+ "CAMPAIGN_ID",
+ "INVENTORY_SOURCE_ID",
+ "PARTNER_ID"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "version": {
+ "description": "SDF Version (column names, types, order) in which the entities will be returned. Default to 5.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DownloadResponse": {
+ "description": "Download response.",
+ "id": "DownloadResponse",
+ "properties": {
+ "adGroups": {
+ "description": "Retrieved ad groups in SDF format.",
+ "type": "string"
+ },
+ "ads": {
+ "description": "Retrieved ads in SDF format.",
+ "type": "string"
+ },
+ "campaigns": {
+ "description": "Retrieved campaigns in SDF format.",
+ "type": "string"
+ },
+ "insertionOrders": {
+ "description": "Retrieved insertion orders in SDF format.",
+ "type": "string"
+ },
+ "inventorySources": {
+ "type": "string"
+ },
+ "lineItems": {
+ "description": "Retrieved line items in SDF format.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "FilterPair": {
+ "description": "Filter used to match traffic data in your report.",
+ "id": "FilterPair",
+ "properties": {
+ "type": {
+ "description": "Filter type.",
+ "enum": [
+ "FILTER_UNKNOWN",
+ "FILTER_DATE",
+ "FILTER_DAY_OF_WEEK",
+ "FILTER_WEEK",
+ "FILTER_MONTH",
+ "FILTER_YEAR",
+ "FILTER_TIME_OF_DAY",
+ "FILTER_CONVERSION_DELAY",
+ "FILTER_CREATIVE_ID",
+ "FILTER_CREATIVE_SIZE",
+ "FILTER_CREATIVE_TYPE",
+ "FILTER_EXCHANGE_ID",
+ "FILTER_AD_POSITION",
+ "FILTER_INVENTORY_SOURCE",
+ "FILTER_CITY",
+ "FILTER_REGION",
+ "FILTER_DMA",
+ "FILTER_COUNTRY",
+ "FILTER_SITE_ID",
+ "FILTER_CHANNEL_ID",
+ "FILTER_PARTNER",
+ "FILTER_ADVERTISER",
+ "FILTER_INSERTION_ORDER",
+ "FILTER_LINE_ITEM",
+ "FILTER_PARTNER_CURRENCY",
+ "FILTER_ADVERTISER_CURRENCY",
+ "FILTER_ADVERTISER_TIMEZONE",
+ "FILTER_LINE_ITEM_TYPE",
+ "FILTER_USER_LIST",
+ "FILTER_USER_LIST_FIRST_PARTY",
+ "FILTER_USER_LIST_THIRD_PARTY",
+ "FILTER_TARGETED_USER_LIST",
+ "FILTER_DATA_PROVIDER",
+ "FILTER_ORDER_ID",
+ "FILTER_VIDEO_PLAYER_SIZE",
+ "FILTER_VIDEO_DURATION_SECONDS",
+ "FILTER_KEYWORD",
+ "FILTER_PAGE_CATEGORY",
+ "FILTER_CAMPAIGN_DAILY_FREQUENCY",
+ "FILTER_LINE_ITEM_DAILY_FREQUENCY",
+ "FILTER_LINE_ITEM_LIFETIME_FREQUENCY",
+ "FILTER_OS",
+ "FILTER_BROWSER",
+ "FILTER_CARRIER",
+ "FILTER_SITE_LANGUAGE",
+ "FILTER_INVENTORY_FORMAT",
+ "FILTER_ZIP_CODE",
+ "FILTER_VIDEO_RATING_TIER",
+ "FILTER_VIDEO_FORMAT_SUPPORT",
+ "FILTER_VIDEO_SKIPPABLE_SUPPORT",
+ "FILTER_VIDEO_VPAID_SUPPORT",
+ "FILTER_VIDEO_CREATIVE_DURATION",
+ "FILTER_PAGE_LAYOUT",
+ "FILTER_VIDEO_AD_POSITION_IN_STREAM",
+ "FILTER_AGE",
+ "FILTER_GENDER",
+ "FILTER_QUARTER",
+ "FILTER_TRUEVIEW_CONVERSION_TYPE",
+ "FILTER_MOBILE_GEO",
+ "FILTER_MRAID_SUPPORT",
+ "FILTER_ACTIVE_VIEW_EXPECTED_VIEWABILITY",
+ "FILTER_VIDEO_CREATIVE_DURATION_SKIPPABLE",
+ "FILTER_NIELSEN_COUNTRY_CODE",
+ "FILTER_NIELSEN_DEVICE_ID",
+ "FILTER_NIELSEN_GENDER",
+ "FILTER_NIELSEN_AGE",
+ "FILTER_INVENTORY_SOURCE_TYPE",
+ "FILTER_CREATIVE_WIDTH",
+ "FILTER_CREATIVE_HEIGHT",
+ "FILTER_DFP_ORDER_ID",
+ "FILTER_TRUEVIEW_AGE",
+ "FILTER_TRUEVIEW_GENDER",
+ "FILTER_TRUEVIEW_PARENTAL_STATUS",
+ "FILTER_TRUEVIEW_REMARKETING_LIST",
+ "FILTER_TRUEVIEW_INTEREST",
+ "FILTER_TRUEVIEW_AD_GROUP_ID",
+ "FILTER_TRUEVIEW_AD_GROUP_AD_ID",
+ "FILTER_TRUEVIEW_IAR_LANGUAGE",
+ "FILTER_TRUEVIEW_IAR_GENDER",
+ "FILTER_TRUEVIEW_IAR_AGE",
+ "FILTER_TRUEVIEW_IAR_CATEGORY",
+ "FILTER_TRUEVIEW_IAR_COUNTRY",
+ "FILTER_TRUEVIEW_IAR_CITY",
+ "FILTER_TRUEVIEW_IAR_REGION",
+ "FILTER_TRUEVIEW_IAR_ZIPCODE",
+ "FILTER_TRUEVIEW_IAR_REMARKETING_LIST",
+ "FILTER_TRUEVIEW_IAR_INTEREST",
+ "FILTER_TRUEVIEW_IAR_PARENTAL_STATUS",
+ "FILTER_TRUEVIEW_IAR_TIME_OF_DAY",
+ "FILTER_TRUEVIEW_CUSTOM_AFFINITY",
+ "FILTER_TRUEVIEW_CATEGORY",
+ "FILTER_TRUEVIEW_KEYWORD",
+ "FILTER_TRUEVIEW_PLACEMENT",
+ "FILTER_TRUEVIEW_URL",
+ "FILTER_TRUEVIEW_COUNTRY",
+ "FILTER_TRUEVIEW_REGION",
+ "FILTER_TRUEVIEW_CITY",
+ "FILTER_TRUEVIEW_DMA",
+ "FILTER_TRUEVIEW_ZIPCODE",
+ "FILTER_NOT_SUPPORTED",
+ "FILTER_MEDIA_PLAN",
+ "FILTER_TRUEVIEW_IAR_YOUTUBE_CHANNEL",
+ "FILTER_TRUEVIEW_IAR_YOUTUBE_VIDEO",
+ "FILTER_SKIPPABLE_SUPPORT",
+ "FILTER_COMPANION_CREATIVE_ID",
+ "FILTER_BUDGET_SEGMENT_DESCRIPTION",
+ "FILTER_FLOODLIGHT_ACTIVITY_ID",
+ "FILTER_DEVICE_MODEL",
+ "FILTER_DEVICE_MAKE",
+ "FILTER_DEVICE_TYPE",
+ "FILTER_CREATIVE_ATTRIBUTE",
+ "FILTER_INVENTORY_COMMITMENT_TYPE",
+ "FILTER_INVENTORY_RATE_TYPE",
+ "FILTER_INVENTORY_DELIVERY_METHOD",
+ "FILTER_INVENTORY_SOURCE_EXTERNAL_ID",
+ "FILTER_AUTHORIZED_SELLER_STATE",
+ "FILTER_VIDEO_DURATION_SECONDS_RANGE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
"",
"",
"",
@@ -167,94 +705,314 @@
"",
""
],
- "type": "string",
- "enum": [
- "CUSTOM_DATES",
- "CURRENT_DAY",
- "PREVIOUS_DAY",
- "WEEK_TO_DATE",
- "MONTH_TO_DATE",
- "QUARTER_TO_DATE",
- "YEAR_TO_DATE",
- "PREVIOUS_WEEK",
- "PREVIOUS_HALF_MONTH",
- "PREVIOUS_MONTH",
- "PREVIOUS_QUARTER",
- "PREVIOUS_YEAR",
- "LAST_7_DAYS",
- "LAST_30_DAYS",
- "LAST_90_DAYS",
- "LAST_365_DAYS",
- "ALL_TIME",
- "LAST_14_DAYS",
- "TYPE_NOT_SUPPORTED"
- ],
- "description": "Report data range used to generate the report."
+ "type": "string"
},
- "reportDataStartTimeMs": {
- "description": "The starting time for the data that is shown in the report. Note, reportDataStartTimeMs is required if dataRange is CUSTOM_DATES and ignored otherwise.",
- "format": "int64",
+ "value": {
+ "description": "Filter value.",
"type": "string"
}
},
- "type": "object",
- "id": "RunQueryRequest",
- "description": "Request to run a stored query to generate a report."
- },
- "DownloadResponse": {
- "description": "Download response.",
- "properties": {
- "inventorySources": {
- "type": "string"
- },
- "campaigns": {
- "type": "string",
- "description": "Retrieved campaigns in SDF format."
- },
- "insertionOrders": {
- "description": "Retrieved insertion orders in SDF format.",
- "type": "string"
- },
- "lineItems": {
- "description": "Retrieved line items in SDF format.",
- "type": "string"
- },
- "adGroups": {
- "description": "Retrieved ad groups in SDF format.",
- "type": "string"
- },
- "ads": {
- "description": "Retrieved ads in SDF format.",
- "type": "string"
- }
- },
- "type": "object",
- "id": "DownloadResponse"
+ "type": "object"
},
"ListQueriesResponse": {
- "type": "object",
+ "description": "List queries response.",
+ "id": "ListQueriesResponse",
"properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"doubleclickbidmanager#listQueriesResponse\".",
+ "type": "string"
+ },
"queries": {
+ "description": "Retrieved queries.",
"items": {
"$ref": "Query"
},
- "type": "array",
- "description": "Retrieved queries."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"doubleclickbidmanager#listQueriesResponse\"."
+ "type": "array"
}
},
- "description": "List queries response.",
- "id": "ListQueriesResponse"
+ "type": "object"
+ },
+ "ListReportsResponse": {
+ "description": "List reports response.",
+ "id": "ListReportsResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"doubleclickbidmanager#listReportsResponse\".",
+ "type": "string"
+ },
+ "reports": {
+ "description": "Retrieved reports.",
+ "items": {
+ "$ref": "Report"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
},
"Parameters": {
"description": "Parameters of a query or report.",
+ "id": "Parameters",
"properties": {
- "metrics": {
+ "filters": {
+ "description": "Filters used to match traffic data in your report.",
"items": {
- "type": "string",
+ "$ref": "FilterPair"
+ },
+ "type": "array"
+ },
+ "groupBys": {
+ "description": "Data is grouped by the filters listed in this field.",
+ "items": {
+ "enum": [
+ "FILTER_UNKNOWN",
+ "FILTER_DATE",
+ "FILTER_DAY_OF_WEEK",
+ "FILTER_WEEK",
+ "FILTER_MONTH",
+ "FILTER_YEAR",
+ "FILTER_TIME_OF_DAY",
+ "FILTER_CONVERSION_DELAY",
+ "FILTER_CREATIVE_ID",
+ "FILTER_CREATIVE_SIZE",
+ "FILTER_CREATIVE_TYPE",
+ "FILTER_EXCHANGE_ID",
+ "FILTER_AD_POSITION",
+ "FILTER_INVENTORY_SOURCE",
+ "FILTER_CITY",
+ "FILTER_REGION",
+ "FILTER_DMA",
+ "FILTER_COUNTRY",
+ "FILTER_SITE_ID",
+ "FILTER_CHANNEL_ID",
+ "FILTER_PARTNER",
+ "FILTER_ADVERTISER",
+ "FILTER_INSERTION_ORDER",
+ "FILTER_LINE_ITEM",
+ "FILTER_PARTNER_CURRENCY",
+ "FILTER_ADVERTISER_CURRENCY",
+ "FILTER_ADVERTISER_TIMEZONE",
+ "FILTER_LINE_ITEM_TYPE",
+ "FILTER_USER_LIST",
+ "FILTER_USER_LIST_FIRST_PARTY",
+ "FILTER_USER_LIST_THIRD_PARTY",
+ "FILTER_TARGETED_USER_LIST",
+ "FILTER_DATA_PROVIDER",
+ "FILTER_ORDER_ID",
+ "FILTER_VIDEO_PLAYER_SIZE",
+ "FILTER_VIDEO_DURATION_SECONDS",
+ "FILTER_KEYWORD",
+ "FILTER_PAGE_CATEGORY",
+ "FILTER_CAMPAIGN_DAILY_FREQUENCY",
+ "FILTER_LINE_ITEM_DAILY_FREQUENCY",
+ "FILTER_LINE_ITEM_LIFETIME_FREQUENCY",
+ "FILTER_OS",
+ "FILTER_BROWSER",
+ "FILTER_CARRIER",
+ "FILTER_SITE_LANGUAGE",
+ "FILTER_INVENTORY_FORMAT",
+ "FILTER_ZIP_CODE",
+ "FILTER_VIDEO_RATING_TIER",
+ "FILTER_VIDEO_FORMAT_SUPPORT",
+ "FILTER_VIDEO_SKIPPABLE_SUPPORT",
+ "FILTER_VIDEO_VPAID_SUPPORT",
+ "FILTER_VIDEO_CREATIVE_DURATION",
+ "FILTER_PAGE_LAYOUT",
+ "FILTER_VIDEO_AD_POSITION_IN_STREAM",
+ "FILTER_AGE",
+ "FILTER_GENDER",
+ "FILTER_QUARTER",
+ "FILTER_TRUEVIEW_CONVERSION_TYPE",
+ "FILTER_MOBILE_GEO",
+ "FILTER_MRAID_SUPPORT",
+ "FILTER_ACTIVE_VIEW_EXPECTED_VIEWABILITY",
+ "FILTER_VIDEO_CREATIVE_DURATION_SKIPPABLE",
+ "FILTER_NIELSEN_COUNTRY_CODE",
+ "FILTER_NIELSEN_DEVICE_ID",
+ "FILTER_NIELSEN_GENDER",
+ "FILTER_NIELSEN_AGE",
+ "FILTER_INVENTORY_SOURCE_TYPE",
+ "FILTER_CREATIVE_WIDTH",
+ "FILTER_CREATIVE_HEIGHT",
+ "FILTER_DFP_ORDER_ID",
+ "FILTER_TRUEVIEW_AGE",
+ "FILTER_TRUEVIEW_GENDER",
+ "FILTER_TRUEVIEW_PARENTAL_STATUS",
+ "FILTER_TRUEVIEW_REMARKETING_LIST",
+ "FILTER_TRUEVIEW_INTEREST",
+ "FILTER_TRUEVIEW_AD_GROUP_ID",
+ "FILTER_TRUEVIEW_AD_GROUP_AD_ID",
+ "FILTER_TRUEVIEW_IAR_LANGUAGE",
+ "FILTER_TRUEVIEW_IAR_GENDER",
+ "FILTER_TRUEVIEW_IAR_AGE",
+ "FILTER_TRUEVIEW_IAR_CATEGORY",
+ "FILTER_TRUEVIEW_IAR_COUNTRY",
+ "FILTER_TRUEVIEW_IAR_CITY",
+ "FILTER_TRUEVIEW_IAR_REGION",
+ "FILTER_TRUEVIEW_IAR_ZIPCODE",
+ "FILTER_TRUEVIEW_IAR_REMARKETING_LIST",
+ "FILTER_TRUEVIEW_IAR_INTEREST",
+ "FILTER_TRUEVIEW_IAR_PARENTAL_STATUS",
+ "FILTER_TRUEVIEW_IAR_TIME_OF_DAY",
+ "FILTER_TRUEVIEW_CUSTOM_AFFINITY",
+ "FILTER_TRUEVIEW_CATEGORY",
+ "FILTER_TRUEVIEW_KEYWORD",
+ "FILTER_TRUEVIEW_PLACEMENT",
+ "FILTER_TRUEVIEW_URL",
+ "FILTER_TRUEVIEW_COUNTRY",
+ "FILTER_TRUEVIEW_REGION",
+ "FILTER_TRUEVIEW_CITY",
+ "FILTER_TRUEVIEW_DMA",
+ "FILTER_TRUEVIEW_ZIPCODE",
+ "FILTER_NOT_SUPPORTED",
+ "FILTER_MEDIA_PLAN",
+ "FILTER_TRUEVIEW_IAR_YOUTUBE_CHANNEL",
+ "FILTER_TRUEVIEW_IAR_YOUTUBE_VIDEO",
+ "FILTER_SKIPPABLE_SUPPORT",
+ "FILTER_COMPANION_CREATIVE_ID",
+ "FILTER_BUDGET_SEGMENT_DESCRIPTION",
+ "FILTER_FLOODLIGHT_ACTIVITY_ID",
+ "FILTER_DEVICE_MODEL",
+ "FILTER_DEVICE_MAKE",
+ "FILTER_DEVICE_TYPE",
+ "FILTER_CREATIVE_ATTRIBUTE",
+ "FILTER_INVENTORY_COMMITMENT_TYPE",
+ "FILTER_INVENTORY_RATE_TYPE",
+ "FILTER_INVENTORY_DELIVERY_METHOD",
+ "FILTER_INVENTORY_SOURCE_EXTERNAL_ID",
+ "FILTER_AUTHORIZED_SELLER_STATE",
+ "FILTER_VIDEO_DURATION_SECONDS_RANGE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "includeInviteData": {
+ "description": "Deprecated. This field is no longer in use.",
+ "type": "boolean"
+ },
+ "metrics": {
+ "description": "Metrics to include as columns in your report.",
+ "items": {
"enum": [
"METRIC_UNKNOWN",
"METRIC_IMPRESSIONS",
@@ -802,58 +1560,12 @@
"",
"",
""
- ]
+ ],
+ "type": "string"
},
- "description": "Metrics to include as columns in your report.",
"type": "array"
},
- "includeInviteData": {
- "description": "Deprecated. This field is no longer in use.",
- "type": "boolean"
- },
- "filters": {
- "description": "Filters used to match traffic data in your report.",
- "type": "array",
- "items": {
- "$ref": "FilterPair"
- }
- },
"type": {
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string",
"description": "Report type.",
"enum": [
"TYPE_GENERAL",
@@ -888,262 +1600,7 @@
"TYPE_NOT_SUPPORTED",
"TYPE_REACH_AUDIENCE",
"TYPE_LINEAR_TV_SEARCH_LIFT"
- ]
- },
- "groupBys": {
- "description": "Data is grouped by the filters listed in this field.",
- "type": "array",
- "items": {
- "type": "string",
- "enum": [
- "FILTER_UNKNOWN",
- "FILTER_DATE",
- "FILTER_DAY_OF_WEEK",
- "FILTER_WEEK",
- "FILTER_MONTH",
- "FILTER_YEAR",
- "FILTER_TIME_OF_DAY",
- "FILTER_CONVERSION_DELAY",
- "FILTER_CREATIVE_ID",
- "FILTER_CREATIVE_SIZE",
- "FILTER_CREATIVE_TYPE",
- "FILTER_EXCHANGE_ID",
- "FILTER_AD_POSITION",
- "FILTER_INVENTORY_SOURCE",
- "FILTER_CITY",
- "FILTER_REGION",
- "FILTER_DMA",
- "FILTER_COUNTRY",
- "FILTER_SITE_ID",
- "FILTER_CHANNEL_ID",
- "FILTER_PARTNER",
- "FILTER_ADVERTISER",
- "FILTER_INSERTION_ORDER",
- "FILTER_LINE_ITEM",
- "FILTER_PARTNER_CURRENCY",
- "FILTER_ADVERTISER_CURRENCY",
- "FILTER_ADVERTISER_TIMEZONE",
- "FILTER_LINE_ITEM_TYPE",
- "FILTER_USER_LIST",
- "FILTER_USER_LIST_FIRST_PARTY",
- "FILTER_USER_LIST_THIRD_PARTY",
- "FILTER_TARGETED_USER_LIST",
- "FILTER_DATA_PROVIDER",
- "FILTER_ORDER_ID",
- "FILTER_VIDEO_PLAYER_SIZE",
- "FILTER_VIDEO_DURATION_SECONDS",
- "FILTER_KEYWORD",
- "FILTER_PAGE_CATEGORY",
- "FILTER_CAMPAIGN_DAILY_FREQUENCY",
- "FILTER_LINE_ITEM_DAILY_FREQUENCY",
- "FILTER_LINE_ITEM_LIFETIME_FREQUENCY",
- "FILTER_OS",
- "FILTER_BROWSER",
- "FILTER_CARRIER",
- "FILTER_SITE_LANGUAGE",
- "FILTER_INVENTORY_FORMAT",
- "FILTER_ZIP_CODE",
- "FILTER_VIDEO_RATING_TIER",
- "FILTER_VIDEO_FORMAT_SUPPORT",
- "FILTER_VIDEO_SKIPPABLE_SUPPORT",
- "FILTER_VIDEO_VPAID_SUPPORT",
- "FILTER_VIDEO_CREATIVE_DURATION",
- "FILTER_PAGE_LAYOUT",
- "FILTER_VIDEO_AD_POSITION_IN_STREAM",
- "FILTER_AGE",
- "FILTER_GENDER",
- "FILTER_QUARTER",
- "FILTER_TRUEVIEW_CONVERSION_TYPE",
- "FILTER_MOBILE_GEO",
- "FILTER_MRAID_SUPPORT",
- "FILTER_ACTIVE_VIEW_EXPECTED_VIEWABILITY",
- "FILTER_VIDEO_CREATIVE_DURATION_SKIPPABLE",
- "FILTER_NIELSEN_COUNTRY_CODE",
- "FILTER_NIELSEN_DEVICE_ID",
- "FILTER_NIELSEN_GENDER",
- "FILTER_NIELSEN_AGE",
- "FILTER_INVENTORY_SOURCE_TYPE",
- "FILTER_CREATIVE_WIDTH",
- "FILTER_CREATIVE_HEIGHT",
- "FILTER_DFP_ORDER_ID",
- "FILTER_TRUEVIEW_AGE",
- "FILTER_TRUEVIEW_GENDER",
- "FILTER_TRUEVIEW_PARENTAL_STATUS",
- "FILTER_TRUEVIEW_REMARKETING_LIST",
- "FILTER_TRUEVIEW_INTEREST",
- "FILTER_TRUEVIEW_AD_GROUP_ID",
- "FILTER_TRUEVIEW_AD_GROUP_AD_ID",
- "FILTER_TRUEVIEW_IAR_LANGUAGE",
- "FILTER_TRUEVIEW_IAR_GENDER",
- "FILTER_TRUEVIEW_IAR_AGE",
- "FILTER_TRUEVIEW_IAR_CATEGORY",
- "FILTER_TRUEVIEW_IAR_COUNTRY",
- "FILTER_TRUEVIEW_IAR_CITY",
- "FILTER_TRUEVIEW_IAR_REGION",
- "FILTER_TRUEVIEW_IAR_ZIPCODE",
- "FILTER_TRUEVIEW_IAR_REMARKETING_LIST",
- "FILTER_TRUEVIEW_IAR_INTEREST",
- "FILTER_TRUEVIEW_IAR_PARENTAL_STATUS",
- "FILTER_TRUEVIEW_IAR_TIME_OF_DAY",
- "FILTER_TRUEVIEW_CUSTOM_AFFINITY",
- "FILTER_TRUEVIEW_CATEGORY",
- "FILTER_TRUEVIEW_KEYWORD",
- "FILTER_TRUEVIEW_PLACEMENT",
- "FILTER_TRUEVIEW_URL",
- "FILTER_TRUEVIEW_COUNTRY",
- "FILTER_TRUEVIEW_REGION",
- "FILTER_TRUEVIEW_CITY",
- "FILTER_TRUEVIEW_DMA",
- "FILTER_TRUEVIEW_ZIPCODE",
- "FILTER_NOT_SUPPORTED",
- "FILTER_MEDIA_PLAN",
- "FILTER_TRUEVIEW_IAR_YOUTUBE_CHANNEL",
- "FILTER_TRUEVIEW_IAR_YOUTUBE_VIDEO",
- "FILTER_SKIPPABLE_SUPPORT",
- "FILTER_COMPANION_CREATIVE_ID",
- "FILTER_BUDGET_SEGMENT_DESCRIPTION",
- "FILTER_FLOODLIGHT_ACTIVITY_ID",
- "FILTER_DEVICE_MODEL",
- "FILTER_DEVICE_MAKE",
- "FILTER_DEVICE_TYPE",
- "FILTER_CREATIVE_ATTRIBUTE",
- "FILTER_INVENTORY_COMMITMENT_TYPE",
- "FILTER_INVENTORY_RATE_TYPE",
- "FILTER_INVENTORY_DELIVERY_METHOD",
- "FILTER_INVENTORY_SOURCE_EXTERNAL_ID",
- "FILTER_AUTHORIZED_SELLER_STATE",
- "FILTER_VIDEO_DURATION_SECONDS_RANGE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- }
- }
- },
- "type": "object",
- "id": "Parameters"
- },
- "ReportFailure": {
- "id": "ReportFailure",
- "description": "An explanation of a report failure.",
- "properties": {
- "errorCode": {
+ ],
"enumDescriptions": [
"",
"",
@@ -1162,683 +1619,74 @@
"",
"",
"",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
""
],
- "description": "Error code that shows why the report was not created.",
- "enum": [
- "AUTHENTICATION_ERROR",
- "UNAUTHORIZED_API_ACCESS",
- "SERVER_ERROR",
- "VALIDATION_ERROR",
- "REPORTING_FATAL_ERROR",
- "REPORTING_TRANSIENT_ERROR",
- "REPORTING_IMCOMPATIBLE_METRICS",
- "REPORTING_ILLEGAL_FILENAME",
- "REPORTING_QUERY_NOT_FOUND",
- "REPORTING_BUCKET_NOT_FOUND",
- "REPORTING_CREATE_BUCKET_FAILED",
- "REPORTING_DELETE_BUCKET_FAILED",
- "REPORTING_UPDATE_BUCKET_PERMISSION_FAILED",
- "REPORTING_WRITE_BUCKET_OBJECT_FAILED",
- "DEPRECATED_REPORTING_INVALID_QUERY",
- "REPORTING_INVALID_QUERY_TOO_MANY_UNFILTERED_LARGE_GROUP_BYS",
- "REPORTING_INVALID_QUERY_TITLE_MISSING",
- "REPORTING_INVALID_QUERY_MISSING_PARTNER_AND_ADVERTISER_FILTERS"
- ],
"type": "string"
}
},
"type": "object"
},
- "UploadStatus": {
- "type": "object",
- "id": "UploadStatus",
- "description": "Represents the status of upload.",
- "properties": {
- "errors": {
- "description": "Reasons why upload can't be completed.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "rowStatus": {
- "description": "Per-row upload status.",
- "items": {
- "$ref": "RowStatus"
- },
- "type": "array"
- }
- }
- },
- "UploadLineItemsResponse": {
- "id": "UploadLineItemsResponse",
- "type": "object",
- "description": "Upload line items response.",
- "properties": {
- "uploadStatus": {
- "description": "Status of upload.",
- "$ref": "UploadStatus"
- }
- }
- },
- "DownloadRequest": {
- "type": "object",
- "description": "Request to fetch stored inventory sources, campaigns, insertion orders, line items, YouTube ad groups and ads.",
- "properties": {
- "filterType": {
- "enum": [
- "ADVERTISER_ID",
- "INSERTION_ORDER_ID",
- "LINE_ITEM_ID",
- "CAMPAIGN_ID",
- "INVENTORY_SOURCE_ID",
- "PARTNER_ID"
- ],
- "description": "Filter type used to filter entities to fetch. PARTNER_ID and INVENTORY_SOURCE_ID may only be used when downloading inventory sources.",
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "fileTypes": {
- "description": "File types that will be returned. If INVENTORY_SOURCE is requested, no other file types may be requested. Acceptable values are: - \"AD\" - \"AD_GROUP\" - \"CAMPAIGN\" - \"INSERTION_ORDER\" - \"INVENTORY_SOURCE\" - \"LINE_ITEM\" ",
- "items": {
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string",
- "enum": [
- "INSERTION_ORDER",
- "LINE_ITEM",
- "AD_GROUP",
- "AD",
- "CAMPAIGN",
- "INVENTORY_SOURCE"
- ]
- },
- "type": "array"
- },
- "filterIds": {
- "items": {
- "format": "int64",
- "type": "string"
- },
- "type": "array",
- "description": "The IDs of the specified filter type. This is used to filter entities to fetch. At least one ID must be specified."
- },
- "version": {
- "type": "string",
- "description": "SDF Version (column names, types, order) in which the entities will be returned. Default to 5."
- }
- },
- "id": "DownloadRequest"
- },
- "ReportStatus": {
- "type": "object",
- "description": "Report status.",
- "properties": {
- "finishTimeMs": {
- "format": "int64",
- "description": "The time when this report either completed successfully or failed.",
- "type": "string"
- },
- "state": {
- "description": "The state of the report.",
- "enum": [
- "RUNNING",
- "DONE",
- "FAILED"
- ],
- "type": "string",
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "failure": {
- "$ref": "ReportFailure",
- "description": "If the report failed, this records the cause."
- },
- "format": {
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "description": "The file type of the report.",
- "type": "string",
- "enum": [
- "CSV",
- "EXCEL_CSV",
- "XLSX"
- ]
- }
- },
- "id": "ReportStatus"
- },
- "UploadLineItemsRequest": {
- "description": "Request to upload line items.",
- "type": "object",
- "id": "UploadLineItemsRequest",
- "properties": {
- "lineItems": {
- "description": "Line items in CSV to upload. Refer to Entity Write File Format for more information on file format.",
- "type": "string"
- },
- "dryRun": {
- "description": "Set to true to get upload status without actually persisting the line items.",
- "type": "boolean"
- },
- "format": {
- "enumDescriptions": [
- ""
- ],
- "description": "Format the line items are in. Default to CSV.",
- "enum": [
- "CSV"
- ],
- "type": "string"
- }
- }
- },
- "FilterPair": {
- "properties": {
- "type": {
- "enum": [
- "FILTER_UNKNOWN",
- "FILTER_DATE",
- "FILTER_DAY_OF_WEEK",
- "FILTER_WEEK",
- "FILTER_MONTH",
- "FILTER_YEAR",
- "FILTER_TIME_OF_DAY",
- "FILTER_CONVERSION_DELAY",
- "FILTER_CREATIVE_ID",
- "FILTER_CREATIVE_SIZE",
- "FILTER_CREATIVE_TYPE",
- "FILTER_EXCHANGE_ID",
- "FILTER_AD_POSITION",
- "FILTER_INVENTORY_SOURCE",
- "FILTER_CITY",
- "FILTER_REGION",
- "FILTER_DMA",
- "FILTER_COUNTRY",
- "FILTER_SITE_ID",
- "FILTER_CHANNEL_ID",
- "FILTER_PARTNER",
- "FILTER_ADVERTISER",
- "FILTER_INSERTION_ORDER",
- "FILTER_LINE_ITEM",
- "FILTER_PARTNER_CURRENCY",
- "FILTER_ADVERTISER_CURRENCY",
- "FILTER_ADVERTISER_TIMEZONE",
- "FILTER_LINE_ITEM_TYPE",
- "FILTER_USER_LIST",
- "FILTER_USER_LIST_FIRST_PARTY",
- "FILTER_USER_LIST_THIRD_PARTY",
- "FILTER_TARGETED_USER_LIST",
- "FILTER_DATA_PROVIDER",
- "FILTER_ORDER_ID",
- "FILTER_VIDEO_PLAYER_SIZE",
- "FILTER_VIDEO_DURATION_SECONDS",
- "FILTER_KEYWORD",
- "FILTER_PAGE_CATEGORY",
- "FILTER_CAMPAIGN_DAILY_FREQUENCY",
- "FILTER_LINE_ITEM_DAILY_FREQUENCY",
- "FILTER_LINE_ITEM_LIFETIME_FREQUENCY",
- "FILTER_OS",
- "FILTER_BROWSER",
- "FILTER_CARRIER",
- "FILTER_SITE_LANGUAGE",
- "FILTER_INVENTORY_FORMAT",
- "FILTER_ZIP_CODE",
- "FILTER_VIDEO_RATING_TIER",
- "FILTER_VIDEO_FORMAT_SUPPORT",
- "FILTER_VIDEO_SKIPPABLE_SUPPORT",
- "FILTER_VIDEO_VPAID_SUPPORT",
- "FILTER_VIDEO_CREATIVE_DURATION",
- "FILTER_PAGE_LAYOUT",
- "FILTER_VIDEO_AD_POSITION_IN_STREAM",
- "FILTER_AGE",
- "FILTER_GENDER",
- "FILTER_QUARTER",
- "FILTER_TRUEVIEW_CONVERSION_TYPE",
- "FILTER_MOBILE_GEO",
- "FILTER_MRAID_SUPPORT",
- "FILTER_ACTIVE_VIEW_EXPECTED_VIEWABILITY",
- "FILTER_VIDEO_CREATIVE_DURATION_SKIPPABLE",
- "FILTER_NIELSEN_COUNTRY_CODE",
- "FILTER_NIELSEN_DEVICE_ID",
- "FILTER_NIELSEN_GENDER",
- "FILTER_NIELSEN_AGE",
- "FILTER_INVENTORY_SOURCE_TYPE",
- "FILTER_CREATIVE_WIDTH",
- "FILTER_CREATIVE_HEIGHT",
- "FILTER_DFP_ORDER_ID",
- "FILTER_TRUEVIEW_AGE",
- "FILTER_TRUEVIEW_GENDER",
- "FILTER_TRUEVIEW_PARENTAL_STATUS",
- "FILTER_TRUEVIEW_REMARKETING_LIST",
- "FILTER_TRUEVIEW_INTEREST",
- "FILTER_TRUEVIEW_AD_GROUP_ID",
- "FILTER_TRUEVIEW_AD_GROUP_AD_ID",
- "FILTER_TRUEVIEW_IAR_LANGUAGE",
- "FILTER_TRUEVIEW_IAR_GENDER",
- "FILTER_TRUEVIEW_IAR_AGE",
- "FILTER_TRUEVIEW_IAR_CATEGORY",
- "FILTER_TRUEVIEW_IAR_COUNTRY",
- "FILTER_TRUEVIEW_IAR_CITY",
- "FILTER_TRUEVIEW_IAR_REGION",
- "FILTER_TRUEVIEW_IAR_ZIPCODE",
- "FILTER_TRUEVIEW_IAR_REMARKETING_LIST",
- "FILTER_TRUEVIEW_IAR_INTEREST",
- "FILTER_TRUEVIEW_IAR_PARENTAL_STATUS",
- "FILTER_TRUEVIEW_IAR_TIME_OF_DAY",
- "FILTER_TRUEVIEW_CUSTOM_AFFINITY",
- "FILTER_TRUEVIEW_CATEGORY",
- "FILTER_TRUEVIEW_KEYWORD",
- "FILTER_TRUEVIEW_PLACEMENT",
- "FILTER_TRUEVIEW_URL",
- "FILTER_TRUEVIEW_COUNTRY",
- "FILTER_TRUEVIEW_REGION",
- "FILTER_TRUEVIEW_CITY",
- "FILTER_TRUEVIEW_DMA",
- "FILTER_TRUEVIEW_ZIPCODE",
- "FILTER_NOT_SUPPORTED",
- "FILTER_MEDIA_PLAN",
- "FILTER_TRUEVIEW_IAR_YOUTUBE_CHANNEL",
- "FILTER_TRUEVIEW_IAR_YOUTUBE_VIDEO",
- "FILTER_SKIPPABLE_SUPPORT",
- "FILTER_COMPANION_CREATIVE_ID",
- "FILTER_BUDGET_SEGMENT_DESCRIPTION",
- "FILTER_FLOODLIGHT_ACTIVITY_ID",
- "FILTER_DEVICE_MODEL",
- "FILTER_DEVICE_MAKE",
- "FILTER_DEVICE_TYPE",
- "FILTER_CREATIVE_ATTRIBUTE",
- "FILTER_INVENTORY_COMMITMENT_TYPE",
- "FILTER_INVENTORY_RATE_TYPE",
- "FILTER_INVENTORY_DELIVERY_METHOD",
- "FILTER_INVENTORY_SOURCE_EXTERNAL_ID",
- "FILTER_AUTHORIZED_SELLER_STATE",
- "FILTER_VIDEO_DURATION_SECONDS_RANGE"
- ],
- "type": "string",
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "description": "Filter type."
- },
- "value": {
- "description": "Filter value.",
- "type": "string"
- }
- },
- "type": "object",
- "description": "Filter used to match traffic data in your report.",
- "id": "FilterPair"
- },
- "QuerySchedule": {
- "id": "QuerySchedule",
- "type": "object",
- "description": "Information on how frequently and when to run a query.",
- "properties": {
- "nextRunTimezoneCode": {
- "type": "string",
- "description": "Canonical timezone code for report generation time. Defaults to America/New_York."
- },
- "endTimeMs": {
- "type": "string",
- "format": "int64",
- "description": "Datetime to periodically run the query until."
- },
- "nextRunMinuteOfDay": {
- "type": "integer",
- "format": "int32",
- "description": "Time of day at which a new report will be generated, represented as minutes past midnight. Range is 0 to 1439. Only applies to scheduled reports."
- },
- "frequency": {
- "description": "How often the query is run.",
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "string",
- "enum": [
- "ONE_TIME",
- "DAILY",
- "WEEKLY",
- "SEMI_MONTHLY",
- "MONTHLY",
- "QUARTERLY"
- ]
- }
- }
- },
- "ReportKey": {
- "type": "object",
- "id": "ReportKey",
- "description": "Key used to identify a report.",
- "properties": {
- "reportId": {
- "format": "int64",
- "type": "string",
- "description": "Report ID."
- },
- "queryId": {
- "description": "Query ID.",
- "type": "string",
- "format": "int64"
- }
- }
- },
"Query": {
"description": "Represents a query.",
+ "id": "Query",
"properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"doubleclickbidmanager#query\".",
+ "type": "string"
+ },
"metadata": {
"$ref": "QueryMetadata",
"description": "Query metadata."
},
- "reportDataStartTimeMs": {
- "type": "string",
- "format": "int64",
- "description": "The starting time for the data that is shown in the report. Note, reportDataStartTimeMs is required if metadata.dataRange is CUSTOM_DATES and ignored otherwise."
- },
- "queryId": {
- "type": "string",
- "description": "Query ID.",
- "format": "int64"
- },
- "schedule": {
- "description": "Information on how often and when to run a query.",
- "$ref": "QuerySchedule"
- },
"params": {
"$ref": "Parameters",
"description": "Query parameters."
},
+ "queryId": {
+ "description": "Query ID.",
+ "format": "int64",
+ "type": "string"
+ },
+ "reportDataEndTimeMs": {
+ "description": "The ending time for the data that is shown in the report. Note, reportDataEndTimeMs is required if metadata.dataRange is CUSTOM_DATES and ignored otherwise.",
+ "format": "int64",
+ "type": "string"
+ },
+ "reportDataStartTimeMs": {
+ "description": "The starting time for the data that is shown in the report. Note, reportDataStartTimeMs is required if metadata.dataRange is CUSTOM_DATES and ignored otherwise.",
+ "format": "int64",
+ "type": "string"
+ },
+ "schedule": {
+ "$ref": "QuerySchedule",
+ "description": "Information on how often and when to run a query."
+ },
"timezoneCode": {
"description": "Canonical timezone code for report data time. Defaults to America/New_York.",
"type": "string"
- },
- "reportDataEndTimeMs": {
- "type": "string",
- "format": "int64",
- "description": "The ending time for the data that is shown in the report. Note, reportDataEndTimeMs is required if metadata.dataRange is CUSTOM_DATES and ignored otherwise."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"doubleclickbidmanager#query\"."
}
},
- "type": "object",
- "id": "Query"
- },
- "ReportMetadata": {
- "description": "Report metadata.",
- "type": "object",
- "id": "ReportMetadata",
- "properties": {
- "reportDataEndTimeMs": {
- "type": "string",
- "description": "The ending time for the data that is shown in the report.",
- "format": "int64"
- },
- "reportDataStartTimeMs": {
- "description": "The starting time for the data that is shown in the report.",
- "format": "int64",
- "type": "string"
- },
- "googleCloudStoragePath": {
- "description": "The path to the location in Google Cloud Storage where the report is stored.",
- "type": "string"
- },
- "status": {
- "$ref": "ReportStatus",
- "description": "Report status."
- }
- }
- },
- "ListReportsResponse": {
- "type": "object",
- "id": "ListReportsResponse",
- "description": "List reports response.",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"doubleclickbidmanager#listReportsResponse\".",
- "type": "string"
- },
- "reports": {
- "description": "Retrieved reports.",
- "items": {
- "$ref": "Report"
- },
- "type": "array"
- }
- }
- },
- "DownloadLineItemsResponse": {
- "description": "Download line items response.",
- "type": "object",
- "properties": {
- "lineItems": {
- "type": "string",
- "description": "Retrieved line items in CSV format. For more information about file formats, see Entity Write File Format."
- }
- },
- "id": "DownloadLineItemsResponse"
- },
- "DownloadLineItemsRequest": {
- "type": "object",
- "properties": {
- "filterIds": {
- "description": "Ids of the specified filter type used to filter line items to fetch. If omitted, all the line items will be returned.",
- "type": "array",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "filterType": {
- "enum": [
- "ADVERTISER_ID",
- "INSERTION_ORDER_ID",
- "LINE_ITEM_ID"
- ],
- "description": "Filter type used to filter line items to fetch.",
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "type": "string"
- },
- "format": {
- "description": "Format in which the line items will be returned. Default to CSV.",
- "enum": [
- "CSV"
- ],
- "type": "string",
- "enumDescriptions": [
- ""
- ]
- },
- "fileSpec": {
- "type": "string",
- "description": "File specification (column names, types, order) in which the line items will be returned. Default to EWF.",
- "enum": [
- "EWF"
- ],
- "enumDescriptions": [
- ""
- ]
- }
- },
- "description": "Request to fetch stored line items.",
- "id": "DownloadLineItemsRequest"
+ "type": "object"
},
"QueryMetadata": {
"description": "Query metadata.",
+ "id": "QueryMetadata",
"properties": {
- "latestReportRunTimeMs": {
- "format": "int64",
- "type": "string",
- "description": "The time when the latest report started to run."
- },
"dataRange": {
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
"description": "Range of report data.",
"enum": [
"CUSTOM_DATES",
@@ -1861,294 +1709,446 @@
"LAST_14_DAYS",
"TYPE_NOT_SUPPORTED"
],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
"type": "string"
},
- "shareEmailAddress": {
- "items": {
- "type": "string"
- },
- "description": "List of email addresses which are sent email notifications when the report is finished. Separate from sendNotification.",
- "type": "array"
+ "format": {
+ "description": "Format of the generated report.",
+ "enum": [
+ "CSV",
+ "EXCEL_CSV",
+ "XLSX"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "googleCloudStoragePathForLatestReport": {
+ "description": "The path to the location in Google Cloud Storage where the latest report is stored.",
+ "type": "string"
+ },
+ "googleDrivePathForLatestReport": {
+ "description": "The path in Google Drive for the latest report.",
+ "type": "string"
+ },
+ "latestReportRunTimeMs": {
+ "description": "The time when the latest report started to run.",
+ "format": "int64",
+ "type": "string"
+ },
+ "locale": {
+ "description": "Locale of the generated reports. Valid values are cs CZECH de GERMAN en ENGLISH es SPANISH fr FRENCH it ITALIAN ja JAPANESE ko KOREAN pl POLISH pt-BR BRAZILIAN_PORTUGUESE ru RUSSIAN tr TURKISH uk UKRAINIAN zh-CN CHINA_CHINESE zh-TW TAIWAN_CHINESE An locale string not in the list above will generate reports in English.",
+ "type": "string"
},
"reportCount": {
"description": "Number of reports that have been generated for the query.",
"format": "int32",
"type": "integer"
},
- "locale": {
- "description": "Locale of the generated reports. Valid values are cs CZECH de GERMAN en ENGLISH es SPANISH fr FRENCH it ITALIAN ja JAPANESE ko KOREAN pl POLISH pt-BR BRAZILIAN_PORTUGUESE ru RUSSIAN tr TURKISH uk UKRAINIAN zh-CN CHINA_CHINESE zh-TW TAIWAN_CHINESE An locale string not in the list above will generate reports in English.",
- "type": "string"
- },
- "googleDrivePathForLatestReport": {
- "type": "string",
- "description": "The path in Google Drive for the latest report."
- },
"running": {
- "type": "boolean",
- "description": "Whether the latest report is currently running."
+ "description": "Whether the latest report is currently running.",
+ "type": "boolean"
},
- "googleCloudStoragePathForLatestReport": {
- "description": "The path to the location in Google Cloud Storage where the latest report is stored.",
+ "sendNotification": {
+ "description": "Whether to send an email notification when a report is ready. Default to false.",
+ "type": "boolean"
+ },
+ "shareEmailAddress": {
+ "description": "List of email addresses which are sent email notifications when the report is finished. Separate from sendNotification.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "title": {
+ "description": "Query title. It is used to name the reports generated from this query.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "QuerySchedule": {
+ "description": "Information on how frequently and when to run a query.",
+ "id": "QuerySchedule",
+ "properties": {
+ "endTimeMs": {
+ "description": "Datetime to periodically run the query until.",
+ "format": "int64",
"type": "string"
},
- "format": {
+ "frequency": {
+ "description": "How often the query is run.",
+ "enum": [
+ "ONE_TIME",
+ "DAILY",
+ "WEEKLY",
+ "SEMI_MONTHLY",
+ "MONTHLY",
+ "QUARTERLY"
+ ],
"enumDescriptions": [
"",
"",
+ "",
+ "",
+ "",
""
],
+ "type": "string"
+ },
+ "nextRunMinuteOfDay": {
+ "description": "Time of day at which a new report will be generated, represented as minutes past midnight. Range is 0 to 1439. Only applies to scheduled reports.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "nextRunTimezoneCode": {
+ "description": "Canonical timezone code for report generation time. Defaults to America/New_York.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Report": {
+ "description": "Represents a report.",
+ "id": "Report",
+ "properties": {
+ "key": {
+ "$ref": "ReportKey",
+ "description": "Key used to identify a report."
+ },
+ "metadata": {
+ "$ref": "ReportMetadata",
+ "description": "Report metadata."
+ },
+ "params": {
+ "$ref": "Parameters",
+ "description": "Report parameters."
+ }
+ },
+ "type": "object"
+ },
+ "ReportFailure": {
+ "description": "An explanation of a report failure.",
+ "id": "ReportFailure",
+ "properties": {
+ "errorCode": {
+ "description": "Error code that shows why the report was not created.",
+ "enum": [
+ "AUTHENTICATION_ERROR",
+ "UNAUTHORIZED_API_ACCESS",
+ "SERVER_ERROR",
+ "VALIDATION_ERROR",
+ "REPORTING_FATAL_ERROR",
+ "REPORTING_TRANSIENT_ERROR",
+ "REPORTING_IMCOMPATIBLE_METRICS",
+ "REPORTING_ILLEGAL_FILENAME",
+ "REPORTING_QUERY_NOT_FOUND",
+ "REPORTING_BUCKET_NOT_FOUND",
+ "REPORTING_CREATE_BUCKET_FAILED",
+ "REPORTING_DELETE_BUCKET_FAILED",
+ "REPORTING_UPDATE_BUCKET_PERMISSION_FAILED",
+ "REPORTING_WRITE_BUCKET_OBJECT_FAILED",
+ "DEPRECATED_REPORTING_INVALID_QUERY",
+ "REPORTING_INVALID_QUERY_TOO_MANY_UNFILTERED_LARGE_GROUP_BYS",
+ "REPORTING_INVALID_QUERY_TITLE_MISSING",
+ "REPORTING_INVALID_QUERY_MISSING_PARTNER_AND_ADVERTISER_FILTERS"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ReportKey": {
+ "description": "Key used to identify a report.",
+ "id": "ReportKey",
+ "properties": {
+ "queryId": {
+ "description": "Query ID.",
+ "format": "int64",
+ "type": "string"
+ },
+ "reportId": {
+ "description": "Report ID.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ReportMetadata": {
+ "description": "Report metadata.",
+ "id": "ReportMetadata",
+ "properties": {
+ "googleCloudStoragePath": {
+ "description": "The path to the location in Google Cloud Storage where the report is stored.",
+ "type": "string"
+ },
+ "reportDataEndTimeMs": {
+ "description": "The ending time for the data that is shown in the report.",
+ "format": "int64",
+ "type": "string"
+ },
+ "reportDataStartTimeMs": {
+ "description": "The starting time for the data that is shown in the report.",
+ "format": "int64",
+ "type": "string"
+ },
+ "status": {
+ "$ref": "ReportStatus",
+ "description": "Report status."
+ }
+ },
+ "type": "object"
+ },
+ "ReportStatus": {
+ "description": "Report status.",
+ "id": "ReportStatus",
+ "properties": {
+ "failure": {
+ "$ref": "ReportFailure",
+ "description": "If the report failed, this records the cause."
+ },
+ "finishTimeMs": {
+ "description": "The time when this report either completed successfully or failed.",
+ "format": "int64",
+ "type": "string"
+ },
+ "format": {
+ "description": "The file type of the report.",
"enum": [
"CSV",
"EXCEL_CSV",
"XLSX"
],
- "type": "string",
- "description": "Format of the generated report."
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
},
- "title": {
- "type": "string",
- "description": "Query title. It is used to name the reports generated from this query."
- },
- "sendNotification": {
- "type": "boolean",
- "description": "Whether to send an email notification when a report is ready. Default to false."
+ "state": {
+ "description": "The state of the report.",
+ "enum": [
+ "RUNNING",
+ "DONE",
+ "FAILED"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
}
},
- "type": "object",
- "id": "QueryMetadata"
- }
- },
- "documentationLink": "https://developers.google.com/bid-manager/",
- "rootUrl": "https://doubleclickbidmanager.googleapis.com/",
- "resources": {
- "queries": {
- "methods": {
- "listqueries": {
- "parameters": {},
- "path": "queries",
- "id": "doubleclickbidmanager.queries.listqueries",
- "flatPath": "queries",
- "description": "Retrieves stored queries.",
- "scopes": [
- "https://www.googleapis.com/auth/doubleclickbidmanager"
- ],
- "response": {
- "$ref": "ListQueriesResponse"
- },
- "httpMethod": "GET",
- "parameterOrder": []
- },
- "runquery": {
- "description": "Runs a stored query to generate a report.",
- "parameters": {
- "queryId": {
- "location": "path",
- "format": "int64",
- "description": "Query ID to run.",
- "type": "string",
- "required": true
- }
- },
- "request": {
- "$ref": "RunQueryRequest"
- },
- "parameterOrder": [
- "queryId"
- ],
- "id": "doubleclickbidmanager.queries.runquery",
- "httpMethod": "POST",
- "flatPath": "query/{queryId}",
- "scopes": [
- "https://www.googleapis.com/auth/doubleclickbidmanager"
- ],
- "path": "query/{queryId}"
- },
- "createquery": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "scopes": [
- "https://www.googleapis.com/auth/doubleclickbidmanager"
- ],
- "description": "Creates a query.",
- "path": "query",
- "id": "doubleclickbidmanager.queries.createquery",
- "parameters": {},
- "response": {
- "$ref": "Query"
- },
- "flatPath": "query",
- "request": {
- "$ref": "Query"
- }
- },
- "deletequery": {
- "httpMethod": "DELETE",
- "description": "Deletes a stored query as well as the associated stored reports.",
- "id": "doubleclickbidmanager.queries.deletequery",
- "parameters": {
- "queryId": {
- "format": "int64",
- "description": "Query ID to delete.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "parameterOrder": [
- "queryId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/doubleclickbidmanager"
- ],
- "flatPath": "query/{queryId}",
- "path": "query/{queryId}"
- },
- "getquery": {
- "path": "query/{queryId}",
- "parameterOrder": [
- "queryId"
- ],
- "httpMethod": "GET",
- "id": "doubleclickbidmanager.queries.getquery",
- "description": "Retrieves a stored query.",
- "scopes": [
- "https://www.googleapis.com/auth/doubleclickbidmanager"
- ],
- "flatPath": "query/{queryId}",
- "parameters": {
- "queryId": {
- "type": "string",
- "format": "int64",
- "required": true,
- "location": "path",
- "description": "Query ID to retrieve."
- }
- },
- "response": {
- "$ref": "Query"
- }
- }
- }
+ "type": "object"
},
- "sdf": {
- "methods": {
- "download": {
- "parameters": {},
- "request": {
- "$ref": "DownloadRequest"
- },
- "flatPath": "sdf/download",
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/doubleclickbidmanager"
- ],
- "response": {
- "$ref": "DownloadResponse"
- },
- "parameterOrder": [],
- "id": "doubleclickbidmanager.sdf.download",
- "description": "Retrieves entities in SDF format.",
- "path": "sdf/download"
- }
- }
- },
- "lineitems": {
- "methods": {
- "downloadlineitems": {
- "parameters": {},
- "id": "doubleclickbidmanager.lineitems.downloadlineitems",
- "parameterOrder": [],
- "scopes": [
- "https://www.googleapis.com/auth/doubleclickbidmanager"
- ],
- "httpMethod": "POST",
- "flatPath": "lineitems/downloadlineitems",
- "path": "lineitems/downloadlineitems",
- "description": "Retrieves line items in CSV format. YouTube & partners line items are not supported.",
- "response": {
- "$ref": "DownloadLineItemsResponse"
- },
- "request": {
- "$ref": "DownloadLineItemsRequest"
- }
+ "RowStatus": {
+ "description": "Represents the upload status of a row in the request.",
+ "id": "RowStatus",
+ "properties": {
+ "changed": {
+ "description": "Whether the stored entity is changed as a result of upload.",
+ "type": "boolean"
},
- "uploadlineitems": {
- "description": "Uploads line items in CSV format. YouTube & partners line items are not supported.",
- "parameters": {},
- "parameterOrder": [],
- "scopes": [
- "https://www.googleapis.com/auth/doubleclickbidmanager"
- ],
- "request": {
- "$ref": "UploadLineItemsRequest"
+ "entityId": {
+ "description": "Entity Id.",
+ "format": "int64",
+ "type": "string"
+ },
+ "entityName": {
+ "description": "Entity name.",
+ "type": "string"
+ },
+ "errors": {
+ "description": "Reasons why the entity can't be uploaded.",
+ "items": {
+ "type": "string"
},
- "path": "lineitems/uploadlineitems",
- "id": "doubleclickbidmanager.lineitems.uploadlineitems",
- "httpMethod": "POST",
- "flatPath": "lineitems/uploadlineitems",
- "response": {
- "$ref": "UploadLineItemsResponse"
- }
+ "type": "array"
+ },
+ "persisted": {
+ "description": "Whether the entity is persisted.",
+ "type": "boolean"
+ },
+ "rowNumber": {
+ "description": "Row number.",
+ "format": "int32",
+ "type": "integer"
}
- }
+ },
+ "type": "object"
},
- "reports": {
- "methods": {
- "listreports": {
- "path": "queries/{queryId}/reports",
- "flatPath": "queries/{queryId}/reports",
- "parameterOrder": [
- "queryId"
+ "RunQueryRequest": {
+ "description": "Request to run a stored query to generate a report.",
+ "id": "RunQueryRequest",
+ "properties": {
+ "dataRange": {
+ "description": "Report data range used to generate the report.",
+ "enum": [
+ "CUSTOM_DATES",
+ "CURRENT_DAY",
+ "PREVIOUS_DAY",
+ "WEEK_TO_DATE",
+ "MONTH_TO_DATE",
+ "QUARTER_TO_DATE",
+ "YEAR_TO_DATE",
+ "PREVIOUS_WEEK",
+ "PREVIOUS_HALF_MONTH",
+ "PREVIOUS_MONTH",
+ "PREVIOUS_QUARTER",
+ "PREVIOUS_YEAR",
+ "LAST_7_DAYS",
+ "LAST_30_DAYS",
+ "LAST_90_DAYS",
+ "LAST_365_DAYS",
+ "ALL_TIME",
+ "LAST_14_DAYS",
+ "TYPE_NOT_SUPPORTED"
],
- "scopes": [
- "https://www.googleapis.com/auth/doubleclickbidmanager"
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
],
- "id": "doubleclickbidmanager.reports.listreports",
- "parameters": {
- "queryId": {
- "location": "path",
- "description": "Query ID with which the reports are associated.",
- "format": "int64",
- "type": "string",
- "required": true
- }
- },
- "response": {
- "$ref": "ListReportsResponse"
- },
- "description": "Retrieves stored reports.",
- "httpMethod": "GET"
+ "type": "string"
+ },
+ "reportDataEndTimeMs": {
+ "description": "The ending time for the data that is shown in the report. Note, reportDataEndTimeMs is required if dataRange is CUSTOM_DATES and ignored otherwise.",
+ "format": "int64",
+ "type": "string"
+ },
+ "reportDataStartTimeMs": {
+ "description": "The starting time for the data that is shown in the report. Note, reportDataStartTimeMs is required if dataRange is CUSTOM_DATES and ignored otherwise.",
+ "format": "int64",
+ "type": "string"
+ },
+ "timezoneCode": {
+ "description": "Canonical timezone code for report data time. Defaults to America/New_York.",
+ "type": "string"
}
- }
+ },
+ "type": "object"
+ },
+ "UploadLineItemsRequest": {
+ "description": "Request to upload line items.",
+ "id": "UploadLineItemsRequest",
+ "properties": {
+ "dryRun": {
+ "description": "Set to true to get upload status without actually persisting the line items.",
+ "type": "boolean"
+ },
+ "format": {
+ "description": "Format the line items are in. Default to CSV.",
+ "enum": [
+ "CSV"
+ ],
+ "enumDescriptions": [
+ ""
+ ],
+ "type": "string"
+ },
+ "lineItems": {
+ "description": "Line items in CSV to upload. Refer to Entity Write File Format for more information on file format.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UploadLineItemsResponse": {
+ "description": "Upload line items response.",
+ "id": "UploadLineItemsResponse",
+ "properties": {
+ "uploadStatus": {
+ "$ref": "UploadStatus",
+ "description": "Status of upload."
+ }
+ },
+ "type": "object"
+ },
+ "UploadStatus": {
+ "description": "Represents the status of upload.",
+ "id": "UploadStatus",
+ "properties": {
+ "errors": {
+ "description": "Reasons why upload can't be completed.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "rowStatus": {
+ "description": "Per-row upload status.",
+ "items": {
+ "$ref": "RowStatus"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
}
},
"servicePath": "doubleclickbidmanager/v1/",
- "name": "doubleclickbidmanager",
- "discoveryVersion": "v1",
- "icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
- },
- "ownerName": "Google",
- "kind": "discovery#restDescription",
- "description": "DoubleClick Bid Manager API allows users to manage and create campaigns and reports.",
- "fullyEncodeReservedExpansion": true,
- "protocol": "rest",
- "baseUrl": "https://doubleclickbidmanager.googleapis.com/doubleclickbidmanager/v1/",
- "version": "v1",
- "mtlsRootUrl": "https://doubleclickbidmanager.mtls.googleapis.com/",
- "batchPath": "batch",
- "id": "doubleclickbidmanager:v1",
- "revision": "20201016",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/doubleclickbidmanager": {
- "description": "View and manage your reports in DoubleClick Bid Manager"
- }
- }
- }
- },
"title": "DoubleClick Bid Manager API",
- "canonicalName": "DoubleClick Bid Manager"
-}
+ "version": "v1"
+}
\ No newline at end of file