Interface ReportDocument

Information required for the report document.

Export

ReportDocument

interface ReportDocument {
    compressionAlgorithm?: "GZIP";
    reportDocumentId: string;
    url: string;
}

Properties

compressionAlgorithm? reportDocumentId url

Properties

OptionalcompressionAlgorithm

compressionAlgorithm?: "GZIP"

If the report document contents have been compressed, the compression algorithm used is returned in this property and you must decompress the report when you download. Otherwise, you can download the report directly. Refer to Step 2. Download the report in the use case guide, where sample code is provided.

Memberof

ReportDocument

reportDocumentId

reportDocumentId: string

The identifier for the report document. This identifier is unique only in combination with a seller ID.

Memberof

ReportDocument

url

url: string

A presigned URL for the report document. If compressionAlgorithm is not returned, you can download the report directly from this URL. This URL expires after 5 minutes.

Memberof

ReportDocument

Settings

Member Visibility

On This Page

Properties