Method: advertisers.lineItems.list

広告主の広告申込情報を一覧表示します。

順序は orderBy パラメータで定義されます。entityStatus の filter が指定されていない場合、ENTITY_STATUS_ARCHIVED の広告申込情報は結果に含まれません。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
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

広告申込情報のプロパティでフィルタできます。

サポートされる構文:

  • フィルタ式は 1 つ以上の制限で構成されます。
  • 制限は 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 の概要をご覧ください。