You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/dyn/admin_datatransfer_v1.applications.html
+12-12Lines changed: 12 additions & 12 deletions
Original file line number
Diff line number
Diff line change
@@ -106,15 +106,15 @@ <h3>Method Details</h3>
106
106
Returns:
107
107
An object of the form:
108
108
109
-
{ # Applications resources represent applications installed on the domain that support transferring ownership of user data.
109
+
{ # Application resources represent applications installed on the domain that support transferring ownership of user data.
110
110
"etag": "A String", # Etag of the resource.
111
-
"id": "A String", # The application's ID.
111
+
"id": "A String", # The application's ID. Retrievable by using the [`applications.list()`](/admin-sdk/data-transfer/reference/rest/v1/applications/list) method.
112
112
"kind": "admin#datatransfer#ApplicationResource", # Identifies the resource as a DataTransfer Application Resource.
113
113
"name": "A String", # The application's name.
114
-
"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 transferred.
114
+
"transferParams": [ # The list of all possible transfer parameters for this application. These parameters select which categories of the user's data to transfer.
115
115
{ # Template for application transfer parameters.
116
-
"key": "A String", # The type of the transfer parameter. eg: 'PRIVACY_LEVEL'
117
-
"value": [ # The value of the corresponding transfer parameter. eg: 'PRIVATE' or 'SHARED'
116
+
"key": "A String", # The type of the transfer parameter, such as `PRIVACY_LEVEL`.
117
+
"value": [ # The value of the transfer parameter, such as `PRIVATE` or `SHARED`.
118
118
"A String",
119
119
],
120
120
},
@@ -139,16 +139,16 @@ <h3>Method Details</h3>
139
139
An object of the form:
140
140
141
141
{ # Template for a collection of Applications.
142
-
"applications": [ # List of applications that support data transfer and are also installed for the customer.
143
-
{ # Applications resources represent applications installed on the domain that support transferring ownership of user data.
142
+
"applications": [ # The list of applications that support data transfer and are also installed for the customer.
143
+
{ # Application resources represent applications installed on the domain that support transferring ownership of user data.
144
144
"etag": "A String", # Etag of the resource.
145
-
"id": "A String", # The application's ID.
145
+
"id": "A String", # The application's ID. Retrievable by using the [`applications.list()`](/admin-sdk/data-transfer/reference/rest/v1/applications/list) method.
146
146
"kind": "admin#datatransfer#ApplicationResource", # Identifies the resource as a DataTransfer Application Resource.
147
147
"name": "A String", # The application's name.
148
-
"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 transferred.
148
+
"transferParams": [ # The list of all possible transfer parameters for this application. These parameters select which categories of the user's data to transfer.
149
149
{ # Template for application transfer parameters.
150
-
"key": "A String", # The type of the transfer parameter. eg: 'PRIVACY_LEVEL'
151
-
"value": [ # The value of the corresponding transfer parameter. eg: 'PRIVATE' or 'SHARED'
150
+
"key": "A String", # The type of the transfer parameter, such as `PRIVACY_LEVEL`.
151
+
"value": [ # The value of the transfer parameter, such as `PRIVATE` or `SHARED`.
152
152
"A String",
153
153
],
154
154
},
@@ -157,7 +157,7 @@ <h3>Method Details</h3>
157
157
],
158
158
"etag": "A String", # ETag of the resource.
159
159
"kind": "admin#datatransfer#applicationsList", # Identifies the resource as a collection of Applications.
160
-
"nextPageToken": "A String", # Continuation token which will be used to specify next page in list API.
160
+
"nextPageToken": "A String", # Token to specify the next page in the list.
<pclass="firstline">Inserts a data transfer request.</p>
85
+
<pclass="firstline">Inserts a data transfer request. See the [Transfer parameters](/admin-sdk/data-transfer/v1/parameters) reference for specific application requirements.</p>
<pclass="firstline">Lists the transfers for a customer by source user, destination user, or status.</p>
@@ -110,60 +110,60 @@ <h3>Method Details</h3>
110
110
An object of the form:
111
111
112
112
{ # A Transfer resource represents the transfer of the ownership of user data between users.
113
-
"applicationDataTransfers": [ # List of perapplication 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.
113
+
"applicationDataTransfers": [ # The list of per-application data transfer resources. It contains details of the applications associated with this transfer resource, and also specifies the applications for which data transfer has to be done at the time of the transfer resource creation.
114
114
{ # Template to map fields of ApplicationDataTransfer resource.
115
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.
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. For more information about the specific values available for each application, see the [Transfer parameters](/admin-sdk/data-transfer/v1/parameters) reference.
117
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'
118
+
"key": "A String", # The type of the transfer parameter, such as `PRIVACY_LEVEL`.
119
+
"value": [ # The value of the transfer parameter, such as `PRIVATE` or `SHARED`.
120
120
"A String",
121
121
],
122
122
},
123
123
],
124
-
"applicationTransferStatus": "A String", # Current status of transfer for this application. (Read-only)
124
+
"applicationTransferStatus": "A String", # Read-only. Current status of transfer for this application.
125
125
},
126
126
],
127
127
"etag": "A String", # ETag of the resource.
128
-
"id": "A String", # The transfer's ID (Read-only).
128
+
"id": "A String", # Read-only. The transfer's ID.
129
129
"kind": "admin#datatransfer#DataTransfer", # Identifies the resource as a DataTransfer request.
130
130
"newOwnerUserId": "A String", # ID of the user to whom the data is being transferred.
131
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).
132
+
"overallTransferStatusCode": "A String", # Read-only. Overall transfer status.
133
+
"requestTime": "A String", # Read-only. The time at which the data transfer was requested.
<pre>Inserts a data transfer request. See the [Transfer parameters](/admin-sdk/data-transfer/v1/parameters) reference for specific application requirements.
140
140
141
141
Args:
142
142
body: object, The request body.
143
143
The object takes the form of:
144
144
145
145
{ # A Transfer resource represents the transfer of the ownership of user data between users.
146
-
"applicationDataTransfers": [ # List of perapplication 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.
146
+
"applicationDataTransfers": [ # The list of per-application data transfer resources. It contains details of the applications associated with this transfer resource, and also specifies the applications for which data transfer has to be done at the time of the transfer resource creation.
147
147
{ # Template to map fields of ApplicationDataTransfer resource.
148
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.
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. For more information about the specific values available for each application, see the [Transfer parameters](/admin-sdk/data-transfer/v1/parameters) reference.
150
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'
151
+
"key": "A String", # The type of the transfer parameter, such as `PRIVACY_LEVEL`.
152
+
"value": [ # The value of the transfer parameter, such as `PRIVATE` or `SHARED`.
153
153
"A String",
154
154
],
155
155
},
156
156
],
157
-
"applicationTransferStatus": "A String", # Current status of transfer for this application. (Read-only)
157
+
"applicationTransferStatus": "A String", # Read-only. Current status of transfer for this application.
158
158
},
159
159
],
160
160
"etag": "A String", # ETag of the resource.
161
-
"id": "A String", # The transfer's ID (Read-only).
161
+
"id": "A String", # Read-only. The transfer's ID.
162
162
"kind": "admin#datatransfer#DataTransfer", # Identifies the resource as a DataTransfer request.
163
163
"newOwnerUserId": "A String", # ID of the user to whom the data is being transferred.
164
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).
165
+
"overallTransferStatusCode": "A String", # Read-only. Overall transfer status.
166
+
"requestTime": "A String", # Read-only. The time at which the data transfer was requested.
167
167
}
168
168
169
169
x__xgafv: string, V1 error format.
@@ -175,27 +175,27 @@ <h3>Method Details</h3>
175
175
An object of the form:
176
176
177
177
{ # A Transfer resource represents the transfer of the ownership of user data between users.
178
-
"applicationDataTransfers": [ # List of perapplication 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.
178
+
"applicationDataTransfers": [ # The list of per-application data transfer resources. It contains details of the applications associated with this transfer resource, and also specifies the applications for which data transfer has to be done at the time of the transfer resource creation.
179
179
{ # Template to map fields of ApplicationDataTransfer resource.
180
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.
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. For more information about the specific values available for each application, see the [Transfer parameters](/admin-sdk/data-transfer/v1/parameters) reference.
182
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'
183
+
"key": "A String", # The type of the transfer parameter, such as `PRIVACY_LEVEL`.
184
+
"value": [ # The value of the transfer parameter, such as `PRIVATE` or `SHARED`.
185
185
"A String",
186
186
],
187
187
},
188
188
],
189
-
"applicationTransferStatus": "A String", # Current status of transfer for this application. (Read-only)
189
+
"applicationTransferStatus": "A String", # Read-only. Current status of transfer for this application.
190
190
},
191
191
],
192
192
"etag": "A String", # ETag of the resource.
193
-
"id": "A String", # The transfer's ID (Read-only).
193
+
"id": "A String", # Read-only. The transfer's ID.
194
194
"kind": "admin#datatransfer#DataTransfer", # Identifies the resource as a DataTransfer request.
195
195
"newOwnerUserId": "A String", # ID of the user to whom the data is being transferred.
196
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).
197
+
"overallTransferStatusCode": "A String", # Read-only. Overall transfer status.
198
+
"requestTime": "A String", # Read-only. The time at which the data transfer was requested.
199
199
}</pre>
200
200
</div>
201
201
@@ -221,32 +221,32 @@ <h3>Method Details</h3>
221
221
{ # Template for a collection of DataTransfer resources.
222
222
"dataTransfers": [ # List of data transfer requests.
223
223
{ # A Transfer resource represents the transfer of the ownership of user data between users.
224
-
"applicationDataTransfers": [ # List of perapplication 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.
224
+
"applicationDataTransfers": [ # The list of per-application data transfer resources. It contains details of the applications associated with this transfer resource, and also specifies the applications for which data transfer has to be done at the time of the transfer resource creation.
225
225
{ # Template to map fields of ApplicationDataTransfer resource.
226
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.
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. For more information about the specific values available for each application, see the [Transfer parameters](/admin-sdk/data-transfer/v1/parameters) reference.
228
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'
229
+
"key": "A String", # The type of the transfer parameter, such as `PRIVACY_LEVEL`.
230
+
"value": [ # The value of the transfer parameter, such as `PRIVATE` or `SHARED`.
231
231
"A String",
232
232
],
233
233
},
234
234
],
235
-
"applicationTransferStatus": "A String", # Current status of transfer for this application. (Read-only)
235
+
"applicationTransferStatus": "A String", # Read-only. Current status of transfer for this application.
236
236
},
237
237
],
238
238
"etag": "A String", # ETag of the resource.
239
-
"id": "A String", # The transfer's ID (Read-only).
239
+
"id": "A String", # Read-only. The transfer's ID.
240
240
"kind": "admin#datatransfer#DataTransfer", # Identifies the resource as a DataTransfer request.
241
241
"newOwnerUserId": "A String", # ID of the user to whom the data is being transferred.
242
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).
243
+
"overallTransferStatusCode": "A String", # Read-only. Overall transfer status.
244
+
"requestTime": "A String", # Read-only. The time at which the data transfer was requested.
245
245
},
246
246
],
247
247
"etag": "A String", # ETag of the resource.
248
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.
249
+
"nextPageToken": "A String", # Token to specify the next page in the list.
0 commit comments