Method: inventoryItems.list

  • This page describes how to retrieve a list of inventory items using the specified HTTP request, path parameters, query parameters, and authorization scopes.

  • The HTTP request method is GET and uses gRPC Transcoding syntax with profile and project IDs as path parameters.

  • Various query parameters are available to filter and paginate the list of inventory items.

  • The request body must be empty, and the response body contains a JSON representation of the list of inventory items with optional pagination information.

Retrieves a list of inventory items, possibly filtered. This method supports paging.

HTTP request

GET https://dfareporting.googleapis.com/dfareporting/v4/userprofiles/{profileId}/projects/{projectId}/inventoryItems

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
profileId

string (int64 format)

User profile ID associated with this request.
projectId

string (int64 format)

Project ID for order documents.

Query parameters

Parameters
ids[]

string (int64 format)

Select only inventory items with these IDs.
maxResults

integer

Maximum number of results to return.
inPlan

boolean

Select only inventory items that are in plan.
orderId[]

string (int64 format)

Select only inventory items that belong to specified orders.
type

enum (PlanningPlacementType)

Select only inventory items with this type.
pageToken

string

Value of the

nextPageToken

from the previous result page.
siteId[]

string (int64 format)

Select only inventory items that are associated with these sites.
sortField

enum (SortField)

Field by which to sort the list.
sortOrder

enum (SortOrder)

Order of sorted results.

Request body

The request body must be empty.

Response body

Inventory item inventoryItems.list Response

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

JSON representation 
{
  "kind": string,
  "nextPageToken": string,
  "inventoryItems": [
    {
      object (InventoryItem)
    }
  ]
}
Fields
kind

string

Identifies what kind of resource this is. Value: the fixed string

"dfareporting#inventoryItemsListResponse"

.
nextPageToken

string

Pagination token to be used for the next list operation.
inventoryItems[]

object (InventoryItem)

Inventory item collection

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/dfatrafficking