| { |
| "kind": "discovery#restDescription", |
| "etag": "\"wtgj9ZncHCe-ShJM8RewHb1DgWI/v8_9uAMOwc2xkyyWb4z28R88eF8\"", |
| "discoveryVersion": "v1", |
| "id": "doubleclickbidmanager:v1", |
| "name": "doubleclickbidmanager", |
| "version": "v1", |
| "revision": "20130721", |
| "title": "DoubleClick Bid Manager API", |
| "description": "API for viewing and managing your reports in DoubleClick Bid Manager.", |
| "ownerDomain": "google.com", |
| "ownerName": "Google", |
| "icons": { |
| "x16": "http://www.google.com/images/icons/product/search-16.gif", |
| "x32": "http://www.google.com/images/icons/product/search-32.gif" |
| }, |
| "documentationLink": "https://devsite.googleplex.com/bid-manager/", |
| "protocol": "rest", |
| "baseUrl": "https://www.googleapis.com/doubleclickbidmanager/v1/", |
| "basePath": "/doubleclickbidmanager/v1/", |
| "rootUrl": "https://www.googleapis.com/", |
| "servicePath": "doubleclickbidmanager/v1/", |
| "batchPath": "batch", |
| "parameters": { |
| "alt": { |
| "type": "string", |
| "description": "Data format for the response.", |
| "default": "json", |
| "enum": [ |
| "json" |
| ], |
| "enumDescriptions": [ |
| "Responses with Content-Type of application/json" |
| ], |
| "location": "query" |
| }, |
| "fields": { |
| "type": "string", |
| "description": "Selector specifying which fields to include in a partial response.", |
| "location": "query" |
| }, |
| "key": { |
| "type": "string", |
| "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", |
| "location": "query" |
| }, |
| "oauth_token": { |
| "type": "string", |
| "description": "OAuth 2.0 token for the current user.", |
| "location": "query" |
| }, |
| "prettyPrint": { |
| "type": "boolean", |
| "description": "Returns response with indentations and line breaks.", |
| "default": "true", |
| "location": "query" |
| }, |
| "quotaUser": { |
| "type": "string", |
| "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. Overrides userIp if both are provided.", |
| "location": "query" |
| }, |
| "userIp": { |
| "type": "string", |
| "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.", |
| "location": "query" |
| } |
| }, |
| "schemas": { |
| "FilterPair": { |
| "id": "FilterPair", |
| "type": "object", |
| "description": "Filter used to match traffic data in your report.", |
| "properties": { |
| "type": { |
| "type": "string", |
| "description": "Filter type.", |
| "enum": [ |
| "FILTER_ACTIVITY_ID", |
| "FILTER_ADVERTISER", |
| "FILTER_ADVERTISER_CURRENCY", |
| "FILTER_ADVERTISER_TIMEZONE", |
| "FILTER_AD_POSITION", |
| "FILTER_BRANDSAFE_CHANNEL_ID", |
| "FILTER_BROWSER", |
| "FILTER_CAMPAIGN_DAILY_FREQUENCY", |
| "FILTER_CARRIER", |
| "FILTER_CHANNEL_ID", |
| "FILTER_CITY", |
| "FILTER_CONVERSION_DELAY", |
| "FILTER_COUNTRY", |
| "FILTER_CREATIVE_ID", |
| "FILTER_CREATIVE_SIZE", |
| "FILTER_CREATIVE_TYPE", |
| "FILTER_DATA_PROVIDER", |
| "FILTER_DATE", |
| "FILTER_DAY_OF_WEEK", |
| "FILTER_DMA", |
| "FILTER_EXCHANGE_ID", |
| "FILTER_FLOODLIGHT_PIXEL_ID", |
| "FILTER_INSERTION_ORDER", |
| "FILTER_INVENTORY_FORMAT", |
| "FILTER_INVENTORY_SOURCE", |
| "FILTER_KEYWORD", |
| "FILTER_LINE_ITEM", |
| "FILTER_LINE_ITEM_DAILY_FREQUENCY", |
| "FILTER_LINE_ITEM_LIFETIME_FREQUENCY", |
| "FILTER_LINE_ITEM_TYPE", |
| "FILTER_MACHINE_LEARNING", |
| "FILTER_MOBILE_DEVICE_MAKE", |
| "FILTER_MOBILE_DEVICE_MAKE_MODEL", |
| "FILTER_MOBILE_DEVICE_TYPE", |
| "FILTER_MONTH", |
| "FILTER_ORDER_ID", |
| "FILTER_OS", |
| "FILTER_PAGE_CATEGORY", |
| "FILTER_PARTNER", |
| "FILTER_PARTNER_CURRENCY", |
| "FILTER_PUBLIC_INVENTORY", |
| "FILTER_REGION", |
| "FILTER_REGULAR_CHANNEL_ID", |
| "FILTER_SITE_ID", |
| "FILTER_SITE_LANGUAGE", |
| "FILTER_TARGETED_USER_LIST", |
| "FILTER_TIME_OF_DAY", |
| "FILTER_UNKNOWN", |
| "FILTER_USER_LIST", |
| "FILTER_USER_LIST_FIRST_PARTY", |
| "FILTER_USER_LIST_THIRD_PARTY", |
| "FILTER_VIDEO_DURATION_SECONDS", |
| "FILTER_VIDEO_PLAYER_SIZE", |
| "FILTER_WEEK", |
| "FILTER_YEAR", |
| "FILTER_ZIP_CODE" |
| ], |
| "enumDescriptions": [ |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "" |
| ] |
| }, |
| "value": { |
| "type": "string", |
| "description": "Filter value." |
| } |
| } |
| }, |
| "ListQueriesResponse": { |
| "id": "ListQueriesResponse", |
| "type": "object", |
| "description": "List queries response.", |
| "properties": { |
| "kind": { |
| "type": "string", |
| "description": "The kind, fixed to \"doubleclickbidmanager#listQueriesResponse\".", |
| "default": "doubleclickbidmanager#listQueriesResponse" |
| }, |
| "queries": { |
| "type": "array", |
| "description": "Retrieved queries.", |
| "items": { |
| "$ref": "Query" |
| } |
| } |
| } |
| }, |
| "ListReportsResponse": { |
| "id": "ListReportsResponse", |
| "type": "object", |
| "description": "List reports response.", |
| "properties": { |
| "kind": { |
| "type": "string", |
| "description": "The kind, fixed to \"doubleclickbidmanager#listReportsResponse\".", |
| "default": "doubleclickbidmanager#listReportsResponse" |
| }, |
| "reports": { |
| "type": "array", |
| "description": "Retrieved reports.", |
| "items": { |
| "$ref": "Report" |
| } |
| } |
| } |
| }, |
| "Parameters": { |
| "id": "Parameters", |
| "type": "object", |
| "description": "Parameters of a query or report.", |
| "properties": { |
| "filters": { |
| "type": "array", |
| "description": "Filters used to match traffic data in your report.", |
| "items": { |
| "$ref": "FilterPair" |
| } |
| }, |
| "groupBys": { |
| "type": "array", |
| "description": "Data is grouped by the filters listed in this field.", |
| "items": { |
| "type": "string", |
| "enum": [ |
| "FILTER_ACTIVITY_ID", |
| "FILTER_ADVERTISER", |
| "FILTER_ADVERTISER_CURRENCY", |
| "FILTER_ADVERTISER_TIMEZONE", |
| "FILTER_AD_POSITION", |
| "FILTER_BRANDSAFE_CHANNEL_ID", |
| "FILTER_BROWSER", |
| "FILTER_CAMPAIGN_DAILY_FREQUENCY", |
| "FILTER_CARRIER", |
| "FILTER_CHANNEL_ID", |
| "FILTER_CITY", |
| "FILTER_CONVERSION_DELAY", |
| "FILTER_COUNTRY", |
| "FILTER_CREATIVE_ID", |
| "FILTER_CREATIVE_SIZE", |
| "FILTER_CREATIVE_TYPE", |
| "FILTER_DATA_PROVIDER", |
| "FILTER_DATE", |
| "FILTER_DAY_OF_WEEK", |
| "FILTER_DMA", |
| "FILTER_EXCHANGE_ID", |
| "FILTER_FLOODLIGHT_PIXEL_ID", |
| "FILTER_INSERTION_ORDER", |
| "FILTER_INVENTORY_FORMAT", |
| "FILTER_INVENTORY_SOURCE", |
| "FILTER_KEYWORD", |
| "FILTER_LINE_ITEM", |
| "FILTER_LINE_ITEM_DAILY_FREQUENCY", |
| "FILTER_LINE_ITEM_LIFETIME_FREQUENCY", |
| "FILTER_LINE_ITEM_TYPE", |
| "FILTER_MACHINE_LEARNING", |
| "FILTER_MOBILE_DEVICE_MAKE", |
| "FILTER_MOBILE_DEVICE_MAKE_MODEL", |
| "FILTER_MOBILE_DEVICE_TYPE", |
| "FILTER_MONTH", |
| "FILTER_ORDER_ID", |
| "FILTER_OS", |
| "FILTER_PAGE_CATEGORY", |
| "FILTER_PARTNER", |
| "FILTER_PARTNER_CURRENCY", |
| "FILTER_PUBLIC_INVENTORY", |
| "FILTER_REGION", |
| "FILTER_REGULAR_CHANNEL_ID", |
| "FILTER_SITE_ID", |
| "FILTER_SITE_LANGUAGE", |
| "FILTER_TARGETED_USER_LIST", |
| "FILTER_TIME_OF_DAY", |
| "FILTER_UNKNOWN", |
| "FILTER_USER_LIST", |
| "FILTER_USER_LIST_FIRST_PARTY", |
| "FILTER_USER_LIST_THIRD_PARTY", |
| "FILTER_VIDEO_DURATION_SECONDS", |
| "FILTER_VIDEO_PLAYER_SIZE", |
| "FILTER_WEEK", |
| "FILTER_YEAR", |
| "FILTER_ZIP_CODE" |
| ], |
| "enumDescriptions": [ |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "" |
| ] |
| } |
| }, |
| "includeInviteData": { |
| "type": "boolean", |
| "description": "Whether to include data from Invite Media." |
| }, |
| "metrics": { |
| "type": "array", |
| "description": "Metrics to include as columns in your report.", |
| "items": { |
| "type": "string", |
| "enum": [ |
| "METRIC_BID_REQUESTS", |
| "METRIC_BILLABLE_COST_ADVERTISER", |
| "METRIC_BILLABLE_COST_PARTNER", |
| "METRIC_BILLABLE_COST_USD", |
| "METRIC_CLICKS", |
| "METRIC_CLICK_TO_POST_CLICK_CONVERSION_RATE", |
| "METRIC_CONVERSIONS_PER_MILLE", |
| "METRIC_CPM_FEE1_ADVERTISER", |
| "METRIC_CPM_FEE1_PARTNER", |
| "METRIC_CPM_FEE1_USD", |
| "METRIC_CPM_FEE2_ADVERTISER", |
| "METRIC_CPM_FEE2_PARTNER", |
| "METRIC_CPM_FEE2_USD", |
| "METRIC_CTR", |
| "METRIC_DATA_COST_ADVERTISER", |
| "METRIC_DATA_COST_PARTNER", |
| "METRIC_DATA_COST_USD", |
| "METRIC_IMPRESSIONS", |
| "METRIC_IMPRESSIONS_TO_CONVERSION_RATE", |
| "METRIC_LAST_CLICKS", |
| "METRIC_LAST_IMPRESSIONS", |
| "METRIC_MEDIA_COST_ADVERTISER", |
| "METRIC_MEDIA_COST_ECPAPC_ADVERTISER", |
| "METRIC_MEDIA_COST_ECPAPC_PARTNER", |
| "METRIC_MEDIA_COST_ECPAPC_USD", |
| "METRIC_MEDIA_COST_ECPAPV_ADVERTISER", |
| "METRIC_MEDIA_COST_ECPAPV_PARTNER", |
| "METRIC_MEDIA_COST_ECPAPV_USD", |
| "METRIC_MEDIA_COST_ECPA_ADVERTISER", |
| "METRIC_MEDIA_COST_ECPA_PARTNER", |
| "METRIC_MEDIA_COST_ECPA_USD", |
| "METRIC_MEDIA_COST_ECPC_ADVERTISER", |
| "METRIC_MEDIA_COST_ECPC_PARTNER", |
| "METRIC_MEDIA_COST_ECPC_USD", |
| "METRIC_MEDIA_COST_ECPM_ADVERTISER", |
| "METRIC_MEDIA_COST_ECPM_PARTNER", |
| "METRIC_MEDIA_COST_ECPM_USD", |
| "METRIC_MEDIA_COST_PARTNER", |
| "METRIC_MEDIA_COST_USD", |
| "METRIC_MEDIA_FEE1_ADVERTISER", |
| "METRIC_MEDIA_FEE1_PARTNER", |
| "METRIC_MEDIA_FEE1_USD", |
| "METRIC_MEDIA_FEE2_ADVERTISER", |
| "METRIC_MEDIA_FEE2_PARTNER", |
| "METRIC_MEDIA_FEE2_USD", |
| "METRIC_PIXEL_LOADS", |
| "METRIC_PLATFORM_FEE_ADVERTISER", |
| "METRIC_PLATFORM_FEE_PARTNER", |
| "METRIC_PLATFORM_FEE_USD", |
| "METRIC_POST_CLICK_DFA_REVENUE", |
| "METRIC_POST_VIEW_DFA_REVENUE", |
| "METRIC_PROFIT_ADVERTISER", |
| "METRIC_PROFIT_ECPAPC_ADVERTISER", |
| "METRIC_PROFIT_ECPAPC_PARTNER", |
| "METRIC_PROFIT_ECPAPC_USD", |
| "METRIC_PROFIT_ECPAPV_ADVERTISER", |
| "METRIC_PROFIT_ECPAPV_PARTNER", |
| "METRIC_PROFIT_ECPAPV_USD", |
| "METRIC_PROFIT_ECPA_ADVERTISER", |
| "METRIC_PROFIT_ECPA_PARTNER", |
| "METRIC_PROFIT_ECPA_USD", |
| "METRIC_PROFIT_ECPC_ADVERTISER", |
| "METRIC_PROFIT_ECPC_PARTNER", |
| "METRIC_PROFIT_ECPC_USD", |
| "METRIC_PROFIT_ECPM_ADVERTISER", |
| "METRIC_PROFIT_ECPM_PARTNER", |
| "METRIC_PROFIT_ECPM_USD", |
| "METRIC_PROFIT_MARGIN", |
| "METRIC_PROFIT_PARTNER", |
| "METRIC_PROFIT_USD", |
| "METRIC_REVENUE_ADVERTISER", |
| "METRIC_REVENUE_ECPAPC_ADVERTISER", |
| "METRIC_REVENUE_ECPAPC_PARTNER", |
| "METRIC_REVENUE_ECPAPC_USD", |
| "METRIC_REVENUE_ECPAPV_ADVERTISER", |
| "METRIC_REVENUE_ECPAPV_PARTNER", |
| "METRIC_REVENUE_ECPAPV_USD", |
| "METRIC_REVENUE_ECPA_ADVERTISER", |
| "METRIC_REVENUE_ECPA_PARTNER", |
| "METRIC_REVENUE_ECPA_USD", |
| "METRIC_REVENUE_ECPC_ADVERTISER", |
| "METRIC_REVENUE_ECPC_PARTNER", |
| "METRIC_REVENUE_ECPC_USD", |
| "METRIC_REVENUE_ECPM_ADVERTISER", |
| "METRIC_REVENUE_ECPM_PARTNER", |
| "METRIC_REVENUE_ECPM_USD", |
| "METRIC_REVENUE_PARTNER", |
| "METRIC_REVENUE_USD", |
| "METRIC_RICH_MEDIA_VIDEO_COMPLETIONS", |
| "METRIC_RICH_MEDIA_VIDEO_FIRST_QUARTILE_COMPLETES", |
| "METRIC_RICH_MEDIA_VIDEO_FULL_SCREENS", |
| "METRIC_RICH_MEDIA_VIDEO_MIDPOINTS", |
| "METRIC_RICH_MEDIA_VIDEO_MUTES", |
| "METRIC_RICH_MEDIA_VIDEO_PAUSES", |
| "METRIC_RICH_MEDIA_VIDEO_PLAYS", |
| "METRIC_RICH_MEDIA_VIDEO_THIRD_QUARTILE_COMPLETES", |
| "METRIC_TOTAL_CONVERSIONS", |
| "METRIC_TOTAL_MEDIA_COST_ADVERTISER", |
| "METRIC_TOTAL_MEDIA_COST_ECPAPC_ADVERTISER", |
| "METRIC_TOTAL_MEDIA_COST_ECPAPC_PARTNER", |
| "METRIC_TOTAL_MEDIA_COST_ECPAPC_USD", |
| "METRIC_TOTAL_MEDIA_COST_ECPAPV_ADVERTISER", |
| "METRIC_TOTAL_MEDIA_COST_ECPAPV_PARTNER", |
| "METRIC_TOTAL_MEDIA_COST_ECPAPV_USD", |
| "METRIC_TOTAL_MEDIA_COST_ECPA_ADVERTISER", |
| "METRIC_TOTAL_MEDIA_COST_ECPA_PARTNER", |
| "METRIC_TOTAL_MEDIA_COST_ECPA_USD", |
| "METRIC_TOTAL_MEDIA_COST_ECPC_ADVERTISER", |
| "METRIC_TOTAL_MEDIA_COST_ECPC_PARTNER", |
| "METRIC_TOTAL_MEDIA_COST_ECPC_USD", |
| "METRIC_TOTAL_MEDIA_COST_ECPM_ADVERTISER", |
| "METRIC_TOTAL_MEDIA_COST_ECPM_PARTNER", |
| "METRIC_TOTAL_MEDIA_COST_ECPM_USD", |
| "METRIC_TOTAL_MEDIA_COST_PARTNER", |
| "METRIC_TOTAL_MEDIA_COST_USD", |
| "METRIC_UNIQUE_VISITORS_COOKIES", |
| "METRIC_UNKNOWN", |
| "METRIC_VIDEO_COMPLETION_RATE" |
| ], |
| "enumDescriptions": [ |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "" |
| ] |
| } |
| }, |
| "type": { |
| "type": "string", |
| "description": "Report type.", |
| "enum": [ |
| "TYPE_AUDIENCE_COMPOSITION", |
| "TYPE_AUDIENCE_PERFORMANCE", |
| "TYPE_CLIENT_SAFE", |
| "TYPE_CROSS_PARTNER", |
| "TYPE_CROSS_PARTNER_THIRD_PARTY_DATA_PROVIDER", |
| "TYPE_FEE", |
| "TYPE_GENERAL", |
| "TYPE_INVENTORY_AVAILABILITY", |
| "TYPE_KEYWORD", |
| "TYPE_ORDER_ID", |
| "TYPE_PAGE_CATEGORY", |
| "TYPE_PIXEL_LOAD", |
| "TYPE_THIRD_PARTY_DATA_PROVIDER" |
| ], |
| "enumDescriptions": [ |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "" |
| ] |
| } |
| } |
| }, |
| "Query": { |
| "id": "Query", |
| "type": "object", |
| "description": "Represents a query.", |
| "properties": { |
| "kind": { |
| "type": "string", |
| "description": "The kind, fixed to \"doubleclickbidmanager#query\".", |
| "default": "doubleclickbidmanager#query" |
| }, |
| "metadata": { |
| "$ref": "QueryMetadata", |
| "description": "Query metadata." |
| }, |
| "params": { |
| "$ref": "Parameters", |
| "description": "Query parameters." |
| }, |
| "queryId": { |
| "type": "string", |
| "description": "Query ID.", |
| "format": "int64" |
| }, |
| "reportDataEndTimeMs": { |
| "type": "string", |
| "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" |
| }, |
| "reportDataStartTimeMs": { |
| "type": "string", |
| "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" |
| }, |
| "schedule": { |
| "$ref": "QuerySchedule", |
| "description": "Information on how often and when to run a query." |
| }, |
| "timezoneCode": { |
| "type": "string", |
| "description": "Canonical timezone code for report data time. Defaults to America/New_York." |
| } |
| } |
| }, |
| "QueryMetadata": { |
| "id": "QueryMetadata", |
| "type": "object", |
| "description": "Query metadata.", |
| "properties": { |
| "dataRange": { |
| "type": "string", |
| "description": "Range of report data.", |
| "enum": [ |
| "ALL_TIME", |
| "CURRENT_DAY", |
| "CUSTOM_DATES", |
| "LAST_14_DAYS", |
| "LAST_30_DAYS", |
| "LAST_365_DAYS", |
| "LAST_7_DAYS", |
| "LAST_90_DAYS", |
| "MONTH_TO_DATE", |
| "PREVIOUS_DAY", |
| "PREVIOUS_HALF_MONTH", |
| "PREVIOUS_MONTH", |
| "PREVIOUS_QUARTER", |
| "PREVIOUS_WEEK", |
| "PREVIOUS_YEAR", |
| "QUARTER_TO_DATE", |
| "WEEK_TO_DATE", |
| "YEAR_TO_DATE" |
| ], |
| "enumDescriptions": [ |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "" |
| ] |
| }, |
| "format": { |
| "type": "string", |
| "description": "Format of the generated report.", |
| "enum": [ |
| "CSV", |
| "EXCEL_CSV", |
| "XLSX" |
| ], |
| "enumDescriptions": [ |
| "", |
| "", |
| "" |
| ] |
| }, |
| "googleCloudStoragePathForLatestReport": { |
| "type": "string", |
| "description": "The path to the location in Google Cloud Storage where the latest report is stored." |
| }, |
| "googleDrivePathForLatestReport": { |
| "type": "string", |
| "description": "The path in Google Drive for the latest report." |
| }, |
| "latestReportRunTimeMs": { |
| "type": "string", |
| "description": "The time when the latest report started to run.", |
| "format": "int64" |
| }, |
| "reportCount": { |
| "type": "integer", |
| "description": "Number of reports that have been generated for the query.", |
| "format": "int32" |
| }, |
| "running": { |
| "type": "boolean", |
| "description": "Whether the latest report is currently running." |
| }, |
| "sendNotification": { |
| "type": "boolean", |
| "description": "Whether to send an email notification when a report is ready. Default to false." |
| }, |
| "shareEmailAddress": { |
| "type": "array", |
| "description": "List of email addresses which are sent email notifications when the report is finished. Separate from sendNotification.", |
| "items": { |
| "type": "string" |
| } |
| }, |
| "title": { |
| "type": "string", |
| "description": "Query title. It is used to name the reports generated from this query." |
| } |
| } |
| }, |
| "QuerySchedule": { |
| "id": "QuerySchedule", |
| "type": "object", |
| "description": "Information on how frequently and when to run a query.", |
| "properties": { |
| "endTimeMs": { |
| "type": "string", |
| "description": "Run the query periodically until the specified time.", |
| "format": "int64" |
| }, |
| "frequency": { |
| "type": "string", |
| "description": "How often the query is run.", |
| "enum": [ |
| "DAILY", |
| "MONTHLY", |
| "ONE_TIME", |
| "QUARTERLY", |
| "SEMI_MONTHLY", |
| "WEEKLY" |
| ], |
| "enumDescriptions": [ |
| "", |
| "", |
| "", |
| "", |
| "", |
| "" |
| ] |
| } |
| } |
| }, |
| "Report": { |
| "id": "Report", |
| "type": "object", |
| "description": "Represents a report.", |
| "properties": { |
| "key": { |
| "$ref": "ReportKey", |
| "description": "Key used to identify a report." |
| }, |
| "metadata": { |
| "$ref": "ReportMetadata", |
| "description": "Report metadata." |
| }, |
| "params": { |
| "$ref": "Parameters", |
| "description": "Report parameters." |
| } |
| } |
| }, |
| "ReportFailure": { |
| "id": "ReportFailure", |
| "type": "object", |
| "description": "An explanation of a report failure.", |
| "properties": { |
| "errorCode": { |
| "type": "string", |
| "description": "Error code that shows why the report was not created.", |
| "enum": [ |
| "AUTHENTICATION_ERROR", |
| "DEPRECATED_REPORTING_INVALID_QUERY", |
| "REPORTING_BUCKET_NOT_FOUND", |
| "REPORTING_CREATE_BUCKET_FAILED", |
| "REPORTING_DELETE_BUCKET_FAILED", |
| "REPORTING_FATAL_ERROR", |
| "REPORTING_ILLEGAL_FILENAME", |
| "REPORTING_IMCOMPATIBLE_METRICS", |
| "REPORTING_INVALID_QUERY_TITLE_MISSING", |
| "REPORTING_INVALID_QUERY_TOO_MANY_UNFILTERED_LARGE_GROUP_BYS", |
| "REPORTING_QUERY_NOT_FOUND", |
| "REPORTING_TRANSIENT_ERROR", |
| "REPORTING_UPDATE_BUCKET_PERMISSION_FAILED", |
| "REPORTING_WRITE_BUCKET_OBJECT_FAILED", |
| "SERVER_ERROR", |
| "UNAUTHORIZED_API_ACCESS", |
| "VALIDATION_ERROR" |
| ], |
| "enumDescriptions": [ |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "" |
| ] |
| } |
| } |
| }, |
| "ReportKey": { |
| "id": "ReportKey", |
| "type": "object", |
| "description": "Key used to identify a report.", |
| "properties": { |
| "queryId": { |
| "type": "string", |
| "description": "Query ID.", |
| "format": "int64" |
| }, |
| "reportId": { |
| "type": "string", |
| "description": "Report ID.", |
| "format": "int64" |
| } |
| } |
| }, |
| "ReportMetadata": { |
| "id": "ReportMetadata", |
| "type": "object", |
| "description": "Report metadata.", |
| "properties": { |
| "googleCloudStoragePath": { |
| "type": "string", |
| "description": "The path to the location in Google Cloud Storage where the report is stored." |
| }, |
| "reportDataEndTimeMs": { |
| "type": "string", |
| "description": "The ending time for the data that is shown in the report.", |
| "format": "int64" |
| }, |
| "reportDataStartTimeMs": { |
| "type": "string", |
| "description": "The starting time for the data that is shown in the report.", |
| "format": "int64" |
| }, |
| "status": { |
| "$ref": "ReportStatus", |
| "description": "Report status." |
| } |
| } |
| }, |
| "ReportStatus": { |
| "id": "ReportStatus", |
| "type": "object", |
| "description": "Report status.", |
| "properties": { |
| "failure": { |
| "$ref": "ReportFailure", |
| "description": "If the report failed, this records the cause." |
| }, |
| "finishTimeMs": { |
| "type": "string", |
| "description": "The time when this report either completed successfully or failed.", |
| "format": "int64" |
| }, |
| "format": { |
| "type": "string", |
| "description": "The file type of the report.", |
| "enum": [ |
| "CSV", |
| "EXCEL_CSV", |
| "XLSX" |
| ], |
| "enumDescriptions": [ |
| "", |
| "", |
| "" |
| ] |
| }, |
| "state": { |
| "type": "string", |
| "description": "The state of the report.", |
| "enum": [ |
| "DONE", |
| "FAILED", |
| "RUNNING" |
| ], |
| "enumDescriptions": [ |
| "", |
| "", |
| "" |
| ] |
| } |
| } |
| }, |
| "RunQueryRequest": { |
| "id": "RunQueryRequest", |
| "type": "object", |
| "description": "Request to run a stored query to generate a report.", |
| "properties": { |
| "dataRange": { |
| "type": "string", |
| "description": "Report data range used to generate the report.", |
| "enum": [ |
| "ALL_TIME", |
| "CURRENT_DAY", |
| "CUSTOM_DATES", |
| "LAST_14_DAYS", |
| "LAST_30_DAYS", |
| "LAST_365_DAYS", |
| "LAST_7_DAYS", |
| "LAST_90_DAYS", |
| "MONTH_TO_DATE", |
| "PREVIOUS_DAY", |
| "PREVIOUS_HALF_MONTH", |
| "PREVIOUS_MONTH", |
| "PREVIOUS_QUARTER", |
| "PREVIOUS_WEEK", |
| "PREVIOUS_YEAR", |
| "QUARTER_TO_DATE", |
| "WEEK_TO_DATE", |
| "YEAR_TO_DATE" |
| ], |
| "enumDescriptions": [ |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "", |
| "" |
| ] |
| }, |
| "reportDataEndTimeMs": { |
| "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.", |
| "format": "int64" |
| }, |
| "reportDataStartTimeMs": { |
| "type": "string", |
| "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" |
| }, |
| "timezoneCode": { |
| "type": "string", |
| "description": "Canonical timezone code for report data time. Defaults to America/New_York." |
| } |
| } |
| } |
| }, |
| "resources": { |
| "queries": { |
| "methods": { |
| "createquery": { |
| "id": "doubleclickbidmanager.queries.createquery", |
| "path": "query", |
| "httpMethod": "POST", |
| "description": "Creates a query.", |
| "request": { |
| "$ref": "Query" |
| }, |
| "response": { |
| "$ref": "Query" |
| } |
| }, |
| "deletequery": { |
| "id": "doubleclickbidmanager.queries.deletequery", |
| "path": "query/{queryId}", |
| "httpMethod": "DELETE", |
| "description": "Deletes a stored query as well as the associated stored reports.", |
| "parameters": { |
| "queryId": { |
| "type": "string", |
| "description": "Query ID to delete.", |
| "required": true, |
| "format": "int64", |
| "location": "path" |
| } |
| }, |
| "parameterOrder": [ |
| "queryId" |
| ] |
| }, |
| "getquery": { |
| "id": "doubleclickbidmanager.queries.getquery", |
| "path": "query/{queryId}", |
| "httpMethod": "GET", |
| "description": "Retrieves a stored query.", |
| "parameters": { |
| "queryId": { |
| "type": "string", |
| "description": "Query ID to retrieve.", |
| "required": true, |
| "format": "int64", |
| "location": "path" |
| } |
| }, |
| "parameterOrder": [ |
| "queryId" |
| ], |
| "response": { |
| "$ref": "Query" |
| } |
| }, |
| "listqueries": { |
| "id": "doubleclickbidmanager.queries.listqueries", |
| "path": "queries", |
| "httpMethod": "GET", |
| "description": "Retrieves stored queries.", |
| "response": { |
| "$ref": "ListQueriesResponse" |
| } |
| }, |
| "runquery": { |
| "id": "doubleclickbidmanager.queries.runquery", |
| "path": "query/{queryId}", |
| "httpMethod": "POST", |
| "description": "Runs a stored query to generate a report.", |
| "parameters": { |
| "queryId": { |
| "type": "string", |
| "description": "Query ID to run.", |
| "required": true, |
| "format": "int64", |
| "location": "path" |
| } |
| }, |
| "parameterOrder": [ |
| "queryId" |
| ], |
| "request": { |
| "$ref": "RunQueryRequest" |
| } |
| } |
| } |
| }, |
| "reports": { |
| "methods": { |
| "listreports": { |
| "id": "doubleclickbidmanager.reports.listreports", |
| "path": "queries/{queryId}/reports", |
| "httpMethod": "GET", |
| "description": "Retrieves stored reports.", |
| "parameters": { |
| "queryId": { |
| "type": "string", |
| "description": "Query ID with which the reports are associated.", |
| "required": true, |
| "format": "int64", |
| "location": "path" |
| } |
| }, |
| "parameterOrder": [ |
| "queryId" |
| ], |
| "response": { |
| "$ref": "ListReportsResponse" |
| } |
| } |
| } |
| } |
| } |
| } |
