To discuss and provide feedback on our products, join the official Ad Manager Discord channel in the Google Advertising and Measurement Community server.

Method: networks.roles.list

Page Summary

The API allows retrieval of a list of Role objects.
The HTTP request method is GET, requiring a parent path parameter indicating the network.
Optional query parameters such as pageSize , pageToken , filter , orderBy , and skip can be used to control the response.
The request body should be empty.
The successful response body contains a list of Role objects, an optional nextPageToken for pagination, and an optional totalSize .

HTTP request
Path parameters
Query parameters
Request body
Response body
- JSON representation
Authorization scopes
Try it!

API to retrieve a list of Role objects.

HTTP request

GET https://admanager.googleapis.com/v1/{parent}/roles

Path parameters

Parameters

Parameters
`parent`	`string` Required. The parent, which owns this collection of Roles. Format: `networks/{networkCode}`

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 greater than 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

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` won't 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

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 won't 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 .

Method: networks.roles.list Stay organized with collections Save and categorize content based on your preferences.