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

Resource URL

https://adapi.sizmek.com/sas/tagManagers/activities/thirdparty

Objects Used by This Resource

The following objects are used by this endpoint:

HTTP Method and URI List

HTTP METHOD

URI

DESCRIPTION

GET

/tagManagers/activities/thirdparty

Retrieves all 3rd party activities.

GET

/tagManagers/activities/thirdparty/{id}

Retrieves a 3rd party activity by ID.

POST

/tagManagers/activities/thirdparty

Creates a 3rd party activity.

PUT

/tagManagers/activities/thirdparty/{id}

Updates an existing 3rd party activity.

DELETE

/tagManagers/activities/thirdparty/{id}

Deletes a 3rd party activity.

POST

/tagManagers/activities/thirdparty/delete

Deletes 3rd party activities in bulk.

GET

/tagManagers/activities/thirdparty/existsInConversion/{id}

Searches for 3rd party activities that exist in the conversion activity.

GET

/tagManagers/activities/thirdparty/getByConversionId/{id}

Determines whether a 3rd party activity exists in a conversion activity.

Method Examples and Request Parameters

Important

Important:

  • For PUT calls, do the following:

    • For any PUT method that updates an object, make sure that you include the entire "result": object from the GET response in the request body. If there is missing information, even if it is read-only, the request might fail or override the existing fields with the new values.

    • You must also change the "result": to "entities": and make the entities contents into an array. For example, here is the output from the GET request:

       { "result": { "type": "Advertiser", ... } }

      You should make the following modifications, including your specific modifications, to the json object that you submit for the request.

       { "entities": [{ "type": "Advertiser", ... }] }   

  • For POST calls, do the following:

    • Include the fields marked as Required, as indicated in the corresponding Object article.

    • Format the JSON object as follows:

       { "entities": [{ "type": "Advertiser", ... }] }   

GET all 3rd Party Activities (GET)

Retrieves multiple 3rd party activities. Can be filtered according to query parameters.

Request Query Parameters

Name

Description

Type

Required

Notes

from

Starting index by which to fetch new 3rd party activities for paging purposes.

Long

Required

Getting multiple entities requires using from and max query parameters.

max

Maximum number of 3rd party activities to fetch for each page.

Long

Required

q

Filtering options for the request (see here).

String

Optional

Example of query string: q={"1":{"CREATEDBYNAME":["MonicaSmith"]},"2":{"ADVERTISERNAME":["autoads"]}}

Note

Note: The date is according to the Unix epoch timestamp.

View values

NAME

DESCRIPTION

TYPE

ADVERTISER

Name of advertiser to which the 3rd party activity belongs.

String

ADVERTISERID

ID of advertiser to which the 3rd party activity belongs.

Long

TYPE

Type of entity.

String

DEDUPLICATION

Deduplication setting.

String

CREATEDBY

Name of the user that created the 3rd party activity.

String

UPDATEDBY

Name of the user that was last to update the 3rd party activity.

String

CREATEDON

Date 3rd party activity was created.

Long

UPDATEDON

Date of last update (Date epoch).

Long

TRIGGERINGCONVERSIONACTIVITIES

Number of conversion activities that trigger this 3rd party activity.

Integer

TRIGGERINGTAGMANAGERS

Number of tag managers that trigger this 3rd party activity.

Integer

order

Sort order ASC or DESC, required if sort field name is specified (see here).

String

Optional

Note

Note: Required if a sort field name is specified.

By default, the API response is ascending.

sort

Sort by field name (see here).

String

Optional

  

advertiserID

Advertiser ID from which to retrieve tag manager.

Long

Optional

  

enrichWithEntitiesCounts

Determines whether to enrich tag manager with related entities' counts.

Boolean

Optional

Specify true if counts are required; otherwise, counts will be zero and performance is improved.

Request Format

https://adapi.sizmek.com/sas/tagManagers/activities/thirdparty?from=0&max=250

Response Format

Example
{"result": [{
  "type": "ThirdPartyActivity",
  "id": 1083878971,
  "relationsBag": {
    "parents": {
      "account": {
        "id": 1073744288,
        "name": "AccountDemo0",
        "internal": false
      },
      "advertiser": {
        "id": 1083762304,
        "name": "reut adv3333"
      },
      "brand": null,
      "campaign": null,
      "site": null
    },
    "children": {
      "advertisers": {
        "count": 0
      },
      "brands": {
        "count": 0
      },
      "campaigns": {
        "count": 0
      },
      "users": {
        "count": 0
      }
    },
    "creativeAccountContact": false
  },
  "version": 1561451016021803000,
  "createdBy": 1073741831,
  "createdByName": "User",
  "createdByAccount": 1073741826,
  "createdByAccountName": "Account",
  "createdOn": 1561448933204,
  "lastUpdatedBy": 1073741831,
  "lastUpdatedByName": "User",
  "lastUpdatedByAccount": 1073741826,
  "lastUpdatedByAccountName": "Account",
  "lastUpdateOn": 1561451016017,
  "name": "fff",
  "activityType": "ThirdPartyConversionTracking",
  "advertiserId": 1083762304,
  "rulesCount": null,
  "tagManagersCount": null,
  "conversionsCount": 2,
  "tagManagerIds": null,
  "accessLevel": "Full",
  "nxtTagManagement": true,
  "code": "ff",
  "noScriptMode": false,
  "piggyBack": {
    "type": "PiggyBack",
    "deduplication": "AttributedSite",
    "firingMode": "Inherited",
    "siteName": "00X1Fkdrm0de111",
    "siteId": 1083782050,
    "deduplicationConversionAttributionModel": {
      "type": "DeduplicationConversionAttributionModel",
      "fire3rdPartyTracking": "LastEventImpressionOrClick",
      "impressionValidUpTo": 30,
      "clickValidUpTo": 30
    }
  },
  "conditions": [
    {
      "type": "VariableCondition",
      "orConditions": [
        {
          "type": "VariableInnerCondition",
          "andConditions": [
            {
              "type": "AndVariableInnerCondition",
              "values": [
                "tttt"
              ],
              "variableId": 1083753345,
              "variableName": "111",
              "variableDataType": "String",
              "operator": "EqualsOneOfTheFollowing"
            },
            {
              "type": "AndVariableInnerCondition",
              "values": [
                "43534345"
              ],
              "variableId": 1083753342,
              "variableName": "666",
              "variableDataType": "String",
              "operator": "DoesNotEqualOneOfTheFollowing"
            }
          ]
        },
        {
          "type": "VariableInnerCondition",
          "andConditions": [
            {
              "type": "AndVariableInnerCondition",
              "values": [
                "7777"
              ],
              "variableId": 1083753345,
              "variableName": "111",
              "variableDataType": "String",
              "operator": "EqualsOneOfTheFollowing"
            }
          ]
        }
      ],
      "criteriaType": "Variable"
    }
  ],
  "conversionIds": null,
  "codeVariableIds": null
}
]
}

GET a 3rd Party Activity (GET)

Retrieve a 3rd party activity.

Request Parameters

NAME

DESCRIPTION

TYPE

REQUIRED

NOTES

id

ID of 3rd party activity to fetch.

Long

Required

  

Request Format

GET https://adapi.sizmek.com/sas/tagManagers/activities/thirdparty/{id}

Response Format

Example
{
  "type": "ThirdPartyActivity",
  "id": 1083878971,
  "relationsBag": {
    "parents": {
      "account": {
        "id": 1073744288,
        "name": "AccountDemo0",
        "internal": false
      },
      "advertiser": {
        "id": 1083762304,
        "name": "adv3333"
      },
      "brand": null,
      "campaign": null,
      "site": null
    },
    "children": {
      "advertisers": {
        "count": 0
      },
      "brands": {
        "count": 0
      },
      "campaigns": {
        "count": 0
      },
      "users": {
        "count": 0
      }
    },
    "creativeAccountContact": false
  },
  "version": 1561451016021803000,
  "createdBy": 1073741831,
  "createdByName": "User",
  "createdByAccount": 1073741826,
  "createdByAccountName": "Account",
  "createdOn": 1561448933204,
  "lastUpdatedBy": 1073741831,
  "lastUpdatedByName": "User",
  "lastUpdatedByAccount": 1073741826,
  "lastUpdatedByAccountName": "Account",
  "lastUpdateOn": 1561451016017,
  "name": "fff",
  "activityType": "ThirdPartyConversionTracking",
  "advertiserId": 1083762304,
  "rulesCount": null,
  "tagManagersCount": null,
  "conversionsCount": 2,
  "tagManagerIds": null,
  "accessLevel": "Full",
  "nxtTagManagement": true,
  "code": "ff",
  "noScriptMode": false,
  "piggyBack": {
    "type": "PiggyBack",
    "deduplication": "AttributedSite",
    "firingMode": "Inherited",
    "siteName": "00X1Fkdrm0de111",
    "siteId": 1083782050,
    "deduplicationConversionAttributionModel": {
      "type": "DeduplicationConversionAttributionModel",
      "fire3rdPartyTracking": "LastEventImpressionOrClick",
      "impressionValidUpTo": 30,
      "clickValidUpTo": 30
    }
  },
  "conditions": [
    {
      "type": "VariableCondition",
      "orConditions": [
        {
          "type": "VariableInnerCondition",
          "andConditions": [
            {
              "type": "AndVariableInnerCondition",
              "values": [
                "tttt"
              ],
              "variableId": 1083753345,
              "variableName": "111",
              "variableDataType": "String",
              "operator": "EqualsOneOfTheFollowing"
            },
            {
              "type": "AndVariableInnerCondition",
              "values": [
                "43534345"
              ],
              "variableId": 1083753342,
              "variableName": "666",
              "variableDataType": "String",
              "operator": "DoesNotEqualOneOfTheFollowing"
            }
          ]
        },
        {
          "type": "VariableInnerCondition",
          "andConditions": [
            {
              "type": "AndVariableInnerCondition",
              "values": [
                "7777"
              ],
              "variableId": 1083753345,
              "variableName": "111",
              "variableDataType": "String",
              "operator": "EqualsOneOfTheFollowing"
            }
          ]
        }
      ],
      "criteriaType": "Variable"
    }
  ],
  "conversionIds": null,
  "codeVariableIds": null
}

Create a 3rd Party Activity (POST)

Create a new 3rd party activity.

Request Parameters

NAME

DESCRIPTION

TYPE

REQUIRED

NOTES

Body

Request containing 3rd party activity body to create.

JSON

Required

  

Request Format

POST https://adapi.sizmek.com/sas/tagManagers/activities/thirdparty

Example
{
  "entities": [
    {
      "type": "ThirdPartyActivity",
      "id": "",
      "name": "test",
      "activityType": "ThirdParty",
      "advertiserId": 1073747395,
      "relationsBag": {
        "parents": {
          "account": {
            "id": 1073746545,
            "name": "Testing Account",
            "internal": null
          },
          "advertiser": {
            "id": "",
            "name": ""
          },
          "brand": null,
          "campaign": null,
          "site": null
        },
        "children": {
          "advertisers": {
            "count": 0
          },
          "brands": {
            "count": 0
          },
          "campaigns": {
            "count": 0
          },
          "users": {
            "count": 0
          }
        },
        "creativeAccountContact": false
      },
      "code": "[%newVar%]",
      "noScriptMode": false,
      "piggyBack": null,
      "conditions": null,
      "advertiserName": "!!!eidanAdvertiser11072017"
    }
  ]
}

Response Format

A successful request returns the HTTP 200 OK status code and a JSON response body that shows the new 3rd party activity resource.

Update an Existing 3rd Party Activity (PUT)

Updates an existing 3rd party activity.

Request Parameters

NAME

DESCRIPTION

TYPE

REQUIRED

NOTES

ID

ID of the 3rd party activity.

Long

Required

  

Body

Request containing 3rd party activity body to update.

JSON

Required

  

Request Format

PUT https://adapi.sizmek.com/sas/tagManagers/activities/thirdparty/{id}

Example
{"entities": [{
  "type": "ThirdPartyActivity",
  "id": 1083878971,
  "relationsBag": {
    "parents": {
      "account": {
        "id": 1073744288,
        "name": "AccountDemo0",
        "internal": false
      },
      "advertiser": {
        "id": 1083762304,
        "name": "adv3333"
      },
      "brand": null,
      "campaign": null,
      "site": null
    },
    "children": {
      "advertisers": {
        "count": 0
      },
      "brands": {
        "count": 0
      },
      "campaigns": {
        "count": 0
      },
      "users": {
        "count": 0
      }
    },
    "creativeAccountContact": false
  },
  "version": 1561451016021803000,
  "createdBy": 1073741831,
  "createdByName": "User",
  "createdByAccount": 1073741826,
  "createdByAccountName": "Account",
  "createdOn": 1561448933204,
  "lastUpdatedBy": 1073741831,
  "lastUpdatedByName": "User",
  "lastUpdatedByAccount": 1073741826,
  "lastUpdatedByAccountName": "Account",
  "lastUpdateOn": 1561451016017,
  "name": "fff",
  "activityType": "ThirdPartyConversionTracking",
  "advertiserId": 1083762304,
  "rulesCount": null,
  "tagManagersCount": null,
  "conversionsCount": 2,
  "tagManagerIds": null,
  "accessLevel": "Full",
  "nxtTagManagement": true,
  "code": "ff",
  "noScriptMode": false,
  "piggyBack": {
    "type": "PiggyBack",
    "deduplication": "AttributedSite",
    "firingMode": "Inherited",
    "siteName": "00X1Fkdrm0de111",
    "siteId": 1083782050,
    "deduplicationConversionAttributionModel": {
      "type": "DeduplicationConversionAttributionModel",
      "fire3rdPartyTracking": "LastEventImpressionOrClick",
      "impressionValidUpTo": 30,
      "clickValidUpTo": 30
    }
  },
  "conditions": [
    {
      "type": "VariableCondition",
      "orConditions": [
        {
          "type": "VariableInnerCondition",
          "andConditions": [
            {
              "type": "AndVariableInnerCondition",
              "values": [
                "tttt"
              ],
              "variableId": 1083753345,
              "variableName": "111",
              "variableDataType": "String",
              "operator": "EqualsOneOfTheFollowing"
            },
            {
              "type": "AndVariableInnerCondition",
              "values": [
                "43534345"
              ],
              "variableId": 1083753342,
              "variableName": "666",
              "variableDataType": "String",
              "operator": "DoesNotEqualOneOfTheFollowing"
            }
          ]
        },
        {
          "type": "VariableInnerCondition",
          "andConditions": [
            {
              "type": "AndVariableInnerCondition",
              "values": [
                "7777"
              ],
              "variableId": 1083753345,
              "variableName": "111",
              "variableDataType": "String",
              "operator": "EqualsOneOfTheFollowing"
            }
          ]
        }
      ],
      "criteriaType": "Variable"
    }
  ],
  "conversionIds": null,
  "codeVariableIds": null
}
]
}

Response Format

A successful request returns the HTTP 200 OK status code and a JSON response body that shows the updated 3rd party activity resource.

Delete a 3rd Party Activity (DELETE)

Deletes a single 3rd party activity.

Request Parameters

NAME

DESCRIPTION

TYPE

REQUIRED

NOTES

id

ID of 3rd party activity to delete.

Long

Required

  

Request Format

DELETE https://adapi.sizmek.com/sas/tagManagers/activities/thirdparty/{id}

Response Format

A successful request returns the HTTP 200 OK status code; the requested 3rd party activity is deleted.

Delete 3rd Party Activities in Bulk (POST)

Deletes a single 3rd party activity.

Request Format

POST https://adapi.sizmek.com/sas/tagManagers/activities/thirdparty/delete

Response Format

A successful request returns the HTTP 200 OK status code; the 3rd party activities are deleted.

Retrieve 3rd Party Activity in a Conversion Activity (GET)

Retrieves a 3rd party activity within a conversion activity.

Request Format

GET https://adapi.sizmek.com/sas/tagManagers/activities/thirdparty/getByConversionId/{ConversionActivityID}?from=0&max=250&order=asc&sort=name

Response Format

A successful request returns the HTTP 200 OK status code and an array of the 3rd party activities in the conversion activity.

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments