Submit a request
 
PRODUCT
Privacy Policy |  AAS Advertising Policy | Terms of Use
Cookie Preference
✖

Amazon Ad Server will be sunset in Q4 2024, please visit this page (AAS offboarding information) for offboarding support resources and sunset FAQs. Details shared on that page represent the most up to date information in the Help Center, if you find disparate information in other resources please default to the information in the AAS offboarding information page accordingly.

Please note that on October 1, 2024, the ability to create new campaigns, placements, and tag managers will be disabled.

Follow
Last Update:
  viewable by end users
  editable by agents

Related Entities

Endpoints Using the deliveryGroup Object

deliveryGroup Object Definition

Note

Note: The Required column includes the following values:

  • Required: The field must be included in the POST call.

  • Read-only: The field is received in the GET call and required in the PUT call. It is not required in the POST call. You cannot edit this field.

  • Optional: If the field was received in the GET call, include it in the PUT call. This field is editable.

  • Internal: (For Amazon Ad Server (AAS) internal use) If the field was received in the GET call, include it in the PUT call.

Name

Description

Type

Required

Notes

type

Type of entity.

String

Read-only

id

ID of the delivery group.

Integer

Read-only

relationsBag

Holds hierarchy entities (parent/children).

relationsBag Object

Read-only

version

Internal.

Integer

Read-only

createdBy

ID of the user who created the delivery group.

Long

Read-only

createdByName

Name of the user that created the entity.

String

Read-only

createdByAccount

ID of the account that created the entity.

Long

Read-only

createdByAccountName

Name of the account that created the entity.

String

Read-only

createdOn

Date of creation (Date epoch).

Long

Read-only

lastUpdatedBy

ID of the user that was last to update the entity.

Long

Read-only

lastUpdatedByName

Name of the user that was last to update the entity.

String

Read-only

lastUpdatedByAccount

ID of the account that was last to update the entity.

Long

Read-only

lastUpdatedByAccountName

Name of the account that was last to update the entity.

String

Read-only

lastUpdateOn

Date of last update (Date epoch).

Long

Read-only

name

Name of delivery group.

String

Required

subContainers

Container of all of the master ads in the delivery group.

subContainers Object

Required

placementType

Object type data.

String

Required
View values

  • OUT_OF_BANNER

  • TRACKING_ONLY

  • IN_STREAM_VIDEO

  • IN_STREAM_VIDEO_TRACKING

  • VERIFICATION_TRACKING

  • IN_BANNER

width

Dimension of first ad.

Integer

Read-only

height

Dimension of first ad.

Integer

Read-only

rootContainer

Tree of all ads in delivery group.

rootContainer Object

Optional

timeZone

Time zone (GMT) when the delivery group will be delivered.

Integer

Required
View values

  • GMT_Minus_12

  • GMT_Minus_11

  • GMT_Minus_10

  • GMT_Minus_09

  • GMT_Minus_08

  • GMT_Minus_07

  • GMT_Minus_06

  • GMT_Minus_05

  • GMT_Minus_04

  • GMT_Minus_03

  • GMT_Minus_02

  • GMT_Minus_01

  • GMT

  • GMT_Plus_01

  • GMT_Plus_02

  • GMT_Plus_03

  • GMT_Plus_04

  • GMT_Plus_05

  • GMT_Plus_06

  • GMT_Plus_07

  • GMT_Plus_08

  • GMT_Plus_09

  • GMT_Plus_10

  • GMT_Plus_11

  • GMT_Plus_12

servingSetting

Describes the delivery group serving parameters and definitions.

servingSetting Object

Required

rotationAds

Ads related to the specific rotation settings.

List of strings

Optional

placements

List of placement IDs associated with delivery group.

List of strings

Optional

defaultAds

List of ad IDs associated with delivery group.

defaultAds Object

Optional

campaignId

Campaign ID.

Long

Read-only

campaignName

Name of campaign.

String

Read-only

targetAudienceId

ID of the target audience assigned to the delivery group.

Long

Optional

aosCrossPlacement

Internal.

Integer

Read-only

aoMethodTypeId

Internal.

Integer

Read-only

gmt

Internal.

Internal

Internal

hideDisableAds

Determines whether the user can view ads that are disabled.

Boolean

Required

targetAudienceName

Name of the target audience assigned to delivery group.

String

Read-only

strategyId

ID of the strategy (if the target audience was created as part of an audience strategy).

Long

Read-only

strategyName

Name of the strategy (if the target audience was created as part of an audience strategy).

String

Read-only

automaticOptimization

Determines whether automatic optimization is used in this delivery group.

Boolean

Optional

published

If the delivery group is attached to a published placement, the delivery group is also published.

Boolean

Read-only

sequenceLevelCrossPlacementSupport

(For sequence type rotation) Defines whether the sequence parameter set per ad is across placements or per specific placement.

Boolean

Required

aoMethodType

Internal.

Internal

Internal

Object JSON Example

Example
{
    "result": {
        "type": "DeliveryGroup",
        "id": 1073770000,
        "clientRefId": "dg_11",
        "relationsBag": {
            "parents": {
                "account": {
                    "id": 2,
                    "name": "Account1",
                    "internal": true
                },
                "advertiser": {
                    "id": 146673,
                    "name": "! GW  !"
                },
                "brand": {
                    "id": 1073806000,
                    "name": "! GW  !"
                },
                "campaign": {
                    "id": 1073787800,
                    "name": "Advanced1"
                },
                "site": null
            },
            "children": {
                "advertisers": {
                    "count": 0
                },
                "brands": {
                    "count": 0
                },
                "campaigns": {
                    "count": 0
                },
                "users": {
                    "count": 0
                }
            },
            "creativeAccountContact": false
        },

        "version": 1584873119570788352,
        "createdBy": 359567,
        "createdByName": "Tom Smith",
        "createdByAccount": 2,
        "createdByAccountName": "testing",
        "createdOn": 1472725985501,
        "lastUpdatedBy": 359567,
        "lastUpdatedByName": "Tom Smith",
        "lastUpdatedByAccount": 2,
        "lastUpdatedByAccountName": "Account1",
        "lastUpdateOn": 1584873119480,
        "name": "Default Target Audience_DG_3",
        "subContainers": null,
        "placementType": "IN_BANNER",
        "width": 300,
        "height": 250,
        "rootContainer": {
            "type": "RootContainer",
            "id": null,
            "relationsBag": null,
            "childRotationType": "TimeBased",
            "aiMetric": null,
            "subContainers": [{
                "type": "DeliveryGroupAd",
                "id": 1075088400,
                "rotationSetting": {
                    "type": "TimeBased",
                    "enabled": true,
                    "rotationType": "TimeBased",
                    "datesAccordingToPlacements": true,
                    "startDate": null,
                    "endDate": null,
                    "dateRanges": [{
                        "type": "APIDateRange",
                        "startDate": 1577232000000,
                        "endDate": 1577404799999
                    }],
                    "serveOnSpecificDaysAndHours": false,
                    "hoursPerDay": null
                },
                "masterAdId": 1073787412,
                "name": "Ad1",
                "adName": "Ad1"
            }, {
                "type": "AdContainer",
                "id": 1075088500,
                "rotationSetting": {
                    "type": "TimeBased",
                    "enabled": true,
                    "rotationType": "TimeBased",
                    "datesAccordingToPlacements": false,
                    "startDate": 1584489600000,
                    "endDate": 1585612799999,
                    "dateRanges": [{
                        "type": "APIDateRange",
                        "startDate": 1584489600000,
                        "endDate": 1585612799999
                    }],
                    "serveOnSpecificDaysAndHours": true,
                    "hoursPerDay": ["* * 0-23 ? * 2", "* * 0-5 ? * 3", "* * 0-23 ? * 4", "* * 7-23 ? * 5", "* * 0-23 ? * 6"]
                },
                "name": "Sub Group",
                "childRotationType": "EvenDistribution",
                "subContainers": [{
                    "type": "DeliveryGroupAd",
                    "id": 1075088524,
                    "rotationSetting": {
                        "type": "EvenDistribution",
                        "enabled": true,
                        "rotationType": "EvenDistribution",
                        "weight": 100.0
                    },
                    "masterAdId": 1073787412,
                    "name": "Ad1",
                    "adName": "Ad1"
                }],
                "childOptimizationMetric": null
            }, {
                "type": "DeliveryGroupAd",
                "id": 1075268700,
                "rotationSetting": {
                    "type": "TimeBased",
                    "enabled": true,
                    "rotationType": "TimeBased",
                    "datesAccordingToPlacements": true,
                    "startDate": null,
                    "endDate": null,
                    "dateRanges": [],
                    "serveOnSpecificDaysAndHours": false,
                    "hoursPerDay": null
                },
                "masterAdId": 1074685894,
                "name": "Demo Ad",
                "adName": "Demo Ad"
            }],
            "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": ["1073939267", "1073939266", "1075287606", "1073939264", "1075215437", "1075287611", "1073939996"],
        "defaultAds": [],
        "campaignId": 1073787800,
        "campaignName": null,
        "targetAudiencePriority": null,
        "targetAudienceId": null,
        "targetingTypeId": -1,
        "geoTargetingTypeId": -1,
        "geoTargetingCountryId": -1,
        "aosCrossPlacement": 1,
        "aoCrossPlacement": null,
        "aoMethodTypeId": -1,
        "gmt": -9,
        "hideDisableAds": false,
        "servingTimeZoneType": "Brand",
        "targetAudienceName": "Untargeted",
        "strategyId": null,
        "strategyName": null,
        "automaticOptimization": false,
        "attachToTaContextual": false,
        "published": true,
        "aoMethodType": -1,
        "sequenceLevelCrossPlacementSupport": false
    }
}
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments