Method: advertisers.lineItems.list

列出某个广告客户名下的订单项。

顺序由 orderBy 形参定义。如果未指定 entityStatus 的 filter，结果中将不包含具有 ENTITY_STATUS_ARCHIVED 的订单项。

HTTP 请求

GET https://displayvideo.googleapis.com/v1beta2/advertisers/{advertiserId}/lineItems

网址采用 gRPC 转码语法。

路径参数

参数
advertiserId

string (int64 format)

必需。要为其列出订单项的广告客户的 ID。

查询参数

参数
pageSize

integer

请求的页面大小。必须介于 1 到 100 之间。如果未指定，则默认为 100。如果指定了无效值，则返回错误代码 INVALID_ARGUMENT。
pageToken

string

标识服务器应返回的结果页面的令牌。通常，这是上一次调用 lineItems.list 方法时返回的 nextPageToken 值。如果未指定，将返回第一页结果。
orderBy

string

列表排序所依据的字段。可接受的值为：

  • displayName（默认）
  • entityStatus
  • flight.dateRange.endDate
  • updateTime

默认排序顺序是升序。要为字段指定降序，应在字段名称中添加后缀“desc”。示例：displayName desc。
filter

string

允许按订单项属性进行过滤。

支持的语法：

  • 过滤表达式由一项或多项限制组成。
  • 限制可以使用 AND 或 OR 逻辑运算符合并。一系列限制隐式使用 AND。
  • 限制的形式为 {field} {operator} {value}。
  • flight.dateRange.endDate 中使用的运算符必须小于 (<)。
  • 用于 updateTime 的运算符必须是 GREATER THAN OR EQUAL TO (>=) 或 LESS THAN OR EQUAL TO (<=)。
  • 用于 warningMessages 的运算符必须是 HAS (:)。
  • 所有其他字段使用的运算符必须为 EQUALS (=)。
  • 支持的属性：
    • campaignId
    • displayName
    • insertionOrderId
    • entityStatus
    • lineItemId
    • lineItemType
    • flight.dateRange.endDate（格式为 YYYY-MM-DD 的输入内容）
    • warningMessages
    • flight.triggerId
    • updateTime（采用 ISO 8601 格式输入，或 YYYY-MM-DDTHH:MM:SSZ）
    • targetedChannelId
    • targetedNegativeKeywordListId

示例：

  • 广告订单下的所有订单项：insertionOrderId="1234" 个
  • 广告客户名下的所有 ENTITY_STATUS_ACTIVE 或 ENTITY_STATUS_PAUSED 和 LINE_ITEM_TYPE_DISPLAY_DEFAULT 订单项：(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"
  • 排期在 2019 年 3 月 28 日之前结束的所有订单项：flight.dateRange.endDate<"2019-03-28"
  • warningMessages中NO_VALID_CREATIVE的所有订单项：warningMessages:"NO_VALID_CREATIVE" 个
  • 更新时间不超过 2020-11-04T18:54:47Z (format of ISO 8601) 的所有订单项：updateTime<="2020-11-04T18:54:47Z"
  • 更新时间大于或等于 2020-11-04T18:54:47Z (format of ISO 8601) 的所有订单项：updateTime>="2020-11-04T18:54:47Z"
  • 在定位条件中同时使用指定渠道和指定否定关键字列表的所有订单项：targetedNegativeKeywordListId=789 AND targetedChannelId=12345

此字段的长度不应超过 500 个字符。

请求正文

请求正文必须为空。

响应正文

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "lineItems": [
    {
      object (LineItem)
    }
  ],
  "nextPageToken": string
}
字段
lineItems[]

object (LineItem)

订单项列表。

如果为空，则不会显示此列表。
nextPageToken

string

用于检索下一页结果的令牌。在后续调用 lineItems.list 方法时，将此值传入 pageToken 字段，以检索下一页结果。

授权范围

需要以下 OAuth 作用域：

  • https://www.googleapis.com/auth/display-video

有关详情，请参阅 OAuth 2.0 概览。