List
|
|||||
|
|
||||
Retrieves a list of order documents, possibly filtered. This method supports paging
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and manage your DoubleClick Campaign Manager's (DCM) display ad campaigns
Input
This building block consumes 11 input parameters
| Name | Format | Description |
|---|---|---|
profileId Required |
INTEGER |
User profile ID associated with this request |
projectId Required |
INTEGER |
Project ID for order documents |
approved |
BOOLEAN |
Select only order documents that have been approved by at least one user |
ids |
INTEGER |
Select only order documents with these IDs |
maxResults |
INTEGER |
Maximum number of results to return |
orderId |
INTEGER |
Select only order documents for specified orders |
pageToken |
STRING |
Value of the nextPageToken from the previous result page |
searchString |
STRING |
Allows searching for order documents by name or ID. Wildcards () are allowed. For example, "orderdocument2015" will return order documents with names like "orderdocument June 2015", "orderdocument April 2015", or simply "orderdocument 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "orderdocument" will match order documents with name "my orderdocument", "orderdocument 2015", or simply "orderdocument" |
siteId |
INTEGER |
Select only order documents that are associated with these sites |
sortField |
ENUMERATION |
Field by which to sort the list |
sortOrder |
ENUMERATION |
Order of sorted results |
= Parameter name
= Format
|
profileId INTEGER Required User profile ID associated with this request |
|
projectId INTEGER Required Project ID for order documents |
|
approved BOOLEAN Select only order documents that have been approved by at least one user |
|
ids INTEGER Select only order documents with these IDs |
|
maxResults INTEGER Maximum number of results to return |
|
orderId INTEGER Select only order documents for specified orders |
|
pageToken STRING Value of the nextPageToken from the previous result page |
|
searchString STRING Allows searching for order documents by name or ID. Wildcards () are allowed. For example, "orderdocument2015" will return order documents with names like "orderdocument June 2015", "orderdocument April 2015", or simply "orderdocument 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "orderdocument" will match order documents with name "my orderdocument", "orderdocument 2015", or simply "orderdocument" |
|
siteId INTEGER Select only order documents that are associated with these sites |
|
sortField ENUMERATION Field by which to sort the list |
|
sortOrder ENUMERATION Order of sorted results |
Output
This building block provides 21 output parameters
| Name | Format | Description |
|---|---|---|
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#orderDocumentsListResponse" |
nextPageToken |
STRING |
Pagination token to be used for the next list operation |
orderDocuments[] |
OBJECT |
Contains properties of a Planning order document |
orderDocuments[].accountId |
INTEGER |
Account ID of this order document |
orderDocuments[].advertiserId |
INTEGER |
Advertiser ID of this order document |
orderDocuments[].amendedOrderDocumentId |
INTEGER |
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 |
orderDocuments[].approvedByUserProfileIds[] |
INTEGER |
|
orderDocuments[].cancelled |
BOOLEAN |
Whether this order document is cancelled |
orderDocuments[].createdInfo |
OBJECT |
Modification timestamp |
orderDocuments[].createdInfo.time |
INTEGER |
Timestamp of the last change in milliseconds since epoch |
orderDocuments[].effectiveDate |
DATE |
Effective date of this order document |
orderDocuments[].id |
INTEGER |
ID of this order document |
orderDocuments[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#orderDocument" |
orderDocuments[].lastSentRecipients[] |
STRING |
|
orderDocuments[].lastSentTime |
DATE_TIME |
Timestamp of the last email sent with this order document |
orderDocuments[].orderId |
INTEGER |
ID of the order from which this order document is created |
orderDocuments[].projectId |
INTEGER |
Project ID of this order document |
orderDocuments[].signed |
BOOLEAN |
Whether this order document has been signed |
orderDocuments[].subaccountId |
INTEGER |
Subaccount ID of this order document |
orderDocuments[].title |
STRING |
Title of this order document |
orderDocuments[].type |
ENUMERATION |
Type of this order document |
= Parameter name
= Format
|
kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#orderDocumentsListResponse" |
|
nextPageToken STRING Pagination token to be used for the next list operation |
|
orderDocuments[] OBJECT Contains properties of a Planning order document |
|
orderDocuments[].accountId INTEGER Account ID of this order document |
|
orderDocuments[].advertiserId INTEGER Advertiser ID of this order document |
|
orderDocuments[].amendedOrderDocumentId INTEGER 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 |
|
orderDocuments[].approvedByUserProfileIds[] INTEGER |
|
orderDocuments[].cancelled BOOLEAN Whether this order document is cancelled |
|
orderDocuments[].createdInfo OBJECT Modification timestamp |
|
orderDocuments[].createdInfo.time INTEGER Timestamp of the last change in milliseconds since epoch |
|
orderDocuments[].effectiveDate DATE Effective date of this order document |
|
orderDocuments[].id INTEGER ID of this order document |
|
orderDocuments[].kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#orderDocument" |
|
orderDocuments[].lastSentRecipients[] STRING |
|
orderDocuments[].lastSentTime DATE_TIME Timestamp of the last email sent with this order document |
|
orderDocuments[].orderId INTEGER ID of the order from which this order document is created |
|
orderDocuments[].projectId INTEGER Project ID of this order document |
|
orderDocuments[].signed BOOLEAN Whether this order document has been signed |
|
orderDocuments[].subaccountId INTEGER Subaccount ID of this order document |
|
orderDocuments[].title STRING Title of this order document |
|
orderDocuments[].type ENUMERATION Type of this order document |