Method: networks.roles.list
Stay organized with collections
Save and categorize content based on your preferences.
API to retrieve a list of Role objects.
HTTP request
GET https://admanager.googleapis.com/v1/{parent}/roles
Path parameters
| Parameters |
parent |
string
Required. The parent, which owns this collection of Roles. Format: networks/{networkCode}
|
Query parameters
| Parameters |
pageSize |
integer
Optional. The maximum number of Roles to return. The service may return fewer than this value. If unspecified, at most 50 Roles 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 roles.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to roles.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 ListRolesRequest containing matching Role objects.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"roles": [
{
object (Role)
}
],
"nextPageToken": string,
"totalSize": integer
} |
| Fields |
roles[] |
object (Role)
The Role objects from the specified network.
|
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 Role 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 2025-08-20 UTC.
[null,null,["Last updated 2025-08-20 UTC."],[[["\u003cp\u003eRetrieves a list of \u003ccode\u003eRole\u003c/code\u003e objects for a given network using the \u003ccode\u003eGET\u003c/code\u003e method.\u003c/p\u003e\n"],["\u003cp\u003eAllows for filtering, sorting, and pagination of results using query parameters.\u003c/p\u003e\n"],["\u003cp\u003eThe response includes an array of \u003ccode\u003eRole\u003c/code\u003e objects, a token for pagination, and the total number of roles.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/admanager\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["This API uses a `GET` request to retrieve a list of `Role` objects via the URL `https://admanager.googleapis.com/v1/{parent}/roles`. The `parent` path parameter is required. Optional query parameters include `pageSize`, `pageToken`, `filter`, `orderBy`, and `skip` for pagination and filtering. The request body must be empty. The response contains an array of `Role` objects, a `nextPageToken` for pagination, and `totalSize`, all formatted in JSON. It requires the OAuth scope `https://www.googleapis.com/auth/admanager`.\n"],null,["# Method: networks.roles.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListRolesResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nAPI to retrieve a list of `Role` objects.\n\n### HTTP request\n\n`GET https://admanager.googleapis.com/v1/{parent}/roles`\n\n### Path parameters\n\n| Parameters ||\n|----------|------------------------------------------------------------------------------------------------------|\n| `parent` | `string` Required. The parent, which owns this collection of Roles. Format: `networks/{networkCode}` |\n\n### Query parameters\n\n| Parameters ||\n|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` Optional. The maximum number of `Roles` to return. The service may return fewer than this value. If unspecified, at most 50 `Roles` will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |\n| `pageToken` | `string` Optional. A page token, received from a previous `roles.list` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `roles.list` must match the call that provided the page token. |\n| `filter` | `string` Optional. Expression to filter the response. See syntax details at \u003chttps://developers.google.com/ad-manager/api/beta/filters\u003e |\n| `orderBy` | `string` Optional. Expression to specify sorting order. See syntax details at \u003chttps://developers.google.com/ad-manager/api/beta/filters#order\u003e |\n| `skip` | `integer` Optional. Number of individual resources to skip while paginating. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse object for `ListRolesRequest` containing matching `Role` objects.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"roles\": [ { object (/ad-manager/api/beta/reference/rest/v1/networks.roles#Role) } ], \"nextPageToken\": string, \"totalSize\": integer } ``` |\n\n| Fields ||\n|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `roles[]` | `object (`[Role](/ad-manager/api/beta/reference/rest/v1/networks.roles#Role)`)` The `Role` objects from the specified network. |\n| `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. |\n| `totalSize` | `integer` Total number of `Role` 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 \u003chttps://developers.google.com/ad-manager/api/beta/field-masks\u003e |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/admanager`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2)."]]
