OrderDocuments

For a list of methods for this resource, see the end of this page.

Resource representations

Contains properties of a Planning order document.

{
  "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
  ]
}

Property name	Value	Description	Notes
accountId	long	Account ID of this order document.
advertiserId	long	Advertiser ID of this order document.
amendedOrderDocumentId	long	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.
approvedByUserProfileIds[]	list	IDs of users who have approved this order document.
cancelled	boolean	Whether this order document is cancelled.
createdInfo	nested object	Information about the creation of this order document.
createdInfo.time	long	Timestamp of the last change in milliseconds since epoch.
effectiveDate	date	Effective date of this order document.
id	long	ID of this order document.
kind	string	Identifies what kind of resource this is. Value: the fixed string "dfareporting#orderDocument".
lastSentRecipients[]	list	List of email addresses that received the last sent document.
lastSentTime	datetime	Timestamp of the last email sent with this order document.
orderId	long	ID of the order from which this order document is created.
projectId	long	Project ID of this order document.
signed	boolean	Whether this order document has been signed.
subaccountId	long	Subaccount ID of this order document.
title	string	Title of this order document.
type	string	Type of this order document Acceptable values are: "PLANNING_ORDER_TYPE_CHANGE_ORDER" "PLANNING_ORDER_TYPE_INSERTION_ORDER"

Methods

get

Gets one order document by ID.

list

Retrieves a list of order documents, possibly filtered. This method supports paging.