v1Resources/Locations/getSearch a publisher's own category catalog
Search a publisher's own category catalog
Searches one publisher's own (GABF) category catalog — global reference data, not scoped to your agency. Use the returned id for a location's publisherCategories on create or update. Omit query entirely to list the publisher's whole catalog, uncapped.
get
locations:read/api/v1/locations/publisher-categoriesQuery parameters
publisherstring (google | facebook | apple | bing)required
Which publisher's catalog to search: google, apple, bing, or facebook.
querystringoptional
Category name substring to match. Omit to list the publisher's entire catalog, uncapped.
countrystringoptional
ISO-3166-1 alpha-2 country — recommended for apple, whose categories are country-specific.
Response
dataobjectoptional
categoriesarray of objectoptional
The matching categories in the requested publisher's own catalog.
idstringoptional
The publisher's own category id — pass this in publisherCategories on create or update. Null is possible for a catalog entry with no id.
displayNamestringoptional
The category's display name in that publisher's catalog.
Errors
400The request is missing a required parameter or is otherwise malformed.
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
429Too many requests. Retry after the number of seconds in the Retry-After header.
get/api/v1/locations/publisher-categories
Your API key
publisher *
query
country
{
"data": {
"categories": [
{
"id": "gcid:dentist",
"displayName": "Dentist"
}
]
}
}