1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="dfareporting_v3_4.html">Campaign Manager 360 API</a> . <a href="dfareporting_v3_4.orders.html">orders</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#get">get(profileId, projectId, id, x__xgafv=None)</a></code></p>
<p class="firstline">Gets one order by ID.</p>
<p class="toc_element">
<code><a href="#list">list(profileId, projectId, ids=None, maxResults=None, pageToken=None, searchString=None, siteId=None, sortField=None, sortOrder=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a list of orders, possibly filtered. This method supports paging.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="get">get(profileId, projectId, id, x__xgafv=None)</code>
<pre>Gets one order by ID.
Args:
profileId: string, User profile ID associated with this request. (required)
projectId: string, Project ID for orders. (required)
id: string, Order ID. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Describes properties of a Planning order.
"accountId": "A String", # Account ID of this order.
"advertiserId": "A String", # Advertiser ID of this order.
"approverUserProfileIds": [ # IDs for users that have to approve documents created for this order.
"A String",
],
"buyerInvoiceId": "A String", # Buyer invoice ID associated with this order.
"buyerOrganizationName": "A String", # Name of the buyer organization.
"comments": "A String", # Comments in this order.
"contacts": [ # Contacts for this order.
{ # Contact of an order.
"contactInfo": "A 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.
"contactName": "A String", # Name of this contact.
"contactTitle": "A String", # Title of this contact.
"contactType": "A String", # Type of this contact.
"signatureUserProfileId": "A String", # ID of the user profile containing the signature that will be embedded into order documents.
},
],
"id": "A String", # ID of this order. This is a read-only, auto-generated field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#order".
"lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this order.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"name": "A String", # Name of this order.
"notes": "A String", # Notes of this order.
"planningTermId": "A String", # ID of the terms and conditions template used in this order.
"projectId": "A String", # Project ID of this order.
"sellerOrderId": "A String", # Seller order ID associated with this order.
"sellerOrganizationName": "A String", # Name of the seller organization.
"siteId": [ # Site IDs this order is associated with.
"A String",
],
"siteNames": [ # Free-form site names this order is associated with.
"A String",
],
"subaccountId": "A String", # Subaccount ID of this order.
"termsAndConditions": "A String", # Terms and conditions of this order.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(profileId, projectId, ids=None, maxResults=None, pageToken=None, searchString=None, siteId=None, sortField=None, sortOrder=None, x__xgafv=None)</code>
<pre>Retrieves a list of orders, possibly filtered. This method supports paging.
Args:
profileId: string, User profile ID associated with this request. (required)
projectId: string, Project ID for orders. (required)
ids: string, Select only orders with these IDs. (repeated)
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, "order*2015" 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: string, Select only orders that are associated with these site IDs. (repeated)
sortField: string, Field by which to sort the list.
Allowed values
ID -
NAME -
sortOrder: string, Order of sorted results.
Allowed values
ASCENDING -
DESCENDING -
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Order List Response
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ordersListResponse".
"nextPageToken": "A String", # Pagination token to be used for the next list operation.
"orders": [ # Order collection.
{ # Describes properties of a Planning order.
"accountId": "A String", # Account ID of this order.
"advertiserId": "A String", # Advertiser ID of this order.
"approverUserProfileIds": [ # IDs for users that have to approve documents created for this order.
"A String",
],
"buyerInvoiceId": "A String", # Buyer invoice ID associated with this order.
"buyerOrganizationName": "A String", # Name of the buyer organization.
"comments": "A String", # Comments in this order.
"contacts": [ # Contacts for this order.
{ # Contact of an order.
"contactInfo": "A 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.
"contactName": "A String", # Name of this contact.
"contactTitle": "A String", # Title of this contact.
"contactType": "A String", # Type of this contact.
"signatureUserProfileId": "A String", # ID of the user profile containing the signature that will be embedded into order documents.
},
],
"id": "A String", # ID of this order. This is a read-only, auto-generated field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#order".
"lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this order.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"name": "A String", # Name of this order.
"notes": "A String", # Notes of this order.
"planningTermId": "A String", # ID of the terms and conditions template used in this order.
"projectId": "A String", # Project ID of this order.
"sellerOrderId": "A String", # Seller order ID associated with this order.
"sellerOrganizationName": "A String", # Name of the seller organization.
"siteId": [ # Site IDs this order is associated with.
"A String",
],
"siteNames": [ # Free-form site names this order is associated with.
"A String",
],
"subaccountId": "A String", # Subaccount ID of this order.
"termsAndConditions": "A String", # Terms and conditions of this order.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>
|
