orders
Create, update, delete, and query DoubleClick for Publishers Orders.
Select
The following queries are processed server side by the Google Ad Manager APIs. The driver processes other SELECT queries client-side in memory.
Retrieve a list of Orders. For example:
SELECT * FROM [ Orders ]
Additionally, you can specify the Id or filter by any other column.
SELECT * FROM [Orders] WHERE Id = '2112977260'
Insert
To create a new Order, the Name, AdvertiserId, and TraffickerId fields are required.
INSERT INTO [Orders] (Name, AdvertiserId, TraffickerId) VALUES ('Ord313', '4410125029', '244525926')
Update
You can update the Notes of an Order row by specifying the Id column.
UPDATE [Orders] SET Notes = 'Updated notes22222' WHERE Id = '2112977260'
Delete
You can delete an Order row by specifying the Id column.
DELETE FROM [Orders] WHERE Id = '2108997295'
Columns
| Name | Type | ReadOnly | Description |
| Id [KEY] | Long | False |
The unique ID of the Order. This value is readonly and is assigned by Google. |
| Name | String | False |
The name of the Order. This value is required to create an order and has a maximum length of 255 characters. |
| StartDateTime | Datetime | True |
The date and time at which the Order and its associated line items are eligible to begin serving. This attribute is readonly and is derived from the line item of the order which has the earliest LineItem.startDateTime. |
| EndDateTime | Datetime | True |
The date and time at which the Order and its associated line items stop being served. This attribute is readonly and is derived from the line item of the order which has the latest LineItem.endDateTime. |
| UnlimitedEndDateTime | Bool | False |
Specifies whether or not the Order has an unlimited end date. This attribute is readonly and is true if any of the order's line items has LineItem.unlimitedEndDateTime set to true. |
| Status | String | True |
The status of the Order. This attribute is read-only. |
| IsArchived | Bool | False |
The archival status of the Order. This attribute is readonly. |
| Notes | String | False |
Provides any additional notes that may annotate the Order. This attribute is optional and has a maximum length of 65,535 characters. |
| ExternalOrderId | Int | False |
An arbitrary ID to associate to the Order, which can be used as a key to an external system. This value is optional. |
| PoNumber | String | False |
The purchase order number for the Order. This value is optional and has a maximum length of 63 characters. |
| CurrencyCode | String | True |
The ISO currency code for the currency used by the Order. This value is read-only and is the network's currency code. |
| AdvertiserId | Long | False |
The unique ID of the Company, which is of type Company.Type.ADVERTISER, to which this order belongs. This attribute is required. |
| AdvertiserContactIds | String | False |
List of IDs for advertiser contacts of the order. |
| AgencyId | Long | False |
The unique ID of the Company, which is of type Company.Type.AGENCY, with which this order is associated. This attribute is optional. |
| AgencyContactIds | String | False |
List of IDs for agency contacts of the order. |
| CreatorId | Long | True |
The unique ID of the User who created the Order on behalf of the advertiser. This value is readonly and is assigned by Google. |
| TraffickerId | Long | False |
The unique ID of the User responsible for trafficking the Order. This value is required for creating an order |
| SecondaryTraffickerIds | String | False |
The IDs of the secondary traffickers associated with the order. This value is optional. |
| SalespersonId | Long | False |
The unique ID of the User responsible for the sales of the Order. This value is optional. |
| SecondarySalespersonIds | String | False |
The IDs of the secondary salespeople associated with the order. This value is optional. |
| TotalImpressionsDelivered | Long | True |
Total impressions delivered for all line items of this Order. This value is read-only and is assigned by Google. |
| TotalClicksDelivered | Long | True |
Total clicks delivered for all line items of this Order. This value is read-only and is assigned by Google. |
| TotalViewableImpressionsDelivered | Long | True |
Total viewable impressions delivered for all line items of this Order. This value is read-only and is assigned by Google. Starting in v201705, this will be null when the order does not have line items trafficked against a viewable impressions goal. |
| TotalBudget | String | False |
Total budget for all line items of this Order. This value is a readonly field assigned by Google and is calculated from the associated LineItem.costPerUnit values. |
| AppliedLabels | String | False |
The set of labels applied directly to this order. |
| EffectiveAppliedLabels | String | True |
Contains the set of labels applied directly to the order as well as those inherited from the company that owns the order. If a label has been negated, only the negated label is returned. This field is readonly and is assigned by Google. |
| LastModifiedByApp | String | True |
The application which modified this order. This attribute is read only and is assigned by Google. |
| IsProgrammatic | Bool | False |
Specifies whether or not the Order is a programmatic order. This value is optional and defaults to false. |
| AppliedTeamIds | String | False |
The IDs of all teams that this order is on directly. |
| LastModifiedDateTime | Datetime | True |
The date and time this order was last modified. |
| CustomFieldName | String | True |
This is the name of the custom field. There will be as many custom columns as custom fields are related to Orders. |