globalData Object – API Help Center

Related Entities

Endpoints Using the globalData Object

Parent Objects

globalData 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	Required	globalData
status	Defines the status of the advertiser in regards to its global feature.	String	Required	View values Global: Global advertiser Local: Local advertiser GlobalLocal: Local advertiser that is also global for other advertisers.
local	For a local advertiser, this field is populated with the global advertiser of the current advertiser.	localEntityData Object	Optional	LocalEntityData
global	Object that describes the global fields.	global Object	Optional

Object JSON Example

...
 },
    "globalData": {
      "type": "GlobalData",
      "status": "Global",
      "global": {
        "type": "GlobalEntityData",
        "allowUserAccessToLocalAdvertisers": true,
        "localAdvertisers": [
          {
            "type": "AdvertiserIdName",
            "id": 1083743300,
            "name": "Concertified Japan",
            "accountId": 1073747100,
            "accountName": "b&eAadvertising",
            "hasGlobalAdvertiserPermissionAccess": true,
            "hasGlobalTagManagerPermissionAccess": true
          },
          {
            "type": "AdvertiserIdName",
            "id": 1083743300,
            "name": "Concertified France",
            "accountId": 1073747106,
            "accountName": "b&eAadvertising",
            "hasGlobalAdvertiserPermissionAccess": true,
            "hasGlobalTagManagerPermissionAccess": true
          },
          {
            "type": "AdvertiserIdName",
            "id": 1083743306,
            "name": "Concertified UK",
            "accountId": 1073747106,
            "accountName": "b&eAadvertising",
            "hasGlobalAdvertiserPermissionAccess": true,
            "hasGlobalTagManagerPermissionAccess": true
          }
        ]
      },
      "local": null
    }
  }
}

"globalData": {
        "type": "GlobalData",
        "status": "Local",
        "global": null,
        "local": {
                "type": "LocalEntityData",
                "globalAdvertisers": [{
                        "type": "AdvertiserIdName",
                        "id": 1073754106,
                        "name": "global advertiser",
                        "accountId": null,
                        "accountName": null
                }]
        }
}

localEntityData Object

localEntityData 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	LocalEntityData
globalAdvertisers	Represents a central location under which you can aggregate local advertisers that are managed by multiple accounts.	globalAdvertisers Object	Optional

Object JSON Example

globalAdvertisers Object

globalAdvertisers 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	AdvertiserIdName
id	ID of global advertiser.	Integer	Read-only
name	Name of global advertiser.	String	Required
accountId	ID of the account that holds the global advertiser.	Long	Optional
accountName	Name of the account to which the global advertiser belongs.	String	Optional

Object JSON Example

global Object

global 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	GlobalEntityData
allowUserAccessToLocalAdvertisers	Determines whether each user under the account that holds this global advertiser has access to all of the local advertisers.	Boolean	Optional
localAdvertisers	Array of local advertiser objects.	Array of localAdvertisers Object	Optional

Object JSON Example

 ...,
"global": {
        "type": "GlobalEntityData",
        "allowUserAccessToLocalAdvertisers": true,
        "localAdvertisers": [{
                "type": "AdvertiserIdName",
                "id": 1083743305,
                "name": "Concertified Japan",
                "accountId": 1073747106,
                "accountName": "b&eAadvertising",
                "hasGlobalAdvertiserPermissionAccess": true,
                "hasGlobalTagManagerPermissionAccess": true
        }]
}

localAdvertisers Object

localAdvertisers 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 the entity	String	Read-only	AdvertiserIdName
id	ID of the local advertiser.	Long	Read-only
name	Name of local advertiser.	String	Read-only
accountId	ID of account that holds the local advertiser.	Long	Read-only
accountName	Name of account to which the local advertiser advertiser belongs.	String	Read-only

Object JSON Example

Related Entities

Endpoints Using the globalData Object

Parent Objects

globalData Object Definition

Note

Object JSON Example

localEntityData Object

localEntityData Object Definition

Note

Object JSON Example

globalAdvertisers Object

globalAdvertisers Object Definition

Note

Object JSON Example

global Object

global Object Definition

Note

Object JSON Example

localAdvertisers Object

localAdvertisers Object Definition

Note

Object JSON Example

Comments