{"_id":"56e7eaa8f0fafd36008faf59","githubsync":"","__v":54,"category":{"_id":"56e5362775eb791700a9c4d2","__v":6,"project":"56cecbdb44c5700b0095c03a","pages":["56e590ae69d7890e000ec286","56e590fa3c29b117008dae50","56e6f058d66be417007d2364","56e7eaa8f0fafd36008faf59","56ea8db9ed3ad20e004e5a02","56ea8f3e0252fb17008804ac"],"version":"56cecbdc44c5700b0095c03d","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-03-13T09:43:03.596Z","from_sync":false,"order":7,"slug":"remote-api","title":"Server API"},"project":"56cecbdb44c5700b0095c03a","user":"56cecbb2e50c9c1b008303eb","version":{"_id":"56cecbdc44c5700b0095c03d","project":"56cecbdb44c5700b0095c03a","__v":10,"createdAt":"2016-02-25T09:39:40.121Z","releaseDate":"2016-02-25T09:39:40.121Z","categories":["56cecbdc44c5700b0095c03e","56d1d2c05ad7ad0b00b7e809","56d1d2fa5ad7ad0b00b7e80a","56d369331660770b00081159","56d3693d1660770b0008115a","56e5361e7990160e002e3fbc","56e5362775eb791700a9c4d2","57a9030947f2f419009188d4","57b4705ee9e4c60e00f6f4c3","5828f5b04774ab0f005179a2"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-03-15T10:57:44.707Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":13,"body":"This section contains documentation for all the objects that are required to use the api endpoints. \n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Examples can be found in each endpoint page.\"\n}\n[/block]\n#Template\n[block:parameters]\n{\n  \"data\": {\n    \"0-1\": \"string\",\n    \"0-0\": \"**name**\",\n    \"h-0\": \"Field\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"0-2\": \"yes\",\n    \"h-3\": \"Default\",\n    \"0-3\": \"\",\n    \"3-0\": \"**strings**\",\n    \"2-0\": \"**settings**\",\n    \"2-1\": \"[TemplateSettings](doc:objects#section-templatesettings)\",\n    \"2-2\": \"yes\",\n    \"2-3\": \"all inner fields will be assigned with their default values as seen [here](doc:objects#section-templatesettings)\",\n    \"4-0\": \"**is_default**\",\n    \"4-1\": \"boolean\",\n    \"4-2\": \"No\",\n    \"4-3\": \"false\",\n    \"h-4\": \"Description\",\n    \"0-4\": \"the name of the tepmlate\",\n    \"2-4\": \"settings which control parts of the notification UI\",\n    \"3-4\": \"strings for the constant text of the notification and some of the sharing features. Possible `name` values: \\n* `recommendations_title` - the text above content recommendations\\n* `share_prefix` - the prefix of the text when sharing the notification\\n* `share_subject` - the subject of the sharing action ( when sharing by email for example)\\n* `ext_prefix` - the prefix of the text for external content, before the publisher's name\",\n    \"4-4\": \"if set to `true`, this will be the default campaign\",\n    \"3-1\": \"array of [PA_String](doc:objects#section-pa_string)\",\n    \"5-0\": \"**features**\",\n    \"5-1\": \"array of [Feature](doc:objects#section-feature)\",\n    \"5-2\": \"Yes\",\n    \"5-4\": \"the enrichment features for this campaign. set the following number of features according to their types:\\n* `internal_content` - 1\\n* `external_content` - 1\\n* `action_buttons` - 3\\n* `custom_feed` - 1\",\n    \"1-0\": \"**layout_id**\",\n    \"1-1\": \"string\",\n    \"1-2\": \"yes\",\n    \"1-4\": \"layout of the notification. possible values:\\n* `content_with_two`\\n* `content_with_three`\\n* `content_wide_image_with_two`\\n*  `content_wide_image_with_three`\"\n  },\n  \"cols\": 5,\n  \"rows\": 6\n}\n[/block]\n#TemplateSettings\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Required\",\n    \"0-0\": \"**big_share_button**\",\n    \"h-2\": \"Type\",\n    \"h-3\": \"Default\",\n    \"h-4\": \"Description\",\n    \"1-0\": \"**small_view**\",\n    \"2-0\": \"**build_without_image**\",\n    \"3-0\": \"**small_share_button**\",\n    \"4-0\": \"**drag_to_expand**\",\n    \"0-1\": \"no\",\n    \"1-1\": \"no\",\n    \"2-1\": \"no\",\n    \"3-1\": \"no\",\n    \"4-1\": \"no\",\n    \"0-2\": \"boolean\",\n    \"1-2\": \"boolean\",\n    \"2-2\": \"boolean\",\n    \"3-2\": \"boolean\",\n    \"4-2\": \"boolean\",\n    \"0-3\": \"true\",\n    \"1-3\": \"true\",\n    \"2-3\": \"true\",\n    \"3-3\": \"true\",\n    \"4-3\": \"false\",\n    \"0-4\": \"display share button when the notification is visible in its big view\",\n    \"1-4\": \"show our UI when the notification is visible in its small view\",\n    \"2-4\": \"show enrichment even if there is no image to the main notification\",\n    \"3-4\": \"display share button when the notification is visible in its small view\",\n    \"4-4\": \"show \\\"drag to expand\\\" text with an arrow in the small view, instead of the share button\"\n  },\n  \"cols\": 5,\n  \"rows\": 5\n}\n[/block]\n#PA_String\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"h-3\": \"Default\",\n    \"0-0\": \"**name**\",\n    \"0-1\": \"string\",\n    \"0-2\": \"Yes\",\n    \"h-4\": \"Description\",\n    \"0-4\": \"key for the string\",\n    \"1-0\": \"**translations**\",\n    \"1-1\": \"[Translations](doc:objects#section-translations)\",\n    \"1-2\": \"Yes\",\n    \"1-4\": \"text values for localization. Currently only one value is supported.\"\n  },\n  \"cols\": 5,\n  \"rows\": 2\n}\n[/block]\n#Translations\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"h-3\": \"Default\",\n    \"h-4\": \"Description\",\n    \"0-0\": \"**def**\",\n    \"0-1\": \"string\",\n    \"0-2\": \"Yes\",\n    \"0-3\": \"default text\"\n  },\n  \"cols\": 5,\n  \"rows\": 1\n}\n[/block]\n#Feature\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"h-3\": \"Default\",\n    \"h-4\": \"Description\",\n    \"0-0\": \"**type**\",\n    \"0-1\": \"string\",\n    \"0-2\": \"yes\",\n    \"0-3\": \"\",\n    \"0-4\": \"the type of the feature. possible values:\\n* `content_feed`\\n* `external_content`\\n* `action_button`\\n* `custom_feed`\",\n    \"1-0\": \"**position**\",\n    \"1-1\": \"number\",\n    \"1-2\": \"yes\",\n    \"1-4\": \"the position of the feature in the notification layout. begins with 1\",\n    \"2-0\": \"**data**\",\n    \"2-1\": \"JSON object. can be one of the types as listed in [Feature Objects](doc:objects#section-feature-objects)\",\n    \"2-2\": \"yes\"\n  },\n  \"cols\": 5,\n  \"rows\": 3\n}\n[/block]\n#Feature Objects\n\n##ContentFeedObject\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"h-3\": \"Default\",\n    \"h-4\": \"Description\",\n    \"0-0\": \"**feeds**\",\n    \"0-1\": \"array of [Feed](doc:objects#section-feed)\",\n    \"0-2\": \"yes\",\n    \"0-4\": \"feeds from which the content of the enrichment will be takes. needs to have at least 1 element. you can either use an existing feed with providing the `feed_id or create a new one on the fly with providing `url`\",\n    \"1-0\": \"**view_ext_on_browser**\",\n    \"2-0\": \"**recommendations_title**\",\n    \"2-1\": \"boolean\",\n    \"1-1\": \"boolean\",\n    \"1-2\": \"no\",\n    \"1-3\": \"false\",\n    \"2-2\": \"no\",\n    \"2-3\": \"false\",\n    \"1-4\": \"should external content be opened in an external browser\",\n    \"2-4\": \"show or hide the title above the recommendation ( such as *You may also like* )\"\n  },\n  \"cols\": 5,\n  \"rows\": 3\n}\n[/block]\n##ExternalContentObject\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"h-3\": \"Default\",\n    \"h-4\": \"Description\",\n    \"0-0\": \"**type**\",\n    \"1-0\": \"**ob_widget_id**\",\n    \"2-0\": \"**view_ext_on_browser**\",\n    \"3-0\": \"**recommendations_title**\",\n    \"0-1\": \"string\",\n    \"0-2\": \"yes\",\n    \"0-4\": \"origin of the external content. possible values:\\n* `ob_sdk`\",\n    \"1-1\": \"string\",\n    \"1-2\": \"yes - if type is `ob_sdk`\",\n    \"1-4\": \"the widget id from outbrain\",\n    \"2-1\": \"boolean\",\n    \"2-2\": \"no\",\n    \"2-3\": \"false\",\n    \"2-4\": \"should promoted content be opened in an external browser\",\n    \"3-1\": \"boolean\",\n    \"3-2\": \"no\",\n    \"3-3\": \"false\",\n    \"3-4\": \"show or hide the title above the recommendation ( such as *You may also like* )\"\n  },\n  \"cols\": 5,\n  \"rows\": 4\n}\n[/block]\n##CustomFeedObject\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"h-3\": \"Default\",\n    \"h-4\": \"Description\",\n    \"0-0\": \"**articles**\",\n    \"1-0\": \"**recommendations_title**\",\n    \"1-1\": \"boolean\",\n    \"1-2\": \"no\",\n    \"1-3\": \"false\",\n    \"1-4\": \"show or hide the title above the recommendation ( such as *You may also like* )\",\n    \"0-1\": \"array of [Objects](doc:objects#section-article)\",\n    \"0-2\": \"yes\",\n    \"0-4\": \"the articles that will be shown as recommendations. size of the array must fit the selected `layout_id`\"\n  },\n  \"cols\": 5,\n  \"rows\": 2\n}\n[/block]\n##ActionButtonObject\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"h-3\": \"Default\",\n    \"h-4\": \"Description\",\n    \"0-0\": \"**type**\",\n    \"1-0\": \"**title**\",\n    \"2-0\": \"**url**\",\n    \"3-0\": \"**start_date**\",\n    \"4-0\": \"**end_date**\",\n    \"5-0\": \"**description**\",\n    \"6-0\": \"**lat**\",\n    \"7-0\": \"**lng**\",\n    \"8-0\": \"**icon**\",\n    \"9-0\": \"**icon_url**\",\n    \"10-0\": \"**data**\",\n    \"0-1\": \"string\",\n    \"1-1\": \"string\",\n    \"2-1\": \"string\",\n    \"3-1\": \"number\",\n    \"4-1\": \"number\",\n    \"5-1\": \"string\",\n    \"6-1\": \"float\",\n    \"7-1\": \"float\",\n    \"8-1\": \"string\",\n    \"9-1\": \"string\",\n    \"10-1\": \"JSON object\",\n    \"0-2\": \"yes\",\n    \"0-4\": \"button type. possible values:\\n* `fb` - facebook share \\n* `wa` - whatsapp share \\n* `sms` - sms share\\n* `email` - email share\\n* `cal` - add to calendar\\n* `video` - play video from link\\n* `url` - open url ( can be also url scheme )\\n* `nav` - open navigation intent\\n* `custom` - custom action , for deep linking\",\n    \"1-2\": \"required for type  `custom`, optional for other type\",\n    \"1-4\": \"title of the button\",\n    \"2-2\": \"required for `url`, `video`\",\n    \"3-2\": \"required for `cal`\",\n    \"4-2\": \"required for `cal`\",\n    \"5-2\": \"required for `cal`\",\n    \"3-4\": \"starting time of the event, unix timestamp in [ms]\",\n    \"4-4\": \"ending time of the event, unix timestamp in [ms]\",\n    \"5-4\": \"description of the event\",\n    \"6-2\": \"required for `nav`\",\n    \"7-2\": \"required for `nav`\",\n    \"2-4\": \"url to open or play\",\n    \"6-4\": \"latitude of the destination\",\n    \"7-4\": \"longitude of the destination\",\n    \"8-2\": \"required for `custom` ( either this or **icon_url** )\",\n    \"9-2\": \"required for `custom` ( either this or **icon** )\",\n    \"10-2\": \"no\",\n    \"10-4\": \"extra data to be passed in the activity when clicking on the button\",\n    \"8-4\": \"icon filename which will be the resource id, for example : ic_share\"\n  },\n  \"cols\": 5,\n  \"rows\": 11\n}\n[/block]\n###Feed\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"h-3\": \"Default\",\n    \"h-4\": \"Description\",\n    \"0-0\": \"**id**\",\n    \"1-0\": \"**url**\",\n    \"2-0\": \"**name**\",\n    \"0-1\": \"string\",\n    \"1-1\": \"string\",\n    \"2-1\": \"string\",\n    \"0-2\": \"required if you want to use an exiting feed\",\n    \"1-2\": \"required if you want to create a new feed\",\n    \"2-2\": \"required if you use `url`\",\n    \"2-4\": \"the name of the new generated feed\",\n    \"0-4\": \"id of an existing campaign.  you can get the current feeds from [/feeds endpoint](doc:feeds)\",\n    \"1-4\": \"url of the feed ( needs to be an RSS or JSON feed )\"\n  },\n  \"cols\": 5,\n  \"rows\": 3\n}\n[/block]\n###Article\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"h-3\": \"Default\",\n    \"h-4\": \"Description\",\n    \"0-0\": \"**url**\",\n    \"1-0\": \"**title**\",\n    \"2-0\": \"**thumb_url**\",\n    \"3-0\": \"**is_external**\",\n    \"0-1\": \"string\",\n    \"1-1\": \"string\",\n    \"2-1\": \"string\",\n    \"3-1\": \"boolean\",\n    \"0-2\": \"yes\",\n    \"1-2\": \"yes\",\n    \"2-2\": \"yes\",\n    \"3-2\": \"no\",\n    \"3-3\": \"false\",\n    \"0-4\": \"url of the article\",\n    \"1-4\": \"title that will be displayed for the recommendation\",\n    \"2-4\": \"the url of the thumbnail for the article\",\n    \"3-4\": \"determined if this is an external content\"\n  },\n  \"cols\": 5,\n  \"rows\": 4\n}\n[/block]\n#AndroidSettings\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"h-3\": \"Default\",\n    \"h-4\": \"Description\",\n    \"0-0\": \"title\",\n    \"0-1\": \"string\",\n    \"0-2\": \"no\",\n    \"0-3\": \"if not set, the app name will be used\",\n    \"0-4\": \"the title of the notification\",\n    \"1-0\": \"sound\",\n    \"1-1\": \"string\",\n    \"1-2\": \"no\",\n    \"1-3\": \"if not set, the app will use the default notification sound\",\n    \"1-4\": \"the name of the sound file in the **raw** folder. [see relevant docs here](http://developer.android.com/guide/appendix/media-formats.html)\"\n  },\n  \"cols\": 5,\n  \"rows\": 2\n}\n[/block]\n#IOSSettings\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"h-3\": \"Default\",\n    \"h-4\": \"Description\",\n    \"0-0\": \"badge\",\n    \"0-1\": \"number\",\n    \"0-2\": \"yes\",\n    \"0-4\": \"the number that will be shown on top of the application's icon\",\n    \"1-0\": \"sound\",\n    \"1-1\": \"string\",\n    \"1-2\": \"yes\",\n    \"1-3\": \"\",\n    \"1-4\": \"the name of the sound file in the app project. use `default` for the regular iOS sound. [see relevant docs here](https://developer.apple.com/library/ios/documentation/AudioVideo/Conceptual/MultimediaPG/UsingAudio/UsingAudio.html#//apple_ref/doc/uid/TP40009767-CH2-SW28)\"\n  },\n  \"cols\": 5,\n  \"rows\": 2\n}\n[/block]\n#WebPushSettings\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"actions\",\n    \"h-0\": \"Field\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"h-3\": \"Default\",\n    \"0-1\": \"array of [WebPushAction](doc:objects#section-webpushaction)\",\n    \"0-2\": \"yes\",\n    \"h-4\": \"Description\",\n    \"0-4\": \"creates action button on the push layout. Must have 1-2 elements.\"\n  },\n  \"cols\": 5,\n  \"rows\": 1\n}\n[/block]\n#WebPushAction\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"h-3\": \"Default\",\n    \"0-0\": \"title\",\n    \"0-1\": \"string\",\n    \"0-2\": \"yes\",\n    \"h-4\": \"Description\",\n    \"0-4\": \"title to be displayed on the button\",\n    \"1-0\": \"icon\",\n    \"1-1\": \"string\",\n    \"1-2\": \"no\",\n    \"2-0\": \"action\",\n    \"3-0\": \"url\",\n    \"2-1\": \"string\",\n    \"2-2\": \"no\",\n    \"3-1\": \"string\",\n    \"3-2\": \"no\",\n    \"1-4\": \"icon url for the button\",\n    \"2-4\": \"unique string to be identify the clicked action\",\n    \"3-4\": \"the url that will be launched after a click\"\n  },\n  \"cols\": 5,\n  \"rows\": 4\n}\n[/block]\n#FacebookMessengerSettings\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Feild\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"h-3\": \"Default\",\n    \"h-4\": \"Description\",\n    \"0-0\": \"view_button\",\n    \"0-1\": \"string\",\n    \"0-2\": \"no\",\n    \"0-3\": \"View\",\n    \"0-4\": \"the text on the button in case the message is built with a template ( has content url, video or audio )\"\n  },\n  \"cols\": 5,\n  \"rows\": 1\n}\n[/block]\n#Poll\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"h-3\": \"Default\",\n    \"h-4\": \"Description\",\n    \"0-0\": \"text\",\n    \"0-1\": \"string\",\n    \"0-2\": \"yes\",\n    \"0-4\": \"the text that will be shown as the poll's question\",\n    \"2-0\": \"image_url\",\n    \"2-1\": \"string\",\n    \"2-2\": \"no\",\n    \"2-3\": \"\",\n    \"2-4\": \"url to the image to show with the text of the poll\",\n    \"3-0\": \"answers\",\n    \"3-1\": \"array of [PollAnswer](doc:objects#section-pollanswer)\",\n    \"3-2\": \"yes\",\n    \"3-4\": \"possible answers\",\n    \"1-0\": \"layout_id\",\n    \"1-1\": \"string\",\n    \"1-2\": \"yes\",\n    \"1-4\": \"layout of the poll. possible values:\\n* `poll_images`\\n* `poll_text`\\n* `poll_text_wide_image`\"\n  },\n  \"cols\": 5,\n  \"rows\": 4\n}\n[/block]\n#PollAnswer\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"h-3\": \"Default\",\n    \"h-4\": \"Description\",\n    \"0-0\": \"text\",\n    \"0-1\": \"string\",\n    \"0-2\": \"required for layouts: \\n* `poll_text`\\n* `poll_text_wide_image`\",\n    \"0-4\": \"text for the answer\",\n    \"1-0\": \"image_url\",\n    \"1-1\": \"string\",\n    \"1-2\": \"required for layouts: \\n* `poll_images`\\n* `poll_text_wide_image`\",\n    \"1-4\": \"image url for the answer\"\n  },\n  \"cols\": 5,\n  \"rows\": 2\n}\n[/block]\n#Tag\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"h-3\": \"Default\",\n    \"h-4\": \"Description\",\n    \"0-0\": \"name\",\n    \"1-0\": \"type\",\n    \"2-0\": \"value\",\n    \"0-1\": \"string\",\n    \"1-1\": \"string\",\n    \"2-1\": \"according to ```type```\",\n    \"0-2\": \"yes\",\n    \"1-2\": \"yes\",\n    \"2-2\": \"yes\",\n    \"0-4\": \"the name of the tag, unique within the app\",\n    \"1-4\": \"data type of the tag. currently ```bool``` is supported\",\n    \"2-4\": \"```true``` or ```false``` for ```bool``` type\"\n  },\n  \"cols\": 5,\n  \"rows\": 3\n}\n[/block]","excerpt":"","slug":"objects","type":"basic","title":"Objects"}
This section contains documentation for all the objects that are required to use the api endpoints. [block:callout] { "type": "info", "body": "Examples can be found in each endpoint page." } [/block] #Template [block:parameters] { "data": { "0-1": "string", "0-0": "**name**", "h-0": "Field", "h-1": "Type", "h-2": "Required", "0-2": "yes", "h-3": "Default", "0-3": "", "3-0": "**strings**", "2-0": "**settings**", "2-1": "[TemplateSettings](doc:objects#section-templatesettings)", "2-2": "yes", "2-3": "all inner fields will be assigned with their default values as seen [here](doc:objects#section-templatesettings)", "4-0": "**is_default**", "4-1": "boolean", "4-2": "No", "4-3": "false", "h-4": "Description", "0-4": "the name of the tepmlate", "2-4": "settings which control parts of the notification UI", "3-4": "strings for the constant text of the notification and some of the sharing features. Possible `name` values: \n* `recommendations_title` - the text above content recommendations\n* `share_prefix` - the prefix of the text when sharing the notification\n* `share_subject` - the subject of the sharing action ( when sharing by email for example)\n* `ext_prefix` - the prefix of the text for external content, before the publisher's name", "4-4": "if set to `true`, this will be the default campaign", "3-1": "array of [PA_String](doc:objects#section-pa_string)", "5-0": "**features**", "5-1": "array of [Feature](doc:objects#section-feature)", "5-2": "Yes", "5-4": "the enrichment features for this campaign. set the following number of features according to their types:\n* `internal_content` - 1\n* `external_content` - 1\n* `action_buttons` - 3\n* `custom_feed` - 1", "1-0": "**layout_id**", "1-1": "string", "1-2": "yes", "1-4": "layout of the notification. possible values:\n* `content_with_two`\n* `content_with_three`\n* `content_wide_image_with_two`\n* `content_wide_image_with_three`" }, "cols": 5, "rows": 6 } [/block] #TemplateSettings [block:parameters] { "data": { "h-0": "Field", "h-1": "Required", "0-0": "**big_share_button**", "h-2": "Type", "h-3": "Default", "h-4": "Description", "1-0": "**small_view**", "2-0": "**build_without_image**", "3-0": "**small_share_button**", "4-0": "**drag_to_expand**", "0-1": "no", "1-1": "no", "2-1": "no", "3-1": "no", "4-1": "no", "0-2": "boolean", "1-2": "boolean", "2-2": "boolean", "3-2": "boolean", "4-2": "boolean", "0-3": "true", "1-3": "true", "2-3": "true", "3-3": "true", "4-3": "false", "0-4": "display share button when the notification is visible in its big view", "1-4": "show our UI when the notification is visible in its small view", "2-4": "show enrichment even if there is no image to the main notification", "3-4": "display share button when the notification is visible in its small view", "4-4": "show \"drag to expand\" text with an arrow in the small view, instead of the share button" }, "cols": 5, "rows": 5 } [/block] #PA_String [block:parameters] { "data": { "h-0": "Field", "h-1": "Type", "h-2": "Required", "h-3": "Default", "0-0": "**name**", "0-1": "string", "0-2": "Yes", "h-4": "Description", "0-4": "key for the string", "1-0": "**translations**", "1-1": "[Translations](doc:objects#section-translations)", "1-2": "Yes", "1-4": "text values for localization. Currently only one value is supported." }, "cols": 5, "rows": 2 } [/block] #Translations [block:parameters] { "data": { "h-0": "Field", "h-1": "Type", "h-2": "Required", "h-3": "Default", "h-4": "Description", "0-0": "**def**", "0-1": "string", "0-2": "Yes", "0-3": "default text" }, "cols": 5, "rows": 1 } [/block] #Feature [block:parameters] { "data": { "h-0": "Field", "h-1": "Type", "h-2": "Required", "h-3": "Default", "h-4": "Description", "0-0": "**type**", "0-1": "string", "0-2": "yes", "0-3": "", "0-4": "the type of the feature. possible values:\n* `content_feed`\n* `external_content`\n* `action_button`\n* `custom_feed`", "1-0": "**position**", "1-1": "number", "1-2": "yes", "1-4": "the position of the feature in the notification layout. begins with 1", "2-0": "**data**", "2-1": "JSON object. can be one of the types as listed in [Feature Objects](doc:objects#section-feature-objects)", "2-2": "yes" }, "cols": 5, "rows": 3 } [/block] #Feature Objects ##ContentFeedObject [block:parameters] { "data": { "h-0": "Field", "h-1": "Type", "h-2": "Required", "h-3": "Default", "h-4": "Description", "0-0": "**feeds**", "0-1": "array of [Feed](doc:objects#section-feed)", "0-2": "yes", "0-4": "feeds from which the content of the enrichment will be takes. needs to have at least 1 element. you can either use an existing feed with providing the `feed_id or create a new one on the fly with providing `url`", "1-0": "**view_ext_on_browser**", "2-0": "**recommendations_title**", "2-1": "boolean", "1-1": "boolean", "1-2": "no", "1-3": "false", "2-2": "no", "2-3": "false", "1-4": "should external content be opened in an external browser", "2-4": "show or hide the title above the recommendation ( such as *You may also like* )" }, "cols": 5, "rows": 3 } [/block] ##ExternalContentObject [block:parameters] { "data": { "h-0": "Field", "h-1": "Type", "h-2": "Required", "h-3": "Default", "h-4": "Description", "0-0": "**type**", "1-0": "**ob_widget_id**", "2-0": "**view_ext_on_browser**", "3-0": "**recommendations_title**", "0-1": "string", "0-2": "yes", "0-4": "origin of the external content. possible values:\n* `ob_sdk`", "1-1": "string", "1-2": "yes - if type is `ob_sdk`", "1-4": "the widget id from outbrain", "2-1": "boolean", "2-2": "no", "2-3": "false", "2-4": "should promoted content be opened in an external browser", "3-1": "boolean", "3-2": "no", "3-3": "false", "3-4": "show or hide the title above the recommendation ( such as *You may also like* )" }, "cols": 5, "rows": 4 } [/block] ##CustomFeedObject [block:parameters] { "data": { "h-0": "Field", "h-1": "Type", "h-2": "Required", "h-3": "Default", "h-4": "Description", "0-0": "**articles**", "1-0": "**recommendations_title**", "1-1": "boolean", "1-2": "no", "1-3": "false", "1-4": "show or hide the title above the recommendation ( such as *You may also like* )", "0-1": "array of [Objects](doc:objects#section-article)", "0-2": "yes", "0-4": "the articles that will be shown as recommendations. size of the array must fit the selected `layout_id`" }, "cols": 5, "rows": 2 } [/block] ##ActionButtonObject [block:parameters] { "data": { "h-0": "Field", "h-1": "Type", "h-2": "Required", "h-3": "Default", "h-4": "Description", "0-0": "**type**", "1-0": "**title**", "2-0": "**url**", "3-0": "**start_date**", "4-0": "**end_date**", "5-0": "**description**", "6-0": "**lat**", "7-0": "**lng**", "8-0": "**icon**", "9-0": "**icon_url**", "10-0": "**data**", "0-1": "string", "1-1": "string", "2-1": "string", "3-1": "number", "4-1": "number", "5-1": "string", "6-1": "float", "7-1": "float", "8-1": "string", "9-1": "string", "10-1": "JSON object", "0-2": "yes", "0-4": "button type. possible values:\n* `fb` - facebook share \n* `wa` - whatsapp share \n* `sms` - sms share\n* `email` - email share\n* `cal` - add to calendar\n* `video` - play video from link\n* `url` - open url ( can be also url scheme )\n* `nav` - open navigation intent\n* `custom` - custom action , for deep linking", "1-2": "required for type `custom`, optional for other type", "1-4": "title of the button", "2-2": "required for `url`, `video`", "3-2": "required for `cal`", "4-2": "required for `cal`", "5-2": "required for `cal`", "3-4": "starting time of the event, unix timestamp in [ms]", "4-4": "ending time of the event, unix timestamp in [ms]", "5-4": "description of the event", "6-2": "required for `nav`", "7-2": "required for `nav`", "2-4": "url to open or play", "6-4": "latitude of the destination", "7-4": "longitude of the destination", "8-2": "required for `custom` ( either this or **icon_url** )", "9-2": "required for `custom` ( either this or **icon** )", "10-2": "no", "10-4": "extra data to be passed in the activity when clicking on the button", "8-4": "icon filename which will be the resource id, for example : ic_share" }, "cols": 5, "rows": 11 } [/block] ###Feed [block:parameters] { "data": { "h-0": "Field", "h-1": "Type", "h-2": "Required", "h-3": "Default", "h-4": "Description", "0-0": "**id**", "1-0": "**url**", "2-0": "**name**", "0-1": "string", "1-1": "string", "2-1": "string", "0-2": "required if you want to use an exiting feed", "1-2": "required if you want to create a new feed", "2-2": "required if you use `url`", "2-4": "the name of the new generated feed", "0-4": "id of an existing campaign. you can get the current feeds from [/feeds endpoint](doc:feeds)", "1-4": "url of the feed ( needs to be an RSS or JSON feed )" }, "cols": 5, "rows": 3 } [/block] ###Article [block:parameters] { "data": { "h-0": "Field", "h-1": "Type", "h-2": "Required", "h-3": "Default", "h-4": "Description", "0-0": "**url**", "1-0": "**title**", "2-0": "**thumb_url**", "3-0": "**is_external**", "0-1": "string", "1-1": "string", "2-1": "string", "3-1": "boolean", "0-2": "yes", "1-2": "yes", "2-2": "yes", "3-2": "no", "3-3": "false", "0-4": "url of the article", "1-4": "title that will be displayed for the recommendation", "2-4": "the url of the thumbnail for the article", "3-4": "determined if this is an external content" }, "cols": 5, "rows": 4 } [/block] #AndroidSettings [block:parameters] { "data": { "h-0": "Field", "h-1": "Type", "h-2": "Required", "h-3": "Default", "h-4": "Description", "0-0": "title", "0-1": "string", "0-2": "no", "0-3": "if not set, the app name will be used", "0-4": "the title of the notification", "1-0": "sound", "1-1": "string", "1-2": "no", "1-3": "if not set, the app will use the default notification sound", "1-4": "the name of the sound file in the **raw** folder. [see relevant docs here](http://developer.android.com/guide/appendix/media-formats.html)" }, "cols": 5, "rows": 2 } [/block] #IOSSettings [block:parameters] { "data": { "h-0": "Field", "h-1": "Type", "h-2": "Required", "h-3": "Default", "h-4": "Description", "0-0": "badge", "0-1": "number", "0-2": "yes", "0-4": "the number that will be shown on top of the application's icon", "1-0": "sound", "1-1": "string", "1-2": "yes", "1-3": "", "1-4": "the name of the sound file in the app project. use `default` for the regular iOS sound. [see relevant docs here](https://developer.apple.com/library/ios/documentation/AudioVideo/Conceptual/MultimediaPG/UsingAudio/UsingAudio.html#//apple_ref/doc/uid/TP40009767-CH2-SW28)" }, "cols": 5, "rows": 2 } [/block] #WebPushSettings [block:parameters] { "data": { "0-0": "actions", "h-0": "Field", "h-1": "Type", "h-2": "Required", "h-3": "Default", "0-1": "array of [WebPushAction](doc:objects#section-webpushaction)", "0-2": "yes", "h-4": "Description", "0-4": "creates action button on the push layout. Must have 1-2 elements." }, "cols": 5, "rows": 1 } [/block] #WebPushAction [block:parameters] { "data": { "h-0": "Field", "h-1": "Type", "h-2": "Required", "h-3": "Default", "0-0": "title", "0-1": "string", "0-2": "yes", "h-4": "Description", "0-4": "title to be displayed on the button", "1-0": "icon", "1-1": "string", "1-2": "no", "2-0": "action", "3-0": "url", "2-1": "string", "2-2": "no", "3-1": "string", "3-2": "no", "1-4": "icon url for the button", "2-4": "unique string to be identify the clicked action", "3-4": "the url that will be launched after a click" }, "cols": 5, "rows": 4 } [/block] #FacebookMessengerSettings [block:parameters] { "data": { "h-0": "Feild", "h-1": "Type", "h-2": "Required", "h-3": "Default", "h-4": "Description", "0-0": "view_button", "0-1": "string", "0-2": "no", "0-3": "View", "0-4": "the text on the button in case the message is built with a template ( has content url, video or audio )" }, "cols": 5, "rows": 1 } [/block] #Poll [block:parameters] { "data": { "h-0": "Field", "h-1": "Type", "h-2": "Required", "h-3": "Default", "h-4": "Description", "0-0": "text", "0-1": "string", "0-2": "yes", "0-4": "the text that will be shown as the poll's question", "2-0": "image_url", "2-1": "string", "2-2": "no", "2-3": "", "2-4": "url to the image to show with the text of the poll", "3-0": "answers", "3-1": "array of [PollAnswer](doc:objects#section-pollanswer)", "3-2": "yes", "3-4": "possible answers", "1-0": "layout_id", "1-1": "string", "1-2": "yes", "1-4": "layout of the poll. possible values:\n* `poll_images`\n* `poll_text`\n* `poll_text_wide_image`" }, "cols": 5, "rows": 4 } [/block] #PollAnswer [block:parameters] { "data": { "h-0": "Field", "h-1": "Type", "h-2": "Required", "h-3": "Default", "h-4": "Description", "0-0": "text", "0-1": "string", "0-2": "required for layouts: \n* `poll_text`\n* `poll_text_wide_image`", "0-4": "text for the answer", "1-0": "image_url", "1-1": "string", "1-2": "required for layouts: \n* `poll_images`\n* `poll_text_wide_image`", "1-4": "image url for the answer" }, "cols": 5, "rows": 2 } [/block] #Tag [block:parameters] { "data": { "h-0": "Field", "h-1": "Type", "h-2": "Required", "h-3": "Default", "h-4": "Description", "0-0": "name", "1-0": "type", "2-0": "value", "0-1": "string", "1-1": "string", "2-1": "according to ```type```", "0-2": "yes", "1-2": "yes", "2-2": "yes", "0-4": "the name of the tag, unique within the app", "1-4": "data type of the tag. currently ```bool``` is supported", "2-4": "```true``` or ```false``` for ```bool``` type" }, "cols": 5, "rows": 3 } [/block]