PRODUCT
Follow

Overview

You can use the advertiser resource to retrieve an advertiser or a set of advertisers, create a new advertiser, update an existing advertiser, or delete an advertiser.

Resource URL

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

  • https://api.sizmek.com/rest/advertisers

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

Note

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

Objects Used by This Resource

HTTP Method and URI List

HTTP Method

URI

Description

GET

/advertisers/

Retrieves multiple advertisers.

GET

/advertisers/{id}

Retrieves an existing advertiser.

POST

/advertisers/

Creates a new advertiser.

PUT

/advertisers/{id}

Updates an existing advertiser.

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 Multiple Advertisers (GET)

Retrieves multiple advertisers. Can be filtered according to query parameters.

Request Query Parameters

Name

Description

Type

Required

Notes

from

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

Long

Required

Getting multiple entities requires using from and max query parameters.

max

Maximum number of advertisers 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.

accountID

ID of account from which to fetch all advertisers.

Long

Optional

sort

Sort by field name (see here).

String

Optional

permissionNames

Name of the permission to filter.

String

Optional

enrichLocalAdvertiserWithAccess

Enrich with local advertisers access.

String

Optional

globalStatus

Filter advertisers according to global status.

String

Optional

Request Format

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

  • GET https://api.sizmek.com/rest/advertisers?from=0&max=250

  • GET https://adapi.sizmek.com/sas/advertisers?from=0&max=250

Response Format

A successful request returns the HTTP 200 OK status code and a JSON response body that shows the advertiser details. The metadata object specifies the total number of advertisers.

Get an Advertiser (GET)

Retrieves a specific advertiser.

Request Parameters

Name

Description

Type

Required

Notes

ID

ID of advertiser to fetch.

Long

Required

Request Format

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

  • GET https://api.sizmek.com/rest/advertisers/{id}

  • GET https://adapi.sizmek.com/sas/advertisers/{id}

Response Format

A successful request returns the HTTP 200 OK status code and a JSON response body that shows the specific advertiser's details.

Create an Advertiser (POST)

Create a new advertiser.

Request Parameters

Name

Description

Type

Required

Notes

Body

Request containing advertiser body to create.

JSON

Required

Request Format

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

  • POST https://api.sizmek.com/rest/advertisers/

  • POST https://adapi.sizmek.com/sas/advertisers/

Response Format

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

Update an Existing Advertiser (PUT)

Updates an existing advertiser.

Request Parameters

Name

Description

Type

Required

Notes

ID

ID of advertiser

Long

Required

Body

Request containing advertiser body to update.

JSON

Required

Request Format

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

  • PUT https://api.sizmek.com/rest/advertisers/{ID}

  • PUT https://adapi.sizmek.com/sas/advertisers/{ID}

Response Format

A successful request returns the HTTP 200 OK status code and a JSON response body that shows the updated advertiser's details.

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.

The following table lists the possible internal server errors for the advertiser resource.

internal code

string

Description

60203

Field 'impressionValidUpTo' is required/not allowed for this model.

  • The 'impressionValidUpTo' field is required for this conversion attribution model.

  • This conversion attribution model does not support the 'impressionValidUpTo' field.

60204

Fields 'resetOn' and 'customEventsNumber' is required/not allowed for this model.

  • The 'resetOn' and 'customEventsNumber' fields are required for this conversion attribution model.

  • This conversion attribution model does not support the 'resetOn' and 'customEventsNumber' fields.

60205

Field 'resetOn' should be at the max 1 year/minimum 1 day from today based on the advertiser timezone

  • The 'resetOn' field should be set to a minimum of 1 day from the current date (based on the advertiser's time zone).

  • The 'resetOn' field should be set to a maximum of 1 year from the current date (based on the advertiser's time zone).

60206

Additional Conversion Attribution Settings is not allowed without default.

Additional conversion attribution settings are not allowed without a default set of attribution settings.

60207

Additional Conversion Attribution Settings allowed only {amount}.

Only {amount} additional conversion attribution settings are allowed.

60208

Additional Conversion Attribution Settings duplicate values are not allowed.

Duplicate values for conversion attribution settings are not allowed.

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

Comments

Powered by Zendesk