1<html><body> 2<style> 3 4body, 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 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, 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="admin_datatransfer_v1.html">Admin SDK API</a> . <a href="admin_datatransfer_v1.transfers.html">transfers</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(dataTransferId, x__xgafv=None)</a></code></p> 82<p class="firstline">Retrieves a data transfer request by its resource ID.</p> 83<p class="toc_element"> 84 <code><a href="#insert">insert(body=None, x__xgafv=None)</a></code></p> 85<p class="firstline">Inserts a data transfer request.</p> 86<p class="toc_element"> 87 <code><a href="#list">list(customerId=None, maxResults=None, newOwnerUserId=None, oldOwnerUserId=None, pageToken=None, status=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Lists the transfers for a customer by source user, destination user, or status.</p> 89<p class="toc_element"> 90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 91<p class="firstline">Retrieves the next page of results.</p> 92<h3>Method Details</h3> 93<div class="method"> 94 <code class="details" id="close">close()</code> 95 <pre>Close httplib2 connections.</pre> 96</div> 97 98<div class="method"> 99 <code class="details" id="get">get(dataTransferId, x__xgafv=None)</code> 100 <pre>Retrieves a data transfer request by its resource ID. 101 102Args: 103 dataTransferId: string, ID of the resource to be retrieved. This is returned in the response from the insert method. (required) 104 x__xgafv: string, V1 error format. 105 Allowed values 106 1 - v1 error format 107 2 - v2 error format 108 109Returns: 110 An object of the form: 111 112 { # A Transfer resource represents the transfer of the ownership of user data between users. 113 "applicationDataTransfers": [ # List of per application data transfer resources. It contains data transfer details of the applications associated with this transfer resource. Note that this list is also used to specify the applications for which data transfer has to be done at the time of the transfer resource creation. 114 { # Template to map fields of ApplicationDataTransfer resource. 115 "applicationId": "A String", # The application's ID. 116 "applicationTransferParams": [ # The transfer parameters for the application. These parameters are used to select the data which will get transferred in context of this application. 117 { # Template for application transfer parameters. 118 "key": "A String", # The type of the transfer parameter. eg: 'PRIVACY_LEVEL' 119 "value": [ # The value of the corresponding transfer parameter. eg: 'PRIVATE' or 'SHARED' 120 "A String", 121 ], 122 }, 123 ], 124 "applicationTransferStatus": "A String", # Current status of transfer for this application. (Read-only) 125 }, 126 ], 127 "etag": "A String", # ETag of the resource. 128 "id": "A String", # The transfer's ID (Read-only). 129 "kind": "admin#datatransfer#DataTransfer", # Identifies the resource as a DataTransfer request. 130 "newOwnerUserId": "A String", # ID of the user to whom the data is being transferred. 131 "oldOwnerUserId": "A String", # ID of the user whose data is being transferred. 132 "overallTransferStatusCode": "A String", # Overall transfer status (Read-only). 133 "requestTime": "A String", # The time at which the data transfer was requested (Read-only). 134}</pre> 135</div> 136 137<div class="method"> 138 <code class="details" id="insert">insert(body=None, x__xgafv=None)</code> 139 <pre>Inserts a data transfer request. 140 141Args: 142 body: object, The request body. 143 The object takes the form of: 144 145{ # A Transfer resource represents the transfer of the ownership of user data between users. 146 "applicationDataTransfers": [ # List of per application data transfer resources. It contains data transfer details of the applications associated with this transfer resource. Note that this list is also used to specify the applications for which data transfer has to be done at the time of the transfer resource creation. 147 { # Template to map fields of ApplicationDataTransfer resource. 148 "applicationId": "A String", # The application's ID. 149 "applicationTransferParams": [ # The transfer parameters for the application. These parameters are used to select the data which will get transferred in context of this application. 150 { # Template for application transfer parameters. 151 "key": "A String", # The type of the transfer parameter. eg: 'PRIVACY_LEVEL' 152 "value": [ # The value of the corresponding transfer parameter. eg: 'PRIVATE' or 'SHARED' 153 "A String", 154 ], 155 }, 156 ], 157 "applicationTransferStatus": "A String", # Current status of transfer for this application. (Read-only) 158 }, 159 ], 160 "etag": "A String", # ETag of the resource. 161 "id": "A String", # The transfer's ID (Read-only). 162 "kind": "admin#datatransfer#DataTransfer", # Identifies the resource as a DataTransfer request. 163 "newOwnerUserId": "A String", # ID of the user to whom the data is being transferred. 164 "oldOwnerUserId": "A String", # ID of the user whose data is being transferred. 165 "overallTransferStatusCode": "A String", # Overall transfer status (Read-only). 166 "requestTime": "A String", # The time at which the data transfer was requested (Read-only). 167} 168 169 x__xgafv: string, V1 error format. 170 Allowed values 171 1 - v1 error format 172 2 - v2 error format 173 174Returns: 175 An object of the form: 176 177 { # A Transfer resource represents the transfer of the ownership of user data between users. 178 "applicationDataTransfers": [ # List of per application data transfer resources. It contains data transfer details of the applications associated with this transfer resource. Note that this list is also used to specify the applications for which data transfer has to be done at the time of the transfer resource creation. 179 { # Template to map fields of ApplicationDataTransfer resource. 180 "applicationId": "A String", # The application's ID. 181 "applicationTransferParams": [ # The transfer parameters for the application. These parameters are used to select the data which will get transferred in context of this application. 182 { # Template for application transfer parameters. 183 "key": "A String", # The type of the transfer parameter. eg: 'PRIVACY_LEVEL' 184 "value": [ # The value of the corresponding transfer parameter. eg: 'PRIVATE' or 'SHARED' 185 "A String", 186 ], 187 }, 188 ], 189 "applicationTransferStatus": "A String", # Current status of transfer for this application. (Read-only) 190 }, 191 ], 192 "etag": "A String", # ETag of the resource. 193 "id": "A String", # The transfer's ID (Read-only). 194 "kind": "admin#datatransfer#DataTransfer", # Identifies the resource as a DataTransfer request. 195 "newOwnerUserId": "A String", # ID of the user to whom the data is being transferred. 196 "oldOwnerUserId": "A String", # ID of the user whose data is being transferred. 197 "overallTransferStatusCode": "A String", # Overall transfer status (Read-only). 198 "requestTime": "A String", # The time at which the data transfer was requested (Read-only). 199}</pre> 200</div> 201 202<div class="method"> 203 <code class="details" id="list">list(customerId=None, maxResults=None, newOwnerUserId=None, oldOwnerUserId=None, pageToken=None, status=None, x__xgafv=None)</code> 204 <pre>Lists the transfers for a customer by source user, destination user, or status. 205 206Args: 207 customerId: string, Immutable ID of the Google Workspace account. 208 maxResults: integer, Maximum number of results to return. Default is 100. 209 newOwnerUserId: string, Destination user's profile ID. 210 oldOwnerUserId: string, Source user's profile ID. 211 pageToken: string, Token to specify the next page in the list. 212 status: string, Status of the transfer. 213 x__xgafv: string, V1 error format. 214 Allowed values 215 1 - v1 error format 216 2 - v2 error format 217 218Returns: 219 An object of the form: 220 221 { # Template for a collection of DataTransfer resources. 222 "dataTransfers": [ # List of data transfer requests. 223 { # A Transfer resource represents the transfer of the ownership of user data between users. 224 "applicationDataTransfers": [ # List of per application data transfer resources. It contains data transfer details of the applications associated with this transfer resource. Note that this list is also used to specify the applications for which data transfer has to be done at the time of the transfer resource creation. 225 { # Template to map fields of ApplicationDataTransfer resource. 226 "applicationId": "A String", # The application's ID. 227 "applicationTransferParams": [ # The transfer parameters for the application. These parameters are used to select the data which will get transferred in context of this application. 228 { # Template for application transfer parameters. 229 "key": "A String", # The type of the transfer parameter. eg: 'PRIVACY_LEVEL' 230 "value": [ # The value of the corresponding transfer parameter. eg: 'PRIVATE' or 'SHARED' 231 "A String", 232 ], 233 }, 234 ], 235 "applicationTransferStatus": "A String", # Current status of transfer for this application. (Read-only) 236 }, 237 ], 238 "etag": "A String", # ETag of the resource. 239 "id": "A String", # The transfer's ID (Read-only). 240 "kind": "admin#datatransfer#DataTransfer", # Identifies the resource as a DataTransfer request. 241 "newOwnerUserId": "A String", # ID of the user to whom the data is being transferred. 242 "oldOwnerUserId": "A String", # ID of the user whose data is being transferred. 243 "overallTransferStatusCode": "A String", # Overall transfer status (Read-only). 244 "requestTime": "A String", # The time at which the data transfer was requested (Read-only). 245 }, 246 ], 247 "etag": "A String", # ETag of the resource. 248 "kind": "admin#datatransfer#dataTransfersList", # Identifies the resource as a collection of data transfer requests. 249 "nextPageToken": "A String", # Continuation token which will be used to specify next page in list API. 250}</pre> 251</div> 252 253<div class="method"> 254 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 255 <pre>Retrieves the next page of results. 256 257Args: 258 previous_request: The request for the previous page. (required) 259 previous_response: The response from the request for the previous page. (required) 260 261Returns: 262 A request object that you can call 'execute()' on to request the next 263 page. Returns None if there are no more items in the collection. 264 </pre> 265</div> 266 267</body></html>