Title
Page icon
Create new category
Edit page index title
Edit category
Edit link
Activation
The various methods for Activation are listed below:
Activate retail campaign
Triggers activation of a retail campaign — generates trackers and/or creative assets and pushes the campaign live. Requires MediaPlan_Tags_Create permission.
Path Parameters
Name | Data Type | Requirement | Parameter Type | Description |
|---|---|---|---|---|
accountId | string | Mandatory | path | ID of the account. |
retailCampaignIdx | integer | Mandatory | path | Index of the retail campaign. |
Sample Request
Parameters
Field | Data Type | Requirement | Description |
|---|---|---|---|
trackerTypes | array of string | Optional | List of tracker types to generate. Values: |
assetGenerationType | enum (string) | Optional | Asset format to generate. Values: |
Request Body
Response
Field | Data Type | Description |
|---|---|---|
message | string | Result message from the activation flow. |
retailCampaignIdx | integer | Index of the activated retail campaign. |
Request Body
Get activation status
Returns the current activation status and progress percentage for a retail campaign. Requires MediaPlan_Tags_Create permission.
Path Parameters
Name | Data Type | Requirement | Parameter Type | Description |
|---|---|---|---|---|
accountId | string | Mandatory | path | ID of the account. |
retailCampaignIdx | integer | Mandatory | path | Index of the retail campaign. |
Sample Request
Response
Field | Data Type | Description |
|---|---|---|
percentage | integer | Activation progress as a percentage (0–100). |
message | string | Human-readable status message. |
status | enum (string) | Current activation status. Values: |
Request Body