Difference between revisions of "NATS4 API Admin Get Adtools"
From TMM Wiki
Jump to navigationJump to searchTMMStephenY2 (talk | contribs) |
|||
| Line 2: | Line 2: | ||
| show_api_admin_section = true | | show_api_admin_section = true | ||
}} | }} | ||
| + | |||
| + | [[NATS4]] supports an API function to place and call adtool functions on your site; this function is called admin_get_adtools. | ||
| + | |||
admin_get_adtools accepts the following parameters: | admin_get_adtools accepts the following parameters: | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | * '''natscode''' - Input your NATS code here. This specifies the loginid, campaignid, programid, siteid, and tourid used for the adtool. This is used when deciding what adtools are available, as well as what link code to use. | |
| + | |||
| + | * '''siteid''' - This gives you the option to override the siteid that already exists in the NATS code. This parameter is optional; if you do not want to override your siteid, input '''0''' to disable it. | ||
| + | |||
| + | * '''adtool_type_id''' - The adtool type to get adtools for (see the ([[NATS4_API_Adtool_Types|Adtool Types function]]) | ||
| + | |||
| + | * '''params''' - A serialized array of parameters. See [[Nats_display_adtools|nats_display_adtools]] for the available parameters (you can use category, typeid, start, count, order, searchinline, and the search fields) | ||
| + | |||
| + | == API Request Example == | ||
| + | |||
| + | The following is an example of a request for adtools: | ||
| + | |||
<pre> | <pre> | ||
<?xml version="1.0" encoding="ISO-8859-1"?> | <?xml version="1.0" encoding="ISO-8859-1"?> | ||
| Line 23: | Line 33: | ||
</pre> | </pre> | ||
| − | + | This will output a response similar to: | |
| + | |||
<pre> | <pre> | ||
<?xml version="1.0" encoding="ISO-8859-1"?> | <?xml version="1.0" encoding="ISO-8859-1"?> | ||
| Line 76: | Line 87: | ||
</pre> | </pre> | ||
| − | NuSOAP Example | + | == NuSOAP Example == |
| + | |||
| + | This example continues from the [[NATS4_API#Example|main article NuSOAP Example]]): | ||
| + | |||
<pre> | <pre> | ||
$params = Array( | $params = Array( | ||
| Line 93: | Line 107: | ||
print_r($result); | print_r($result); | ||
</pre> | </pre> | ||
| − | Output | + | |
| + | == Adtools Output == | ||
| + | |||
<pre> | <pre> | ||
Array | Array | ||
Revision as of 12:13, 29 June 2010
NATS4 supports an API function to place and call adtool functions on your site; this function is called admin_get_adtools.
admin_get_adtools accepts the following parameters:
- natscode - Input your NATS code here. This specifies the loginid, campaignid, programid, siteid, and tourid used for the adtool. This is used when deciding what adtools are available, as well as what link code to use.
- siteid - This gives you the option to override the siteid that already exists in the NATS code. This parameter is optional; if you do not want to override your siteid, input 0 to disable it.
- adtool_type_id - The adtool type to get adtools for (see the (Adtool Types function)
- params - A serialized array of parameters. See nats_display_adtools for the available parameters (you can use category, typeid, start, count, order, searchinline, and the search fields)
API Request Example
The following is an example of a request for adtools:
<?xml version="1.0" encoding="ISO-8859-1"?>
<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:tns="urn:natsapiadmin_wsdl">
<SOAP-ENV:Body>
<tns:admin_get_adtools xmlns:tns="urn:natsapiadmin_wsdl">
<natscode xsi:type="xsd:string">MS4xLjEuMS4wLjEwLjAuMA</natscode>
<siteid xsi:nil="true" xsi:type="xsd:int"/>
<adtool_type_id xsi:type="xsd:int">2</adtool_type_id>
<params xsi:type="xsd:string">a:2:{s:12:"searchinline";i:1;s:11:"search_type";s:3:"5:1";}</params>
</tns:admin_get_adtools>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
This will output a response similar to:
<?xml version="1.0" encoding="ISO-8859-1"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:tns="urn:natsapiadmin_wsdl">
<SOAP-ENV:Body>
<ns1:admin_get_adtoolsResponse xmlns:ns1="urn:natsapiadmin_wsdl">
<return xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:Adtool[4]">
<item xsi:type="tns:Adtool">
<adtoolid xsi:type="xsd:int">10</adtoolid>
<name xsi:type="xsd:string">HATS</name>
<url xsi:type="xsd:string">http://www.google.com/hats</url>
<date_added xsi:type="xsd:int">1246909656</date_added>
<published_date xsi:type="xsd:int">1246852800</published_date>
<trackurl xsi:type="xsd:string">http://nats.site.com/gallery/MC4xLjEuMS4wLjEwLjAuMC4w</trackurl>
<natscode xsi:type="xsd:string">MS4xLjEuMS4wLjEwLjAuMC4w</natscode>
<extra xsi:type="xsd:string">a:13:{s:9:"networkid";s:1:"0";s:14:"adtool_type_id";s:1:"2";s:7:"deleted";s:1:"0";s:9:"byo_owner";s:1:"0";s:14:"byo_owner_only";s:1:"0";s:11:"byo_program";s:1:"0";s:4:"type";s:1:"1";s:5:"items";s:1:"0";s:11:"description";s:12:"Lots of hats";s:9:"thumbnail";s:0:"";s:9:"thumb_ext";s:0:"";s:10:"var_divide";s:1:"?";s:3:"ids";a:3:{s:7:"loginid";s:1:"1";s:9:"programid";s:1:"1";s:6:"siteid";s:1:"1";}}</extra>
</item>
<item xsi:type="tns:Adtool">
<adtoolid xsi:type="xsd:int">11</adtoolid>
<name xsi:type="xsd:string">bags</name>
<url xsi:type="xsd:string">http://www.google.com/bags</url>
<date_added xsi:type="xsd:int">1246909656</date_added>
<published_date xsi:type="xsd:int">1246852800</published_date>
<trackurl xsi:type="xsd:string">http://nats.site.com/gallery/MC4xLjEuMS4wLjExLjAuMC4w</trackurl>
<natscode xsi:type="xsd:string">MS4xLjEuMS4wLjExLjAuMC4w</natscode>
<extra xsi:type="xsd:string">a:13:{s:9:"networkid";s:1:"0";s:14:"adtool_type_id";s:1:"2";s:7:"deleted";s:1:"0";s:9:"byo_owner";s:1:"0";s:14:"byo_owner_only";s:1:"0";s:11:"byo_program";s:1:"0";s:4:"type";s:1:"1";s:5:"items";s:1:"0";s:11:"description";s:12:"Lots of bags";s:9:"thumbnail";s:0:"";s:9:"thumb_ext";s:0:"";s:10:"var_divide";s:1:"?";s:3:"ids";a:3:{s:7:"loginid";s:1:"1";s:9:"programid";s:1:"1";s:6:"siteid";s:1:"1";}}</extra>
</item>
<item xsi:type="tns:Adtool">
<adtoolid xsi:type="xsd:int">12</adtoolid>
<name xsi:type="xsd:string">gowns</name>
<url xsi:type="xsd:string">http://www.google.com/gowns</url>
<date_added xsi:type="xsd:int">1246909656</date_added>
<published_date xsi:type="xsd:int">1246852800</published_date>
<trackurl xsi:type="xsd:string">http://nats.site.com/gallery/MC4xLjEuMS4wLjEyLjAuMC4w</trackurl>
<natscode xsi:type="xsd:string">MS4xLjEuMS4wLjEyLjAuMC4w</natscode>
<extra xsi:type="xsd:string">a:13:{s:9:"networkid";s:1:"0";s:14:"adtool_type_id";s:1:"2";s:7:"deleted";s:1:"0";s:9:"byo_owner";s:1:"0";s:14:"byo_owner_only";s:1:"0";s:11:"byo_program";s:1:"0";s:4:"type";s:1:"1";s:5:"items";s:1:"0";s:11:"description";s:13:"Lots of gowns";s:9:"thumbnail";s:0:"";s:9:"thumb_ext";s:0:"";s:10:"var_divide";s:1:"?";s:3:"ids";a:3:{s:7:"loginid";s:1:"1";s:9:"programid";s:1:"1";s:6:"siteid";s:1:"1";}}</extra>
</item>
<item xsi:type="tns:Adtool">
<adtoolid xsi:type="xsd:int">13</adtoolid>
<name xsi:type="xsd:string">shirts</name>
<url xsi:type="xsd:string">http://www.google.com/shirts</url>
<date_added xsi:type="xsd:int">1246909656</date_added>
<published_date xsi:type="xsd:int">1246852800</published_date>
<trackurl xsi:type="xsd:string">http://nats.site.com/gallery/MC4xLjEuMS4wLjEzLjAuMC4w</trackurl>
<natscode xsi:type="xsd:string">MS4xLjEuMS4wLjEzLjAuMC4w</natscode>
<extra xsi:type="xsd:string">a:13:{s:9:"networkid";s:1:"0";s:14:"adtool_type_id";s:1:"2";s:7:"deleted";s:1:"0";s:9:"byo_owner";s:1:"0";s:14:"byo_owner_only";s:1:"0";s:11:"byo_program";s:1:"0";s:4:"type";s:1:"1";s:5:"items";s:1:"0";s:11:"description";s:14:"Lots of shirts";s:9:"thumbnail";s:0:"";s:9:"thumb_ext";s:0:"";s:10:"var_divide";s:1:"?";s:3:"ids";a:3:{s:7:"loginid";s:1:"1";s:9:"programid";s:1:"1";s:6:"siteid";s:1:"1";}}</extra>
</item>
</return>
</ns1:admin_get_adtoolsResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
NuSOAP Example
This example continues from the main article NuSOAP Example):
$params = Array(
'searchinline' => 1,
'search_type' => '5:1'
);
$values = array(
'natscode'=>'MS4xLjEuMS4wLjEwLjAuMA',
'adtool_type_id'=>2,
'params' => serialize($params)
);
$result = $client->call('admin_get_adtools', $values, 'natsapiadmin_wsdl');
if($result) foreach($result as $key => $adtool){
if($adtool['extra']) $result[$key]['extra'] = unserialize($adtool['extra']);
}
print_r($result);
Adtools Output
Array
(
[0] => Array
(
[adtoolid] => 10
[name] => HATS
[url] => http://www.google.com/hats
[date_added] => 1246909656
[published_date] => 1246852800
[trackurl] => http://nats.site.com/gallery/MC4xLjEuMS4wLjEwLjAuMC4w
[natscode] => MS4xLjEuMS4wLjEwLjAuMC4w
[extra] => Array
(
[networkid] => 0
[adtool_type_id] => 2
[deleted] => 0
[byo_owner] => 0
[byo_owner_only] => 0
[byo_program] => 0
[type] => 1
[items] => 0
[description] => Lots of hats
[thumbnail] =>
[thumb_ext] =>
[var_divide] => ?
[ids] => Array
(
[loginid] => 1
[programid] => 1
[siteid] => 1
)
)
)
[1] => Array
(
[adtoolid] => 11
[name] => bags
[url] => http://www.google.com/bags
[date_added] => 1246909656
[published_date] => 1246852800
[trackurl] => http://nats.site.com/gallery/MC4xLjEuMS4wLjExLjAuMC4w
[natscode] => MS4xLjEuMS4wLjExLjAuMC4w
[extra] => Array
(
[networkid] => 0
[adtool_type_id] => 2
[deleted] => 0
[byo_owner] => 0
[byo_owner_only] => 0
[byo_program] => 0
[type] => 1
[items] => 0
[description] => Lots of bags
[thumbnail] =>
[thumb_ext] =>
[var_divide] => ?
[ids] => Array
(
[loginid] => 1
[programid] => 1
[siteid] => 1
)
)
)
[2] => Array
(
[adtoolid] => 12
[name] => gowns
[url] => http://www.google.com/gowns
[date_added] => 1246909656
[published_date] => 1246852800
[trackurl] => http://nats.site.com/gallery/MC4xLjEuMS4wLjEyLjAuMC4w
[natscode] => MS4xLjEuMS4wLjEyLjAuMC4w
[extra] => Array
(
[networkid] => 0
[adtool_type_id] => 2
[deleted] => 0
[byo_owner] => 0
[byo_owner_only] => 0
[byo_program] => 0
[type] => 1
[items] => 0
[description] => Lots of gowns
[thumbnail] =>
[thumb_ext] =>
[var_divide] => ?
[ids] => Array
(
[loginid] => 1
[programid] => 1
[siteid] => 1
)
)
)
[3] => Array
(
[adtoolid] => 13
[name] => shirts
[url] => http://www.google.com/shirts
[date_added] => 1246909656
[published_date] => 1246852800
[trackurl] => http://nats.site.com/gallery/MC4xLjEuMS4wLjEzLjAuMC4w
[natscode] => MS4xLjEuMS4wLjEzLjAuMC4w
[extra] => Array
(
[networkid] => 0
[adtool_type_id] => 2
[deleted] => 0
[byo_owner] => 0
[byo_owner_only] => 0
[byo_program] => 0
[type] => 1
[items] => 0
[description] => Lots of shirts
[thumbnail] =>
[thumb_ext] =>
[var_divide] => ?
[ids] => Array
(
[loginid] => 1
[programid] => 1
[siteid] => 1
)
)
)
)
