REST Resource: orderDocuments

Page Summary

The OrderDocument resource contains properties of a Planning order document.
It includes fields such as ID, title, type, effective date, and boolean indicators for whether it's signed or cancelled.
The resource can be retrieved by ID using the get method or a list can be retrieved using the list method.

Resource: OrderDocument

Contains properties of a Planning order document.

JSON representation

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 }

 { 
 "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
`get`	Gets one order document by ID.
`list`	Retrieves a list of order documents, possibly filtered.

REST Resource: orderDocuments

Page Summary

Resource: OrderDocument

Type

Methods

`get`

`list`

REST Resource: orderDocuments Stay organized with collections Save and categorize content based on your preferences.

Page Summary

Resource: OrderDocument

Type

Methods

get

list

REST Resource: orderDocuments

`get`

`list`