Method: advertisers.insertionOrders.list
HTTP 请求
GET https://displayvideo.googleapis.com/v3/advertisers/{advertiserId}/insertionOrders
网址采用 gRPC 转码语法。
路径参数
参数 |
advertiserId |
string (int64 format)
必需。要为其列出广告订单的广告客户的 ID。
|
查询参数
参数 |
pageSize |
integer
请求的页面大小。 必须介于 1 到 100 之间。如果未指定,则默认为 100 。如果指定的值无效,则返回错误代码 INVALID_ARGUMENT 。
|
pageToken |
string
标识服务器应返回的结果页面的令牌。通常,这是上次调用 insertionOrders.list 方法返回的 nextPageToken 值。如果未指定,则返回第一页的结果。
|
orderBy |
string
表示要按哪个字段对此列表进行排序。可接受的值包括:
- “displayName”(默认)
- “entityStatus”
- "updateTime"
默认排序顺序为升序。如需将字段指定为降序,应将后缀“desc”添加到字段名称中。示例:displayName desc 。
|
filter |
string
允许按广告订单字段进行过滤。 支持的语法:
- 过滤条件表达式由一个或多个限制条件组成。
- 限制条件可以通过
AND 或 OR 逻辑运算符组合使用。一系列限制会隐式使用 AND 。
- 限制的格式为
{field} {operator} {value} 。
updateTime 字段必须使用 GREATER THAN OR EQUAL TO (>=) 或 LESS THAN OR EQUAL TO (<=) 运算符。
- 所有其他字段都必须使用
EQUALS (=) 运算符。
支持的字段:
campaignId
displayName
entityStatus
updateTime (输入值采用 ISO 8601 格式,或 YYYY-MM-DDTHH:MM:SSZ )
示例:
- 广告系列下的所有广告订单:
campaignId="1234"
- 广告客户下的所有
ENTITY_STATUS_ACTIVE 或 ENTITY_STATUS_PAUSED 广告订单:(entityStatus="ENTITY_STATUS_ACTIVE" OR
entityStatus="ENTITY_STATUS_PAUSED")
- 更新时间小于或等于 2020-11-04T18:54:47Z(ISO 8601 格式)的所有广告订单:
updateTime<="2020-11-04T18:54:47Z"
- 更新时间大于或等于 2020-11-04T18:54:47Z(ISO 8601 格式)的所有广告订单:
updateTime>="2020-11-04T18:54:47Z"
此字段的长度不应超过 500 个字符。 如需了解详情,请参阅我们的过滤 LIST 请求指南。
|
响应正文
JSON 表示法 |
{
"insertionOrders": [
{
object (InsertionOrder )
}
],
"nextPageToken": string
} |
字段 |
insertionOrders[] |
object (InsertionOrder )
广告订单列表。 如果为空,则不会显示此列表。
|
nextPageToken |
string
用于检索下一页结果的令牌。在后续调用 insertionOrders.list 方法时,将此值传入 pageToken 字段以检索下一页结果。
|
授权范围
需要以下 OAuth 范围:
https://www.googleapis.com/auth/display-video
如需了解详情,请参阅 OAuth 2.0 概览。
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2024-11-07。
[null,null,["最后更新时间 (UTC):2024-11-07。"],[[["Lists insertion orders, filterable by campaign ID, display name, entity status, and update time, within a specified advertiser."],["Supports pagination to retrieve large result sets via `pageToken` and `pageSize` parameters."],["Allows sorting results by display name, entity status, or update time, with optional descending order."],["Response provides a list of insertion orders and a token for fetching the next page if available."],["Requires authorization with the `https://www.googleapis.com/auth/display-video` scope."]]],[]]