Submit a request
PRODUCT
Privacy Policy  |  Terms of Use
Follow
Last Update:
  viewable by end users
  editable by agents

Overview

You can use the delivery group resource to retrieve a a set of delivery groups or a delivery group attached to a specific placement, create a new delivery group, modify a delivery group, replace an existing delivery group, enable/disable a placement, or detach a delivery group from a placement.

Resource URL

https://adapi.sizmek.com/sas/deliveryGroups/

Objects Used by This Resource

HTTP Method and URI List

HTTP Method

URI

Description

GET

/deliveryGroups/

Retrieves a set of delivery groups.

GET

/deliveryGroups/placement/{id}

Retrieves delivery groups attached to a specific placement.

GET

/deliveryGroups/{id}

Retrieves an existing delivery group.

PUT

/deliveryGroups/swapDeliveryGroups

Replaces an existing delivery group.

PUT

/deliveryGroups/

Modifies a delivery group.

PUT

  • /deliveryGroups/simpleAttachment

  • /deliveryGroups/advancedAttachment

Attaches an ad or a delivery group to a placement.

PUT

  • /deliveryGroups/simpleDetach/

  • /deliveryGroups/partialDetachPlacementsFromDeliveryGroups

Detaches a delivery group from a placement.

PUT

/deliveryGroups/enableDisable

Enables/disables a delivery group.

POST

/deliveryGroups/

Creates a new delivery group.

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 Delivery Groups (GET)

Retrieves multiple delivery groups. Can be filtered according to query parameters.

Request Parameters

Name

Description

Type

Required

Notes

from

Starting index by which to fetch new campaigns for paging purposes.

Long

Required

Getting multiple entities requires using from and max query parameters.

max

Maximum number of campaigns to fetch for each page.

Long

Required

q

Filtering options for the request (see here).

String

Optional

Example of query string: q={"1":{"CREATEDBYNAME":["MonicaSmith"]},"2":{"ADVERTISERNAME":["autoads"]}}

Note

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

View values

NAME

DESCRIPTION

TYPE

NAME

Name of delivery group.

String

ID

ID of delivery group.

Long

TYPE

Type of delivery group.

Long

DIMENSIONS

Dimensions of delivery group.

String

ROTATIONMETHOD

Rotation method of delivery group.

String

ATTACHED

Number of attached placements.

Long

CREATEDBYNAME

Name of the user that created the delivery group.

String

UPDATEDBYNAME

Name of the user that was last to update the delivery group.

String

CREATEDON

Date delivery group was created.

Long

UPDATEDON

Date of last update (Date epoch).

Long

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.

sort

Sort by field name (see here).

String

Optional

campaignID

Campaign IDs from which to retrieve delivery groups.

Long

Optional

Request Format

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

Response Format

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

Example
{
    "result": [
        {
            "type": "DeliveryGroup",
            "id": 1073906228,
            "relationsBag": {
                "parents": {
                    "account": {
                        "id": 97183,
                        "name": "SanityAccount",
                        "internal": false
                    },
                    "advertiser": {
                        "id": 121373,
                        "name": "SanityAdvertiser"
                    },
                    "brand": {
                        "id": 1073759390,
                        "name": "SanityAdvertiser"
                    },
                    "campaign": {
                        "id": 1073875407,
                        "name": "Campaign March 2018"
                    },
                    "site": null
                },
                "children": {
                    "advertisers": {
                        "count": 0
                    },
                    "brands": {
                        "count": 0
                    },
                    "campaigns": {
                        "count": 0
                    },
                    "users": {
                        "count": 0
                    }
                },
                "creativeAccountContact": false
            },
            "version": 1520772541491904512,
            "createdBy": 457575,
            "createdByName": "QaAdminUserTest",
            "createdByAccount": 2,
            "createdByAccountName": "QaAdminAccountTest",
            "createdOn": 1520767331154,
            "lastUpdatedBy": 457575,
            "lastUpdatedByName": "QaAdminUserTest",
            "lastUpdatedByAccount": 2,
            "lastUpdatedByAccountName": "QaAdminAccountTest",
            "lastUpdateOn": 1520772541489,
            "name": "Delivery_Group1074227147",
            "subContainers": null,
            "placementType": "IN_BANNER",
            "width": null,
            "height": null,
            "rootContainer": {
                "type": "RootContainer",
                "id": null,
                "relationsBag": null,
                "version": null,
                "childRotationType": "EvenDistribution",
                "subContainers": [
                    {
                        "type": "DeliveryGroupAd",
                        "id": 1073905474,
                        "rotationSetting": {
                            "type": "EvenDistribution",
                            "enabled": true,
                            "rotationType": "EvenDistribution",
                            "weight": 100
                        },
                        "masterAdId": 1074819059,
                        "name": "EH_300x50-EN-prg",
                        "adName": "EH_300x50-EN-prg"
                    }
                ],
                "childOptimizationMetric": null,
                "childConversionTagId": null,
                "childConversionTagName": null
            },
            "timeZone": 0,
            "servingSetting": {
                "type": "APIServingSetting",
                "impressionsPerUser": -1,
                "impressionsPerDay": -1,
                "timeBetweenAds": -1,
                "frequencyCappingLevel": false,
                "serveDefaultImage": true
            },
            "rotationAds": null,
            "placements": [
                "1074227147"
            ],
            "defaultAds": [
            ],
            "campaignId": 1073875407,
            "campaignName": null,
            "targetAudiencePriority": null,
            "targetAudienceId": null,
            "targetingTypeId": -1,
            "geoTargetingTypeId": -1,
            "geoTargetingCountryId": -1,
            "aosCrossPlacement": 0,
            "aoMethodTypeId": -1,
            "gmt": -1,
            "hideDisableAds": false,
            "targetAudienceName": null,
            "strategyId": null,
            "strategyName": null,
            "automaticOptimization": false,
            "published": true,
            "sequenceLevelCrossPlacementSupport": true,
            "aoMethodType": -1
        },
        {
            "type": "DeliveryGroup",
            "id": 1073906227,
            "relationsBag": {
                "parents": {
                    "account": {
                        "id": 97195,
                        "name": "SanityAccount",
                        "internal": false
                    },
                    "advertiser": {
                        "id": 121374,
                        "name": "SanityAdvertiser"
                    },
                    "brand": {
                        "id": 1073759391,
                        "name": "SanityAdvertiser"
                    },
                    "campaign": {
                        "id": 1073875407,
                        "name": "Campaign March 2018"
                    },
                    "site": null
                },
                "children": {
                    "advertisers": {
                        "count": 0
                    },
                    "brands": {
                        "count": 0
                    },
                    "campaigns": {
                        "count": 0
                    },
                    "users": {
                        "count": 0
                    }
                },
                "creativeAccountContact": false
            },
          
            "version": 1520772541484105728,
            "createdBy": 457575,
            "createdByName": "QaAdminUserTest",
            "createdByAccount": 2,
            "createdByAccountName": "QaAdminAccountTest",
            "createdOn": 1520767324794,
            "lastUpdatedBy": 457575,
            "lastUpdatedByName": "QaAdminUserTest",
            "lastUpdatedByAccount": 2,
            "lastUpdatedByAccountName": "QaAdminAccountTest",
            "lastUpdateOn": 1520772541481,
            "name": "Delivery_Group1074227146",
            "subContainers": null,
            "placementType": "IN_BANNER",
            "width": null,
            "height": null,
            "rootContainer": {
                "type": "RootContainer",
                "id": null,
                "relationsBag": null,
                "version": null,
                "childRotationType": "EvenDistribution",
                "subContainers": [
                    {
                        "type": "DeliveryGroupAd",
                        "id": 1073905473,
                        "rotationSetting": {
                            "type": "EvenDistribution",
                            "enabled": true,
                            "rotationType": "EvenDistribution",
                            "weight": 100
                        },
                        "masterAdId": 1074819063,
                        "name": "EH_300x50-AR-prg",
                        "adName": "EH_300x50-AR-prg"
                    }
                ],
                "childOptimizationMetric": null,
                "childConversionTagId": null,
                "childConversionTagName": null
            },
            "timeZone": 0,
            "servingSetting": {
                "type": "APIServingSetting",
                "impressionsPerUser": -1,
                "impressionsPerDay": -1,
                "timeBetweenAds": -1,
                "frequencyCappingLevel": false,
                "serveDefaultImage": true
            },
            "rotationAds": null,
            "placements": [
                "1074227146"
            ],
            "defaultAds": [
            ],
            "campaignId": 1073875407,
            "campaignName": null,
            "targetAudiencePriority": null,
            "targetAudienceId": null,
            "targetingTypeId": -1,
            "geoTargetingTypeId": -1,
            "geoTargetingCountryId": -1,
            "aosCrossPlacement": 0,
            "aoMethodTypeId": -1,
            "gmt": -1,
            "hideDisableAds": false,
            "targetAudienceName": null,
            "strategyId": null,
            "strategyName": null,
            "automaticOptimization": false,
            "published": true,
            "sequenceLevelCrossPlacementSupport": true,
            "aoMethodType": -1
        },
        {
            "type": "DeliveryGroup",
            "id": 1073906226,
            "relationsBag": {
                "parents": {
                    "account": {
                        "id": 97195,
                        "name": "SanityAccount",
                        "internal": false
                    },
                    "advertiser": {
                        "id": 121374,
                        "name": "SanityAdvertiser"
                    },
                    "brand": {
                        "id": 1073759391,
                        "name": "SanityAdvertiser"
                    },
                    "campaign": {
                        "id": 1073875407,
                        "name": "Campaign March 2018"
                    },
                    "site": null
                },
                "children": {
                    "advertisers": {
                        "count": 0
                    },
                    "brands": {
                        "count": 0
                    },
                    "campaigns": {
                        "count": 0
                    },
                    "users": {
                        "count": 0
                    }
                },
                "creativeAccountContact": false
            },
           
            "version": 1520772541484761088,
            "createdBy": 457575,
            "createdByName": "QaAdminUserTest",
            "createdByAccount": 2,
            "createdByAccountName": "QaAdminAccountTest",
            "createdOn": 1520767300226,
            "lastUpdatedBy": 457575,
            "lastUpdatedByName": "QaAdminUserTest",
            "lastUpdatedByAccount": 2,
            "lastUpdatedByAccountName": "QaAdminAccountTest",
            "lastUpdateOn": 1520772541483,
            "name": "Delivery_Group1074227151",
            "subContainers": null,
            "placementType": "IN_BANNER",
            "width": null,
            "height": null,
            "rootContainer": {
                "type": "RootContainer",
                "id": null,
                "relationsBag": null,
                "version": null,
                "childRotationType": "EvenDistribution",
                "subContainers": [
                    {
                        "type": "DeliveryGroupAd",
                        "id": 1073905472,
                        "rotationSetting": {
                            "type": "EvenDistribution",
                            "enabled": true,
                            "rotationType": "EvenDistribution",
                            "weight": 100
                        },
                        "masterAdId": 1074819066,
                        "name": "EH_300x600-EN-prg",
                        "adName": "EH_300x600-EN-prg"
                    }
                ],
                "childOptimizationMetric": null,
                "childConversionTagId": null,
                "childConversionTagName": null
            },
            "timeZone": 0,
            "servingSetting": {
                "type": "APIServingSetting",
                "impressionsPerUser": -1,
                "impressionsPerDay": -1,
                "timeBetweenAds": -1,
                "frequencyCappingLevel": false,
                "serveDefaultImage": true
            },
            "rotationAds": null,
            "placements": [
                "1074227121"
            ],
            "defaultAds": [
            ],
            "campaignId": 1073875483,
            "campaignName": null,
            "targetAudiencePriority": null,
            "targetAudienceId": null,
            "targetingTypeId": -1,
            "geoTargetingTypeId": -1,
            "geoTargetingCountryId": -1,
            "aosCrossPlacement": 0,
            "aoMethodTypeId": -1,
            "gmt": -1,
            "hideDisableAds": false,
            "targetAudienceName": null,
            "strategyId": null,
            "strategyName": null,
            "automaticOptimization": false,
            "published": true,
            "sequenceLevelCrossPlacementSupport": true,
            "aoMethodType": -1
        }
    ]
}

Get Delivery Groups Attached to a Placement (GET)

Retrieves all delivery groups attached to a specific placement.

Request Parameters

NAME

DESCRIPTION

TYPE

REQUIRED

NOTES

ID

Placement ID

Long

Required

Request Format

GET https://adapi.sizmek.com/sas/deliveryGroups/placement/1234567890

Response Format

A successful request returns the HTTP 200 OK status code and a JSON response body that shows the delivery group details for the specific placement.

Example
{
    "entities": [
        {
            "type": "DeliveryGroup",
            "id": 1083808884,
            "relationsBag": {
                "parents": {
                    "account": {
                        "id": 1083742414,
                        "name": "SanityAccount",
                        "internal": false
                    },
                    "advertiser": {
                        "id": 1083743993,
                        "name": "01Adv0702"
                    },
                    "brand": {
                        "id": 1083745907,
                        "name": "01Adv0702"
                    },
                    "campaign": {
                        "id": 1083754341,
                        "name": "01Cmp0702"
                    },
                    "site": null
                },
                "children": {
                    "advertisers": {
                        "count": 0
                    },
                    "brands": {
                        "count": 0
                    },
                    "campaigns": {
                        "count": 0
                    },
                    "users": {
                        "count": 0
                    }
                },
                "creativeAccountContact": false
            },
            "version": 1518711102642323456,
            "createdBy": 1073741831,
            "createdByName": "QaAdminUser",
            "createdByAccount": 1073741826,
            "createdByAccountName": "QaAdminAccount",
            "createdOn": 1517983609569,
            "lastUpdatedBy": 1073741831,
            "lastUpdatedByName": "QaAdminUser",
            "lastUpdatedByAccount": 1073741826,
            "lastUpdatedByAccountName": "QaAdminAccount",
            "lastUpdateOn": 1518711102640,
            "name": "Delivery_Group1083798632",
            "subContainers": null,
            "placementType": "IN_BANNER",
            "width": null,
            "height": null,
            "rootContainer": {
                "type": "RootContainer",
                "id": null,
                "relationsBag": null,
                "version": null,
                "childRotationType": "EvenDistribution",
                "subContainers": [
                    {
                        "type": "DeliveryGroupAd",
                        "id": 1083814774,
                        "rotationSetting": {
                            "type": "EvenDistribution",
                            "enabled": true,
                            "rotationType": "EvenDistribution",
                            "weight": 50
                        },
                        "masterAdId": 1084016573,
                        "name": "01ad0702",
                        "adName": "01ad0702"
                    },
                    {
                        "type": "DeliveryGroupAd",
                        "id": 1083814805,
                        "rotationSetting": {
                            "type": "EvenDistribution",
                            "enabled": true,
                            "rotationType": "EvenDistribution",
                            "weight": 50
                        },
                        "masterAdId": 1084016589,
                        "name": "02Ad For DCO",
                        "adName": "02Ad For DCO"
                    }
                ],
                "childOptimizationMetric": null,
                "childConversionTagId": null,
                "childConversionTagName": null
            },
            "timeZone": 0,
            "servingSetting": {
                "type": "APIServingSetting",
                "impressionsPerUser": -1,
                "impressionsPerDay": -1,
                "timeBetweenAds": -1,
                "frequencyCappingLevel": false,
                "serveDefaultImage": true
            },
            "rotationAds": null,
            "placements": [
                "1083798632"
            ],
            "defaultAds": [
            ],
            "campaignId": 1083754341,
            "campaignName": null,
            "targetAudiencePriority": null,
            "targetAudienceId": null,
            "targetingTypeId": -1,
            "geoTargetingTypeId": -1,
            "geoTargetingCountryId": -1,
            "aosCrossPlacement": 0,
            "aoMethodTypeId": -1,
            "gmt": -1,
            "hideDisableAds": false,
            "targetAudienceName": null,
            "strategyId": null,
            "strategyName": null,
            "automaticOptimization": false,
            "sequenceLevelCrossPlacementSupport": true,
            "aoMethodType": -1,
            "published": true
        }
    ]
}

Get an Existing Delivery Group (GET)

Retrieves an existing delivery group.

Request Parameters

NAME

DESCRIPTION

TYPE

REQUIRED

NOTES

ID

Delivery group ID.

Long

Required

Request Format

GET https://adapi.sizmek.com/sas/rest/deliveryGroups/1234567890

Response Format

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

Example
{
    "entities": {
        "type": "DeliveryGroup",
        "id": 1083808884,
        "relationsBag": {
            "parents": {
                "account": {
                    "id": 1083742414,
                    "name": "SanityAccount",
                    "internal": false
                },
                "advertiser": {
                    "id": 1083743993,
                    "name": "01Adv0702"
                },
                "brand": {
                    "id": 1083745907,
                    "name": "01Adv0702"
                },
                "campaign": {
                    "id": 1083754341,
                    "name": "01Cmp0702"
                },
                "site": null
            },
            "children": {
                "advertisers": {
                    "count": 0
                },
                "brands": {
                    "count": 0
                },
                "campaigns": {
                    "count": 0
                },
                "users": {
                    "count": 0
                }
            },
            "creativeAccountContact": false
        },
        "version": 1518711102642323456,
        "createdBy": 1073741831,
        "createdByName": "QaAdminUser",
        "createdByAccount": 1073741826,
        "createdByAccountName": "QaAdminAccount",
        "createdOn": 1517983609569,
        "lastUpdatedBy": 1073741831,
        "lastUpdatedByName": "QaAdminUser",
        "lastUpdatedByAccount": 1073741826,
        "lastUpdatedByAccountName": "QaAdminAccount",
        "lastUpdateOn": 1518711102640,
        "name": "Delivery_Group1083798632",
        "subContainers": null,
        "placementType": "IN_BANNER",
        "width": null,
        "height": null,
        "rootContainer": {
            "type": "RootContainer",
            "id": null,
            "relationsBag": null,
            "version": null,
            "childRotationType": "EvenDistribution",
            "subContainers": [
                {
                    "type": "DeliveryGroupAd",
                    "id": 1083814774,
                    "rotationSetting": {
                        "type": "EvenDistribution",
                        "enabled": true,
                        "rotationType": "EvenDistribution",
                        "weight": 50
                    },
                    "masterAdId": 1084016573,
                    "name": "01ad0702",
                    "adName": "01ad0702"
                },
                {
                    "type": "DeliveryGroupAd",
                    "id": 1083814805,
                    "rotationSetting": {
                        "type": "EvenDistribution",
                        "enabled": true,
                        "rotationType": "EvenDistribution",
                        "weight": 50
                    },
                    "masterAdId": 1084016589,
                    "name": "02Ad For DCO",
                    "adName": "02Ad For DCO"
                }
            ],
            "childOptimizationMetric": null,
            "childConversionTagId": null,
            "childConversionTagName": null
        },
        "timeZone": 0,
        "servingSetting": {
            "type": "APIServingSetting",
            "impressionsPerUser": -1,
            "impressionsPerDay": -1,
            "timeBetweenAds": -1,
            "frequencyCappingLevel": false,
            "serveDefaultImage": true
        },
        "rotationAds": null,
        "placements": [
            "1083798632"
        ],
        "defaultAds": [
        ],
        "campaignId": 1083754341,
        "campaignName": null,
        "targetAudiencePriority": null,
        "targetAudienceId": null,
        "targetingTypeId": -1,
        "geoTargetingTypeId": -1,
        "geoTargetingCountryId": -1,
        "aosCrossPlacement": 0,
        "aoMethodTypeId": -1,
        "gmt": -1,
        "hideDisableAds": false,
        "targetAudienceName": null,
        "strategyId": null,
        "strategyName": null,
        "automaticOptimization": false,
        "sequenceLevelCrossPlacementSupport": true,
        "aoMethodType": -1,
        "published": true
    }
}

Replace an Existing Delivery Group (PUT)

Replaces an existing delivery group that is attached to a placement.

Request Parameters

Name

Description

Type

Required

Notes

Body

Request containing delivery group to replace.

JSON

Required

Request Format

PUT https://adapi.sizmek.com/sas/deliveryGroups/swapDeliveryGroups

Example
{"entities": [{"deliveryGroupCandidateIds":[1073742219,1073742223],"placementIds":[1073748384,1073748386],"newDeliveryGroupId":1073742225,"campaignId":1073741901}]}

Response Format

A successful request returns the HTTP 200 OK status code, and a JSON response body that shows the new delivery group's details.

Update an Existing Delivery Group (PUT)

Modifies an existing delivery group.

Request Parameters

NAME

DESCRIPTION

TYPE

REQUIRED

NOTES

id

ID of the delivery group.

Long

Required

Body

Request containing delivery group to replace.

JSON

Required

Request Format

PUT https://adapi.sizmek.com/sas/deliveryGroups/

Example
{
  "entities": [
    {
      "type": "DeliveryGroup",
      "id": 1073742087,
      "relationsBag": {
        "parents": {
          "account": {
            "id": 1073741827,
            "name": "SanityAccount",
            "internal": true
          },
          "advertiser": {
            "id": 1073741825,
            "name": "SanityAdvertiser"
          },
          "brand": {
            "id": 1073741826,
            "name": "SanityBrand"
          },
          "campaign": {
            "id": 1073741826,
            "name": "SanityAdvanceCampaign"
          },
          "site": null
        },
        "children": {
          "advertisers": {
            "count": 0
          },
          "brands": {
            "count": 0
          },
          "campaigns": {
            "count": 0
          },
          "users": {
            "count": 0
          }
        },
        "creativeAccountContact": false
      },
      "version": 1516691396796219400,
      "createdBy": 1073741831,
      "createdByName": "QaAdminUser",
      "createdByAccount": 1073741826,
      "createdByAccountName": "QaAdminAccount",
      "createdOn": 1516691396799,
      "lastUpdatedBy": 1073741831,
      "lastUpdatedByName": "QaAdminUser",
      "lastUpdatedByAccount": 1073741826,
      "lastUpdatedByAccountName": "QaAdminAccount",
      "lastUpdateOn": 1516691396799,
      "name": "DeliveryGroupGxdd33JG",
      "subContainers": null,
      "placementType": null,
      "width": null,
      "height": null,
      "rootContainer": {
        "type": "RootContainer",
        "id": null,
        "relationsBag": null,
        "version": null,
        "childRotationType": "EvenDistribution",
        "subContainers": [
          {
            "type": "DeliveryGroupAd",
            "id": null,
            "rotationSetting": {
              "type": "EvenDistribution",
              "enabled": true,
              "rotationType": "EvenDistribution",
              "weight": 33.33
            },
            "masterAdId": 1073758286,
            "name": "AutomationAPIDeliveryGroupAd",
            "adName": null
          },
          {
            "type": "AdContainer",
            "id": null,
            "rotationSetting": {
              "type": "EvenDistribution",
              "enabled": true,
              "rotationType": "EvenDistribution",
              "weight": 33.33
            },
            "name": "AutomationAPIDeliveryGroupAd",
            "childRotationType": "Weighted",
            "subContainers": [
              {
                "type": "DeliveryGroupAd",
                "id": null,
                "rotationSetting": {
                  "type": "Weighted",
                  "enabled": true,
                  "rotationType": "Weighted",
                  "weight": 60
                },
                "masterAdId": 1073758286,
                "name": null,
                "adName": null
              },
              {
                "type": "DeliveryGroupAd",
                "id": null,
                "rotationSetting": {
                  "type": "Weighted",
                  "enabled": true,
                  "rotationType": "Weighted",
                  "weight": 20
                },
                "masterAdId": 1073758301,
                "name": null,
                "adName": null
              },
              {
                "type": "DeliveryGroupAd",
                "id": null,
                "rotationSetting": {
                  "type": "Weighted",
                  "enabled": true,
                  "rotationType": "Weighted",
                  "weight": 20
                },
                "masterAdId": 1073758301,
                "name": null,
                "adName": null
              }
            ],
            "childOptimizationMetric": null
          },
          {
            "type": "AdContainer",
            "id": null,
            "rotationSetting": {
              "type": "EvenDistribution",
              "enabled": true,
              "rotationType": "EvenDistribution",
              "weight": 33.33
            },
            "name": "AutomationAPIDeliveryGroupAd",
            "childRotationType": "Weighted",
            "subContainers": [
              {
                "type": "DeliveryGroupAd",
                "id": null,
                "rotationSetting": {
                  "type": "Weighted",
                  "enabled": true,
                  "rotationType": "Weighted",
                  "weight": 60
                },
                "masterAdId": 1073758286,
                "name": null,
                "adName": null
              },
              {
                "type": "DeliveryGroupAd",
                "id": null,
                "rotationSetting": {
                  "type": "Weighted",
                  "enabled": true,
                  "rotationType": "Weighted",
                  "weight": 40
                },
                "masterAdId": 1073758294,
                "name": null,
                "adName": null
              }
            ],
            "childOptimizationMetric": null
          }
        ],
        "childOptimizationMetric": null,
        "childConversionTagId": null,
        "childConversionTagName": null
      },
      "timeZone": -2017946709,
      "servingSetting": {
        "type": "APIServingSetting",
        "impressionsPerUser": 5,
        "impressionsPerDay": 37,
        "timeBetweenAds": 8,
        "frequencyCappingLevel": true,
        "serveDefaultImage": true
      },
      "rotationAds": null,
      "placements": [],
      "defaultAds": [],
      "campaignId": 1073741826,
      "campaignName": null,
      "targetAudiencePriority": null,
      "targetAudienceId": null,
      "targetingTypeId": 0,
      "geoTargetingTypeId": -1,
      "geoTargetingCountryId": -1,
      "aosCrossPlacement": 1,
      "aoMethodTypeId": -1,
      "gmt": -1,
      "hideDisableAds": false,
      "targetAudienceName": null,
      "strategyId": null,
      "strategyName": null,
      "automaticOptimization": false,
      "published": false,
      "sequenceLevelCrossPlacementSupport": true,
      "aoMethodType": -1
    }
  ]
}

Attach an Ad or Delivery Group to a Placement (PUT)

There are two types of API calls for attachment:

  • Simple: Attaches placements to ads without using delivery groups. Use this flow when you have single ads in each placement, or when you have multiple ads that can be rotated evenly.

  • Advanced: Attaches placements to delivery groups. Use this flow when attaching multiple ads to placements and setting up rotation settings. This option is mandatory when using targeting or retargeting features.

Request Parameters for Simple Attach

Name

Description

Type

Required

Notes

type

Read-only

SimpleAttachmentDataContainer

campaignId

ID of campaign on which you are working.

Long

Required

simpleAttachmentDataList

List that includes the  placement and ad to attach.

Object

Required

type

Read-only

simpleAttachmentData

placementId

ID of the placement.

Long

Required

adIds

IDs of the ads to attach.

Long

Required

enableAds

Indicates whether the ad is enabled or disabled (for serving purposes).

Boolean

Required

Request Parameters for Advanced Attach

Name

Description

Type

Required

Notes

type

Read-only

AdvancedAttachmentDataContainer

advancedAttachmentDataList

List that includes the delivery group and placements to attach.

Object

Required

type

Read-only

AdvancedAttachmentData

deliveryGroupId

ID of the delivery group to which to attach placements.

Long

Required

placementsIds

IDs of the placements to attach.

Long

Required

campaignId

ID of campaign on which you are working.

Long

Required

Request Format

  • PUT https://adapi.sizmek.com/sas/deliveryGroups/simpleAttachment

  • PUT https://adapi.sizmek.com/sas/deliveryGroups/advancedAttachment

Example of Simple Attach
{
    "entities": [{
        "type": "SimpleAttachmentDataContainer",
        "campaignId": 1083810552,
        "simpleAttachmentDataList": [{
            "type": "SimpleAttachmentData",
            "placementId": 1084027440,
            "adIds": [
                1085770226
            ]
        }],
        "enableAds": true
    }]
}
Example of Advanced Attach
{
    "entities": [{
        "type": "AdvancedAttachmentDataContainer",
        "advancedAttachmentDataList": [{
            "type": "AdvancedAttachmentData",
            "deliveryGroupId": 1073803945,
            "placementsIds": [
                1084027443
            ]
        }],
        "campaignId": 1073790345
    }]
}

Response Format

Example of Simple Attach Response

A successful request returns the HTTP 200 OK status code.

{
    "metadata": null,
    "debug": null,
    "error": [],
    "result": [1084027440]
}
Example of Advanced Attach Response

A successful request returns the HTTP 200 OK status code.

{
    "metadata": null,
    "debug": null,
    "error": [],
    "result": [{
        "type": "DeliveryGroup",
        "id": 1073803945,
        "relationsBag": {
            "parents": {
                "account": {
                    "id": 1073741826,
                    "name": "QaAdminAccount",
                    "internal": false
                },
                "advertiser": {
                    "id": 1073746030,
                    "name": "03AdvertiserEidanTest05-01-17"
                },
                "brand": {
                    "id": 1073748832,
                    "name": "03AdvertiserEidanTest05-01-17"
                },
                "campaign": {
                    "id": 1073790345,
                    "name": "bat-el_advanced"
                },
                "site": null
            },
            "children": {
                "advertisers": {
                    "count": 0
                },
                "brands": {
                    "count": 0
                },
                "campaigns": {
                    "count": 0
                },
                "users": {
                    "count": 0
                }
            },
            "creativeAccountContact": false
        },
        "version": 1550747951428730880,
        "createdBy": 1073741831,
        "createdByName": "QaAdminUser",
        "createdByAccount": 1073741826,
        "createdByAccountName": "QaAdminAccount",
        "createdOn": 1502174301595,
        "lastUpdatedBy": 1073741831,
        "lastUpdatedByName": "QaAdminUser",
        "lastUpdatedByAccount": 1073741826,
        "lastUpdatedByAccountName": "QaAdminAccount",
        "lastUpdateOn": 1550747951430,
        "name": "dg",
        "subContainers": null,
        "placementType": "IN_BANNER",
        "width": 600,
        "height": 400,
        "rootContainer": {
            "type": "RootContainer",
            "id": null,
            "relationsBag": null,
            "childRotationType": "EvenDistribution",
            "aiMetric": null,
            "subContainers": [{
                "type": "DeliveryGroupAd",
                "id": 1085595849,
                "rotationSetting": {
                    "type": "EvenDistribution",
                    "enabled": true,
                    "rotationType": "EvenDistribution",
                    "weight": 100.0
                },
                "masterAdId": 1085770231,
                "name": "adddddddddddddd",
                "adName": "adddddddddddddd"
            }],
            "childOptimizationMetric": null,
            "childConversionTagId": null,
            "childConversionTagName": null,
            "acrossPlacement": false
        },
        "timeZone": 0,
        "servingSetting": {
            "type": "APIServingSetting",
            "impressionsPerUser": -1,
            "impressionsPerDay": -1,
            "timeBetweenAds": -1,
            "frequencyCappingLevel": false,
            "serveDefaultImage": true
        },
        "rotationAds": null,
        "placements": ["1084027443"],
        "defaultAds": [],
        "campaignId": 1073790345,
        "campaignName": null,
        "targetAudiencePriority": null,
        "targetAudienceId": null,
        "targetingTypeId": -1,
        "geoTargetingTypeId": -1,
        "geoTargetingCountryId": -1,
        "aosCrossPlacement": 0,
        "aoMethodTypeId": -1,
        "gmt": -1,
        "hideDisableAds": false,
        "servingTimeZoneType": "Brand",
        "targetAudienceName": "Untargeted",
        "strategyId": null,
        "strategyName": null,
        "automaticOptimization": false,
        "attachToTaContextual": false,
        "published": false,
        "sequenceLevelCrossPlacementSupport": false,
        "aoMethodType": -1
    }]
}

Detach a Delivery Group From a Placement (PUT)

Detaches a delivery group from a placement.

Request Parameters

NAME

DESCRIPTION

TYPE

REQUIRED

NOTES

Body

Request containing delivery group to detach.

JSON

Required

Request Format

  • PUT https://adapi.sizmek.com/sas/deliveryGroups/simpleDetach/

  • PUT https://adapi.sizmek.com/sas/deliveryGroups/partialDetachPlacementsFromDeliveryGroups

Example
{
  "entities": [
    {
      "placementToAdMap": {
        "1073748187": [
          1073758825
        ]
      },
      "campaignId": 1073741825
    }
  ]
}
Example
{
  "entities": [
        {
      "type": "APIDetachDeliveryGroupContainer",
      "campaignId":"1083754283", 
      "deliveryGroups": [1083917639,1083917640]
      "placements": [1084006804]
           
    }
  ]
}

Response Format

A successful request returns the HTTP 200 OK status code with the detached delivery group in the JSON response body.

Enable/Disable a Delivery Group From a Placement (PUT)

Enables/disables a delivery group from a placement.

Request Parameters

NAME

DESCRIPTION

TYPE

REQUIRED

NOTES

id

ID of the delivery group.

Long

Required

Body

Request containing delivery group to enable/disable.

JSON

Required

Request Format

PUT https://adapi.sizmek.com/sas/deliveryGroups/enableDisable

Example
{
  "entities": [
    {
      "placementToAdMap": {
        "1073748223": [
          1073758659
        ]
      },
      "campaignId": 1073741867,
      "action": false
    }
  ]
}

Response Format

A successful request returns the HTTP 200 OK status code with the enabled/disabled delivery group in the JSON response body.

Create a Delivery Group (POST)

Creates a new delivery group.

Request Parameters

Name

Description

Type

Required

Notes

Body

Request containing delivery group body

JSON

Required

Request Format

POST https://adapi.sizmek.com/sas/deliveryGroups/

Example
{
  "entities": [
    {
      "type": "DeliveryGroup",
      "id": null,
      "relationsBag": null,
      "version": null,
      "createdBy": null,
      "createdByName": null,
      "createdByAccount": null,
      "createdByAccountName": null,
      "createdOn": null,
      "lastUpdatedBy": null,
      "lastUpdatedByName": null,
      "lastUpdatedByAccount": null,
      "lastUpdatedByAccountName": null,
      "lastUpdateOn": null,
      "name": "DeliveryGroupGxdd33JG",
      "subContainers": null,
      "placementType": null,
      "width": 1007514647,
      "height": -788198688,
      "rootContainer": {
        "type": "RootContainer",
        "id": null,
        "relationsBag": null,
        "version": null,
        "childRotationType": "EvenDistribution",
        "subContainers": [],
        "childOptimizationMetric": null,
        "childConversionTagId": null,
        "childConversionTagName": null
      },
      "timeZone": -2017946709,
      "servingSetting": {
        "type": "APIServingSetting",
        "impressionsPerUser": 5,
        "impressionsPerDay": 37,
        "timeBetweenAds": 8,
        "frequencyCappingLevel": true,
        "serveDefaultImage": true
      },
      "rotationAds": [],
      "placements": [],
      "defaultAds": [],
      "campaignId": 1073741826,
      "campaignName": "33LAp63Bcc",
      "targetAudiencePriority": 1155983754,
      "targetAudienceId": null,
      "targetingTypeId": 0,
      "geoTargetingTypeId": -1,
      "geoTargetingCountryId": -1,
      "aosCrossPlacement": 1,
      "aoMethodTypeId": -1,
      "gmt": -1,
      "hideDisableAds": false,
      "targetAudienceName": null,
      "strategyId": null,
      "strategyName": null,
      "automaticOptimization": false,
      "published": false,
      "sequenceLevelCrossPlacementSupport": true,
      "aoMethodType": -1
    }
  ]
}

Response Format

A successful request returns the HTTP 200 OK status code and a JSON response body that shows the new delivery group 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

500 Internal server errors

Internal Server Errors

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

Example
{
        "metadata": null,
        "debug": null,
        "error": [{
                "type": "APIErrorCollection",
                "id": 1073917873,
                "errors": [{
                        "code": 41002,
                        "innerMessage": "Ad format mismatch",
                        "propertyPath": null,
                        "value": null,
                        "entity": null,
                        "params": null
                }]
        }],
        "result": []
}

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

INTERNAL CODE

STRING

DESCRIPTION

41002

Ad format mismatch.

The ad that was added to the delivery group does not match the other ads. A delivery group can either include all video (In-Stream) ads, or all In-Banner ads, but not a mixture of ad types.

41004

Ad does not belong to same campaign as delivery group.

The ad that was added does not belong to the selected campaign. You should first assign the ad to the selected campaign.

41005

Placement does not belong to same campaign as delivery group.

The placement and delivery group must be in the same campaign.

41013

Duplicate delivery group placements.

The delivery group is already attached to the selected placement.

41014

Delivery group type is different than placement.

The placement type (In-Banner/In-Stream) must match the delivery group type.

41021

Could not connect the placements and ad due to sizing mismatch.

The placements' dimensions and the ads' dimensions are not the same, and therefore cannot be attached. You can either change the placements' dimensions or attach a different placement.

41024

Failed to detach placement from delivery group. All placements must belong to any untargeted delivery group.

The placement cannot be detached from the delivery group because the delivery group is the last untargeted delivery group attached to this placement.

41025

Delivery group target audience cannot be changed for published delivery group.

Delivery group target audience cannot be changed for published delivery group
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk