REST Resource: orders
Stay organized with collections
Save and categorize content based on your preferences.
Resource: Order
Describes properties of a Planning order.
| JSON representation |
{
"id": string,
"accountId": string,
"subaccountId": string,
"advertiserId": string,
"projectId": string,
"name": string,
"buyerOrganizationName": string,
"sellerOrganizationName": string,
"contacts": [
{
object (OrderContact)
}
],
"termsAndConditions": string,
"kind": string,
"notes": string,
"buyerInvoiceId": string,
"sellerOrderId": string,
"comments": string,
"planningTermId": string,
"approverUserProfileIds": [
string
],
"siteNames": [
string
],
"siteId": [
string
],
"lastModifiedInfo": {
object (LastModifiedInfo)
}
} |
| Fields |
id |
string (int64 format)
ID of this order. This is a read-only, auto-generated field.
|
accountId |
string (int64 format)
Account ID of this order.
|
subaccountId |
string (int64 format)
Subaccount ID of this order.
|
advertiserId |
string (int64 format)
Advertiser ID of this order.
|
projectId |
string (int64 format)
Project ID of this order.
|
name |
string
Name of this order.
|
buyerOrganizationName |
string
Name of the buyer organization.
|
sellerOrganizationName |
string
Name of the seller organization.
|
contacts[] |
object (OrderContact)
Contacts for this order.
|
termsAndConditions |
string
Terms and conditions of this order.
|
kind |
string
Identifies what kind of resource this is. Value: the fixed string
"dfareporting#order"
.
|
notes |
string
Notes of this order.
|
buyerInvoiceId |
string
Buyer invoice ID associated with this order.
|
sellerOrderId |
string
Seller order ID associated with this order.
|
planningTermId |
string (int64 format)
ID of the terms and conditions template used in this order.
|
approverUserProfileIds[] |
string (int64 format)
IDs for users that have to approve documents created for this order.
|
siteNames[] |
string
Free-form site names this order is associated with.
|
siteId[] |
string (int64 format)
Site IDs this order is associated with.
|
lastModifiedInfo |
object (LastModifiedInfo)
Information about the most recent modification of this order.
|
Methods |
|
|
Gets one order by ID. |
|
|
Retrieves a list of orders, possibly filtered. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-16 UTC.
[null,null,["Last updated 2024-10-16 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eOrder\u003c/code\u003e resource describes properties of a planning order, including details like ID, advertiser, and contact information.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eOrderContact\u003c/code\u003e represents a contact associated with an order, specifying their type, title, and other relevant information.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003ePlanningOrderContactType\u003c/code\u003e defines the various types of contacts for an order, such as buyer or seller contacts.\u003c/p\u003e\n"],["\u003cp\u003eThe API provides methods to \u003ccode\u003eget\u003c/code\u003e an order by ID and \u003ccode\u003elist\u003c/code\u003e multiple orders with optional filtering.\u003c/p\u003e\n"]]],[],null,["# REST Resource: orders\n\n- [Resource: Order](#Order)\n - [JSON representation](#Order.SCHEMA_REPRESENTATION)\n- [OrderContact](#OrderContact)\n - [JSON representation](#OrderContact.SCHEMA_REPRESENTATION)\n- [PlanningOrderContactType](#PlanningOrderContactType)\n- [Methods](#METHODS_SUMMARY)\n\nResource: Order\n---------------\n\nDescribes properties of a Planning [order](https://support.google.com/dcm/answer/6025561).\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"id\": string, \"accountId\": string, \"subaccountId\": string, \"advertiserId\": string, \"projectId\": string, \"name\": string, \"buyerOrganizationName\": string, \"sellerOrganizationName\": string, \"contacts\": [ { object (/doubleclick-advertisers/rest/v4/orders#OrderContact) } ], \"termsAndConditions\": string, \"kind\": string, \"notes\": string, \"buyerInvoiceId\": string, \"sellerOrderId\": string, \"comments\": string, \"planningTermId\": string, \"approverUserProfileIds\": [ string ], \"siteNames\": [ string ], \"siteId\": [ string ], \"lastModifiedInfo\": { object (/doubleclick-advertisers/rest/v4/LastModifiedInfo) } } ``` |\n\n| Fields ||\n|----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `id` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` ID of this order. This is a read-only, auto-generated field. |\n| `account``Id` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Account ID of this order. |\n| `subaccount``Id` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Subaccount ID of this order. |\n| `advertiser``Id` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Advertiser ID of this order. |\n| `project``Id` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Project ID of this order. |\n| `name` | `string` Name of this order. |\n| `buyer``Organization``Name` | `string` Name of the buyer organization. |\n| `seller``Organization``Name` | `string` Name of the seller organization. |\n| `contacts[]` | `object (`[OrderContact](/doubleclick-advertisers/rest/v4/orders#OrderContact)`)` Contacts for this order. |\n| `terms``And``Conditions` | `string` Terms and conditions of this order. |\n| `kind` | `string` Identifies what kind of resource this is. Value: the fixed string `\"dfareporting#order\"` . |\n| `notes` | `string` Notes of this order. |\n| `buyer``Invoice``Id` | `string` Buyer invoice ID associated with this order. |\n| `seller``Order``Id` | `string` Seller order ID associated with this order. |\n| `comments` | `string` Comments in this order. |\n| `planning``Term``Id` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` ID of the terms and conditions template used in this order. |\n| `approver``User``Profile``Ids[]` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` IDs for users that have to approve documents created for this order. |\n| `site``Names[]` | `string` Free-form site names this order is associated with. |\n| `site``Id[]` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Site IDs this order is associated with. |\n| `last``Modified``Info` | `object (`[LastModifiedInfo](/doubleclick-advertisers/rest/v4/LastModifiedInfo)`)` Information about the most recent modification of this order. |\n\nOrderContact\n------------\n\nContact of an order.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"contactInfo\": string, \"contactType\": enum (/doubleclick-advertisers/rest/v4/orders#PlanningOrderContactType), \"contactTitle\": string, \"contactName\": string, \"signatureUserProfileId\": string } ``` |\n\n| Fields ||\n|--------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `contact``Info` | `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. |\n| `contact``Type` | `enum (`[PlanningOrderContactType](/doubleclick-advertisers/rest/v4/orders#PlanningOrderContactType)`)` Type of this contact. |\n| `contact``Title` | `string` Title of this contact. |\n| `contact``Name` | `string` Name of this contact. |\n| `signature``User``Profile``Id` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` ID of the user profile containing the signature that will be embedded into order documents. |\n\nPlanningOrderContactType\n------------------------\n\nDDM Planning's order contact type. Next value = 4\n\n| Enums ||\n|------------------------------------------------|---|\n| `PLANNING_ORDER_CONTACT_BUYER_CONTACT` | |\n| `PLANNING_ORDER_CONTACT_BUYER_BILLING_CONTACT` | |\n| `PLANNING_ORDER_CONTACT_SELLER_CONTACT` | |\n\n| Methods ------- ||\n|----------------------------------------------------------|------------------------------------------------|\n| ### [get](/doubleclick-advertisers/rest/v4/orders/get) | Gets one order by ID. |\n| ### [list](/doubleclick-advertisers/rest/v4/orders/list) | Retrieves a list of orders, possibly filtered. |"]]
