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
|
<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="admin_datatransfer_v1.html">Admin SDK API</a> . <a href="admin_datatransfer_v1.applications.html">applications</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(applicationId, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves information about an application for the given application ID.</p>
<p class="toc_element">
<code><a href="#list">list(customerId=None, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the applications available for data transfer for a customer.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</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(applicationId, x__xgafv=None)</code>
<pre>Retrieves information about an application for the given application ID.
Args:
applicationId: string, ID of the application resource to be retrieved. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Application resources represent applications installed on the domain that support transferring ownership of user data.
"etag": "A String", # Etag of the resource.
"id": "A String", # The application's ID. Retrievable by using the [`applications.list()`](https://developers.google.com/workspace/admin/data-transfer/reference/rest/v1/applications/list) method.
"kind": "admin#datatransfer#ApplicationResource", # Identifies the resource as a DataTransfer Application Resource.
"name": "A String", # The application's name.
"transferParams": [ # The list of all possible transfer parameters for this application. These parameters select which categories of the user's data to transfer.
{ # Template for application transfer parameters.
"key": "A String", # The type of the transfer parameter, such as `PRIVACY_LEVEL`.
"value": [ # The value of the transfer parameter, such as `PRIVATE` or `SHARED`.
"A String",
],
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(customerId=None, maxResults=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists the applications available for data transfer for a customer.
Args:
customerId: string, Immutable ID of the Google Workspace account.
maxResults: integer, Maximum number of results to return. Default is 100.
pageToken: string, Token to specify next page in the list.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Template for a collection of Applications.
"applications": [ # The list of applications that support data transfer and are also installed for the customer.
{ # Application resources represent applications installed on the domain that support transferring ownership of user data.
"etag": "A String", # Etag of the resource.
"id": "A String", # The application's ID. Retrievable by using the [`applications.list()`](https://developers.google.com/workspace/admin/data-transfer/reference/rest/v1/applications/list) method.
"kind": "admin#datatransfer#ApplicationResource", # Identifies the resource as a DataTransfer Application Resource.
"name": "A String", # The application's name.
"transferParams": [ # The list of all possible transfer parameters for this application. These parameters select which categories of the user's data to transfer.
{ # Template for application transfer parameters.
"key": "A String", # The type of the transfer parameter, such as `PRIVACY_LEVEL`.
"value": [ # The value of the transfer parameter, such as `PRIVATE` or `SHARED`.
"A String",
],
},
],
},
],
"etag": "A String", # ETag of the resource.
"kind": "admin#datatransfer#applicationsList", # Identifies the resource as a collection of Applications.
"nextPageToken": "A String", # Token to specify the next page in the list.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</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>
|