Debian Codegraph @

docs/dyn/dfareporting_v3_4.orders.html

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