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

Related Entities

Endpoints Using the Advertiser Object

Advertiser 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

Required

Advertiser

id

ID of advertiser. read-only parameter, auto-generated.

Integer

Read-only

relationsBag

Internal.

relationsBag Object

Internal

version

Internal.

Internal

Internal

createdBy

ID of the user that created the account.

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 advertiser.

String

Required

accountId

ID of the campaign manager account.

Long

Required

analyticsSettings

Definitions for analytics settings. Inherited by the account and passed to campaigns. Can override the account analytics settings.

analyticsSettings Object

Optional with default values

accountAnalyticsSettings

Parent account analytics settings.

analyticsSettings Object

Optional with default values

status

Advertiser status.

String

Read-only
View values

  • Enabled

  • Disabled

vertical

Advertiser's related industry.

String

Required
View values

  • Apparel

  • Auto

  • B2B

  • Career

  • Consumer_Packaged_Goods

  • Corporate

  • Electronics

  • Entertainment

  • Financial

  • Gaming

  • Government_Utilities

  • Health_Beauty

  • Insurance, Medical

  • News_Media

  • Other

  • Restaurant

  • Retail, Services

  • Sports

  • Tech_Internet

  • Telecom

  • Travel

adminSettings

Object container for joined setting of admin entities.

adminSettings Object

Optional with default values

office

Account office (office, market, currency).

Internal

Internal

retargetingTagList

Internal.

Internal

Internal

providers

DMP providers that can be assigned to advertiser.

Internal

Internal

customFields

Custom field values on entity level, each field must have metadata definition on parent account.

customFields Object

Optional

keepRetargetingValueUpTo

Amount of time the retargeting value is saved in the cookies.

Long

Optional with default values

Default value is 90.

conversionAttributionSettings

Settings for the advertiser to perform detailed analysis of media performance. This is the primary attribution model.

conversionAttributionSettings Objects

Optional with default values

additionalConversionAttributionSettings

An array of conversion attribution settings. You can add up to two attribution models.

conversionAttributionSettings Objects

Optional

Currently, you can only add one additional attribution model.

accessLevel

Access definition of account.

String

Optional
View values

  • Basic

  • Full

  • Limited

nxtTagManagement

Internal.

Internal

Internal

cookieSync

Represents the list of vendors with whom Amazon performs cookie syncing (for data hub).

cookieSync Object

Optional

globalData

Object that includes data about the advertiser, if it is a global advertiser or a local advertiser and which advertisers are global or local.

globalData Object

Optional

Object JSON Example

Example
{
  "result": 
    {
      "type": "Advertiser",
      "id": 1073741900,
      "relationsBag": {
        "parents": {
          "account": {
            "id": 1073741900,
            "name": "HPJ3O8kCTj",
            "internal": true
          },
          "advertiser": null,
          "brand": null,
          "campaign": null,
          "site": null
        },
        "children": {
          "advertisers": {
            "count": 0
          },
          "brands": {
            "count": 0
          },
          "campaigns": {
            "count": 0
          },
          "users": {
            "count": 0
          }
        },
        "creativeAccountContact": false
      },
     
      "version": 1516691562337009700,
      "createdBy": 1073741800,
      "createdByName": "ChrisChapman",
      "createdByAccount": 1073741826,
      "createdByAccountName": "ChrisChapman",
      "createdOn": 1516691562338,
      "lastUpdatedBy": 1073741831,
      "lastUpdatedByName": "ChrisChapman",
      "lastUpdatedByAccount": 1073741826,
      "lastUpdatedByAccountName": "UniversalAdvertising",
      "lastUpdateOn": 1516691562338,
      "name": "AdvertiserKrq3Rw",
      "accountId": 1073741900,
      "analyticsSettings": {
        "type": "AnalyticsSettings",
        "ignoreOverDelivery": true,
        "verificationMode": "NO_COLLECTION",
        "viewabilityThreshold": {
          "type": "ViewabilityThreshold",
          "minimumSurface": 50,
          "minimumDuration": 1
        }
      },
      "accountAnalyticsSettings": {
        "type": "AnalyticsSettings",
        "ignoreOverDelivery": true,
        "verificationMode": "ADVANCED_COLLECTION",
        "viewabilityThreshold": {
          "type": "ViewabilityThreshold",
          "minimumSurface": 1,
          "minimumDuration": 1
        }
      },
      "status": "Disabled",
      "vertical": "B2B",
      "keepRetargetingValueUpTo": 90,
      "conversionAttributionSettings": {
        "type": "ConversionAttributionModel",
        "conversionAttributionModel": "LastEventImpressionOrClick",
        "impressionValidUpTo": 30,
        "clickValidUpTo": 30,
        "pathToConversionLength": "FiveEvents",
        "customEventsNumber": null,
        "resetOn": null
      },
      "adminSettings": {
        "type": "AdminSettings",
        "regionalSettings": {
          "type": "RegionalSettings",
          "defaultTimeZone": "GMT_Plus_09",
          "market": null
        },
        "defaultContacts": {
          "type": "DefaultContacts",
          "relationsBag": null,
          "version": null,
          "sizmekContacts": [
            {
              "type": "DefaultSizmekContact",
              "id": 1920473891030,
              "relationsBag": null,
              "version": null,
              "contactId": 1073741830,
              "name": "FirstSizmekUser",
              "campaignRole": "CreativeServicesSpecialist"
            },
            {
              "type": "DefaultSizmekContact",
              "id": 1920473891031,
              "relationsBag": null,
              "version": null,
              "contactId": 1073741830,
              "name": "FirstSizmekUser",
              "campaignRole": "SalesManager"
            }
          ],
          "campaignManagerContacts": [],
          "creativeManagerContacts": [],
          "creativeAccounts": [
            {
              "id": 1926379471121,
              "accountId": 1073741923,
              "name": "BtDtp5kCwm",
              "primaryCreative": false
            }
          ],
          "siteContacts": []
        },
        "thirdPartyTracking": "ImpressionTracking",
        "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": {
          "type": "CampaignSettings",
          "hardStopMethod": "KEEP_SERVING_AS_USUAL",
          "creativeManagerAccess": true,
          "traffickingMode": "SimpleMode",
          "targetAudiencePriorityPolicy": "Server"
        },
        "privacy": {
          "type": "Privacy",
          "adMarker": {
            "includeInAllAds": false,
            "regulationProgram": "IAB_EU",
            "markerClickthroughURL": null
          },
          "disableCookies": false
        },
        "video": {
          "type": "Video",
          "autoTranscode": true
        }
      },
      "office": null,
      "retargetingTagList": null,
      "providers": null,
      "customFields": null,
      "cookieSync": null,
      "globalData": null,
      "accessLevel": "Full"
    }
}
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments