Read creatives.
The user must be authenticated and have read permissions to the template site group.
Request
The request object has the following fields:
|
Name |
Type |
Required |
Description |
|---|---|---|---|
|
|
String |
No* |
Identifier for reading a single creative collection. |
|
|
String |
No* |
Site group identifier for reading all creatives for a site group. |
|
|
String |
No* |
Creative template id for reading all creatives for a template. |
* Either id, siteGroupId or templateId must be provided, and these fields can not be combined.
Response
The response object has the following fields:
|
Name |
Type |
Description |
|---|---|---|
|
|
Array of Creative objects |
The requested creatives. |
A Creative object has the following fields:
|
Name |
Type |
Description |
|---|---|---|
|
|
String |
Identifier for the creative. |
|
|
String |
The template identifier the creative adheres to. |
|
|
String |
The creative name. |
|
|
Array of Element objects |
The creative elements. |
| offerProductId | String | No | The identifier of the product this creative is affiliated with.
Each Element has the following fields:
|
Name |
Type |
Description |
|---|---|---|
|
|
String |
The type of element, either |
|
|
String |
The name of the element. |
When type is image, the element additionally has the following fields:
|
Name |
Type |
Description |
|---|---|---|
|
|
String |
Unique image identifier. |
|
|
String |
The URL of image that will be delivered to the end user. |
|
|
String |
The filename of the image file that was uploaded. |
|
|
Number |
The pixel width of the image |
|
|
Number |
The pixel height of the image |
When type is text, the element additionally has the following fields
|
Name |
Type |
Description |
|---|---|---|
|
|
String |
The text that will be delivered to the end user. |
When type is url, the element additionally has the following fields
|
Name |
Type |
Description |
|---|---|---|
|
|
String |
The URL that will be delivered to the end user. |