Campaign Manager 360 API v3.4 はサポートが終了し、2021 年 12 月 24 日に廃止されます。この日までに、すべてのユーザーが新しいバージョンの API に移行する必要があります。

Orders: list

オーダーの一覧を取得します。結果をフィルタできます。このメソッドはページングをサポートします。実習をご覧ください。

リクエスト

HTTP リクエスト

GET https://www.googleapis.com/dfareporting/v3.4/userprofiles/profileId/projects/projectId/orders

パラメータ

パラメータ名 説明
パス パラメータ
profileId long このリクエストに関連付けられるユーザー プロフィール ID。
projectId long オーダーのプロジェクト ID。
省略可能なクエリ パラメータ
ids long これらの ID を持つオーダーのみを選択します。
maxResults integer 表示する結果の最大数。設定可能な値は 01000 です。デフォルトは 1000 です。
pageToken string 前の結果ページの nextPageToken の値。
searchString string 名前または ID により、オーダーを検索できます。ワイルドカード(*)を使用できます。たとえば、"order*2015" を検索すると、"order June 2015""order April 2015"、または単に "order 2015" のような名前を持つオーダーが返されます。また、ほとんどの検索では、検索文字列の先頭と末尾にワイルドカードが暗黙的に付加されます。たとえば、"order" という検索文字列は、"my order""order 2015"、または単に "order" という名前を持つオーダーに一致します。
siteId long これらのサイト ID に関連付けられているオーダーのみを選択します。
sortField string 結果の並べ替え基準として使用するフィールド。

設定可能な値は次のとおりです。
  • "ID"(デフォルト)
  • "NAME"
sortOrder string 結果の並べ替え順序。

設定可能な値は次のとおりです。
  • "ASCENDING"(デフォルト)
  • "DESCENDING"

認証

このリクエストには、次のスコープによる認証が必要です。

スコープ
https://www.googleapis.com/auth/dfatrafficking

詳しくは、認証と認可のページをご覧ください。

リクエストの本文

このメソッドでは、リクエストの本文を指定しません。

レスポンス

成功すると、このメソッドは次の構造を含むレスポンスの本文を返します。

{
  "kind": "dfareporting#ordersListResponse",
  "nextPageToken": string,
  "orders": [
    orders Resource
  ]
}
プロパティ名 説明 メモ
kind string リソースの種類を示します。値は固定文字列 "dfareporting#ordersListResponse" です。
nextPageToken string 次のリストに移動する操作に使用されるページ分けトークン。
orders[] list オーダーのコレクション。

実習

以下の API Explorer を使用し、ライブデータに対してこのメソッドを呼び出して、レスポンスを確認してみましょう。