Dynamic Creative Feed Resource – API Help Center

Resource URL

https://adapi.sizmek.com/sas/dco/feed/setting

Objects Used by This Resource

The following objects are used by this endpoint:

Dynamic Creative Feed Object

HTTP Method and URI List

HTTP METHOD	URI	DESCRIPTION
GET	/dco/feed/setting/{id}	Retrieves the existing feed settings of an ad.
POST	dco/feed/setting/	Create a new feed file for an ad.
PUT	dco/feed/setting/{id}	Updates the existing feed settings for an ad.

Method Examples and Request Parameters

Important

Important:

For PUT calls, do the following:
- For any PUT method that updates an object, make sure that you include the entire "result": object from the GET response in the request body. If there is missing information, even if it is read-only, the request might fail or override the existing fields with the new values.
- You must also change the "result": to "entities": and make the entities contents into an array. For example, here is the output from the GET request:
```
 { "result": { "type": "Advertiser", ... } }      
```
  You should make the following modifications, including your specific modifications, to the json object that you submit for the request.
```
 { "entities": [{ "type": "Advertiser", ... }] }   
```
For POST calls, do the following:
- Include the fields marked as Required, as indicated in the corresponding Object article.
- Format the JSON object as follows:
```
 { "entities": [{ "type": "Advertiser", ... }] }   
```

GET Existing Feed Settings (GET)

Retrieves the existing feed settings of an ad.

Request Parameters

NAME	DESCRIPTION	TYPE	REQUIRED	NOTES
ID	ID of the ad for which AAS fetches the feed.	Long	Required

Request Format

GET https://adapi.sizmek.com/sas/dco/feed/setting/{id}

Response Format

A successful request returns the HTTP 200 OK status code and a JSON response body that shows the specific feed settings for the ad.

{
        "metadata": null,
        "debug": null,
        "error": null,
        "result": {
                "type": "FeedSettings",
                "id": 1075178400,
                "relationsBag": null,
                "version": 1540291783634714624,
                "createdBy": 359567,
                "createdByName": "John Smith",
                "createdByAccount": 2,
                "createdByAccountName": "MyAccount",
                "createdOn": 1540291659527,
                "lastUpdatedBy": 359567,
                "lastUpdatedByName": "John Smith",
                "lastUpdatedByAccount": 2,
                "lastUpdatedByAccountName": "MyAccount",
                "lastUpdateOn": 1540291783620,
                "feedInputSetting": {
                        "type": "FeedInputSetting",
                        "feedInputType": "XML",
                        "feedTransferProtocol": "HTTP",
                        "url": "http://creative-dev-sizmdx.s3.amazonaws.com/moran/Regular.xml",
                        "assetId": null,
                        "assetName": null,
                        "username": null,
                        "password": null
                },
                "feedMappingSetting": {
                        "type": "FeedMappingSetting",
                        "feedFieldMappings": [{
                                "type": "GeneralFieldMapping",
                                "inputField": "ClickthroughURL",
                                "outputField": "ClickthroughURL"
                        }, {
                                "type": "GeneralFieldMapping",
                                "inputField": "ThirdPartyClickthroughURL",
                                "outputField": null
                        }, {
                                "type": "GeneralFieldMapping",
                                "inputField": "Name",
                                "outputField": "Name"
                        }, {
                                "type": "GeneralFieldMapping",
                                "inputField": "Preferred",
                                "outputField": "Preferred"
                        }, {
                                "type": "GeneralFieldMapping",
                                "inputField": "image3",
                                "outputField": null
                        }, {
                                "type": "GeneralFieldMapping",
                                "inputField": "text2",
                                "outputField": null
                        }, {
                                "type": "GeneralFieldMapping",
                                "inputField": "text1",
                                "outputField": null
                        }, {
                                "type": "GeneralFieldMapping",
                                "inputField": "Sheet1",
                                "outputField": null
                        }, {
                                "type": "GeneralFieldMapping",
                                "inputField": "UniqueID",
                                "outputField": null
                        }, {
                                "type": "GeneralFieldMapping",
                                "inputField": "Locktype",
                                "outputField": "LockType"
                        }, {
                                "type": "GeneralFieldMapping",
                                "inputField": "ThirdPartyImpressionURL",
                                "outputField": null
                        }, {
                                "type": "GeneralFieldMapping",
                                "inputField": "Active",
                                "outputField": null
                        }],
                        "uniqueFieldMapping": {
                                "type": "GeneralFieldMapping",
                                "inputField": "UniqueID",
                                "outputField": "ExternalId"
                        },
                        "autoMatch": false
                },
                "fetchInterval": 3600,
                "fetchStartTime": 1540289173337,
                "fetchEndTime": 1540375573337,
                "incrementalIngest": true,
                "nextFetchTime": 1540291783619,
                "prevFetchTime": 1540291659524,
                "active": true,
                "disableNewVersions": false,
                "disableUpdatedVersions": false,
                "accountId": 2,
                "executeOnce": true,
                "feedFilter": {
                        "type": "FeedFilter",
                        "conditionList": [],
                        "include": false
                },
                "sendEmailOnFeedUpdate": true,
                "recipientIds": [359567]
        }
}

Create a Feed File (POST)

Create a new feed file.

Request Parameters

NAME	DESCRIPTION	TYPE	REQUIRED	NOTES
Body	Request containing feed file settings to create.	JSON	Required

Request Format

POST https://adapi.sizmek.com/sas/dco/feed/setting/

{
        "entities": [{
                "type": "FeedSettings",
                "id": 1075178400,
                "relationsBag": null,
                "createdBy": null,
                "createdByName": null,
                "createdByAccount": null,
                "createdByAccountName": null,
                "createdOn": null,
                "lastUpdatedBy": null,
                "lastUpdatedByName": null,
                "lastUpdatedByAccount": null,
                "lastUpdatedByAccountName": null,
                "lastUpdateOn": null,
                "feedInputSetting": {
                        "type": "FeedInputSetting",
                        "feedInputType": "XML",
                        "feedTransferProtocol": "HTTP",
                        "url": "http://creative-dev-sizmdx.s3.amazonaws.com/moran/Regular.xml",
                        "assetId": null,
                        "assetName": null,
                        "username": null,
                        "password": null
                },
                "feedMappingSetting": {
                        "type": "FeedMappingSetting",
                        "feedFieldMappings": [{
                                "type": "GeneralFieldMapping",
                                "inputField": "ThirdPartyClickthroughURL",
                                "outputField": null
                        }, {
                                "type": "GeneralFieldMapping",
                                "inputField": "ClickthroughURL",
                                "outputField": "ClickthroughURL"
                        }, {
                                "type": "GeneralFieldMapping",
                                "inputField": "Name",
                                "outputField": "Name"
                        }, {
                                "type": "GeneralFieldMapping",
                                "inputField": "Preferred",
                                "outputField": "Preferred"
                        }, {
                                "type": "GeneralFieldMapping",
                                "inputField": "image3",
                                "outputField": null
                        }, {
                                "type": "GeneralFieldMapping",
                                "inputField": "text2",
                                "outputField": null
                        }, {
                                "type": "GeneralFieldMapping",
                                "inputField": "text1",
                                "outputField": null
                        }, {
                                "type": "GeneralFieldMapping",
                                "inputField": "Sheet1",
                                "outputField": null
                        }, {
                                "type": "GeneralFieldMapping",
                                "inputField": "UniqueID",
                                "outputField": null
                        }, {
                                "type": "GeneralFieldMapping",
                                "inputField": "Locktype",
                                "outputField": "LockType"
                        }, {
                                "type": "GeneralFieldMapping",
                                "inputField": "ThirdPartyImpressionURL",
                                "outputField": null
                        }, {
                                "type": "GeneralFieldMapping",
                                "inputField": "Active",
                                "outputField": null
                        }],
                        "uniqueFieldMapping": {
                                "type": "GeneralFieldMapping",
                                "inputField": "UniqueID",
                                "outputField": "ExternalId"
                        },
                        "autoMatch": false
                },
                "fetchInterval": 3600,
                "fetchStartTime": 1540289173337,
                "fetchEndTime": 1540375573337,
                "incrementalIngest": true,
                "nextFetchTime": null,
                "prevFetchTime": null,
                "active": true,
                "disableNewVersions": false,
                "disableUpdatedVersions": false,
                "accountId": 2,
                "executeOnce": true,
                "feedFilter": {
                        "type": "FeedFilter",
                        "conditionList": [],
                        "include": "false"
                },
                "sendEmailOnFeedUpdate": true,
                "recipientIds": [359567],
                "httpStatusCode": 200,
                "fetchIntervalFormated": 1
        }]
}

Response Format

A successful request returns the HTTP 200 OK status code and a JSON response body that shows the new Dynamic Creative Feed resource.

Update Feed Settings for an Ad (PUT)

Update an existing ad's feed settings.

Request Parameters

NAME	DESCRIPTION	TYPE	REQUIRED	NOTES
ID	ID of the ad.	Long	Required
Body	Request containing feed body to update.	JSON	Required

Request Format

PUT https://adapi.sizmek.com/sas/dco/feed/setting/{id}

{
        "entities": [{
                "type": "FeedSettings",
                "id": 1075178400,
                "relationsBag": null,
                "version": 1540297574516785300,
                "createdBy": 359567,
                "createdByName": "John Smith",
                "createdByAccount": 2,
                "createdByAccountName": "Training Account",
                "createdOn": 1540291659527,
                "lastUpdatedBy": 359567,
                "lastUpdatedByName": "John Smith",
                "lastUpdatedByAccount": 2,
                "lastUpdatedByAccountName": "Training Account",
                "lastUpdateOn": 1540297574507,
                "feedInputSetting": {
                        "type": "FeedInputSetting",
                        "feedInputType": "XML",
                        "feedTransferProtocol": "HTTP",
                        "url": "http://creative-dev-sizmdx.s3.amazonaws.com/moran/Regular.xml",
                        "assetId": null,
                        "assetName": null,
                        "username": "111",
                        "password": "1111"
                },
                "feedMappingSetting": {
                        "type": "FeedMappingSetting",
                        "feedFieldMappings": [{
                                "type": "GeneralFieldMapping",
                                "inputField": "ThirdPartyClickthroughURL",
                                "outputField": null
                        }, {
                                "type": "GeneralFieldMapping",
                                "inputField": "ClickthroughURL",
                                "outputField": "ClickthroughURL"
                        }, {
                                "type": "GeneralFieldMapping",
                                "inputField": "Name",
                                "outputField": "Name"
                        }, {
                                "type": "GeneralFieldMapping",
                                "inputField": "Preferred",
                                "outputField": null
                        }, {
                                "type": "GeneralFieldMapping",
                                "inputField": "image3",
                                "outputField": null
                        }, {
                                "type": "GeneralFieldMapping",
                                "inputField": "text2",
                                "outputField": null
                        }, {
                                "type": "GeneralFieldMapping",
                                "inputField": "text1",
                                "outputField": null
                        }, {
                                "type": "GeneralFieldMapping",
                                "inputField": "Sheet1",
                                "outputField": null
                        }, {
                                "type": "GeneralFieldMapping",
                                "inputField": "UniqueID",
                                "outputField": null
                        }, {
                                "type": "GeneralFieldMapping",
                                "inputField": "Locktype",
                                "outputField": "LockType"
                        }, {
                                "type": "GeneralFieldMapping",
                                "inputField": "ThirdPartyImpressionURL",
                                "outputField": null
                        }, {
                                "type": "GeneralFieldMapping",
                                "inputField": "Active",
                                "outputField": null
                        }],
                        "uniqueFieldMapping": {
                                "type": "GeneralFieldMapping",
                                "inputField": "UniqueID",
                                "outputField": "ExternalId"
                        },
                        "autoMatch": false
                },
                "fetchInterval": 3600,
                "fetchStartTime": 1540289173337,
                "fetchEndTime": 1540375573337,
                "incrementalIngest": true,
                "nextFetchTime": 1540297574507,
                "prevFetchTime": 1540291659524,
                "active": true,
                "disableNewVersions": false,
                "disableUpdatedVersions": false,
                "accountId": 2,
                "executeOnce": true,
                "feedFilter": {
                        "type": "FeedFilter",
                        "conditionList": [],
                        "include": "false"
                },
                "sendEmailOnFeedUpdate": true,
                "recipientIds": [359567],
                "httpStatusCode": 200,
                "intervalType": "Hours",
                "fetchIntervalFormated": 1
        }]
}

Response Format

A successful request returns the HTTP 200 OK status code and a JSON response body that shows the updated Dynamic Creative Feed resource.

Status Codes and Errors

The following table lists the possible HTTP status codes in responses.

CODE	STRING	DESCRIPTION
200OK	Success	Successful API execution
500	Internal Error	Internal Server Errors

Internal Server Errors

The following shows an example of an internal server error in a response body.

{
    "metadata": null,
    "debug": null,
    "error": [{
        "type": "APIErrorCollection",
        "id": null,
        "clientRefId": null,
        "errors": [{
            "code": 61114,
            "innerMessage": "Feed must have URL or Asset ID. master ad 1086002174.",
            "propertyPath": null,
            "value": null,
            "entity": null,
            "params": [
                "1086002100"
            ]
        }]
    }],
    "result": null

The following table lists the possible internal server errors for the <NAME> resource.

INTERNAL CODE	STRING	DESCRIPTION
60003	Feed already in progress [%s]
60004	Feed url %s cannot be read. ad id %s. error %s
60007	Feed unique id must be defined for master ad %s.
60008	Feed job %s cannot be published.
60009	Feed input url %s is not valid url. Must start with http , https or ftp.
61114	Feed must have URL or Asset ID. master ad %s.
61115	XML file must declare utf-8 encoding or no encoding at all and will be treated as utf-8.
61116	The feed input file mapping contains duplicate key.
61121	Please map at least one data matching parameter.
61122	Please include at least one feed settings rule.

Resource URL

Objects Used by This Resource

HTTP Method and URI List

Method Examples and Request Parameters

Important

GET Existing Feed Settings (GET)

Request Parameters

Request Format

Response Format

Create a Feed File (POST)

Request Parameters

Request Format

Response Format

Update Feed Settings for an Ad (PUT)

Request Parameters

Request Format

Response Format

Status Codes and Errors

Internal Server Errors

Comments