cookieSync Object – API Help Center

Related Entities

Endpoints Using the cookieSync Object

Advertiser Resource

Parent Objects

Advertiser Object

cookieSync 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	CookieSync
dataProviders	Internal.	Internal	Internal
dataActivationPlatform	Internal.	Internal	Internal
externalIntegrations	For all campaigns that are running under this advertiser, AAS will fire cookie syncing pixels during the ad request serving, allowing AAS to sync AAS users with the selected external providers. Cookie syncing will be done for all ad impressions and attribution (retargeting, conversions, Tag Manager, and tracking placements).	String	Optional

Object JSON Example

...
"cookieSync": {
                        "type": "CookieSync",
                        "dataProviders": [{
                                "type": "IdName",
                                "id": 8,
                                "name": "Krux"
                        },
                        {
                                "type": "IdName",
                                "id": 36,
                                "name": "Eulerian"
                        },
                        {
                                "type": "IdName",
                                "id": 7,
                                "name": "LiveRamp"
                        }],
                        "dataActivationPlatform": [{
                                "type": "IdName",
                                "id": 29,
                                "name": "MediaMath"
                        },
                        {
                                "type": "IdName",
                                "id": 30,
                                "name": "AppNexus"
                        }],
                        "externalIntegrations": [{
                                "type": "IdName",
                                "id": 1000001,
                                "name": "Tapad"
                        }]
                },
...

Related Entities

Endpoints Using the cookieSync Object

Parent Objects

cookieSync Object Definition

Note

Object JSON Example

Comments