Item set information APIs

Retrieve and validate Item Set status, contents, and configuration for Display workflows.

Overview

Use Item Set Information APIs to retrieve Item Set details, validate contents, monitor build status, and understand how an Item Set was constructed.

These endpoints do not create or update Item Sets. Instead, they help you discover, inspect, and validate existing Item Sets before using them in campaign measurement or audience targeting workflows.

Availability

Supported for Onsite Display Item Sets.

How it works

Different endpoints provide different levels of detail depending on what you need to learn about an Item Set.

1. List

Retrieve available Item Sets.

2. Select

Identify the correct Item Set.

3. Validate

Confirm build status is complete.

4. Inspect Contents

Review included products, brands, or categories.

5. Inspect Metadata

Review build logic and expressions.

6. Use

Apply the Item Set to campaigns or audiences.

Item Set Information endpoints

How these APIs work together

Most workflows follow the sequence below:

  1. List Item Sets
  2. Identify the correct itemsetId
  3. Verify the Item Set status is BUILD
  4. Retrieve contents if you need to validate included products, brands, or categories
  5. Retrieve metadata if you need to understand build logic or expressions
  6. Use the Item Set in campaigns or audiences

Which endpoint should I use?

I need to...Endpoint
Find available Item SetsList Item Sets
Check build statusList Item Sets
Verify products in an Item SetRetrieve Item Set Contents
Understand category filters or expression logicRetrieve Item Set Metadata
Determine whether an Item Set is measurement or targetingList Item Sets
Understand how a targeting Item Set was builtRetrieve Item Set Metadata

Validation scenarios

Use these endpoints to validate various components of the item sets in advertiser's account.

ScenarioUseTo Confirm
Validate item set readinessList Item Sets
  • Build status

  • Ownership

  • Sharing eligibility

  • Item Set type

Validate item set contentsRetrieve item set contents
  • Products

  • Brands

  • Categories

    before campaign activation or audience creation.

Validate item set constructionRetrieve item set metadata
  • Expressions

  • Categories

  • Attributes

  • Logical build criteria

Related pages


Did this page help you?