REST Resource: orderDocuments

  • The OrderDocument resource represents properties of a Planning order document, including details like title, type, effective date, and approval status.

  • Order documents can be either insertion orders or change orders, and they track changes made to associated planning orders.

  • Key properties include IDs for the order document, associated order, account, subaccount, advertiser, and project, along with timestamps for creation and last email sent.

  • You can retrieve individual order documents by ID or list them, applying filters if needed, using the provided methods.

  • OrderDocument resources are part of the Planning API within DCM and contain information about Planning orders like title, ID, type, and associated accounts.

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

get

 Gets one order document by ID.

list

 Retrieves a list of order documents, possibly filtered.