API Reference
Stay organized with collections
Save and categorize content based on your preferences.
The Bid Manager API allows developers to manage Queries, retrieve Reports and Structured Data Files, and download and upload Line Items.
This API reference is organized by resource type. Each resource type has one or more data representations and one or more methods.
Resource types
-
Lineitems
-
Queries
-
Reports
-
Sdf
Lineitems
For Lineitems Resource details, see the resource representation page.
| Method |
HTTP request |
Description |
| URIs relative to https://www.googleapis.com/doubleclickbidmanager/v1, unless otherwise noted |
|
downloadlineitems
|
POST /lineitems/downloadlineitems
|
Retrieves line items in CSV format. YouTube & partners line items are not supported.
|
|
uploadlineitems
|
POST /lineitems/uploadlineitems
|
Uploads line items in CSV format. YouTube & partners line items are not supported.
|
Queries
For Queries Resource details, see the resource representation page.
| Method |
HTTP request |
Description |
| URIs relative to https://www.googleapis.com/doubleclickbidmanager/v1, unless otherwise noted |
|
createquery
|
POST /query
|
Creates a query.
|
|
deletequery
|
DELETE /query/queryId
|
Deletes a stored query as well as the associated stored reports.
|
|
getquery
|
GET /query/queryId
|
Retrieves a stored query.
|
|
listqueries
|
GET /queries
|
Retrieves stored queries.
|
|
runquery
|
POST /query/queryId
|
Runs a stored query to generate a report.
|
Reports
For Reports Resource details, see the resource representation page.
| Method |
HTTP request |
Description |
| URIs relative to https://www.googleapis.com/doubleclickbidmanager/v1, unless otherwise noted |
|
listreports
|
GET /queries/queryId/reports
|
Retrieves stored reports.
|
Sdf
For Sdf Resource details, see the resource representation page.
| Method |
HTTP request |
Description |
| URIs relative to https://www.googleapis.com/doubleclickbidmanager/v1, unless otherwise noted |
|
download
|
POST /sdf/download
|
Retrieves entities in SDF format.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-08-21 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-08-21 UTC."],[[["\u003cp\u003eThis version of the Bid Manager API is sunset and users should migrate to Bid Manager API v2.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can utilize the Bid Manager API to manage Queries, retrieve Reports and Structured Data Files, and handle Line Items.\u003c/p\u003e\n"],["\u003cp\u003eThe API offers functionalities for downloading and uploading Line Items (excluding YouTube & partners), creating, deleting, retrieving and running Queries, and listing Reports and SDF downloads.\u003c/p\u003e\n"],["\u003cp\u003eThis API reference is structured by resource type, including Lineitems, Queries, Reports, and Sdf, each with data representations and methods.\u003c/p\u003e\n"]]],["The Bid Manager API (now sunset, use v2) allows management of Queries, Reports, Structured Data Files (SDF), and Line Items. Key actions include creating, deleting, retrieving, and running Queries. Reports can be retrieved and Line Items can be downloaded or uploaded in CSV format. SDF entities are available for retrieval. The API uses POST and GET methods, with resources organized by type, each with specific methods and data representations.\n"],null,["# API Reference\n\nThis version of the Bid Manager API has been sunset. Users must use [Bid Manager API v2](/bid-manager/reference/rest). \nThe Bid Manager API allows developers to manage [Queries](/bid-manager/v1/queries), retrieve [Reports](/bid-manager/v1/reports) and [Structured Data Files](/bid-manager/v1/sdf), and download and upload [Line Items](/bid-manager/v1/lineitems).\n\nThis API reference is organized by resource type. Each resource type has one or more data representations and one or more methods.\n\nResource types\n--------------\n\n1. [Lineitems](#Lineitems)\n2. [Queries](#Queries)\n3. [Reports](#Reports)\n4. [Sdf](#Sdf)\n\nLineitems\n---------\n\nFor Lineitems Resource details, see the [resource representation](/bid-manager/v1/lineitems#resource) page.\n\n| Method | HTTP request | Description |\n|------------------------------------------------------------------|-------------------------------------|---------------------------------------------------------------------------------------|\n| URIs relative to https://www.googleapis.com/doubleclickbidmanager/v1, unless otherwise noted |||\n| [downloadlineitems](/bid-manager/v1/lineitems/downloadlineitems) | `POST /lineitems/downloadlineitems` | Retrieves line items in CSV format. YouTube \\& partners line items are not supported. |\n| [uploadlineitems](/bid-manager/v1/lineitems/uploadlineitems) | `POST /lineitems/uploadlineitems` | Uploads line items in CSV format. YouTube \\& partners line items are not supported. |\n\nQueries\n-------\n\nFor Queries Resource details, see the [resource representation](/bid-manager/v1/queries#resource) page.\n\n| Method | HTTP request | Description |\n|----------------------------------------------------|--------------------------------------------------------------------|------------------------------------------------------------------|\n| URIs relative to https://www.googleapis.com/doubleclickbidmanager/v1, unless otherwise noted |||\n| [createquery](/bid-manager/v1/queries/createquery) | `POST /query` | Creates a query. |\n| [deletequery](/bid-manager/v1/queries/deletequery) | `DELETE /query/`\u003cvar class=\"apiparam\" translate=\"no\"\u003equeryId\u003c/var\u003e | Deletes a stored query as well as the associated stored reports. |\n| [getquery](/bid-manager/v1/queries/getquery) | `GET /query/`\u003cvar class=\"apiparam\" translate=\"no\"\u003equeryId\u003c/var\u003e | Retrieves a stored query. |\n| [listqueries](/bid-manager/v1/queries/listqueries) | `GET /queries` | Retrieves stored queries. |\n| [runquery](/bid-manager/v1/queries/runquery) | `POST /query/`\u003cvar class=\"apiparam\" translate=\"no\"\u003equeryId\u003c/var\u003e | Runs a stored query to generate a report. |\n\nReports\n-------\n\nFor Reports Resource details, see the [resource representation](/bid-manager/v1/reports#resource) page.\n\n| Method | HTTP request | Description |\n|----------------------------------------------------|-----------------------------------------------------------------------------|---------------------------|\n| URIs relative to https://www.googleapis.com/doubleclickbidmanager/v1, unless otherwise noted |||\n| [listreports](/bid-manager/v1/reports/listreports) | `GET /queries/`\u003cvar class=\"apiparam\" translate=\"no\"\u003equeryId\u003c/var\u003e`/reports` | Retrieves stored reports. |\n\nSdf\n---\n\nFor Sdf Resource details, see the [resource representation](/bid-manager/v1/sdf#resource) page.\n\n| Method | HTTP request | Description |\n|------------------------------------------|----------------------|-----------------------------------|\n| URIs relative to https://www.googleapis.com/doubleclickbidmanager/v1, unless otherwise noted |||\n| [download](/bid-manager/v1/sdf/download) | `POST /sdf/download` | Retrieves entities in SDF format. |"]]
