Method: inventorySourceGroups.list

  • Display & Video 360 API v3 has sunset and users should transition to v4.

  • This document describes how to list inventory source groups accessible to the current user using the Display & Video 360 API v3.

  • The request uses a GET method to the specified URL with optional query parameters for filtering, sorting, and pagination.

  • The response contains a list of inventory source groups and a token for retrieving the next page of results.

  • Accessing this method requires the https://www.googleapis.com/auth/display-video OAuth scope.

Lists inventory source groups that are accessible to the current user.

The order is defined by the orderBy parameter.

HTTP request

GET https://displayvideo.googleapis.com/v3/inventorySourceGroups

The URL uses gRPC Transcoding syntax.

Query parameters

Parameters
pageSize

integer

Requested page size. Must be between 1 and 200. If unspecified will default to 100.
pageToken

string

A token identifying a page of results the server should return. Typically, this is the value of nextPageToken returned from the previous call to ListInventorySources method. If not specified, the first page of results will be returned.
orderBy

string

Field by which to sort the list. Acceptable values are:

  • displayName (default)
  • inventorySourceGroupId

The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, displayName desc.
filter

string

Allows filtering by inventory source group fields.

Supported syntax:

  • Filter expressions are made up of one or more restrictions.
  • Restrictions can be combined by the logical operator OR.
  • A restriction has the form of {field} {operator} {value}.
  • All fields must use the EQUALS (=) operator.

Supported fields:

  • inventorySourceGroupId

The length of this field should be no more than 500 characters.

Reference our filter LIST requests guide for more information.
Union parameter accessor. Required. Identifies which DV360 entity the request is being made within. The LIST request will only return the inventory source group entities that are accessible to the DV360 entity identified within the accessor. accessor can be only one of the following:
partnerId

string (int64 format)

The ID of the partner that has access to the inventory source group.

A partner cannot access advertiser-owned inventory source groups.
advertiserId

string (int64 format)

The ID of the advertiser that has access to the inventory source group.

If an inventory source group is partner-owned, only advertisers to which the group is explicitly shared can access the group.

Request body

The request body must be empty.

Response body

Response message for InventorySourceGroupService.ListInventorySourceGroups.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "inventorySourceGroups": [
    {
      object (InventorySourceGroup)
    }
  ],
  "nextPageToken": string
}
Fields
inventorySourceGroups[]

object (InventorySourceGroup)

The list of inventory source groups.

This list will be absent if empty.
nextPageToken

string

A token to retrieve the next page of results. Pass this value in the pageToken field in the subsequent call to inventorySourceGroups.list method to retrieve the next page of results.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/display-video

For more information, see the OAuth 2.0 Overview.