Create Entity Snapshot
Description:
You can create file-based snapshot for all the campaign entities for an advertiser using this method.
URL: POST/api/v1/snapshot/entity
Query Parameters
| Parameter | Description | Type | Required | Possible Values |
|---|---|---|---|---|
| advertiserId | The ID of the advertiser | integer | Y | Unique numeric identifier |
| entityStatus | The status of the entity Note: The default status is “enabled”. Disabled entities won’t be part of the snapshot unless you request “disabled” and/or “all” | string | Y | Possible values: enabled, disabled, all |
| entityTypes | The type of entity for which the snapshot should be generated. | string array | Y | Possible values: 1. campaign 2. adGroup 3. keyword 4. adItem 5. bidMultiplier 6. placement: If you select this value, the entity snapshot will return which placements have been included or excluded for a given keyword campaign. The placements are: For a keyword campaign: Search In-grid, Carousel, Buybox, Others For an Auto campaign: Search In-grid, Carousel, Buybox, Browse In-Grid, Stock Up, Home Page, Others sbaProfile: only for Sponsored Brands (earlier known as Search Brand Amplifier or SBA) adGroupMedia: only for Sponsored Video campaigns category: only for Sponsored Brand campaigns |
| format | Choose the format type for your snapshot | string | N | Types of Format: gzip, zip Note: gzip allows decompression while file is being transferred over the network, hence it is a faster and simpler way to download the reports. You will receive snapshot in zip format if no specific format is selected |
Note: There is no limit on number of snapshot requests for an advertiser.
Updated 4 months ago