Coming soon: Changes to environment and position targeting in Structured Data Files. Learn more.

Lineitems: uploadlineitems

Requires authorization

Uploads line items in CSV format. TrueView line items are not supported. Try it now.


HTTP request



This request requires authorization with the following scope (read more about authentication and authorization).


Request body

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

  "lineItems": string,
  "format": string,
  "dryRun": boolean
Property name Value Description Notes
lineItems string Line items in CSV to upload. For more information about file formats, see Entity Write File Format.
format string Format the line items are in. Default to CSV.

Acceptable values are:
  • "CSV"
dryRun boolean Set to true to get upload status without actually persisting the line items.


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

  "uploadStatus": {
    "errors": [
    "rowStatus": [
        "rowNumber": integer,
        "entityId": long,
        "entityName": string,
        "changed": boolean,
        "persisted": boolean,
        "errors": [
Property name Value Description Notes
uploadStatus nested object Status of upload.
uploadStatus.errors[] list Reasons why upload can't be completed.
uploadStatus.rowStatus[] list Per-row upload status.
uploadStatus.rowStatus[].rowNumber integer Row number.
uploadStatus.rowStatus[].entityId long Entity Id.
uploadStatus.rowStatus[].entityName string Entity name.
uploadStatus.rowStatus[].changed boolean Whether the stored entity is changed as a result of upload.
uploadStatus.rowStatus[].persisted boolean Whether the entity is persisted.
uploadStatus.rowStatus[].errors[] list Reasons why the entity can't be uploaded.

Try it!

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