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

reportDeliveryMethods 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

type

Delivery option of the generated report.

String

Required

exportFileNamePrefix

Adds a prefix to the report file name.

String

Required

exportFileType

File type for the generated report.

String

Required

compressionType

Type of compress report file.

String

Optional

emailRecipients

List of email recipients or subscribers for the report.

Array of string

Required

Multiple email addresses must be separated by commas.

host

For SFTP type only. IP or domain name of the SFTP server.

String

Required

IP or domain name.

Required for SFTP type.

username

For SFTP type only. Username for SFTP.

String

Required

Required for SFTP type.

password

For SFTP type only. Password for SFTP.

String

Required

Required for SFTP type.

ftpDirectory

For SFTP type only. Defines the storage location for the files in the SFTP site.

String

Required

Use double slash (//) to identify the path. For example, //MyReports.

Object JSON Example

Parent Objects

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

Comments