{"_id":"56d099ed167e1e1b008079d2","parentDoc":null,"user":"56c39c05bc41330d009f25d7","githubsync":"","project":"56c35c56c0c4630d004e864c","__v":1,"editedParams2":true,"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"},"editedParams":true,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-26T18:31:09.591Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"creative_approval_history_id\": 1,\n            \"creative_approval_id\": 1,\n            \"creative_id\": 1,\n            \"vendor_id\": 3,\n            \"account_id\": 1,\n            \"alternative_id\": null,\n            \"action\": \"CREATE\",\n            \"request_date\": \"2016-02-03 17:42:20\",\n            \"request_status\": 0,\n            \"approval_status_message\": {\n              \"message\":\"Creative submitted to Google\",\n              \"issues\":[\n                {\n                  \"code\":\"unique code for an issue\",\n                \t\"description\":\"Wow, this creative is really bad\"}\n                ]\n            }\n            \"update_date\": \"2016-02-03 17:42:20\",\n            \"approved\": 0,\n            \"buzz_key\": \"stingersbx\"\n        }\n    ]\n}","language":"json","status":200}]},"settings":"","examples":{"codes":[{"code":"curl -X GET \"[host]/rest/creative_approval_queue_history\" -b cookies.txt -d '{\"creative_id\":1}'","language":"curl"}]},"method":"get","auth":"required","params":[{"_id":"56d099ed167e1e1b008079d3","ref":"","in":"query","required":false,"desc":"Unique id of the creative_approval_queue_history entry","default":"","type":"int","name":"creative_approval_queue_history_id"},{"_id":"56c38f9c2d97560d00e23cba","ref":"","in":"query","required":false,"desc":"Unique id of the creative_approval_queue entry","default":"","type":"int","name":"creative_approval_id"},{"_id":"56c38f9c2d97560d00e23cb9","ref":"","in":"query","required":false,"desc":"ID of the creative","default":"","type":"int","name":"creative_id"},{"_id":"56cf65ba336aa60b0086a43a","ref":"","in":"query","required":false,"desc":"ID of the `vendor` such as Google","default":"","type":"int","name":"vendor_id"},{"_id":"56cf65ba336aa60b0086a437","ref":"","in":"query","required":false,"desc":"The latest action that is required to be performed on this queue entry. Valid actions are `CREATE`, `PAUSE`, `RESUME`, and `DELETE`. Not all actions are relevant to all vendors.","default":"","type":"string","name":"action"},{"_id":"56cf65ba336aa60b0086a438","ref":"","in":"query","required":false,"desc":"Date the latest approval was submitted","default":"","type":"datetime","name":"request_date"},{"_id":"56cf65ba336aa60b0086a436","ref":"","in":"query","required":false,"desc":"Status of the latest approval request. Note, this is not the same as the status of the Creative with this vendor.","default":"","type":"int","name":"request_status"},{"_id":"56d0992940d36e1d00bc13df","ref":"","in":"query","required":false,"desc":"Whether this `creative_id` to `vendor_id` combination is currently in an approved state.","default":"","type":"boolean","name":"approved"},{"_id":"56d0992940d36e1d00bc13de","ref":"","in":"query","required":false,"desc":"Date the queue entry was created or updated","default":"","type":"datetime","name":"update_date"}],"url":"/rest/creative_approval_queue_history"},"isReference":true,"order":51,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Understanding the creative_approval_status field\"\n}\n[/block]\nThe `creative_approval_status` field is filled automatically when a Creative Approval is submitted or feedback is received. The field is json with the following fields:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Values\",\n    \"h-2\": \"Example value\",\n    \"0-0\": \"message\",\n    \"0-1\": \"String with summary of what happened\",\n    \"0-2\": \"`\\\"Creative submitted to Google OK\\\"`\",\n    \"1-0\": \"issues\",\n    \"1-1\": \"List of objects describing critical problems with the creative in form:\\n\\n`[ {\\\"code\\\":\\\"whatever\\\",\\\"description\\\":\\\"longer whatever\\\"} ]`\",\n    \"1-2\": \"`'[{\\\"code:\\\"SSL Error\\\",\\\"description\\\":\\\"Creative does not render in secure environments\\\"},\\n{\\\"code:\\\"VPAID\\\",\\\"description\\\":\\\"Creative returns VPAID errors\\\"}\\n]'`\",\n    \"2-0\": \"corrections\",\n    \"2-1\": \"List of objects describing non-critical problems with the creative in form:\\n\\n`[ {\\\"code\\\":\\\"whatever\\\",\\\"description\\\":\\\"longer whatever\\\"} ]`\",\n    \"2-2\": \"Same as above\",\n    \"3-0\": \"error\",\n    \"3-1\": \"List of strings representing fatal errors with submission\",\n    \"3-2\": \"`[\\\"Could not submit to Google\\\"]`\",\n    \"4-0\": \"admin\",\n    \"4-1\": \"List of strings representing administrative notes relating to the submission.\",\n    \"4-2\": \"`[\\\"No email set for this account\\\"]`\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]","excerpt":"","slug":"creativeapprovalqueuehistory","type":"endpoint","title":"creative_approval_queue_history"}

getcreative_approval_queue_history


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

creative_approval_queue_history_id:
integer
Unique id of the creative_approval_queue_history entry
creative_approval_id:
integer
Unique id of the creative_approval_queue entry
creative_id:
integer
ID of the creative
vendor_id:
integer
ID of the `vendor` such as Google
action:
string
The latest action that is required to be performed on this queue entry. Valid actions are `CREATE`, `PAUSE`, `RESUME`, and `DELETE`. Not all actions are relevant to all vendors.
request_date:
datetime
Date the latest approval was submitted
request_status:
integer
Status of the latest approval request. Note, this is not the same as the status of the Creative with this vendor.
approved:
boolean
Whether this `creative_id` to `vendor_id` combination is currently in an approved state.
update_date:
datetime
Date the queue entry was created or updated

Examples


Result Format


Documentation

[block:api-header] { "type": "basic", "title": "Understanding the creative_approval_status field" } [/block] The `creative_approval_status` field is filled automatically when a Creative Approval is submitted or feedback is received. The field is json with the following fields: [block:parameters] { "data": { "h-0": "Field", "h-1": "Values", "h-2": "Example value", "0-0": "message", "0-1": "String with summary of what happened", "0-2": "`\"Creative submitted to Google OK\"`", "1-0": "issues", "1-1": "List of objects describing critical problems with the creative in form:\n\n`[ {\"code\":\"whatever\",\"description\":\"longer whatever\"} ]`", "1-2": "`'[{\"code:\"SSL Error\",\"description\":\"Creative does not render in secure environments\"},\n{\"code:\"VPAID\",\"description\":\"Creative returns VPAID errors\"}\n]'`", "2-0": "corrections", "2-1": "List of objects describing non-critical problems with the creative in form:\n\n`[ {\"code\":\"whatever\",\"description\":\"longer whatever\"} ]`", "2-2": "Same as above", "3-0": "error", "3-1": "List of strings representing fatal errors with submission", "3-2": "`[\"Could not submit to Google\"]`", "4-0": "admin", "4-1": "List of strings representing administrative notes relating to the submission.", "4-2": "`[\"No email set for this account\"]`" }, "cols": 3, "rows": 5 } [/block]

User Information

Try It Out

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