REST Resource: orderDocuments
Stay organized with collections
Save and categorize content based on your preferences.
Resource: OrderDocument
Contains properties of a Planning order document.
| JSON representation |
{
"id": string,
"kind": string,
"title": string,
"type": enum (Type),
"amendedOrderDocumentId": string,
"effectiveDate": string,
"signed": boolean,
"cancelled": boolean,
"approvedByUserProfileIds": [
string
],
"createdInfo": {
object (LastModifiedInfo)
},
"lastSentTime": string,
"lastSentRecipients": [
string
],
"orderId": string,
"accountId": string,
"subaccountId": string,
"advertiserId": string,
"projectId": string
} |
| Fields |
id |
string (int64 format)
ID of this order document.
|
kind |
string
Identifies what kind of resource this is. Value: the fixed string
"dfareporting#orderDocument"
.
|
title |
string
Title of this order document.
|
type |
enum (Type)
Type of this order document
|
amendedOrderDocumentId |
string (int64 format)
The amended order document ID of this order document. An order document can be created by optionally amending another order document so that the change history can be preserved.
|
effectiveDate |
string
Effective date of this order document.
|
signed |
boolean
Whether this order document has been signed.
|
cancelled |
boolean
Whether this order document is cancelled.
|
approvedByUserProfileIds[] |
string (int64 format)
IDs of users who have approved this order document.
|
createdInfo |
object (LastModifiedInfo)
Information about the creation of this order document.
|
lastSentTime |
string
Timestamp of the last email sent with this order document.
|
lastSentRecipients[] |
string
accountPermissionGroups.list of email addresses that received the last sent document.
|
orderId |
string (int64 format)
ID of the order from which this order document is created.
|
accountId |
string (int64 format)
Account ID of this order document.
|
subaccountId |
string (int64 format)
Subaccount ID of this order document.
|
advertiserId |
string (int64 format)
Advertiser ID of this order document.
|
projectId |
string (int64 format)
Project ID of this order document.
|
Type
| Enums |
PLANNING_ORDER_TYPE_INSERTION_ORDER |
|
PLANNING_ORDER_TYPE_CHANGE_ORDER |
|
Methods |
|
|
Gets one order document by ID. |
|
|
Retrieves a list of order documents, possibly filtered. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-19 UTC.
[null,null,["Last updated 2024-09-19 UTC."],[[["\u003cp\u003eThe OrderDocument resource represents properties of a Planning order document, including details like title, type, effective date, and approval status.\u003c/p\u003e\n"],["\u003cp\u003eOrder documents can be either insertion orders or change orders, and they track changes made to associated planning orders.\u003c/p\u003e\n"],["\u003cp\u003eKey properties include IDs for the order document, associated order, account, subaccount, advertiser, and project, along with timestamps for creation and last email sent.\u003c/p\u003e\n"],["\u003cp\u003eYou can retrieve individual order documents by ID or list them, applying filters if needed, using the provided methods.\u003c/p\u003e\n"],["\u003cp\u003eOrderDocument resources are part of the Planning API within DCM and contain information about Planning orders like title, ID, type, and associated accounts.\u003c/p\u003e\n"]]],[],null,["# REST Resource: orderDocuments\n\nResource: OrderDocument\n-----------------------\n\nContains properties of a Planning [order](https://support.google.com/dcm/answer/6025561) document.\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"id\": string, \"kind\": string, \"title\": string, \"type\": enum (/doubleclick-advertisers/rest/v4/orderDocuments#Type), \"amendedOrderDocumentId\": string, \"effectiveDate\": string, \"signed\": boolean, \"cancelled\": boolean, \"approvedByUserProfileIds\": [ string ], \"createdInfo\": { object (/doubleclick-advertisers/rest/v4/LastModifiedInfo) }, \"lastSentTime\": string, \"lastSentRecipients\": [ string ], \"orderId\": string, \"accountId\": string, \"subaccountId\": string, \"advertiserId\": string, \"projectId\": string } ``` |\n\n| Fields ||\n|------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `id` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` ID of this order document. |\n| `kind` | `string` Identifies what kind of resource this is. Value: the fixed string `\"dfareporting#orderDocument\"` . |\n| `title` | `string` Title of this order document. |\n| `type` | `enum (`[Type](/doubleclick-advertisers/rest/v4/orderDocuments#Type)`)` Type of this order document |\n| `amendedOrderDocumentId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The amended order document ID of this order document. An order document can be created by optionally amending another order document so that the change history can be preserved. |\n| `effectiveDate` | `string` Effective date of this order document. |\n| `signed` | `boolean` Whether this order document has been signed. |\n| `cancelled` | `boolean` Whether this order document is cancelled. |\n| `approvedByUserProfileIds[]` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` IDs of users who have approved this order document. |\n| `createdInfo` | `object (`[LastModifiedInfo](/doubleclick-advertisers/rest/v4/LastModifiedInfo)`)` Information about the creation of this order document. |\n| `lastSentTime` | `string` Timestamp of the last email sent with this order document. |\n| `lastSentRecipients[]` | `string` accountPermissionGroups.list of email addresses that received the last sent document. |\n| `orderId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` ID of the order from which this order document is created. |\n| `accountId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Account ID of this order document. |\n| `subaccountId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Subaccount ID of this order document. |\n| `advertiserId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Advertiser ID of this order document. |\n| `projectId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Project ID of this order document. |\n\nType\n----\n\n| Enums ||\n|---------------------------------------|---|\n| `PLANNING_ORDER_TYPE_INSERTION_ORDER` | |\n| `PLANNING_ORDER_TYPE_CHANGE_ORDER` | |\n\n| Methods ------- ||\n|------------------------------------------------------------------|---------------------------------------------------------|\n| ### [get](/doubleclick-advertisers/rest/v4/orderDocuments/get) | Gets one order document by ID. |\n| ### [list](/doubleclick-advertisers/rest/v4/orderDocuments/list) | Retrieves a list of order documents, possibly filtered. |"]]
