Read creative templates.
The user must be authenticated and have read permissions to the 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 creative templates for a site group. |
* Either id or siteGroupId must be provided, and these fields can not be combined.
Response
The response object has the following fields:
|
Name |
Type |
Description |
|---|---|---|
|
|
Array of Creative Template objects |
The requested templates. |
A Creative Template object has the following fields:
|
Name |
Type |
Description |
|---|---|---|
|
|
String |
Identifier for the creative template. |
|
|
String |
The site group identifier the creative template belongs to. |
|
|
String |
The template name. |
|
|
Array of Element objects |
The creative template elements. |
Each Element has the following fields:
|
Name |
Type |
Description |
|---|---|---|
|
|
String |
The type of element, either |
|
|
String |
The descriptive name of the element. |
|
|
Boolean |
Whether this element is required or optional for the template. |
When type is image, the element additionally has the following fields:
|
Name |
Type |
Description |
|---|---|---|
|
|
Number |
Integer width of the image. |
|
|
Number |
Integer height of the image. |