OrderDocuments

このリソースのメソッドの一覧は、このページの最後に掲載されています。

リソース表現

プランニングのオーダー ドキュメントのプロパティが含まれています。

{
  "kind": "dfareporting#orderDocument",
  "id": long,
  "orderId": long,
  "accountId": long,
  "subaccountId": long,
  "advertiserId": long,
  "projectId": long,
  "title": string,
  "type": string,
  "amendedOrderDocumentId": long,
  "effectiveDate": date,
  "signed": boolean,
  "cancelled": boolean,
  "approvedByUserProfileIds": [
    long
  ],
  "createdInfo": {
    "time": long
  },
  "lastSentTime": datetime,
  "lastSentRecipients": [
    string
  ]
}
プロパティ名 説明 メモ
accountId long このオーダー ドキュメントのアカウント ID。
advertiserId long このオーダー ドキュメントの広告主 ID。
amendedOrderDocumentId long このオーダー ドキュメントの修正後オーダー ドキュメント ID。オーダー ドキュメントは、変更履歴を保存するために、必要に応じて別のオーダー ドキュメントを修正して作成できます。
approvedByUserProfileIds[] list このオーダー ドキュメントを承認したユーザーの ID。
cancelled boolean このオーダー ドキュメントがキャンセルされたかどうか。
createdInfo nested object このオーダー ドキュメントの作成に関する情報。
createdInfo.time long 最終変更のタイムスタンプ(エポックからのミリ秒単位の経過時間)。
effectiveDate date このオーダー ドキュメントの発効日。
id long このオーダー ドキュメントの ID。
kind string リソースの種類を示します。値は固定文字列 "dfareporting#orderDocument" です。
lastSentRecipients[] list 最後に送信されたドキュメントを受信したメールアドレスのリスト。
lastSentTime datetime このオーダー ドキュメントとともに送信された最後のメールのタイムスタンプ。
orderId long このオーダー ドキュメントの作成に使用されたオーダーの ID。
projectId long このオーダー ドキュメントのプロジェクト ID。
signed boolean このオーダー ドキュメントが署名されているかどうか。
subaccountId long このオーダー ドキュメントのサブアカウント ID。
title string このオーダー ドキュメントのタイトル。
type string このオーダー ドキュメントのタイプ。

有効な値は次のとおりです。
  • PLANNING_ORDER_TYPE_CHANGE_ORDER
  • PLANNING_ORDER_TYPE_INSERTION_ORDER

メソッド

get
ID により、オーダー ドキュメントを 1 つ取得します。
list
オーダー ドキュメントの一覧を取得します。結果をフィルタできます。このメソッドはページングをサポートします。