| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 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 | |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 75 | <h1><a href="dfareporting_v3_4.html">Campaign Manager 360 API</a> . <a href="dfareporting_v3_4.orders.html">orders</a></h1> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 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> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 82 | <p class="firstline">Gets one order by ID.</p> |
| 83 | <p class="toc_element"> |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame^] | 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> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 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"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 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> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 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) |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 103 | x__xgafv: string, V1 error format. |
| 104 | Allowed values |
| 105 | 1 - v1 error format |
| 106 | 2 - v2 error format |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 107 | |
| 108 | Returns: |
| 109 | An object of the form: |
| 110 | |
| 111 | { # Describes properties of a Planning order. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame^] | 112 | "accountId": "A String", # Account ID of this order. |
| 113 | "advertiserId": "A String", # Advertiser ID of this order. |
| 114 | "approverUserProfileIds": [ # IDs for users that have to approve documents created for this order. |
| 115 | "A String", |
| 116 | ], |
| 117 | "buyerInvoiceId": "A String", # Buyer invoice ID associated with this order. |
| 118 | "buyerOrganizationName": "A String", # Name of the buyer organization. |
| 119 | "comments": "A String", # Comments in this order. |
| 120 | "contacts": [ # Contacts for this order. |
| 121 | { # Contact of an order. |
| 122 | "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. |
| 123 | "contactName": "A String", # Name of this contact. |
| 124 | "contactTitle": "A String", # Title of this contact. |
| 125 | "contactType": "A String", # Type of this contact. |
| 126 | "signatureUserProfileId": "A String", # ID of the user profile containing the signature that will be embedded into order documents. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 127 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame^] | 128 | ], |
| 129 | "id": "A String", # ID of this order. This is a read-only, auto-generated field. |
| 130 | "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#order". |
| 131 | "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this order. |
| 132 | "time": "A String", # Timestamp of the last change in milliseconds since epoch. |
| 133 | }, |
| 134 | "name": "A String", # Name of this order. |
| 135 | "notes": "A String", # Notes of this order. |
| 136 | "planningTermId": "A String", # ID of the terms and conditions template used in this order. |
| 137 | "projectId": "A String", # Project ID of this order. |
| 138 | "sellerOrderId": "A String", # Seller order ID associated with this order. |
| 139 | "sellerOrganizationName": "A String", # Name of the seller organization. |
| 140 | "siteId": [ # Site IDs this order is associated with. |
| 141 | "A String", |
| 142 | ], |
| 143 | "siteNames": [ # Free-form site names this order is associated with. |
| 144 | "A String", |
| 145 | ], |
| 146 | "subaccountId": "A String", # Subaccount ID of this order. |
| 147 | "termsAndConditions": "A String", # Terms and conditions of this order. |
| 148 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 149 | </div> |
| 150 | |
| 151 | <div class="method"> |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame^] | 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> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 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) |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame^] | 161 | 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". |
| 162 | siteId: string, Select only orders that are associated with these site IDs. (repeated) |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 163 | sortField: string, Field by which to sort the list. |
| 164 | Allowed values |
| 165 | ID - |
| 166 | NAME - |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame^] | 167 | sortOrder: string, Order of sorted results. |
| 168 | Allowed values |
| 169 | ASCENDING - |
| 170 | DESCENDING - |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 171 | x__xgafv: string, V1 error format. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 172 | Allowed values |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 173 | 1 - v1 error format |
| 174 | 2 - v2 error format |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 175 | |
| 176 | Returns: |
| 177 | An object of the form: |
| 178 | |
| 179 | { # Order List Response |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame^] | 180 | "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ordersListResponse". |
| 181 | "nextPageToken": "A String", # Pagination token to be used for the next list operation. |
| 182 | "orders": [ # Order collection. |
| 183 | { # Describes properties of a Planning order. |
| 184 | "accountId": "A String", # Account ID of this order. |
| 185 | "advertiserId": "A String", # Advertiser ID of this order. |
| 186 | "approverUserProfileIds": [ # IDs for users that have to approve documents created for this order. |
| 187 | "A String", |
| 188 | ], |
| 189 | "buyerInvoiceId": "A String", # Buyer invoice ID associated with this order. |
| 190 | "buyerOrganizationName": "A String", # Name of the buyer organization. |
| 191 | "comments": "A String", # Comments in this order. |
| 192 | "contacts": [ # Contacts for this order. |
| 193 | { # Contact of an order. |
| 194 | "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. |
| 195 | "contactName": "A String", # Name of this contact. |
| 196 | "contactTitle": "A String", # Title of this contact. |
| 197 | "contactType": "A String", # Type of this contact. |
| 198 | "signatureUserProfileId": "A String", # ID of the user profile containing the signature that will be embedded into order documents. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 199 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame^] | 200 | ], |
| 201 | "id": "A String", # ID of this order. This is a read-only, auto-generated field. |
| 202 | "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#order". |
| 203 | "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this order. |
| 204 | "time": "A String", # Timestamp of the last change in milliseconds since epoch. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 205 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame^] | 206 | "name": "A String", # Name of this order. |
| 207 | "notes": "A String", # Notes of this order. |
| 208 | "planningTermId": "A String", # ID of the terms and conditions template used in this order. |
| 209 | "projectId": "A String", # Project ID of this order. |
| 210 | "sellerOrderId": "A String", # Seller order ID associated with this order. |
| 211 | "sellerOrganizationName": "A String", # Name of the seller organization. |
| 212 | "siteId": [ # Site IDs this order is associated with. |
| 213 | "A String", |
| 214 | ], |
| 215 | "siteNames": [ # Free-form site names this order is associated with. |
| 216 | "A String", |
| 217 | ], |
| 218 | "subaccountId": "A String", # Subaccount ID of this order. |
| 219 | "termsAndConditions": "A String", # Terms and conditions of this order. |
| 220 | }, |
| 221 | ], |
| 222 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 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 'execute()' 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> |