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

Endpoints Using the Report Object

Report 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.

Name

Description

Type

Required

Notes

type

Type of report to generate.

String

Required

AnalyticsReport

reportName

Name of report.

String

Required

When the report is ready, the name of the report appears as the subject of the email notification.

reportScope

Determines the attribution model and cookie window details, in addition to currency and time range information.

reportScope Object

Required

reportStructure

Determines the dimensions and metrics that will be included in the report.

reportStructure Object

Required

reportExecution

Determines the type (ad-hoc/scheduled) and time that the report will run.

reportExecution Object

Required

reportDeliveryMethods

Determines how the report will be delivered.

reportDeliveryMethods Object

Required

Note

Note: If the delivery method is Email, the email recipients will receive an email message after the report runs successfully. The email message will include either an attachment (for reports that are smaller than 5 MB) or a link (for reports that are larger than 5 MB).

reportAuthorization

Authorization parameters.

reportAuthorization Object

Required

Object JSON Example

Child Objects

reportScope Object

reportScope 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

entitiesHierarchy

Entities included in the report.

entitiesHierarchy Object

Required

attributionModelID

Conversion metric settings

Integer

Required

Note

Notes:

  • Set to 0 if not using conversion metrics. These values are omitted if you are not using any conversion metric in your report.

  • -1 (Primary) must be set when choosing an account level, multiple advertisers, or campaigns from multiple advertisers (any level that might include more than one advertiser).

impressionCookieWindow

Window of time (in days) that includes the user actions (impressions or clicks) relevant to the path to conversion.

Integer

Required

Possible values: 0-90

Set to 0 if not using conversion metrics. These values are omitted if you are not using any conversion metric in your report.

clickCookieWindow

Integer

Required

filters

Name of filter for the report.

String

Optional

Note

Note: The Video Asset filter and Custom Interactions filter are available when you select the Video/Audio Asset dimension or Custom Interaction dimension respectively.

timeRange

Includes the mode of time range, time zone, and start/end timestamps.

timeRange Object

Required

currencyOptions

Currency settings for the report.

currencyOptions Object

Required

presetId

Corresponds to the AAS Templates.

Integer

Optional

Set to null if not using this parameter.

Object JSON Example

Parent Objects

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

Comments