If you have any question left, please drop a note with the discussion link of this page.
CreateCashbackReportJob
From Wiki.zanox.com
Contents |
Description
Use the method createCashbackReportJob to request a cashback report.
Input parameters
| Parameter | Description | Data Type | Possible Values | Comment |
|---|---|---|---|---|
| adspaceId |
zanox-internal ID of the ad space on which your cashback solution is implemented. | ns:adspaceId | zanox-internal numeric ID, e.g. 159236 |
If you have more than one ad space, you need to send a separate cashback report request for each of your ad spaces. |
| fromDate |
Report period start date (start date included) | ns:fromDate | Date format YYY-MM-DD |
|
| toDate |
Report period end date (end date included) | ns:toDate | Date format YYY-MM-DD |
|
| connectId |
Connect ID of the user who is requesting the report. | ns:connectId |
Alphanumeric string |
Included in the |
| timestamp |
Timestamp for the session. | ns:timestamp |
Timestamp using the format YYYY-MM-DDThh:mm:ss |
Included in the |
| nonce |
Nonce for the session. | ns:nonce |
Alphanumeric string |
Included in the |
| signature | Signature for the session. | ns:signature |
Alphanumeric string |
Included in the |
Example request
<soapenv:Envelope xmlns:ns="http://data.zanox.com/namespace/2010-08-12/" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Header/> <soapenv:Body> <ns:CreateCashbackReportJobRequest> <ns:adspaceId>159236</ns:adspaceId> <ns:fromDate>2011-02-01</ns:fromDate> <ns:toDate>2011-03-01</ns:toDate> <ns:connectId>0B262F6492E856204016</ns:connectId> <ns:timestamp>2011-03-01T13:35:53</ns:timestamp> <ns:nonce>879fcb70-c72a-4609-847a-2e57006f7385</ns:nonce> <ns:signature>RUV/DsU7EbtQiM1d5ODCPlKx3ZA=</ns:signature> </ns:CreateCashbackReportJobRequest> </soapenv:Body> </soapenv:Envelope>
Output parameters
| Parameter | Description | Data Type | Possible Values | Comment |
|---|---|---|---|---|
|
id |
Job ID of the report to be created |
jobItem |
Alphanumeric value |
|
|
type |
Type of job requested |
type |
report |
|
|
format |
Report format |
format |
csv |
|
|
compression |
Tool with which the report was compressed |
compression |
gzip |
|
|
status |
Report status |
status |
scheduled |
|
|
createDate |
Date when the report was requested |
createDate |
Date and time format yyyy-MM-ddTHH:mm:ss.000+Z |
|
|
availableInSeconds |
Time period in seconds when the report will be available for download, in relation to the create date. |
availableInSeconds |
Numeric string |
|
Example response
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <CreateCashbackReportJobResponse xmlns="http://data.zanox.com/namespace/2010-08-12/"> <jobItem id="2011030112-603-996915429"> <type>report</type> <format>csv</format> <compression>gzip</compression> <status>scheduled</status> <createDate>2011-03-01T14:35:57.922+01:00</createDate> <availableInSeconds>7742</availableInSeconds> </jobItem> </CreateCashbackReportJobResponse> </soap:Body> </soap:Envelope>
Report request restrictions
Please keep in mind the following restrictions when requesting a report:
1. Availability
Report data from the previous day is available from 9 a.m. the following day. You cannot request reports with a report period that lies in the future.
2. Frequency
The report data is updated once a day. You may request reports on a daily basis but no more than once a day.
Example process:
We recommend the following process: Check if updated report data is available at 9 a.m. If no updated data is available, check again on a two-hour basis until 1 p.m. If there is still no updated report data available, wait until 9 a.m. the following day and request two reports at a time.
3. Fault tolerance
The fault tolerance for unavailable report data is three working days. Please make sure you only contact zanox if you have not received updated report data in three consecutive days.