Skip to main content

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.

KeyTypeDescriptionExample
tileIndexinteger0 based position of the tile in the grid2
displayIndexinteger1 based position of the tile in the grid5
isBigTilebooleanIs the current tile a big showcase tiletrue
isTopTilebooleanis the tile in the top rowfalse
isLeftTilebooleanis the tile the first of a row (left position)true

Product

This is the definition of the product object.

KeyTypeDescriptionExample
idintegerID of the UGC item7992013
translationsobjectAvailable translation units for the UGC item{}
activate_unitsarrayList of activation unit objects[]
submissionobjectSubmission details if the image is UGC from a campaign{}
hashtagobjectInjested Hashtag DetailsSee below
hashtag.social_platformstringThe platform the hashtag was ingested frominstagram
hashtag.hashtag_textstringThe hashtag content (without the # sign)nofilter
featuredbooleanIndicates if this specific UGC item is a featured itemfalse
approval_statusstringThe approval status of the UGC item. Should be app if the content has been approvedapp
shortened_permalinkstringPermalink if it has been generatedhttps://perma.link/123
last_modifiedstringISO 8601 Timestamp of last modification2020-11-23T21:51:54+00:00
created_onstringISO 8601 Timestamp of creation2020-11-23T21:51:54+00:00
tagsobjectUGC Tags DetailsSee below
tags.hashtagsarrayList of all the tags associated['nofilter', 'foodporn']
contentobjectAdditional content detailsSee below
content.content_typestringimage or video or textimage
content.mediaobjectAdditional media infosSee below
content.media.idintegerInternal ID of the media1234
content.media.platform_data.urlstringLink to the original post/mediahttps://www.instagram.com/p/CX328Pth82W/
content.media.original_urlstringURL of the original image on Wyng servers,https://cdn.wyng.com/i123/image.jpg
content.media.base_urlstringURL of the folder containing the images,https://cdn.wyng.com/i123
content.media.media_typestringimage or video or textimage
content.media.social_platformstringThe platform the image was ingested from (instagram, twitter…)instagram
content.media.media_urlsobjectObject containing links to the available image sizesSee below
content.media.media_urls.large_imagestringDirect URL to the image in the largest formathttps://cdn.wyng.com/i123/image_1.jpg
content.media.media_urls.medium_imagestringhttps://cdn.wyng.com/i123/image_2.jpg
content.media.media_urls.small_imagestringhttps://cdn.wyng.com/i123/image_3.jpg
content.social_platformstringThe platform the image was ingested from (instagram, twitter…)instagram
content.authorobjectAuthor infosSee below
content.author.idintegerWyng internal ID for this author12312321321
content.author.profileobjectAuthor Profile infosSee below
content.author.profile.usernamestringPlatform Usernamebeeple_crap
content.author.profile.namestringDisplay name, might be empty on some platformsbeeple
content.author.profile.profile_linkstringDisplay name, might be empty on some platformshttps://www.instagram.com/beeple_crap/
content.author.profile.avatarstringLink to the profile avatarhttps://images.url/avatar.jpg
content.author.platform_idstringThe ID or username of the author on the platform the content comes from12342141223
content.author.social_platformstringThe platform the image was ingested from (instagram, twitter…)instagram
content.permission_modifiedstringISO 8601 Timestamp of when the UGC permission was last modified2020-11-23T21:51:54+00:00

Conversion unit

This is the definition of the single conversion-unit object.

KeyTypeDescriptionExample
idintegerID of the conversion unit item123
click_through_urlstringClick-trough URLhttps://wyng.com
descriptionstringUnit descriptionMarketing platform
descriptionstringUnit descriptionMarketing platform
external_idstringID of the conversion unit item in external systemabcdefg12345
namestringUnit nameWyng
image_urlstringUnit image URLhttps://link.to/image.png