adminSettings Object – API Help Center

Related Entities

Endpoints Using the adminSettings Object

Parent Objects

adminSettings 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	AdminSettings
regionalSettings	Object that describes the regional settings fields.	regionalSettings Object	Required
defaultContacts	Object that describes the default contact fields.	defaultContacts Object	Required
thirdPartyTracking	Deprecated	Deprecated	Deprecated
servingSettings	Object that describes the serving settings fields.	servingSettings Object	Required
campaignSettings	Object that describes the campaign settings fields.	campaignSettings Object	Required
privacy	Object that describes the privacy fields.	privacy Object	Required
video	Object that describes enabling transcoding for In-Stream ads.	video Object	Required

Object JSON Example

...
        "adminSettings": {
            "type": "AdminSettings",
            "regionalSettings": {
                "type": "RegionalSettings",
                "defaultTimeZone": "GMT_Minus_05",
                "market": null
            },
            "defaultContacts": {
                "type": "DefaultContacts",
                "clientRefId": null,
                "relationsBag": null,
                "version": null,
                "sizmekContacts": [
                    {
                        "type": "DefaultSizmekContact",
                        "id": 49629324427200,
                        "clientRefId": "951638c4-1104-8ce6-d52f-accb0a2a5391",
                        "relationsBag": null,
                        "version": null,
                        "contactId": 1083742500,
                        "name": "user",
                        "campaignRole": "ClientServicesManager"
                    },
                    {
                        "type": "DefaultSizmekContact",
                        "id": 49629324427200,
                        "clientRefId": "bac9b5ba-66fb-d0e9-a49a-bfb03a9d07fe",
                        "relationsBag": null,
                        "version": null,
                        "contactId": 1073752000,
                        "name": "Name",
                        "campaignRole": "SalesManager"
                    }
                ],
                "campaignManagerContacts": [
                ],
                "creativeManagerContacts": [
                ],
                "creativeAccounts": [
                ],
                "siteContacts": [
                ]
            },
            "thirdPartyTracking": null,
            "servingSettings": {
                "type": "ServingSettings",
                "collectBelowTheFold": false,
                "dfCollectionID": null,
                "pathLength": null,
                "visibilityMinimumSurface": 0,
                "visibilityMinimumDuration": 0,
                "agencyVisibilityMinimumDuration": 0,
                "agencyVisibilityMinimumSurface": 0,
                "adChoicesCertificationProgramID": 0,
                "adChoicesClickthroughURL": "",
                "disableCookie": false,
                "saveAdCookie": true,
                "retargetingCookieWindow": 0,
                "deviceIntelligenceTypeId": 0
            },
            "campaignSettings": {
                "type": "CampaignSettings",
                "hardStopMethod": "KEEP_SERVING_AS_USUAL",
                "creativeManagerAccess": true,
                "traffickingMode": "AdvancedMode",
                "targetAudiencePriorityPolicy": "Server"
            },
            "privacy": {
                "type": "Privacy",
                "adMarker": {
                    "includeInAllAds": false,
                    "regulationProgram": "IAB_EU",
                    "markerClickthroughURL": null
                },
                "disableCookies": true
            },
            "video": null
        }...

regionalSettings Object

regionalSettings 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	RegionalSettings
market	Internal.	Internal	Internal
defaultTimeZone	Default time zone is inherited from the account level, however you can modify this field.	String	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

Object JSON Example

defaultContacts Object

defaultContacts 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	DefaultContacts
relationsBag	Internal.	relationsBag Object	Read-only
version	Internal.	Long	Read-only
sizmekContacts	Includes the AAS contacts and their roles for the campaign.	Array of Amazon Ad ServerContacts Object	Optional
campaignManagerContacts	These contacts determine which email notifications the media planner, trafficker, and authorized IO signee receive.	Array of campaignManagerContacts Object	Optional
creativeManagerContacts	These contacts can assign ads and assets to the campaign and view the relevant campaign information.	Array of creativeManagerContacts Object	Optional
creativeAccounts	A campaign may have multiple Creative Management accounts set as campaign participants. If a Creative Management account is defined as primary, the contacts in this account can view all campaign information, including campaign setup, placements, delivery groups, and ads created by all Campaign Management participants.	creativeAccounts Object	Optional
siteContacts	Site contacts are derived from the campaign's placements. These contacts receive email notifications related to their delivery of the campaign.	siteContacts Object	Optional

Object JSON Example

... },
        "defaultContacts": {
          "type": "DefaultContacts",      
          "relationsBag": null,
          "version": null,
          "sizmekContacts": [
            {
              "type": "DefaultSizmekContact",
              "id": 1920473891000,             
              "relationsBag": null,            
              "version": null,
              "contactId": 1073741800,
              "name": "FirstSizmekUser",
              "campaignRole": "CreativeServicesSpecialist"
            },
            {
              "type": "DefaultSizmekContact",
              "id": 1920473891031,             
              "relationsBag": null,            
              "version": null,
              "contactId": 1073741833,
              "name": "FirstSizmekUser",
              "campaignRole": "SalesManager"
            }
          ],
          "campaignManagerContacts": [],
          "creativeManagerContacts": [],
          "creativeAccounts": [
            {
              "id": 1926379471100,
              "accountId": 1073741900,
              "name": "BtDtp5kCwm",
              "primaryCreative": false
            }
          ],
          "siteContacts": []
        },...

Amazon Ad ServerContacts Object

AASContacts 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 object.	String	Read-only	DefaultAmazonContact
id	Internal.	Long	Read-only
relationsBag	Internal.	relationsBag Object	Read-only
version	Internal.	Long	Read-only
contactId	ID of the user that is the contact.	Long	Read-only
campaignRole	Role of the AAS contact during the campaign.	String	Read-only	View values CreativeServicesSpecialist SalesManager

Object JSON Example

...},
 "defaultContacts": {
          "type": "DefaultContacts",         
          "relationsBag": null,
          "version": null,
          "sizmekContacts": [
            {
              "type": "DefaultAmazonContact",
              "id": 1920473891030,           
              "relationsBag": null,           
              "version": null,
              "contactId": 1073741830,
              "name": "FirstAmazonUser",
              "campaignRole": "CreativeServicesSpecialist"
            },
            {
              "type": "DefaultAmazonContact",
              "id": 1920473891031,            
              "relationsBag": null,            
              "version": null,
              "contactId": 1073741830,
              "name": "FirstAmazonUser",
              "campaignRole": "SalesManager"
            }
          ],
...

campaignManagerContacts Object

campaignManagerContacts 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	Object type.	String	Read-only	DefaultCampaignManagerContact
id	Internal.	Integer	Read-only
version	Internal.	Long	Read-only
relationsBag	Internal.	relationsBag Object	Read-only
name	Name of the user that is set as the campaign manager contact.	String	Read-only
accountId	ID of the account in which the user is defined as the campaign manager contact.	Integer	Read-only
contactId	ID of the user that is set as the contact.	Integer	Required
campaignRole	Campaign role defined for the campaign manager contact.	String	Required	View values Trafficker MediaPlanner BillingContact

Object JSON Example

...,
"campaignManagerContacts": [{
        "type": "DefaultCampaignManagerContact",
        "id": 85489508614100,
        "relationsBag": null,
        "version": null,
        "contactId": 1073747500,
        "name": "User",
        "accountId": 1073744289,
        "campaignRole": "MediaPlanner"
},
{
        "type": "DefaultCampaignManagerContact",
        "id": 85489508614100,
        "relationsBag": null,
        "version": null,
        "contactId": 1073747500,
        "name": "User",
        "accountId": 1073744200,
        "campaignRole": "Trafficker"
},
{
        "type": "DefaultCampaignManagerContact",
        "id": 85615992045500,
        "relationsBag": null,
        "version": null,
        "contactId": 1073747500,
        "name": "User",
        "accountId": 1073744200,
        "campaignRole": "BillingContact"
}]

creativeManagerContacts Object

creativeManagerContacts 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	Object type.	String	Read-only	defaultCreativeManagerContact
accountId	ID of the account in which the user is defined as the creative manager contact.	Integer	Read-only
contactId	ID of the user that is set as the contact.	Integer	Read-only
campaignRole	Campaign role defined for the creative manager contact.	String		View values Producer Designer Trafficker

Object JSON Example

...
"creativeManagerContacts": [{
        "type": "DefaultCreativeManagerContact",
        "id": 85489508614100,
        "relationsBag": null,
        "version": null,
        "contactId": 1083743300,
        "name": "Name",
        "accountId": 1083742600,
        "campaignRole": "Producer"
},
{
        "type": "DefaultCreativeManagerContact",
        "id": 85672900362200,
        "relationsBag": null,
        "version": null,
        "contactId": 1083742600,
        "name": "9hCRP04bjL",
        "accountId": 1083742600,
        "campaignRole": "Designer"
},
{
        "type": "DefaultCreativeManagerContact",
        "id": 85672900362200,
        "relationsBag": null,
        "version": null,
        "contactId": 1083742600,
        "name": "9hCRP04bjL",
        "accountId": 1083742600,
        "campaignRole": "Trafficker"
}]
...

creativeAccounts Object

creativeAccounts 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
accountId	Creative management account ID.	Long	Read-only
primaryCreative	Contacts in this creative account can view all campaign information, including campaign setup, placements, delivery groups, and ads created by all Campaign Management participants.	Boolean	Required
id	Internal.	Long	Internal
name	Name of creative management account.	String	Required

Object JSON Example

siteContacts Object

siteContacts 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
relationsBag	Internal.	relationsBag Object	Read-only
type	Type of object.	String	Read-only	DefaultSiteContact
version	Internal.	Long	Read-only
id	Internal.	Integer	Read-only
contactId	Internal.	Integer	Read-only
name	Contact name that will receive emails about the delivery of the campaign.	String	Read-only
siteId	Site ID to which the contact belongs.	Integer	Read-only

Object JSON Example

relationsBag Object

This object enables you to view the parent object of an object, for example, the account ID and name of an advertiser. This saves time because you do not need to call another call to get these details.

relationsBag 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

parents

This is an object of the entities that are related to this object, and depends on the object type.For example, a campaign will include "account", "advertiser", and "brand" data.

An advertiser will only include the "account".

Parents Object

Read-only

children

Includes the count of the related entities.

Children Object

Read-only

creativeAccountContact

Internal.

Boolean

Read-only

Object JSON Example

"relationsBag": {
        "parents": {
                "account": {
                        "id": 16674,
                        "name": "[TEST] migrated account",
                        "internal": true
                },
                "advertiser": null,
                "brand": null,
                "campaign": null,
                "site": null
        },
        "children": {
                "advertisers": {
                        "count": 0
                },
                "brands": {
                        "count": 1
                },
                "campaigns": {
                        "count": 231
                },
                "users": {
                        "count": 0
                }
        },
        "creativeAccountContact": false
},

Parents Object

Parents Object Definition

Name	Description	Type	Required	Notes
account	Parent account of current entity (if applicable).	Object	Read-Only	Example: { "id": 1072241834, "name": "testing account", "internal": false }
advertiser	Parent advertiser of current entity (if applicable).	Object	Read-Only	Example: { "id": 1073741822, "name": "AAA" }
brand	Parent brand of current entity (if applicable).	Object	Read-Only	Example: { "id": 1073741833, "name": "BBB" }
campaign	Parent campaign of current entity (if applicable).	Object	Read-Only	Example: { "id": 1073741831, "name": "ccc" }
site	Parent site of current entity (if applicable).	Object	Read-Only	Example: { "id": 1073741853, "name": "ddd" }

Object JSON Example

Children Object

Children Object Definition

Name	Description	Type	Required
advertisers	Contains the count of child advertisers (if applicable).	Object	Read-Only
brands	Contains the count of child brands (if applicable).	Object	Read-Only
campaigns	Contains the count of child campaigns (if applicable).	Object	Read-Only
users	Contains the count of child users (if applicable).	Object	Read-Only

Object JSON Example

servingSettings Object

servingSettings Object Definition

Serving settings inherit default values from the account level; however, you can modify these fields. If there is a change in the advertiser settings, the campaign level is changed accordingly.

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	ServingSettings
collectionBelowTheFold	Deprecated.	Boolean	Deprecated
dfCollecitonID	Deprecated.	Integer	Deprecated
pathLength	Number of events to collect in the conversion path. Path to conversion and conversion reports are calculated according to this setting.	Integer	Required
visibilityMinimumSurface	Percentage of the ad area required for an impression to be counted as viewable.	Integer	Required
visibilityMinimumDuration	Number of seconds that the minimum surface must appear for an impression to be counted as viewable.	Integer	Required
agencyVisibilityMinimumDuration	Number of seconds that the minimum surface must appear for an impression to be counted as viewable.	Integer	Required
agencyVisibilityMinimumSurface	Percentage of the ad area required for an impression to be counted as viewable.	Integer	Required
adChoicesCertificationProgramID	Regulation program to associate with the AdChoices icon. The regulation program you select depends on your country's regulations.	Integer	Required
adChoicesClickthroughURL	URL for a landing page if you want the consumer to arrive at a landing page after clicking the AdChoices icon.	String	Required
disableCookie	Determines whether to disable cookies and tracking capabilities for all ads. In addition, if this check box is selected on the advertiser level, the Disable Cookies check box for all new campaigns and placements under this advertiser is disabled by default.	Boolean	Required
saveAdCookie	Deprecated.	Boolean	Deprecated
retargetingCookieWindow	Deprecated.	Integer	Deprecated
deviceIntelligenceTypeId	Deprecated.	Integer	Deprecated

Object JSON Example

...,
        "servingSettings": {
          "type": "ServingSettings",
          "collectBelowTheFold": true,
          "dfCollectionID": 83256146,
          "pathLength": 0,
          "visibilityMinimumSurface": 711163654,
          "visibilityMinimumDuration": -701382442,
          "agencyVisibilityMinimumDuration": -582032291,
          "agencyVisibilityMinimumSurface": -908719246,
          "adChoicesCertificationProgramID": -1869242221,
          "adChoicesClickthroughURL": "271r6KzUev",
          "disableCookie": true,
          "saveAdCookie": true,
          "retargetingCookieWindow": -186901349,
          "deviceIntelligenceTypeId": 480749887
        },
...

campaignSettings Object

campaignSettings 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.	Object	Read-only	CampaignSettings
hardStopMethod	Serving option to implement after campaigns under this advertiser and brand end.	String	Required	View values KEEP_SERVING_AS_USUAL BOTH_IMPRESSIONS_AND_END_DATE IMPRESSIONS_OR_END_DATE ON_END_DATE ON_VOLUME_GOAL
creativeManagerAccess	When this field is True users can create ads and then assign the ads to campaigns, advertisers, and Campaign Manager accounts.	Boolean	Required
traffickingMode	Attachment process to use for all campaigns under this advertiser and brand.	string	Required	View values SimpleMode AdvancedMode
targetAudiencePriorityPolicy	Determines which messages will be served to the user in case of multiple matches. The target audience priority is set from low to high, 1 being the top prioritized target audience and 4095 being the lowest priority target audience.	String	Required	View values Server Manual

Object JSON Example

privacy Object

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
type	String	Read-only	Privacy
adMarker	Object that describes the ad choices fields	adMarker Object	Required
disableCookies	Determines whether to disable cookies and tracking capabilities for all ads. if this check box is selected on the advertiser level, the Disable Cookies check box for all new campaigns and placements under this advertiser is disabled by default.	Boolean	Required

Object JSON Example

adMarker Object

adMarker 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
includeInAllAds	Enables your consumers to control behavioral based consumer data, otherwise known as OBA (Online Behavioral Advertising). For example, if the user does not want a specific advertising vendor to have access to their tracking cookies, they can click the AdCoices icon in the ad, and either go through `youronlinechoices.com` or `aboutads.info` and opt out from tracking cookies of that specific vendor. This allows the consumer to define their own privacy preferences, including tracking of behavioral advertising information. The user can opt-out of tracking, including targeting and other tracking cookies by AAS. AAS supports all regional AdChoices organizations in the USA, including DAA (Digital Advertising Alliance’s ), and in Europe, including NAI (Networking Advertiser Initiative) and IAB (Interactive Advertising Bureau).	Boolean	Required
regulationProgram	Determines which regulation program to associate with the AdChoices icon. The regulation program you select depends on your country's regulations.	String	Required	View values IAB_EU NAI_DAA_US
markerClickthroughURL	URL for a landing page if you want the consumer to arrive at a landing page after clicking the AdChoices icon.	String	Optional

Object JSON Example

video Object

video 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 object.	String	Read-only	Video
autoTranscode	Enables an automatic process in the platform that converts your video assets to final serving variants according to the placement and site requirements.	Boolean	Required

Object JSON Example

Related Entities

Endpoints Using the adminSettings Object

Parent Objects

adminSettings Object Definition

Note

Object JSON Example

regionalSettings Object

regionalSettings Object Definition

Note

Object JSON Example

defaultContacts Object

defaultContacts Object Definition

Note

Object JSON Example

Amazon Ad ServerContacts Object

AASContacts Object Definition

Note

Object JSON Example

campaignManagerContacts Object

campaignManagerContacts Object Definition

Note

Object JSON Example

creativeManagerContacts Object

creativeManagerContacts Object Definition

Note

Object JSON Example

creativeAccounts Object

creativeAccounts Object Definition

Note

Object JSON Example

siteContacts Object

siteContacts Object Definition

Note

Object JSON Example

relationsBag Object

relationsBag Object Definition

Note

Object JSON Example

Parents Object

Parents Object Definition

Object JSON Example

Children Object

Children Object Definition

Object JSON Example

servingSettings Object

servingSettings Object Definition

Note

Object JSON Example

campaignSettings Object

campaignSettings Object Definition

Note

Object JSON Example

privacy Object

Object Definition

Note

Object JSON Example

adMarker Object

adMarker Object Definition

Note

Object JSON Example

video Object

video Object Definition

Note

Object JSON Example

Comments