Difference between revisions of "Offerit REST API Get Creatives Rules"
From Offerit
OfferitRob (talk | contribs) (Created page with "{{Offerit Manual | show_api_admin_section = true }} == '''GET /creative/get_creative_rules''' == '''Description''' *get_creative_rules Accepts the creativeids that you want a...") |
Offeritnick (talk | contribs) |
||
(One intermediate revision by one other user not shown) | |||
Line 1: | Line 1: | ||
{{Offerit Manual | {{Offerit Manual | ||
− | | | + | | show_rest_api_section = true |
}} | }} | ||
== '''GET /creative/get_creative_rules''' == | == '''GET /creative/get_creative_rules''' == | ||
Line 90: | Line 90: | ||
$resp = curl_exec($curl); | $resp = curl_exec($curl); | ||
− | //dumps an associative array representation of the json | + | //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 | // Close request to clear up some resources | ||
curl_close($curl); | curl_close($curl); |
Latest revision as of 17:24, 12 May 2017
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 Offerit domain
Response Format
- JSON
[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method]]
- 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); ?>