EXPORT Creatives API Version 5

Luke Kadillak

Modified on: Tue, 5 Apr, 2022 at 6:10 PM

EXPORT Creatives API

Updated on 03/18/2022
Current Version: Version 5
Deprecated Version:
Requests Allowed: GET & SOAP

Summary:

Returns an array of buyer creatives potentially filtered by creative_id, creative_name, offer_id and its properties.

You can also obtain this from within your CAKE instance by going to the creatives tab in the offer card where you are allowed to export.

Resource/WSDL Page:

https://<your_domain_here>/api/5/export.asmx?op=Creatives

Parameters

api_key Required Type: STRING Length (Max/Min): 50	This api_key will provide you with the ability to export Campaigns for your instance. You can obtain this api_key from within CAKE >> Setup >> Permissions in the API Key list. Example Value: Fo35NRAqvFLXoZxqB4aViaiYM7iVMhh
creative_id Optional Type: INTEGER Length (Max/Min): N/A	This is the identifier for a unique creative. You can obtain the creative ID from your CAKE instance on the offer card. To get there, go to the advertiser tab >> offers >> choose an offer to open the offer card >> creatives tab >> choose a creative >> ID. Example Values: 1234
creative_name Optional Type: STRING Length (Max/Min): N/A	Not required and can accept blank value. Used to filter records matching the value or will return all records if blank. Example Values: banner 120x60
site_offer_id Required Type: INTEGER Length (Max/Min): N/A	This is the identifier for a unique Offer. This can be found on any Offer card. Offer ID must exist already. Cannot be a wildcard. Example Values: 1234
creative_type_id Optional Type: STRING Length (Max/Min): N/A	Used to filter records matching the value or will return all records if <=0. Must pass at least >= 0 as value. ["1" = Link, "2" = Email, "3" = Image, "4" = Flash] Example Values: 3
creative_status_id Optional Type: STRING Length (Max/Min): N/A	Used to filter records matching the value or will return all records if <=0. Must pass at least >= 0 as value. ["1" = Active, "2" = Inactive, "3" = Hidden] Example Values: 3
start_at_row Optional Type: INTEGER Length (Max/Min): N/A	Must pass at least 0 as value, which means start at the beginning of the data set. Example Values: 3
row_limit Optional Type: INTEGER Length (Max/Min): N/A	Must pass at least 0 as value, which means all rows. Example Values: 3
sort_field Optional Type: INTEGER Length (Max/Min): N/A	Accepts "creative_id", "creative_name", "date_created" or 0 to ignore this filter. The value could be any integer in order to ignore this filter. Example Values: 3
sort_descending Optional Type: BOOL Length (Max/Min): N/A	The following values can only be used for this parameter (TRUE or FALSE). Example Values: TRUE

**Note all optional parameters still need to be passed through in the actual call. These parameters do not need a value (therefore you can use a null value).

Example Request

GET	https://demo-new.cakemarketing.com/api/5/export.asmx/Creatives?api_key=3YmDJeT3VHTFhDqAjr2OlQ&creative_id=0&creative_name=&site_offer_id=100&creative_type_id=0&creative_status_id=0&start_at_row=0&row_limit=10&sort_field=creative_id&sort_descending=FALSE

Sample XML Response:

<success>true</success>
<row_count>34</row_count>
<creatives>
<creative>
<creative_id>236</creative_id>
<creative_name/>
<creative_type>
<creative_type_id xmlns="API:id_name_store">1</creative_type_id>
<creative_type_name xmlns="API:id_name_store">Link</creative_type_name>
</creative_type>
<creative_status>
<creative_status_id xmlns="API:id_name_store">1</creative_status_id>
<creative_status_name xmlns="API:id_name_store">Active</creative_status_name>
</creative_status>
<allow_link_override>false</allow_link_override>
<site_offer_link_override/>
<test_link>http://demo-newtrk.cakemarketing.com/?E=hAv7k8XyNDkURf8DkVf5TRcBPj63H9Ct&s1=Test</test_link>
<width xsi:nil="true"/>
<height xsi:nil="true"/>
<date_created>2012-09-12T12:05:52.577</date_created>
<expiration_date xsi:nil="true"/>
<notes/>
</creative>
<creative>
<creative_id>550</creative_id>
<creative_name>Upsell</creative_name>
<creative_type>
<creative_type_id xmlns="API:id_name_store">1</creative_type_id>
<creative_type_name xmlns="API:id_name_store">Link</creative_type_name>
</creative_type>
<creative_status>
<creative_status_id xmlns="API:id_name_store">3</creative_status_id>
<creative_status_name xmlns="API:id_name_store">Hidden</creative_status_name>
</creative_status>
<allow_link_override>false</allow_link_override>
<site_offer_link_override/>
<test_link>http://demo-newtrk.cakemarketing.com/?E=%2fqlG%2bAG4MNoURf8DkVf5TRcBPj63H9Ct&s1=Test</test_link>
<width xsi:nil="true"/>
<height xsi:nil="true"/>
<date_created>2012-12-27T10:41:17.447</date_created>
<expiration_date xsi:nil="true"/>
<notes/>
</creative>
<creative>
<creative_id>5024</creative_id>
<creative_name>Blue Map</creative_name>
<creative_type>
<creative_type_id xmlns="API:id_name_store">2</creative_type_id>
<creative_type_name xmlns="API:id_name_store">Email</creative_type_name>
</creative_type>
<creative_status>
<creative_status_id xmlns="API:id_name_store">1</creative_status_id>
<creative_status_name xmlns="API:id_name_store">Active</creative_status_name>
</creative_status>
<allow_link_override>false</allow_link_override>
<site_offer_link_override/>
<test_link>http://demo-newtrk.cakemarketing.com/?E=KW6xs9kk6ahUIvG5g76PQ7Droh8ARz4T&s1=Test</test_link>
<width xsi:nil="true"/>
<height xsi:nil="true"/>
<date_created>2013-01-11T14:27:59.747</date_created>
<expiration_date xsi:nil="true"/>
<notes/>
</creative>
<creative>
<creative_id>87615</creative_id>
<creative_name>New Creative</creative_name>
<creative_type>
<creative_type_id xmlns="API:id_name_store">1</creative_type_id>
<creative_type_name xmlns="API:id_name_store">Link</creative_type_name>
</creative_type>
<creative_status>
<creative_status_id xmlns="API:id_name_store">1</creative_status_id>
<creative_status_name xmlns="API:id_name_store">Active</creative_status_name>
</creative_status>
<allow_link_override>false</allow_link_override>
<site_offer_link_override>http://getCAKE.com</site_offer_link_override>
<test_link>http://demo-newtrk.cakemarketing.com/?E=9Eq%2bu3L%2bv7QI8m1jiWYfe9%2b6EixQx2gC&s1=Test</test_link>
<width xsi:nil="true"/>
<height xsi:nil="true"/>
<date_created>2021-01-18T09:58:59.833</date_created>
<expiration_date xsi:nil="true"/>
<notes>Here is where I put my invaluable notes.</notes>
</creative>

Example Error Messages:

Error Message	Likely Cause
Invalid API Key	API Key does not exist or is expired
Invalid Creative ID	Creative ID does not exist.