reportDeliveryMethods Object – API Help Center

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	View type values Email FTP URL SFTP
exportFileNamePrefix	Adds a prefix to the report file name.	String	Required
exportFileType	File type for the generated report.	String	Required	View exportFileType values CSV Excel JSON
compressionType	Type of compress report file.	String	Optional	View compressionType values None Gzip Zip
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

...
"reportDeliveryMethods": [
        {
          "type": "URL",
          "exportFileType": "JSON",
          "compressionType": "NONE",
          "emailRecipients": [
            "Jane.Smith@sizmek.com",
          "exportFileNamePrefix": "test"
          ]
        }
      ],
      
...

Note

Notes:

When choosing SFTP, the following fields are required:

host
username
password
ftpDirectory

Example:

"reportDeliveryMethods": [
     { "type": "SFTP", 
       "exportFileType": "Excel", 
       "compressionType": "NONE", 
       "emailRecipients": [ 
          "Jane.Smith@sizmek.com" ],
       "exportFileNamePrefix": "test", 
       "host": "ftp.fakesite.org", 
       "username": "TestUser", 
       "password": "TestPassword", 
       "ftpDirectory": "TestDirectory" 
     } 
],

When choosing URL, the emailRecipients field is used only to send error messages to those email addresses (and only if there are errors).

Parent Objects

Report Object

reportDeliveryMethods Object Definition

Note

Object JSON Example

Note

Note

Parent Objects

Comments