List

Retrieves a list of orders, possibly filtered

9 variables
29 variables

Retrieves a list of orders, 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 9 input parameters

  = Parameter name
  = Format

profileId INTEGER Required

User profile ID associated with this request

projectId INTEGER Required

Project ID for orders

ids INTEGER

Select only orders with these IDs

maxResults INTEGER

Maximum number of results to return

pageToken STRING

Value of the nextPageToken from the previous result page

searchString STRING

Allows searching for orders by name or ID. Wildcards () are allowed. For example, "order2015" will return orders with names like "order June 2015", "order April 2015", or simply "order 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 "order" will match orders with name "my order", "order 2015", or simply "order"

siteId INTEGER

Select only orders that are associated with these site IDs

sortField ENUMERATION

Field by which to sort the list

sortOrder ENUMERATION

Order of sorted results

Output

This building block provides 29 output parameters

  = Parameter name
  = Format

kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#ordersListResponse"

nextPageToken STRING

Pagination token to be used for the next list operation

orders[] OBJECT

Describes properties of a Planning order

orders[].accountId INTEGER

Account ID of this order

orders[].advertiserId INTEGER

Advertiser ID of this order

orders[].approverUserProfileIds[] INTEGER

orders[].buyerInvoiceId STRING

Buyer invoice ID associated with this order

orders[].buyerOrganizationName STRING

Name of the buyer organization

orders[].comments STRING

Comments in this order

orders[].contacts[] OBJECT

Contact of an order

orders[].contacts[].contactInfo STRING

Free-form information about this contact. It could be any information related to this contact in addition to type, title, name, and signature user profile ID

orders[].contacts[].contactName STRING

Name of this contact

orders[].contacts[].contactTitle STRING

Title of this contact

orders[].contacts[].contactType ENUMERATION

Type of this contact

orders[].contacts[].signatureUserProfileId INTEGER

ID of the user profile containing the signature that will be embedded into order documents

orders[].id INTEGER

ID of this order. This is a read-only, auto-generated field

orders[].kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#order"

orders[].lastModifiedInfo OBJECT

Modification timestamp

orders[].lastModifiedInfo.time INTEGER

Timestamp of the last change in milliseconds since epoch

orders[].name STRING

Name of this order

orders[].notes STRING

Notes of this order

orders[].planningTermId INTEGER

ID of the terms and conditions template used in this order

orders[].projectId INTEGER

Project ID of this order

orders[].sellerOrderId STRING

Seller order ID associated with this order

orders[].sellerOrganizationName STRING

Name of the seller organization

orders[].siteId[] INTEGER

orders[].siteNames[] STRING

orders[].subaccountId INTEGER

Subaccount ID of this order

orders[].termsAndConditions STRING

Terms and conditions of this order