Merchant product list tracking tags

As an advertiser, you can create tracking tags for product lists using the platform UI and then use the Campaign APIs to retrieve the tracking tag information. For example, some merchants may query campaigns for the attribution tracking tags and then use the commerce tracking tag endpoints to keep a map of tracking tags and product lists for advertisers, so that merchants can manage the offline attribution.

The following table lists all tasks that you might need to perform when managing product list tracking tags.

IMPORTANT: All Commerce Solutions endpoints enforce a maximum of 1000 items per request. Payloads that exceed this limit will be rejected. To stay within the limit, split large datasets into multiple requests.

Tracking tag batch response example

A successful response to the tracking tag endpoints returns a BatchResponses object with product list names and IDs in the Response object for the tracking tag specified in the request.

{
   "BatchResponses":{
      "TrackingTagId1":{
         "Response":{
            "ListId":"list1234",
            "ListName":"Merchant Brand Food & Beverages"
         }
      },
      " TrackingTagId2":{
         "Response":{
            "ListId":"list2345",
            "ListName":"Merchant Brand Fresh Produce"
         }
      }
   },
   "ContainsError":false
}

Get all tracking tags and associated product lists for an advertiser

To retrieve all tracking tags and their associated product lists for a given advertiser, in a POST/ecommerce/trackingtag/lists/query request, specify the advertiser ID and the merchant ID of the product catalog used for the lists.

{
   "AdvertiserId":"ADVERTISER_ID_PLACEHOLDER",
   "MerchantId":"MERCHANT_ID_PLACEHOLDER"
}

A successful response returns a BatchResponses object with all available tracking tag IDs and product list names and IDs associated with each tag.

Get product lists for tracking tag IDs

To retrieve names and IDs of product lists for one or more tracking tag IDs, when doing attribution offline, in a POST/ecommerce/trackingtag/lists/batch/query request, specify the advertiser ID, the merchant ID, and the IDs of the tracking tags for which you want to look up associated product list names and IDs.

TIP: To look up tracking tag IDs, you can use the Campaign APIs. Tracking tags are also exposed in the conversion report columns.

Here's an example of a POST/ecommerce/trackingtag/lists/batch/query request:

{
   "AdvertiserId":"ADVERTISER_ID_PLACEHOLDER",
   "MerchantId":"MERCHANT_ID_PLACEHOLDER",
   "TrackingTagIds":[
      {
         "TrackingTagId":"TrackingTagId1"
      },
      {
         "TrackingTagId":"TrackingTagId2"
      }
   ]
}

A successful response returns a BatchResponses object with product list names and IDs for each tracking tag ID.