PRODUCT

Amazon Ad Server will be sunset in Q4 2024, please visit this page (AAS offboarding information) for offboarding support resources and sunset FAQs. Details shared on that page represent the most up to date information in the Help Center, if you find disparate information in other resources please default to the information in the AAS offboarding information page accordingly.

Follow

reportStructure Object Definition

Note

Note: The Required column includes the following values:

  • Required: The field must be included in the POST call.

  • Read-only: The field is received in the GET call and required in the PUT call. It is not required in the POST call. You cannot edit this field.

  • Optional: If the field was received in the GET call, include it in the PUT call. This field is editable.

  • Internal: (For Amazon Ad Server (AAS) internal use) If the field was received in the GET call, include it in the PUT call.

Parameter

Description

Type

Required

Notes

attributeIDs

Attribute names. (Click here for a full list.)

Note

Note: This page is only accessible if you have access to AAS. If you do not have the proper permissions, please reach out to your team or Customer Success Manager.

Array of strings

Required

[

["Placeholder"] "Advertiser Name"

"Advertiser ID"

]

Placeholder columns are empty columns in the report. Can be added anywhere in the attribute or metric collection.

Must have at least one attribute.

attributeIdsOnColumns

Determines which dimensions are pivoted in the report.

Array of strings

Optional

Note

Note: Leave this field empty if you do not want a pivoted dimension in the report.

metricIDs

Metric names. (Click here for a full list.)

Note

Note: This page is only accessible if you have access to AAS. If you do not have the proper permissions, please reach out to your team or Customer Success Manager.

Array of strings

Required

[

["Placeholder"] "Served Impressions"

"Total Clicks"

]

Placeholder columns are empty columns in the report. Can be added anywhere in the attribute or metric collection.

Must have at least one metric.

When selecting an impression metric, use "Served Impressions" for the metricIDs

timeBreakdown

Date resolution of the data.

String

Required

Object JSON Example

Parent Objects

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments