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

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

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/

Retrieves all versions of the ad.

GET

/dco/{id}

Retrieves a specific version of the ad.

PUT

/dco/{id}

Updates a specific version of the 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 all Ad Versions (GET)

Retrieves multiple versions of a specific ad. Can be filtered according to query parameters.

Request Query Parameters

NAME

DESCRIPTION

TYPE

REQUIRED

NOTES

from

Starting index by which to fetch new version (for paging purposes).

Long

Required

Getting multiple entities requires using from and max query parameters.

max

Maximum number of versions to fetch (for each page).

Long

Required

q

Filtering options for the request (see here).

String

Optional

Example of query string: q={"1":{"RECENT":["1519203216427-1526889216427"]},"2":{"NAME":["smith"]}}

Note

Note: The date is according to the Unix epoch timestamp.

order

Sort order ASC or DESC, required if sort field name is specified (see here).

String

Optional

Note

Note: Required if a sort field name is specified.

By default, the API response is ascending.

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?from=0&masterAdId=<AD_ID>&max=250&order=asc&sort=id

  • GET https://adapi.sizmek.com/sas/dco?from=0&masterAdId=<AD_ID>&max=250&order=asc&sort=id

Response Format

GET an Ad Version (GET)

Retrieves a specific ad version.

Request Parameters

NAME

DESCRIPTION

TYPE

REQUIRED

NOTES

ID

ID of the ad version.

Integer

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/<versionID>

  • GET https://adapi.sizmek.com/sas/dco/<versionID>

Response Format

A successful request returns the HTTP 200 OK status code and a JSON response body that shows the variable details. If there is no variable, the request returns an empty response.

Update an Existing Ad Version (PUT)

Request Parameters

NAME

DESCRIPTION

TYPE

REQUIRED

NOTES

ID

ID of the ad version.

Long

Required

Body

Request containing ad version 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

  • PUT https://adapi.sizmek.com/sas/dco

Response Format

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

Status Codes and Errors

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

CODE

STRING

DESCRIPTION

200 OK

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