EXPORT Creatives API

Updated on 2014-03-27
Current Version: Version 3
Depricated Version:
Requests Allowed: GET & SOAP

 

Summary:

Returns an array of buyer creatives potentially filterd 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:

http://<your_domain_here>/api/3/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
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
http://demo.cakemarketing.com/api/3/export.asmx/Creatives?api_key=dNJFmId9rI&creative_id=0&creative_name=&offer_id=100&creative_type_id=0&
creative_status_id=0&start_at_row=1&row_limit=3&sort_field=creative_id&
sort_descending=FALSE

 

Sample XML Response:

<creative_export_response>
  <success>true</success>
  <row_count>64</row_count>
  <creatives>
    <creative>
      <creative_id>1</creative_id>
      <creative_name>Super Creative</creative_name>
      <creative_type>
        <creative_type_id>1</creative_type_id>
        <creative_type_name>Link</creative_type_name>
      </creative_type>
      <creative_status>
        <creative_status_id>2</creative_status_id>
        <creative_status_name>Inactive</creative_status_name>
      </creative_status>
      <offer_link_override/>
      <width xsi:nil="true"/>
      <height xsi:nil="true"/>
      <creative_files>
        <creative_file>
          <creative_file_id>7250</creative_file_id>
          <creative_file_name>AccessibleMarshal.dll</creative_file_name>
          <creative_file_link>http://demo.cakemarketing.com/creatives/1/AccessibleMarshal.dll</creative_file_link>
          <preview>false</preview>
          <date_created>2013-05-08T13:12:23.277</date_created>
        </creative_file>
      </creative_files>
      <date_created>2011-05-13T00:00:00</date_created>
      <expiration_date>2013-03-28T00:00:00</expiration_date>
      <notes/>
    </creative>
    <creative>
      <creative_id>12</creative_id>
      <creative_name/>
      <creative_type>
        <creative_type_id>2</creative_type_id>
        <creative_type_name>Email</creative_type_name>
      </creative_type>
      <creative_status>
        <creative_status_id>1</creative_status_id>
        <creative_status_name>Active</creative_status_name>
      </creative_status>
      <offer_link_override/>
      <width xsi:nil="true"/>
      <height xsi:nil="true"/>
      <creative_files>
        <creative_file>
          <creative_file_id>120</creative_file_id>
          <creative_file_name>1.jpg</creative_file_name>
          <creative_file_link>http://demo.cakemarketing.com/creatives/12/1.jpg</creative_file_link>
          <preview>false</preview>
          <date_created>2012-01-07T10:03:37.303</date_created>
        </creative_file>
        <creative_file>
          <creative_file_id>121</creative_file_id>
          <creative_file_name>1.jpg</creative_file_name>
          <creative_file_link>http://demo.cakemarketing.com/creatives/12/1.jpg</creative_file_link>
          <preview>false</preview>
          <date_created>2012-01-07T10:03:37.303</date_created>
        </creative_file>
        <creative_file>
          <creative_file_id>122</creative_file_id>
          <creative_file_name>1.jpg</creative_file_name>
          <creative_file_link>http://demo.cakemarketing.com/creatives/12/1.jpg</creative_file_link>
          <preview>false</preview>
          <date_created>2012-01-07T10:03:37.303</date_created>
        </creative_file>
        <creative_file>
          <creative_file_id>123</creative_file_id>
          <creative_file_name>1.jpg</creative_file_name>
          <creative_file_link>http://demo.cakemarketing.com/creatives/12/1.jpg</creative_file_link>
          <preview>false</preview>
          <date_created>2012-01-07T10:03:37.303</date_created>
        </creative_file>
        <creative_file>
          <creative_file_id>124</creative_file_id>
          <creative_file_name>1.jpg</creative_file_name>
          <creative_file_link>http://demo.cakemarketing.com/creatives/12/1.jpg</creative_file_link>
          <preview>false</preview>
          <date_created>2012-01-07T10:03:37.303</date_created>
        </creative_file>
        <creative_file>
          <creative_file_id>125</creative_file_id>
          <creative_file_name>1.jpg</creative_file_name>
          <creative_file_link>http://demo.cakemarketing.com/creatives/12/1.jpg</creative_file_link>
          <preview>false</preview>
          <date_created>2012-01-07T10:03:37.303</date_created>
        </creative_file>
        <creative_file>
          <creative_file_id>126</creative_file_id>
          <creative_file_name>1.jpg</creative_file_name>
          <creative_file_link>http://demo.cakemarketing.com/creatives/12/1.jpg</creative_file_link>
          <preview>false</preview>
          <date_created>2012-01-07T10:03:37.303</date_created>
        </creative_file>
      </creative_files>
      <date_created>2011-05-13T00:00:00</date_created>
      <expiration_date xsi:nil="true"/>
      <notes/>
    </creative>
    <creative>
      <creative_id>13</creative_id>
      <creative_name>Sweet Creative</creative_name>
      <creative_type>
        <creative_type_id>2</creative_type_id>
        <creative_type_name>Email</creative_type_name>
      </creative_type>
      <creative_status>
        <creative_status_id>1</creative_status_id>
        <creative_status_name>Active</creative_status_name>
      </creative_status>
      <offer_link_override/>
      <width xsi:nil="true"/>
      <height xsi:nil="true"/>
      <creative_files>
        <creative_file>
          <creative_file_id>141</creative_file_id>
          <creative_file_name>1.jpg</creative_file_name>
          <creative_file_link>http://demo.cakemarketing.com/creatives/13/1.jpg</creative_file_link>
          <preview>false</preview>
          <date_created>2012-01-07T10:03:37.35</date_created>
        </creative_file>
        <creative_file>
          <creative_file_id>142</creative_file_id>
          <creative_file_name>1.jpg</creative_file_name>
          <creative_file_link>http://demo.cakemarketing.com/creatives/13/1.jpg</creative_file_link>
          <preview>false</preview>
          <date_created>2012-01-07T10:03:37.35</date_created>
        </creative_file>
        <creative_file>
          <creative_file_id>143</creative_file_id>
          <creative_file_name>1.jpg</creative_file_name>
          <creative_file_link>http://demo.cakemarketing.com/creatives/13/1.jpg</creative_file_link>
          <preview>false</preview>
          <date_created>2012-01-07T10:03:37.35</date_created>
        </creative_file>
        <creative_file>
          <creative_file_id>144</creative_file_id>
          <creative_file_name>1.jpg</creative_file_name>
          <creative_file_link>http://demo.cakemarketing.com/creatives/13/1.jpg</creative_file_link>
          <preview>false</preview>
          <date_created>2012-01-07T10:03:37.35</date_created>
        </creative_file>
        <creative_file>
          <creative_file_id>145</creative_file_id>
          <creative_file_name>1.jpg</creative_file_name>
          <creative_file_link>http://demo.cakemarketing.com/creatives/13/1.jpg</creative_file_link>
          <preview>false</preview>
          <date_created>2012-01-07T10:03:37.35</date_created>
        </creative_file>
        <creative_file>
          <creative_file_id>146</creative_file_id>
          <creative_file_name>1.jpg</creative_file_name>
          <creative_file_link>http://demo.cakemarketing.com/creatives/13/1.jpg</creative_file_link>
          <preview>false</preview>
          <date_created>2012-01-07T10:03:37.35</date_created>
        </creative_file>
        <creative_file>
          <creative_file_id>147</creative_file_id>
          <creative_file_name>1.jpg</creative_file_name>
          <creative_file_link>http://demo.cakemarketing.com/creatives/13/1.jpg</creative_file_link>
          <preview>false</preview>
          <date_created>2012-01-07T10:03:37.35</date_created>
        </creative_file>
        <creative_file>
          <creative_file_id>148</creative_file_id>
          <creative_file_name>1.jpg</creative_file_name>
          <creative_file_link>http://demo.cakemarketing.com/creatives/13/1.jpg</creative_file_link>
          <preview>false</preview>
          <date_created>2012-01-07T10:03:37.35</date_created>
        </creative_file>
      </creative_files>
      <date_created>2011-05-13T00:00:00</date_created>
      <expiration_date>2012-11-01T00:00:00</expiration_date>
      <notes/>
    </creative>
  </creatives>
</creative_export_response>

 

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.