Method: inventorySourceGroups.assignedInventorySources.list

  • This page describes how to list inventory sources assigned to an inventory source group using the Display & Video 360 API v2.

  • The HTTP request is a GET request to https://displayvideo.googleapis.com/v2/inventorySourceGroups/{inventorySourceGroupId}/assignedInventorySources.

  • Required parameters include the inventorySourceGroupId and an accessor union parameter to identify the DV360 entity.

  • Optional query parameters are available for pagination, ordering, and filtering the results.

  • The response body contains a list of assigned inventory sources and a nextPageToken for retrieving additional pages of results.

  • This method requires the https://www.googleapis.com/auth/display-video authorization scope.

Lists inventory sources assigned to an inventory source group.

HTTP request

GET https://displayvideo.googleapis.com/v2/inventorySourceGroups/{inventorySourceGroupId}/assignedInventorySources

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
inventorySourceGroupId

string (int64 format)

Required. The ID of the inventory source group to which these assignments are assigned.

Query parameters

Parameters
pageSize

integer

Requested page size. Must be between 1 and 100. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.
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 assignedInventorySources.list method. If not specified, the first page of results will be returned.
orderBy

string

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

  • assignedInventorySourceId (default)

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

string

Allows filtering by assigned inventory source fields.

Supported syntax:

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

Supported fields:

  • assignedInventorySourceId

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 assigned inventory sources 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 assignment.

If the parent inventory source group is advertiser-owned, the assignment cannot be accessed via a partner.
advertiserId

string (int64 format)

The ID of the advertiser that has access to the assignment.

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

Request body

The request body must be empty.

Response body

Response message for AssignedInventorySourceService.ListAssignedInventorySources.

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

JSON representation 
{
  "assignedInventorySources": [
    {
      object (AssignedInventorySource)
    }
  ],
  "nextPageToken": string
}
Fields
assignedInventorySources[]

object (AssignedInventorySource)

The list of assigned inventory sources.

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 assignedInventorySources.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.