Method: inventoryItems.list
Stay organized with collections
Save and categorize content based on your preferences.
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
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-16 UTC.
[null,null,["Last updated 2024-10-16 UTC."],[[["\u003cp\u003eRetrieves a paginated list of inventory items, potentially filtered by IDs, plan status, order association, type, site association, and sorted by a specified field.\u003c/p\u003e\n"],["\u003cp\u003eThe request is made using an HTTP GET method to a specific endpoint, requiring \u003ccode\u003eprofileId\u003c/code\u003e and \u003ccode\u003eprojectId\u003c/code\u003e as path parameters.\u003c/p\u003e\n"],["\u003cp\u003eFiltering and pagination are achieved using various query parameters, including \u003ccode\u003eids\u003c/code\u003e, \u003ccode\u003einPlan\u003c/code\u003e, \u003ccode\u003eorderId\u003c/code\u003e, \u003ccode\u003etype\u003c/code\u003e, \u003ccode\u003esiteId\u003c/code\u003e, \u003ccode\u003epageToken\u003c/code\u003e, \u003ccode\u003emaxResults\u003c/code\u003e, \u003ccode\u003esortField\u003c/code\u003e, and \u003ccode\u003esortOrder\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe response body contains a list of inventory items, a pagination token for subsequent requests, and a resource identifier.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization requires the \u003ccode\u003ehttps://www.googleapis.com/auth/dfatrafficking\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],[],null,["# Method: inventoryItems.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.InventoryItemsListResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nRetrieves a list of inventory items, possibly filtered. This method supports [paging](/doubleclick-advertisers/trafficking_tasks#list).\n\n### HTTP request\n\n`GET https://dfareporting.googleapis.com/dfareporting/v4/userprofiles/{profileId}/projects/{projectId}/inventoryItems`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|---------------|-----------------------------------------------------------------------------------------------------------------------------------|\n| `profile``Id` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` User profile ID associated with this request. |\n| `project``Id` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Project ID for order documents. |\n\n### Query parameters\n\n| Parameters ||\n|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `ids[]` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Select only inventory items with these IDs. |\n| `max``Results` | `integer` Maximum number of results to return. |\n| `in``Plan` | `boolean` Select only inventory items that are in plan. |\n| `order``Id[]` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Select only inventory items that belong to specified orders. |\n| `type` | `enum (`[PlanningPlacementType](/doubleclick-advertisers/rest/v4/inventoryItems#PlanningPlacementType)`)` Select only inventory items with this type. |\n| `page``Token` | `string` Value of the `nextPageToken` from the previous result page. |\n| `site``Id[]` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Select only inventory items that are associated with these sites. |\n| `sort``Field` | `enum (`[SortField](/doubleclick-advertisers/rest/v4/SortField)`)` Field by which to sort the list. |\n| `sort``Order` | `enum (`[SortOrder](/doubleclick-advertisers/rest/v4/SortOrder)`)` Order of sorted results. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nInventory item inventoryItems.list Response\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"nextPageToken\": string, \"inventoryItems\": [ { object (/doubleclick-advertisers/rest/v4/inventoryItems#InventoryItem) } ] } ``` |\n\n| Fields ||\n|----------------------|--------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Identifies what kind of resource this is. Value: the fixed string `\"dfareporting#inventoryItemsListResponse\"` . |\n| `next``Page``Token` | `string` Pagination token to be used for the next list operation. |\n| `inventory``Items[]` | `object (`[InventoryItem](/doubleclick-advertisers/rest/v4/inventoryItems#InventoryItem)`)` Inventory item collection |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/dfatrafficking`"]]
