GuidesAPI ReferenceChangelog
GuidesAPI ReferenceChangelogLog In
Guides

[Advertiser] View Advertiser Categories

Retrieving All Categories at the Advertiser Level

For the Advertiser API, all categories for the specified advertiser will be returned.

This will include multiple instances of a category if that category is associated with more than one of the advertiser's campaigns.

https://api.criteo.com/legacy/marketing/v1/advertisers/{advertiserId}/categories
curl --request GET \
  --url https://api.criteo.com/legacy/marketing/v1/advertisers/12345/categories \
  --header 'Accept: application/json'

 

The following is an example of what's returned:

[
  {
      "categoryHashCode": 15304,
      "categoryName": "my-category",
      "catalogId": 45678,
      "catalogName": "My Catalog",
      "advertiserId": 12345,
      "advertiserName": "Advertiser A",
      "campaignId": 555555,
      "campaignName": "Lower Funnel",
      "averagePrice": 538.90,
      "numberOfProducts": 125,
      "categoryBid": { "bidValue": 0.75, "bidCurrency": "USD", "bidType": "CPC" },
      "enabled": true
  },
  {
    "categoryHashCode": 15304,
    "categoryName": "my-category",
    "catalogId": 45678,
    "catalogName": "My Catalog",
    "advertiserId": 12345,
    "advertiserName": "Advertiser A",
    "campaignId": 666666,
    "campaignName": "Prospecting",
    "averagePrice": 538.90,
    "numberOfProducts": 125,
    "categoryBid": { "bidValue": 0.1, "bidCurrency": "USD", "bidType": "CPC" },
    "enabled": true
  }
]

 

Retrieving a Specific Category at the Advertiser Level

To retrieve the category information related to a specific campaign, you can look up that category by its categoryHashCode.

https://api.criteo.com/legacy/marketing/v1/advertisers/{advertiserId}/categories/{categoryHashCode}
curl --request GET \
  --url https://api.criteo.com/legacy/marketing/v1/advertisers/12345/categories/15304 \
  --header 'Accept: application/json'
{
    "categoryHashCode": 15304,
    "categoryName": "my-category",
    "catalogId": 45678,
    "catalogName": "My Catalog",
    "advertiserId": 12345,
    "advertiserName": "Advertiser A",
    "campaignId": 555555,
    "campaignName": "Lower Funnel",
    "averagePrice": 538.90,
    "numberOfProducts": 125,
    "categoryBid": { "bidValue": 0.75, "bidCurrency": "USD", "bidType": "CPC" },
    "enabled": true
}

🚧

Single Category Record Returned

If a category is associated with multiple campaigns, only the first record (associated with a single campaign) will be returned. To retrieve a specific category for a specific campaign, use the All Categories call above and filter the results instead.