| 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.orderDocuments.html">orderDocuments</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 document 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, approved=None, ids=None, maxResults=None, orderId=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 order documents, 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 document by ID. |
| 98 | |
| 99 | Args: |
| 100 | profileId: string, User profile ID associated with this request. (required) |
| 101 | projectId: string, Project ID for order documents. (required) |
| 102 | id: string, Order document 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 | { # Contains properties of a Planning order document. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 112 | "accountId": "A String", # Account ID of this order document. |
| 113 | "advertiserId": "A String", # Advertiser ID of this order document. |
| 114 | "amendedOrderDocumentId": "A String", # The amended order document ID of this order document. An order document can be created by optionally amending another order document so that the change history can be preserved. |
| 115 | "approvedByUserProfileIds": [ # IDs of users who have approved this order document. |
| 116 | "A String", |
| 117 | ], |
| 118 | "cancelled": True or False, # Whether this order document is cancelled. |
| 119 | "createdInfo": { # Modification timestamp. # Information about the creation of this order document. |
| 120 | "time": "A String", # Timestamp of the last change in milliseconds since epoch. |
| 121 | }, |
| 122 | "effectiveDate": "A String", |
| 123 | "id": "A String", # ID of this order document. |
| 124 | "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#orderDocument". |
| 125 | "lastSentRecipients": [ # List of email addresses that received the last sent document. |
| 126 | "A String", |
| 127 | ], |
| 128 | "lastSentTime": "A String", |
| 129 | "orderId": "A String", # ID of the order from which this order document is created. |
| 130 | "projectId": "A String", # Project ID of this order document. |
| 131 | "signed": True or False, # Whether this order document has been signed. |
| 132 | "subaccountId": "A String", # Subaccount ID of this order document. |
| 133 | "title": "A String", # Title of this order document. |
| 134 | "type": "A String", # Type of this order document |
| 135 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 136 | </div> |
| 137 | |
| 138 | <div class="method"> |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 139 | <code class="details" id="list">list(profileId, projectId, approved=None, ids=None, maxResults=None, orderId=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] | 140 | <pre>Retrieves a list of order documents, possibly filtered. This method supports paging. |
| 141 | |
| 142 | Args: |
| 143 | profileId: string, User profile ID associated with this request. (required) |
| 144 | projectId: string, Project ID for order documents. (required) |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 145 | approved: boolean, Select only order documents that have been approved by at least one user. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 146 | ids: string, Select only order documents with these IDs. (repeated) |
| 147 | maxResults: integer, Maximum number of results to return. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 148 | orderId: string, Select only order documents for specified orders. (repeated) |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 149 | pageToken: string, Value of the nextPageToken from the previous result page. |
| 150 | searchString: string, Allows searching for order documents by name or ID. Wildcards (*) are allowed. For example, "orderdocument*2015" will return order documents with names like "orderdocument June 2015", "orderdocument April 2015", or simply "orderdocument 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 "orderdocument" will match order documents with name "my orderdocument", "orderdocument 2015", or simply "orderdocument". |
| 151 | siteId: string, Select only order documents that are associated with these sites. (repeated) |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 152 | sortField: string, Field by which to sort the list. |
| 153 | Allowed values |
| 154 | ID - |
| 155 | NAME - |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 156 | sortOrder: string, Order of sorted results. |
| 157 | Allowed values |
| 158 | ASCENDING - |
| 159 | DESCENDING - |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 160 | x__xgafv: string, V1 error format. |
| 161 | Allowed values |
| 162 | 1 - v1 error format |
| 163 | 2 - v2 error format |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 164 | |
| 165 | Returns: |
| 166 | An object of the form: |
| 167 | |
| 168 | { # Order document List Response |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 169 | "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#orderDocumentsListResponse". |
| 170 | "nextPageToken": "A String", # Pagination token to be used for the next list operation. |
| 171 | "orderDocuments": [ # Order document collection |
| 172 | { # Contains properties of a Planning order document. |
| 173 | "accountId": "A String", # Account ID of this order document. |
| 174 | "advertiserId": "A String", # Advertiser ID of this order document. |
| 175 | "amendedOrderDocumentId": "A String", # The amended order document ID of this order document. An order document can be created by optionally amending another order document so that the change history can be preserved. |
| 176 | "approvedByUserProfileIds": [ # IDs of users who have approved this order document. |
| 177 | "A String", |
| 178 | ], |
| 179 | "cancelled": True or False, # Whether this order document is cancelled. |
| 180 | "createdInfo": { # Modification timestamp. # Information about the creation of this order document. |
| 181 | "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] | 182 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 183 | "effectiveDate": "A String", |
| 184 | "id": "A String", # ID of this order document. |
| 185 | "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#orderDocument". |
| 186 | "lastSentRecipients": [ # List of email addresses that received the last sent document. |
| 187 | "A String", |
| 188 | ], |
| 189 | "lastSentTime": "A String", |
| 190 | "orderId": "A String", # ID of the order from which this order document is created. |
| 191 | "projectId": "A String", # Project ID of this order document. |
| 192 | "signed": True or False, # Whether this order document has been signed. |
| 193 | "subaccountId": "A String", # Subaccount ID of this order document. |
| 194 | "title": "A String", # Title of this order document. |
| 195 | "type": "A String", # Type of this order document |
| 196 | }, |
| 197 | ], |
| 198 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 199 | </div> |
| 200 | |
| 201 | <div class="method"> |
| 202 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 203 | <pre>Retrieves the next page of results. |
| 204 | |
| 205 | Args: |
| 206 | previous_request: The request for the previous page. (required) |
| 207 | previous_response: The response from the request for the previous page. (required) |
| 208 | |
| 209 | Returns: |
| 210 | A request object that you can call 'execute()' on to request the next |
| 211 | page. Returns None if there are no more items in the collection. |
| 212 | </pre> |
| 213 | </div> |
| 214 | |
| 215 | </body></html> |