CategoryGroup
Ads can fall into one or more of various categories (e.g. Dining), and these categories can form a hierarchy (e.g. Dining -> Italian Dining). To facilitate the visual display of ads in this hierarchy the API will return an array of CategoryGroup objects. Each CategoryGroup describes a category along with its subcategories and the ads that fall into that category. Ads can appear in multiple category groups but are guaranteed to appear in at least one.
Info
Note that as of the initial release of the Portal API there are only top-level categories and this the subcategories field will always be undefined or empty.
Property | Type | Description |
---|---|---|
name | string | The human-readable name of this ad category |
id | string | A unique identifier for this category |
subcategories | CategoryGroup[] | Nested subcategories of this category group. If there are no subcategories this field is undefined or empty |
adIds | string[] | An array of ids of the ads that belong in this category. Every ID in this array corresponds to an ad in the master list of ads in the response |