This API is in Beta. The Ad Manager SOAP API documentation is available here.
Method: networks.taxonomyCategories.list
API to retrieve a list of TaxonomyCategory objects.
HTTP request
GET https://admanager.googleapis.com/v1/{parent}/taxonomyCategories
Path parameters
| Parameters |
parent |
string
Required. The parent, which owns this collection of TaxonomyCategories. Format: networks/{networkCode}
|
Query parameters
| Parameters |
pageSize |
integer
Optional. The maximum number of TaxonomyCategories to return. The service may return fewer than this value. If unspecified, at most 50 TaxonomyCategories will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
|
pageToken |
string
Optional. A page token, received from a previous taxonomyCategories.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to taxonomyCategories.list must match the call that provided the page token.
|
filter |
string
Optional. Expression to filter the response. See syntax details at https://developers.google.com/ad-manager/api/beta/filters
|
orderBy |
string
Optional. Expression to specify sorting order. See syntax details at https://developers.google.com/ad-manager/api/beta/filters#order
|
skip |
integer
Optional. Number of individual resources to skip while paginating.
|
Request body
The request body must be empty.
Response body
Response object for ListTaxonomyCategoriesRequest containing matching TaxonomyCategory objects.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"taxonomyCategories": [
{
object (TaxonomyCategory)
}
],
"nextPageToken": string,
"totalSize": integer
} |
| Fields |
taxonomyCategories[] |
object (TaxonomyCategory)
The TaxonomyCategory objects.
|
nextPageToken |
string
A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.
|
totalSize |
integer
Total number of TaxonomyCategory objects. If a filter was included in the request, this reflects the total number after the filtering is applied. totalSize will not be calculated in the response unless it has been included in a response field mask. The response field mask can be provided to the method by using the URL parameter $fields or fields, or by using the HTTP/gRPC header X-Goog-FieldMask.
For more information, see https://developers.google.com/ad-manager/api/beta/field-masks
|
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/admanager
For more information, see the OAuth 2.0 Overview.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-23 UTC.
[null,null,["Last updated 2024-09-23 UTC."],[[["This API retrieves a list of TaxonomyCategory objects, allowing filtering, sorting, and pagination."],["The request requires authorization with the `https://www.googleapis.com/auth/admanager` scope."],["The response includes an array of TaxonomyCategory objects, a token for pagination, and the total size of the result set."],["The API uses a GET request to the endpoint `https://admanager.googleapis.com/v1/{parent}/taxonomyCategories` where `{parent}` is the network code."],["Developers can use query parameters to control the number of results, page through results, filter, and order the returned TaxonomyCategories."]]],["This API retrieves `TaxonomyCategory` objects via a `GET` request to `https://admanager.googleapis.com/v1/{parent}/taxonomyCategories`, where `parent` is a required path parameter. Optional query parameters include `pageSize`, `pageToken`, `filter`, `orderBy`, and `skip` for pagination, filtering, and sorting. The request body must be empty. The response includes a list of `TaxonomyCategory` objects, `nextPageToken` for further pagination, and `totalSize` to indicate the total number of element. Authorization requires the `https://www.googleapis.com/auth/admanager` OAuth scope.\n"]]
