• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 Data Transfer API</a> . <a href="admin_datatransfer_v1.applications.html">applications</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#get">get(applicationId)</a></code></p>
79<p class="firstline">Retrieves information about an application for the given application ID.</p>
80<p class="toc_element">
81  <code><a href="#list">list(pageToken=None, maxResults=None, customerId=None)</a></code></p>
82<p class="firstline">Lists the applications available for data transfer for a customer.</p>
83<p class="toc_element">
84  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
86<h3>Method Details</h3>
87<div class="method">
88    <code class="details" id="get">get(applicationId)</code>
89  <pre>Retrieves information about an application for the given application ID.
90
91Args:
92  applicationId: string, ID of the application resource to be retrieved. (required)
93
94Returns:
95  An object of the form:
96
97    { # The JSON template for an Application resource.
98    "kind": "admin#datatransfer#ApplicationResource", # Identifies the resource as a DataTransfer Application Resource.
99    "etag": "A String", # Etag of the resource.
100    "transferParams": [ # The list of all possible transfer parameters for this application. These parameters can be used to select the data of the user in this application to be transfered.
101      { # Template for application transfer parameters.
102        "value": [ # The value of the coressponding transfer parameter. eg: 'PRIVATE' or 'SHARED'
103          "A String",
104        ],
105        "key": "A String", # The type of the transfer parameter. eg: 'PRIVACY_LEVEL'
106      },
107    ],
108    "id": "A String", # The application's ID.
109    "name": "A String", # The application's name.
110  }</pre>
111</div>
112
113<div class="method">
114    <code class="details" id="list">list(pageToken=None, maxResults=None, customerId=None)</code>
115  <pre>Lists the applications available for data transfer for a customer.
116
117Args:
118  pageToken: string, Token to specify next page in the list.
119  maxResults: integer, Maximum number of results to return. Default is 100.
120  customerId: string, Immutable ID of the Google Apps account.
121
122Returns:
123  An object of the form:
124
125    { # Template for a collection of Applications.
126    "nextPageToken": "A String", # Continuation token which will be used to specify next page in list API.
127    "applications": [ # List of applications that support data transfer and are also installed for the customer.
128      { # The JSON template for an Application resource.
129        "kind": "admin#datatransfer#ApplicationResource", # Identifies the resource as a DataTransfer Application Resource.
130        "etag": "A String", # Etag of the resource.
131        "transferParams": [ # The list of all possible transfer parameters for this application. These parameters can be used to select the data of the user in this application to be transfered.
132          { # Template for application transfer parameters.
133            "value": [ # The value of the coressponding transfer parameter. eg: 'PRIVATE' or 'SHARED'
134              "A String",
135            ],
136            "key": "A String", # The type of the transfer parameter. eg: 'PRIVACY_LEVEL'
137          },
138        ],
139        "id": "A String", # The application's ID.
140        "name": "A String", # The application's name.
141      },
142    ],
143    "kind": "admin#datatransfer#applicationsList", # Identifies the resource as a collection of Applications.
144    "etag": "A String", # ETag of the resource.
145  }</pre>
146</div>
147
148<div class="method">
149    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
150  <pre>Retrieves the next page of results.
151
152Args:
153  previous_request: The request for the previous page. (required)
154  previous_response: The response from the request for the previous page. (required)
155
156Returns:
157  A request object that you can call 'execute()' on to request the next
158  page. Returns None if there are no more items in the collection.
159    </pre>
160</div>
161
162</body></html>