| ad_set_ids |
string[] |
Optional list of ad set IDs to filter on. The ad sets must already exist. If empty, all ad sets will be included. |
[optional] |
| ad_set_status |
string[] |
Optional list of ad set statuses to filter on. If empty, all ad sets will be included. |
[optional] |
| advertiser_id |
string |
The advertiser ID to report on. The advertiser must already exist. At least one advertiser ID should be provided |
|
| brands |
string[] |
Optional list of brand names to filter on. If empty, all brands will be included. |
[optional] |
| campaign_ids |
string[] |
Optional list of campaign IDs to filter on. The campaigns must already exist. If empty, all campaigns will be included. |
[optional] |
| category_ids |
string[] |
Optional list of product catalog category IDs to filter on. If empty, all categories will be included. |
[optional] |
| currency |
string |
The currency used for the report. ISO 4217 code (three-letter capitals). |
[default to 'EUR'] |
| dimensions |
string[] |
Optional list of dimensions for the report. If not provided, defaults to [ProductId, Product, ProductUrl]. When an ID dimension is requested (e.g., CampaignId), the corresponding name dimension (e.g., Campaign) is automatically included, and vice versa. This applies to the following pairs: CampaignId/Campaign, AdSetId/AdSet, ProductId/Product, CategoryId/Category, AdvertiserId/Advertiser. |
[optional] |
| end_date |
\DateTime |
End date of the report. Date component of ISO 8601 format, any time or timezone component is ignored. |
|
| limit |
int |
Optional maximum number of top products returned. Must be between 1 and 200. |
[optional] [default to 200] |
| metrics |
string[] |
Optional list of metrics to report. If not provided, defaults to the metric specified in rankProductsBy. |
[optional] |
| rank_products_by |
string |
Optional metric used to rank the top products. Allowed values: 'Clicks', 'Displays', 'Sales'. |
|
| start_date |
\DateTime |
Start date of the report. Date component of ISO 8601 format, any time or timezone component is ignored. Must be ≤ endDate. |
|
| timezone |
string |
Optional timezone used for the report. Timezone Database format (Tz). |
[optional] [default to 'UTC'] |