NATS For Networks REST API Get Creative Rules
From TMM Wiki
Jump to navigationJump to searchThe printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.
GET /creative/get_creative_rules
Description
- get_creative_rules Accepts the creativeids that you want are requesting, and an optional show_inactive flag to get rules that aren't currently active.
Resource URL
- http://domain/api/creative/get_creative_rules
- Replace domain with the NATS for Networks domain
Response Format
- JSON
- GET
- HTTP headers
Parameters
- creativeids
- type: integer,string,array
- required
- either an int creativeid, a comma separated list of int creativeids, or an array of int creativeids for which you are retrieving rules
- show_inactive
- type: bool
- optional
- includes inactive rules in result. Default is FALSE;
Example Request
GET
http://domain/api/creative/get_creative_rules?creativeids=1&show_hidden=1 http://domain/api/creative/get_creative_rules?creativeids=1,2,3 http://domain/api/creative/get_creative_rules?creativeids[0]=1&creativeids[1]=2&creativeids[2]=3
- Response:
{ "rules": { "13": { "57c7371bd5dfe": { "adtool_rule_id": "151", "identid": "9", "start_time": "1472673563", "end_time": "0", "rule_type": "2", "adtoolid": "13", "adtool_type_id": "1", "rule_key": "57c7371bd5dfe", "start_nice": "2016-08-31 21:59:23", "end_nice": "FOREVER", "rule_type_nice": "HIDE", "loginid": {"ALL": "ALL"}, "offerid": {"ALL": "ALL"}, "landing_pageid": {"ALL": "ALL"} } } } }
Example Code
PHP
<?php $url = 'http://domain/api/creative/get_creative_rules' $curl = curl_init(); $headers = array( 'api-key: 44b5498dbcb481a0d00b404c0169af62', 'api-username: productsupport' ); $data = Array( 'creativeids' => 1 ); $data_string = http_build_query($data); $url .= '?'.$data_string; curl_setopt($curl, CURLOPT_HTTPHEADER, $headers); curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); curl_setopt($curl, CURLOPT_URL, $url); $resp = curl_exec($curl); //dumps an associative array representation of the json response $output = json_decode($resp, true); if($output !== NULL) { //json was valid. Dump the decoded array print_r($output); } else { //invalid json, just dump the raw response print_r($resp); } // Close request to clear up some resources curl_close($curl); ?>