"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.",
"description":"View and manage your reports in DoubleClick Bid Manager"
}
}
}
},
"schemas":{
"DownloadLineItemsRequest":{
"id":"DownloadLineItemsRequest",
"type":"object",
"description":"Request to fetch stored line items.",
"properties":{
"fileSpec":{
"type":"string",
"description":"File specification (column names, types, order) in which the line items will be returned. Default to EWF.",
"enum":[
"EWF"
],
"enumDescriptions":[
""
]
},
"filterIds":{
"type":"array",
"description":"Ids of the specified filter type used to filter line items to fetch. If omitted, all the line items will be returned.",
"items":{
"type":"string",
"format":"int64"
}
},
"filterType":{
"type":"string",
"description":"Filter type used to filter line items to fetch.",
"enum":[
"ADVERTISER_ID",
"INSERTION_ORDER_ID",
"LINE_ITEM_ID"
],
"enumDescriptions":[
"",
"",
""
]
},
"format":{
"type":"string",
"description":"Format in which the line items will be returned. Default to CSV.",
"enum":[
"CSV"
],
"enumDescriptions":[
""
]
}
}
},
"DownloadLineItemsResponse":{
"id":"DownloadLineItemsResponse",
"type":"object",
"description":"Download line items response.",
"properties":{
"lineItems":{
"type":"string",
"description":"Retrieved line items in CSV format. For more information about file formats, see Entity Write File Format."
}
}
},
"DownloadRequest":{
"id":"DownloadRequest",
"type":"object",
"description":"Request to fetch stored insertion orders, line items, TrueView ad groups and ads.",
"properties":{
"fileTypes":{
"type":"array",
"description":"File types that will be returned.",
"items":{
"type":"string",
"enum":[
"AD",
"AD_GROUP",
"INSERTION_ORDER",
"LINE_ITEM"
],
"enumDescriptions":[
"",
"",
"",
""
]
}
},
"filterIds":{
"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. Only one ID is allowed for the ADVERTISER_ID filter type. For INSERTION_ORDER_ID or LINE_ITEM_ID filter types, all IDs must be from the same Advertiser.",
"items":{
"type":"string",
"format":"int64"
}
},
"filterType":{
"type":"string",
"description":"Filter type used to filter line items to fetch.",
"enum":[
"ADVERTISER_ID",
"INSERTION_ORDER_ID",
"LINE_ITEM_ID"
],
"enumDescriptions":[
"",
"",
""
]
},
"version":{
"type":"string",
"description":"SDF Version (column names, types, order) in which the entities will be returned. Default to 3."
}
}
},
"DownloadResponse":{
"id":"DownloadResponse",
"type":"object",
"description":"Download response.",
"properties":{
"adGroups":{
"type":"string",
"description":"Retrieved ad groups in SDF format."
},
"ads":{
"type":"string",
"description":"Retrieved ads in SDF format."
},
"insertionOrders":{
"type":"string",
"description":"Retrieved insertion orders in SDF format."
},
"lineItems":{
"type":"string",
"description":"Retrieved line items in SDF format."
}
}
},
"FilterPair":{
"id":"FilterPair",
"type":"object",
"description":"Filter used to match traffic data in your report.",
"properties":{
"type":{
"type":"string",
"description":"Filter type.",
"enum":[
"FILTER_ACTIVE_VIEW_EXPECTED_VIEWABILITY",
"FILTER_ACTIVITY_ID",
"FILTER_ADVERTISER",
"FILTER_ADVERTISER_CURRENCY",
"FILTER_ADVERTISER_TIMEZONE",
"FILTER_AD_POSITION",
"FILTER_AGE",
"FILTER_BRANDSAFE_CHANNEL_ID",
"FILTER_BROWSER",
"FILTER_BUDGET_SEGMENT_DESCRIPTION",
"FILTER_CAMPAIGN_DAILY_FREQUENCY",
"FILTER_CARRIER",
"FILTER_CHANNEL_ID",
"FILTER_CITY",
"FILTER_COMPANION_CREATIVE_ID",
"FILTER_CONVERSION_DELAY",
"FILTER_COUNTRY",
"FILTER_CREATIVE_HEIGHT",
"FILTER_CREATIVE_ID",
"FILTER_CREATIVE_SIZE",
"FILTER_CREATIVE_TYPE",
"FILTER_CREATIVE_WIDTH",
"FILTER_DATA_PROVIDER",
"FILTER_DATE",
"FILTER_DAY_OF_WEEK",
"FILTER_DFP_ORDER_ID",
"FILTER_DMA",
"FILTER_EXCHANGE_ID",
"FILTER_FLOODLIGHT_PIXEL_ID",
"FILTER_GENDER",
"FILTER_INSERTION_ORDER",
"FILTER_INVENTORY_FORMAT",
"FILTER_INVENTORY_SOURCE",
"FILTER_INVENTORY_SOURCE_TYPE",
"FILTER_KEYWORD",
"FILTER_LINE_ITEM",
"FILTER_LINE_ITEM_DAILY_FREQUENCY",
"FILTER_LINE_ITEM_LIFETIME_FREQUENCY",
"FILTER_LINE_ITEM_TYPE",
"FILTER_MEDIA_PLAN",
"FILTER_MOBILE_DEVICE_MAKE",
"FILTER_MOBILE_DEVICE_MAKE_MODEL",
"FILTER_MOBILE_DEVICE_TYPE",
"FILTER_MOBILE_GEO",
"FILTER_MONTH",
"FILTER_MRAID_SUPPORT",
"FILTER_NIELSEN_AGE",
"FILTER_NIELSEN_COUNTRY_CODE",
"FILTER_NIELSEN_DEVICE_ID",
"FILTER_NIELSEN_GENDER",
"FILTER_NOT_SUPPORTED",
"FILTER_ORDER_ID",
"FILTER_OS",
"FILTER_PAGE_CATEGORY",
"FILTER_PAGE_LAYOUT",
"FILTER_PARTNER",
"FILTER_PARTNER_CURRENCY",
"FILTER_PUBLIC_INVENTORY",
"FILTER_QUARTER",
"FILTER_REGION",
"FILTER_REGULAR_CHANNEL_ID",
"FILTER_SITE_ID",
"FILTER_SITE_LANGUAGE",
"FILTER_SKIPPABLE_SUPPORT",
"FILTER_TARGETED_USER_LIST",
"FILTER_TIME_OF_DAY",
"FILTER_TRUEVIEW_AD_GROUP_AD_ID",
"FILTER_TRUEVIEW_AD_GROUP_ID",
"FILTER_TRUEVIEW_AGE",
"FILTER_TRUEVIEW_CATEGORY",
"FILTER_TRUEVIEW_CITY",
"FILTER_TRUEVIEW_CONVERSION_TYPE",
"FILTER_TRUEVIEW_COUNTRY",
"FILTER_TRUEVIEW_CUSTOM_AFFINITY",
"FILTER_TRUEVIEW_DMA",
"FILTER_TRUEVIEW_GENDER",
"FILTER_TRUEVIEW_IAR_AGE",
"FILTER_TRUEVIEW_IAR_CATEGORY",
"FILTER_TRUEVIEW_IAR_CITY",
"FILTER_TRUEVIEW_IAR_COUNTRY",
"FILTER_TRUEVIEW_IAR_GENDER",
"FILTER_TRUEVIEW_IAR_INTEREST",
"FILTER_TRUEVIEW_IAR_LANGUAGE",
"FILTER_TRUEVIEW_IAR_PARENTAL_STATUS",
"FILTER_TRUEVIEW_IAR_REGION",
"FILTER_TRUEVIEW_IAR_REMARKETING_LIST",
"FILTER_TRUEVIEW_IAR_TIME_OF_DAY",
"FILTER_TRUEVIEW_IAR_YOUTUBE_CHANNEL",
"FILTER_TRUEVIEW_IAR_YOUTUBE_VIDEO",
"FILTER_TRUEVIEW_IAR_ZIPCODE",
"FILTER_TRUEVIEW_INTEREST",
"FILTER_TRUEVIEW_KEYWORD",
"FILTER_TRUEVIEW_PARENTAL_STATUS",
"FILTER_TRUEVIEW_PLACEMENT",
"FILTER_TRUEVIEW_REGION",
"FILTER_TRUEVIEW_REMARKETING_LIST",
"FILTER_TRUEVIEW_URL",
"FILTER_TRUEVIEW_ZIPCODE",
"FILTER_UNKNOWN",
"FILTER_USER_LIST",
"FILTER_USER_LIST_FIRST_PARTY",
"FILTER_USER_LIST_THIRD_PARTY",
"FILTER_VIDEO_AD_POSITION_IN_STREAM",
"FILTER_VIDEO_COMPANION_SIZE",
"FILTER_VIDEO_COMPANION_TYPE",
"FILTER_VIDEO_CREATIVE_DURATION",
"FILTER_VIDEO_CREATIVE_DURATION_SKIPPABLE",
"FILTER_VIDEO_DURATION_SECONDS",
"FILTER_VIDEO_FORMAT_SUPPORT",
"FILTER_VIDEO_INVENTORY_TYPE",
"FILTER_VIDEO_PLAYER_SIZE",
"FILTER_VIDEO_RATING_TIER",
"FILTER_VIDEO_SKIPPABLE_SUPPORT",
"FILTER_VIDEO_VPAID_SUPPORT",
"FILTER_WEEK",
"FILTER_YEAR",
"FILTER_YOUTUBE_VERTICAL",
"FILTER_ZIP_CODE"
],
"enumDescriptions":[
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
]
},
"value":{
"type":"string",
"description":"Filter value."
}
}
},
"ListQueriesResponse":{
"id":"ListQueriesResponse",
"type":"object",
"description":"List queries response.",
"properties":{
"kind":{
"type":"string",
"description":"Identifies what kind of resource this is. Value: the fixed string \"doubleclickbidmanager#listQueriesResponse\".",
"description":"Identifies what kind of resource this is. Value: the fixed string \"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",
"TYPE_NOT_SUPPORTED",
"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"
},
"locale":{
"type":"string",
"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\n\nAn locale string not in the list above will generate reports in English."
},
"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":"Datetime to periodically run the query until.",
"format":"int64"
},
"frequency":{
"type":"string",
"description":"How often the query is run.",
"enum":[
"DAILY",
"MONTHLY",
"ONE_TIME",
"QUARTERLY",
"SEMI_MONTHLY",
"WEEKLY"
],
"enumDescriptions":[
"",
"",
"",
"",
"",
""
]
},
"nextRunMinuteOfDay":{
"type":"integer",
"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"
},
"nextRunTimezoneCode":{
"type":"string",
"description":"Canonical timezone code for report generation time. Defaults to America/New_York."
}
}
},
"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.",
"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":[
"",
"",
""
]
}
}
},
"RowStatus":{
"id":"RowStatus",
"type":"object",
"description":"Represents the upload status of a row in the request.",
"properties":{
"changed":{
"type":"boolean",
"description":"Whether the stored entity is changed as a result of upload."
},
"entityId":{
"type":"string",
"description":"Entity Id.",
"format":"int64"
},
"entityName":{
"type":"string",
"description":"Entity name."
},
"errors":{
"type":"array",
"description":"Reasons why the entity can't be uploaded.",
"items":{
"type":"string"
}
},
"persisted":{
"type":"boolean",
"description":"Whether the entity is persisted."
},
"rowNumber":{
"type":"integer",
"description":"Row number.",
"format":"int32"
}
}
},
"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",
"TYPE_NOT_SUPPORTED",
"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."
}
}
},
"UploadLineItemsRequest":{
"id":"UploadLineItemsRequest",
"type":"object",
"description":"Request to upload line items.",
"properties":{
"dryRun":{
"type":"boolean",
"description":"Set to true to get upload status without actually persisting the line items."
},
"format":{
"type":"string",
"description":"Format the line items are in. Default to CSV.",
"enum":[
"CSV"
],
"enumDescriptions":[
""
]
},
"lineItems":{
"type":"string",
"description":"Line items in CSV to upload. Refer to Entity Write File Format for more information on file format."
}
}
},
"UploadLineItemsResponse":{
"id":"UploadLineItemsResponse",
"type":"object",
"description":"Upload line items response.",
"properties":{
"uploadStatus":{
"$ref":"UploadStatus",
"description":"Status of upload."
}
}
},
"UploadStatus":{
"id":"UploadStatus",
"type":"object",
"description":"Represents the status of upload.",
"properties":{
"errors":{
"type":"array",
"description":"Reasons why upload can't be completed.",
