ReportTask

campaignIds

array of string

A list of IDs for the campaigns that are included in the report. A campaign ID is a unique eBay-assigned identifier of the campaign that's generated when the campaign is created.

Call getCampaigns to return the current campaign IDs for a seller.

channels

array of ChannelEnum

The channel for the advertising campaign that will be included in the report task. This value indicates whether the data included in the report task is for an Onsite or Offsite advertising campaign.

dateFrom

The date defining the start of the timespan covered by the report, formatted as an ISO 8601 timestamp.

dateTo

The date defining the end of the timespan covered by the report, formatted as an ISO 8601 timestamp.

dimensions

array of Dimension

A list containing the dimension in the report.

fundingModels

array of FundingModelEnum

The funding model for the campaign that shall be included in the report.

Note: The default funding model for Promoted Listings reports is COST_PER_SALE.

Valid Values:

• COST_PER_SALE
• COST_PER_CLICK

inventoryReferences

array of InventoryReference

If supplied in the request, this field returns a list of the seller's inventory reference IDs included in the report.

Each item is referenced by a pair of inventoryRefernceID and inventoryReferenceType values, where an inventory reference ID can be either a seller-defined SKU value or an inventoryItemGroupKey. An inventoryItemGroupKey is seller-defined ID for an inventory item group (a multiple-variation listing), and is created and used by the Inventory API.

listingIds

array of string

If supplied in the request, this field returns a list of the listing IDs included in the report. A listing ID is an eBay-assigned ID that's generated when a listing is created.

marketplaceId

The ID of the eBay marketplace used by the report task.

metricKeys

array of string

A list of metrics for the report task.

reportExpirationDate

The date after which the report is no longer be available. Reports are available for 30 days and you cannot download a report after it has expired.

Format (UTC): yyyy-MM-ddThh:mm:ss.sssZ

reportFormat

Indicates the format of the report. Currently, only TSV_GZIP is supported.

reportHref

The URL of the generated report, which can be used to download the report once it has been generated.

reportId

A unique eBay-assigned ID for the report.

reportName

An eBay-assigned name for the report that's created by the createReportTask call. This name is unique for the seller.

reportTaskCompletionDate

The date the report task completed the report generation.

Format (UTC): yyyy-MM-ddThh:mm:ss.sssZ

reportTaskCreationDate

The date the report task was created.

Format (UTC): yyyy-MM-ddThh:mm:ss.sssZ

reportTaskExpectedCompletionDate

The date the report task is expected to complete the report generation.

Format (UTC): yyyy-MM-ddThh:mm:ss.sssZ

reportTaskId

The unique eBay-assigned ID of the report task. This value is generated when the report task is created with a call to createReportTask.

reportTaskStatus

Indicates the current state of the report task.

reportTaskStatusMessage

A status message with additional information about the report task.

reportType

Indicates type of report associated with the report task.

Note: INVENTORY_PERFORMANCE_REPORT is not currently available; availability date is pending.