Lineitems: downloadlineitems

  • The Bid Manager API's Line Items Settings service is sunset, requiring migration to the DV360 API.

  • This service retrieves line items in CSV format, but does not support YouTube & partners line items.

  • The request requires authorization with the https://www.googleapis.com/auth/doubleclickbidmanager scope.

  • The request body allows filtering line items by filterType and filterIds, and specifying the output format and fileSpec.

  • The response returns the retrieved line items as a string in CSV format within the lineItems property.

Retrieves line items in CSV format. YouTube & partners line items are not supported. Try it now.

Request

HTTP request

POST https://www.googleapis.com/doubleclickbidmanager/v1.1/lineitems/downloadlineitems

Authorization

This request requires authorization with the following scope:

Scope
https://www.googleapis.com/auth/doubleclickbidmanager

For more information, see the authentication and authorization page.

Request body

In the request body, supply data with the following structure:

{
  "filterType": string,
  "filterIds": [
    long
  ],
  "format": string,
  "fileSpec": string
}
Property name Value Description Notes
filterType string Filter type used to filter line items to fetch.

Acceptable values are:
  • "ADVERTISER_ID"
  • "INSERTION_ORDER_ID"
  • "LINE_ITEM_ID"
filterIds[] list IDs of the specified filter type used to filter line items to fetch. If omitted, all the line items will be returned.
format string Format in which the line items will be returned. Default to CSV.

Acceptable values are:
  • "CSV"
fileSpec string File specification (column names, types, order) in which the line items will be returned. Default to EWF.

Acceptable values are:
  • "EWF"

Response

If successful, this method returns a response body with the following structure:

{
  "lineItems": string
}
Property name Value Description Notes
lineItems string Retrieved line items in CSV format. For more information about file formats, see Entity Write File Format.

Try it!

Use the APIs Explorer below to call this method on live data and see the response. Alternatively, try the standalone Explorer.