Complex parameters definition
Render/Text-builder function can contain complex object parameters. Here you can find the structure definition of such objects.
Tile
This is the definition of the tile
object.
Key | Type | Description | Example |
---|---|---|---|
tileIndex | integer | 0 based position of the tile in the grid | 2 |
displayIndex | integer | 1 based position of the tile in the grid | 5 |
isBigTile | boolean | Is the current tile a big showcase tile | true |
isTopTile | boolean | is the tile in the top row | false |
isLeftTile | boolean | is the tile the first of a row (left position) | true |
Product
This is the definition of the product
object.
Key | Type | Description | Example |
---|---|---|---|
id | integer | ID of the UGC item | 7992013 |
translations | object | Available translation units for the UGC item | {} |
activate_units | array | List of activation unit objects | [] |
submission | object | Submission details if the image is UGC from a campaign | {} |
hashtag | object | Injested Hashtag Details | See below |
hashtag.social_platform | string | The platform the hashtag was ingested from | instagram |
hashtag.hashtag_text | string | The hashtag content (without the # sign) | nofilter |
featured | boolean | Indicates if this specific UGC item is a featured item | false |
approval_status | string | The approval status of the UGC item. Should be app if the content has been approved | app |
shortened_permalink | string | Permalink if it has been generated | https://perma.link/123 |
last_modified | string | ISO 8601 Timestamp of last modification | 2020-11-23T21:51:54+00:00 |
created_on | string | ISO 8601 Timestamp of creation | 2020-11-23T21:51:54+00:00 |
tags | object | UGC Tags Details | See below |
tags.hashtags | array | List of all the tags associated | ['nofilter', 'foodporn'] |
content | object | Additional content details | See below |
content.content_type | string | image or video or text | image |
content.media | object | Additional media infos | See below |
content.media.id | integer | Internal ID of the media | 1234 |
content.media.platform_data.url | string | Link to the original post/media | https://www.instagram.com/p/CX328Pth82W/ |
content.media.original_url | string | URL of the original image on Wyng servers, | https://cdn.wyng.com/i123/image.jpg |
content.media.base_url | string | URL of the folder containing the images, | https://cdn.wyng.com/i123 |
content.media.media_type | string | image or video or text | image |
content.media.social_platform | string | The platform the image was ingested from (instagram, twitter…) | instagram |
content.media.media_urls | object | Object containing links to the available image sizes | See below |
content.media.media_urls.large_image | string | Direct URL to the image in the largest format | https://cdn.wyng.com/i123/image_1.jpg |
content.media.media_urls.medium_image | string | https://cdn.wyng.com/i123/image_2.jpg | |
content.media.media_urls.small_image | string | https://cdn.wyng.com/i123/image_3.jpg | |
content.social_platform | string | The platform the image was ingested from (instagram, twitter…) | instagram |
content.author | object | Author infos | See below |
content.author.id | integer | Wyng internal ID for this author | 12312321321 |
content.author.profile | object | Author Profile infos | See below |
content.author.profile.username | string | Platform Username | beeple_crap |
content.author.profile.name | string | Display name, might be empty on some platforms | beeple |
content.author.profile.profile_link | string | Display name, might be empty on some platforms | https://www.instagram.com/beeple_crap/ |
content.author.profile.avatar | string | Link to the profile avatar | https://images.url/avatar.jpg |
content.author.platform_id | string | The ID or username of the author on the platform the content comes from | 12342141223 |
content.author.social_platform | string | The platform the image was ingested from (instagram, twitter…) | instagram |
content.permission_modified | string | ISO 8601 Timestamp of when the UGC permission was last modified | 2020-11-23T21:51:54+00:00 |
Conversion unit
This is the definition of the single conversion-unit
object.
Key | Type | Description | Example |
---|---|---|---|
id | integer | ID of the conversion unit item | 123 |
click_through_url | string | Click-trough URL | https://wyng.com |
description | string | Unit description | Marketing platform |
description | string | Unit description | Marketing platform |
external_id | string | ID of the conversion unit item in external system | abcdefg12345 |
name | string | Unit name | Wyng |
image_url | string | Unit image URL | https://link.to/image.png |