Retrieves a list of inventory items, possibly filtered. This method supports paging. Try it now.
Request
HTTP request
GET https://www.googleapis.com/dfareporting/v3.4/userprofiles/profileId/projects/projectId/inventoryItems
Parameters
Parameter name | Value | Description |
---|---|---|
Path parameters | ||
profileId |
long |
User profile ID associated with this request. |
projectId |
long |
Project ID for order documents. |
Optional query parameters | ||
ids |
long |
Select only inventory items with these IDs. |
inPlan |
boolean |
Select only inventory items that are in plan. |
maxResults |
integer |
Maximum number of results to return.
Acceptable values are 0 to 1000 , inclusive.
(Default: 1000 )
|
orderId |
long |
Select only inventory items that belong to specified orders. |
pageToken |
string |
Value of the nextPageToken from the previous result page.
|
siteId |
long |
Select only inventory items that are associated with these sites. |
sortField |
string |
Field by which to sort the list.
Acceptable values are:
|
sortOrder |
string |
Order of sorted results.
Acceptable values are:
|
type |
string |
Select only inventory items with this type.
Acceptable values are:
|
Authorization
This request requires authorization with the following scope:
Scope |
---|
https://www.googleapis.com/auth/dfatrafficking |
For more information, see the authentication and authorization page.
Request body
Do not supply a request body with this method.
Response
If successful, this method returns a response body with the following structure:
{ "kind": "dfareporting#inventoryItemsListResponse", "nextPageToken": string, "inventoryItems": [ inventoryItems Resource ] }
Property name | Value | Description | Notes |
---|---|---|---|
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[] |
list |
Inventory item collection |
Try it!
Use the APIs Explorer below to call this method on live data and see the response.