PRODUCT
Follow

Resource URL

Depending on the API user that was created for you, use one of the following URLs:

  • https://api.sizmek.com/rest/dco/feed/setting

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

Note

Note: Confirm with your customer success manager regarding the correct URL to use.

Objects Used by This Resource

The following objects are used by this endpoint:

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:

    • We recommend that for any PUT method that updates an object, 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.

    • 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 Sizmek fetches the feed.

Long

Required

Request Format

Depending on the API user that was created for you, use one of the following URLs:

  • GET https://api.sizmek.com/rest/dco/feed/setting/{id}

  • 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.

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

Depending on the API user that was created for you, use one of the following URLs:

  • POST https://api.sizmek.com/rest/dco/feed/setting/

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

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

Depending on the API user that was created for you, use one of the following URLs:

  • PUT https://api.sizmek.com/rest/dco/feed/setting/{id}

  • PUT 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 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.

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk