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」使用的運算子必須是小於 THAN (<)。
  • 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 總覽。