{"_id":"593abe938b45d0000fe2546e","project":"56c35c56c0c4630d004e864c","version":{"_id":"56c35c56c0c4630d004e864f","project":"56c35c56c0c4630d004e864c","__v":8,"createdAt":"2016-02-16T17:28:54.864Z","releaseDate":"2016-02-16T17:28:54.864Z","categories":["56c35c57c0c4630d004e8650","56c7b9e5379b311700ed8fe3","56c7bab4606ee717003c4766","56c7bb3613e5400d001e8cbd","56cf3f5a5267d70b00494c4b","56cf3f866c5d7a13005ee894","56fd3956caad892200847bce","599da256e7742b002588bb02"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"0.5.0","version":"0.5"},"category":{"_id":"56cf3f866c5d7a13005ee894","__v":67,"project":"56c35c56c0c4630d004e864c","version":"56c35c56c0c4630d004e864f","pages":["56cf5bb88629f91300fd97c5","56cf5bf68629f91300fd97c7","56cf5fd2287eb20b009f9f37","56cf631a44c5700b0095c1c8","56cf63ae6c5d7a13005eeb58","56cf6408287eb20b009f9f40","56cf643a287eb20b009f9f43","56cf65ba336aa60b0086a435","56cf66df336aa60b0086a440","56cf69b344c5700b0095c1cf","56cf6a3d44c5700b0095c1d3","56cf6ac6336aa60b0086a44e","56cf6b298acacb13008148c9","56cf6cd68629f91300fd97e3","56cf6e048acacb13008148cd","56cf6eac336aa60b0086a455","56cf6edf287eb20b009f9f5a","56cf6f6b336aa60b0086a462","56cf704e8629f91300fd97f0","56cf70bf6c5d7a13005eeb6f","56cf72c6287eb20b009f9f76","56cf74c86c5d7a13005eeb7f","56cf75f5336aa60b0086a496","56cf76b68629f91300fd9801","56cf76da8629f91300fd9805","56cf776c8acacb13008148dc","56cf77ca6c5d7a13005eeb92","56cf788044c5700b0095c1fe","56cf78c28acacb13008148e5","56cf7a9544c5700b0095c207","56cf7b9b44c5700b0095c20c","56cf7c268629f91300fd980f","56cf7c456c5d7a13005eeba4","56d097b1376b040b005b3029","56d0992940d36e1d00bc13dd","56d099ed167e1e1b008079d2","56d09afa376b040b005b3032","56d09ba01ecc471500f1794a","56d09c13376b040b005b3034","56d09cde167e1e1b008079d7","56d09f30167e1e1b008079e2","56d0a00b376b040b005b303d","56d0a063167e1e1b008079e6","56d0a11a7c2e100b000af929","56d0b072167e1e1b00807a2e","56d0b0fb7c2e100b000af98b","56d0b16d1ecc471500f179af","56d0b1ee7c2e100b000af991","56d0b2407c2e100b000af998","56d0b2e640d36e1d00bc1456","56d0b3511ecc471500f179bc","56d0b3aab2cb7013004de65b","56d0b3d1b2cb7013004de65e","56d0b3fe7c2e100b000af9a1","56d0b4d67c2e100b000af9a5","56d0b52fb2cb7013004de666","56d0b59db2cb7013004de66c","56d0b621167e1e1b00807a4c","56d0b787167e1e1b00807a54","56d0b82d167e1e1b00807a55","56d0b8a8167e1e1b00807a5d","56d0b8fe167e1e1b00807a60","56d0b9951ecc471500f179c7","56d0ba55376b040b005b30a1","56d0bac31ecc471500f179cc","56d0bb6e167e1e1b00807a64","56d0bc95167e1e1b00807a6a"],"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-02-25T17:53:10.154Z","from_sync":false,"order":1,"slug":"buzz-api-reference","title":"Buzz API Reference"},"user":"56c39c05bc41330d009f25d7","githubsync":"","__v":1,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-06-09T15:28:19.926Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"post","examples":{"codes":[{"code":"curl -X POST \"[host]/rest/native_offer\" -b cookies.txt -d '{\"native_offer_name\":\"new Offer\", \"advertiser_id\":1, creative_template_id\":[14,15], \"logo_asset_id\":12 \"title_short\":\"Great app from Beeswax\", \"description_short\":\"Using the great app will make you beautiful\", \"star_rating\":3, \"downloads\":150, \"price\":1.99, \"active\":1}'","language":"curl"}]},"settings":"","results":{"codes":[{"name":"","code":"{\n    \"success\": true,\n    \"message\": \"native_offer created with ID = 1\",\n    \"payload\": {\n        \"id\": 1\n    }\n}","language":"json","status":200}]},"auth":"required","params":[{"_id":"56c38f9c2d97560d00e23cba","ref":"","in":"body","required":true,"desc":"Must be active","default":"","type":"int","name":"advertiser_id"},{"_id":"56c38f9c2d97560d00e23cb9","ref":"","in":"body","required":false,"desc":"An alternative id to lookup the  Line Item, if desired","default":"","type":"string","name":"alternative_id"},{"_id":"56fbf3200256470e00525389","ref":"","in":"body","required":false,"desc":"A list of Creative Templates that should be used to validate the fields in this object","default":"","type":"array_int","name":"creative_template_id"},{"_id":"56c39b11e1e4190d003429b7","ref":"","in":"body","required":true,"desc":"Name of the Native Offer","default":"","type":"string","name":"native_offer_name"},{"_id":"56fbf3200256470e00525388","ref":"","in":"body","required":false,"desc":"The ID of a CreativeAsset for the `icon` field to be shown in the Creative.","default":"","type":"int","name":"icon_asset_id"},{"_id":"56c39b11e1e4190d003429b6","ref":"","in":"body","required":false,"desc":"The ID of a CreativeAsset for the `logo` field to be shown in the Creative.","default":"","type":"int","name":"logo_asset_id"},{"_id":"56c39b11e1e4190d003429b5","ref":"","in":"body","required":false,"desc":"A title for the ad under 25 chars","default":"","type":"string","name":"title_short"},{"_id":"56c39b11e1e4190d003429b4","ref":"","in":"body","required":false,"desc":"A title for the ad under 50 chars long","default":"","type":"string","name":"title_long"},{"_id":"56c39b11e1e4190d003429b3","ref":"","in":"body","required":false,"desc":"A description for the ad under 90 chars long","default":"","type":"string","name":"description_short"},{"_id":"56cf74c86c5d7a13005eeb84","ref":"","in":"body","required":false,"desc":"A description for the ad under 200 chars long","default":"","type":"string","name":"description_long"},{"_id":"56cf74c86c5d7a13005eeb83","ref":"","in":"body","required":false,"desc":"Call to action under 15 chars long (e.g. \"click here\")","default":"","type":"string","name":"call_to_action"},{"_id":"56fbf3200256470e00525387","ref":"","in":"body","required":false,"desc":"The name of the advertiser for inclusion in the ad, under 50 chars long","default":"","type":"string","name":"sponsored"},{"_id":"56cf74c86c5d7a13005eeb82","ref":"","in":"body","required":false,"desc":"The name of the app store, under 15 chars long (e.g. \"iTunes\")","default":"","type":"string","name":"store"},{"_id":"56cf74c86c5d7a13005eeb81","ref":"","in":"body","required":false,"desc":"Number of likes the product has on various social networks","default":"","type":"int","name":"likes"},{"_id":"56cf74c86c5d7a13005eeb80","ref":"","in":"body","required":false,"desc":"The number of downloads the product has","default":"","type":"int","name":"downloads"},{"_id":"56c39b11e1e4190d003429b2","ref":"","in":"body","required":false,"desc":"Notes about the Line Item, up to 255 chars","default":"","type":"string","name":"notes"},{"_id":"56c39b11e1e4190d003429b1","ref":"","in":"body","required":false,"desc":"Is the NativeOffer active","default":"1","type":"boolean","name":"active"},{"_id":"593ac16e9c56ba000f300fd3","ref":"","in":"body","required":false,"desc":"A phone number, under 20 chars long","default":"","type":"string","name":"phone"},{"_id":"593ac16e9c56ba000f300fd2","ref":"","in":"body","required":false,"desc":"A physical address, up to 100 chars long","default":"","type":"string","name":"address"},{"_id":"593ac16e9c56ba000f300fd1","ref":"","in":"body","required":false,"desc":"A URL to show in the ad. Will not be used as a click-through URL.","default":"","type":"string","name":"display_url"},{"_id":"593ac16e9c56ba000f300fd0","ref":"","in":"body","required":false,"desc":"A number between 0 and 5 reflecting the user rating of the product.","default":"","type":"int","name":"star_rating"},{"_id":"593ac16e9c56ba000f300fcf","ref":"","in":"body","required":false,"desc":"The price of the product being advertised","default":"","type":"double","name":"price"},{"_id":"593ac16e9c56ba000f300fce","ref":"","in":"body","required":false,"desc":"A discounted price of the product being advertised","default":"","type":"double","name":"sale_price"},{"_id":"58504c9b9d4f700f00e9db86","ref":"","in":"body","required":false,"desc":"Currency in which the product is priced, for display in the ad, has no effect on bidding","default":"","type":"string","name":"currency"}],"url":"/rest/native_offer"},"isReference":true,"order":107,"body":"","excerpt":"","slug":"native_offer","type":"endpoint","title":"native_offer"}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

advertiser_id:
required
integer
Must be active
alternative_id:
string
An alternative id to lookup the Line Item, if desired
creative_template_id:
array of integers
A list of Creative Templates that should be used to validate the fields in this object
native_offer_name:
required
string
Name of the Native Offer
icon_asset_id:
integer
The ID of a CreativeAsset for the `icon` field to be shown in the Creative.
logo_asset_id:
integer
The ID of a CreativeAsset for the `logo` field to be shown in the Creative.
title_short:
string
A title for the ad under 25 chars
title_long:
string
A title for the ad under 50 chars long
description_short:
string
A description for the ad under 90 chars long
description_long:
string
A description for the ad under 200 chars long
call_to_action:
string
Call to action under 15 chars long (e.g. "click here")
sponsored:
string
The name of the advertiser for inclusion in the ad, under 50 chars long
store:
string
The name of the app store, under 15 chars long (e.g. "iTunes")
likes:
integer
Number of likes the product has on various social networks
downloads:
integer
The number of downloads the product has
notes:
string
Notes about the Line Item, up to 255 chars
active:
boolean1
Is the NativeOffer active
phone:
string
A phone number, under 20 chars long
address:
string
A physical address, up to 100 chars long
display_url:
string
A URL to show in the ad. Will not be used as a click-through URL.
star_rating:
integer
A number between 0 and 5 reflecting the user rating of the product.
price:
double
The price of the product being advertised
sale_price:
double
A discounted price of the product being advertised
currency:
string
Currency in which the product is priced, for display in the ad, has no effect on bidding

Examples


Result Format


User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}