feat(admin): update the api

#### admin:directory_v1 The following keys were added: - schemas.UserName.properties.displayName.type (Total Keys: 1)
googleapis · Nov 15, 2022 · 96ecedf · 96ecedf
1 parent 1a8c294
commit 96ecedf
Show file tree

Hide file tree

Showing 8 changed files with 198 additions and 186 deletions.
diff --git a/docs/dyn/admin_datatransfer_v1.applications.html b/docs/dyn/admin_datatransfer_v1.applications.html
@@ -106,15 +106,15 @@ <h3>Method Details</h3>
 Returns:
   An object of the form:
 
-    { # Applications resources represent applications installed on the domain that support transferring ownership of user data.
+    { # Application resources represent applications installed on the domain that support transferring ownership of user data.
   &quot;etag&quot;: &quot;A String&quot;, # Etag of the resource.
-  &quot;id&quot;: &quot;A String&quot;, # The application&#x27;s ID.
+  &quot;id&quot;: &quot;A String&quot;, # The application&#x27;s ID. Retrievable by using the [`applications.list()`](/admin-sdk/data-transfer/reference/rest/v1/applications/list) method.
   &quot;kind&quot;: &quot;admin#datatransfer#ApplicationResource&quot;, # Identifies the resource as a DataTransfer Application Resource.
   &quot;name&quot;: &quot;A String&quot;, # The application&#x27;s name.
-  &quot;transferParams&quot;: [ # 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.
+  &quot;transferParams&quot;: [ # The list of all possible transfer parameters for this application. These parameters select which categories of the user&#x27;s data to transfer.
     { # Template for application transfer parameters.
-      &quot;key&quot;: &quot;A String&quot;, # The type of the transfer parameter. eg: &#x27;PRIVACY_LEVEL&#x27;
-      &quot;value&quot;: [ # The value of the corresponding transfer parameter. eg: &#x27;PRIVATE&#x27; or &#x27;SHARED&#x27;
+      &quot;key&quot;: &quot;A String&quot;, # The type of the transfer parameter, such as `PRIVACY_LEVEL`.
+      &quot;value&quot;: [ # The value of the transfer parameter, such as `PRIVATE` or `SHARED`.
         &quot;A String&quot;,
       ],
     },
@@ -139,16 +139,16 @@ <h3>Method Details</h3>
   An object of the form:
 
     { # Template for a collection of Applications.
-  &quot;applications&quot;: [ # List of applications that support data transfer and are also installed for the customer.
-    { # Applications resources represent applications installed on the domain that support transferring ownership of user data.
+  &quot;applications&quot;: [ # 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.
       &quot;etag&quot;: &quot;A String&quot;, # Etag of the resource.
-      &quot;id&quot;: &quot;A String&quot;, # The application&#x27;s ID.
+      &quot;id&quot;: &quot;A String&quot;, # The application&#x27;s ID. Retrievable by using the [`applications.list()`](/admin-sdk/data-transfer/reference/rest/v1/applications/list) method.
       &quot;kind&quot;: &quot;admin#datatransfer#ApplicationResource&quot;, # Identifies the resource as a DataTransfer Application Resource.
       &quot;name&quot;: &quot;A String&quot;, # The application&#x27;s name.
-      &quot;transferParams&quot;: [ # 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.
+      &quot;transferParams&quot;: [ # The list of all possible transfer parameters for this application. These parameters select which categories of the user&#x27;s data to transfer.
         { # Template for application transfer parameters.
-          &quot;key&quot;: &quot;A String&quot;, # The type of the transfer parameter. eg: &#x27;PRIVACY_LEVEL&#x27;
-          &quot;value&quot;: [ # The value of the corresponding transfer parameter. eg: &#x27;PRIVATE&#x27; or &#x27;SHARED&#x27;
+          &quot;key&quot;: &quot;A String&quot;, # The type of the transfer parameter, such as `PRIVACY_LEVEL`.
+          &quot;value&quot;: [ # The value of the transfer parameter, such as `PRIVATE` or `SHARED`.
             &quot;A String&quot;,
           ],
         },
@@ -157,7 +157,7 @@ <h3>Method Details</h3>
   ],
   &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
   &quot;kind&quot;: &quot;admin#datatransfer#applicationsList&quot;, # Identifies the resource as a collection of Applications.
-  &quot;nextPageToken&quot;: &quot;A String&quot;, # Continuation token which will be used to specify next page in list API.
+  &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to specify the next page in the list.
 }</pre>
 </div>
 

diff --git a/docs/dyn/admin_datatransfer_v1.transfers.html b/docs/dyn/admin_datatransfer_v1.transfers.html
@@ -82,7 +82,7 @@ <h2>Instance Methods</h2>
 <p class="firstline">Retrieves a data transfer request by its resource ID.</p>
 <p class="toc_element">
   <code><a href="#insert">insert(body=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Inserts a data transfer request.</p>
+<p class="firstline">Inserts a data transfer request. See the [Transfer parameters](/admin-sdk/data-transfer/v1/parameters) reference for specific application requirements.</p>
 <p class="toc_element">
   <code><a href="#list">list(customerId=None, maxResults=None, newOwnerUserId=None, oldOwnerUserId=None, pageToken=None, status=None, x__xgafv=None)</a></code></p>
 <p class="firstline">Lists the transfers for a customer by source user, destination user, or status.</p>
@@ -110,60 +110,60 @@ <h3>Method Details</h3>
   An object of the form:
 
     { # A Transfer resource represents the transfer of the ownership of user data between users.
-  &quot;applicationDataTransfers&quot;: [ # 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.
+  &quot;applicationDataTransfers&quot;: [ # 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.
     { # Template to map fields of ApplicationDataTransfer resource.
       &quot;applicationId&quot;: &quot;A String&quot;, # The application&#x27;s ID.
-      &quot;applicationTransferParams&quot;: [ # The transfer parameters for the application. These parameters are used to select the data which will get transferred in context of this application.
+      &quot;applicationTransferParams&quot;: [ # 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.
         { # Template for application transfer parameters.
-          &quot;key&quot;: &quot;A String&quot;, # The type of the transfer parameter. eg: &#x27;PRIVACY_LEVEL&#x27;
-          &quot;value&quot;: [ # The value of the corresponding transfer parameter. eg: &#x27;PRIVATE&#x27; or &#x27;SHARED&#x27;
+          &quot;key&quot;: &quot;A String&quot;, # The type of the transfer parameter, such as `PRIVACY_LEVEL`.
+          &quot;value&quot;: [ # The value of the transfer parameter, such as `PRIVATE` or `SHARED`.
             &quot;A String&quot;,
           ],
         },
       ],
-      &quot;applicationTransferStatus&quot;: &quot;A String&quot;, # Current status of transfer for this application. (Read-only)
+      &quot;applicationTransferStatus&quot;: &quot;A String&quot;, # Read-only. Current status of transfer for this application.
     },
   ],
   &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
-  &quot;id&quot;: &quot;A String&quot;, # The transfer&#x27;s ID (Read-only).
+  &quot;id&quot;: &quot;A String&quot;, # Read-only. The transfer&#x27;s ID.
   &quot;kind&quot;: &quot;admin#datatransfer#DataTransfer&quot;, # Identifies the resource as a DataTransfer request.
   &quot;newOwnerUserId&quot;: &quot;A String&quot;, # ID of the user to whom the data is being transferred.
   &quot;oldOwnerUserId&quot;: &quot;A String&quot;, # ID of the user whose data is being transferred.
-  &quot;overallTransferStatusCode&quot;: &quot;A String&quot;, # Overall transfer status (Read-only).
-  &quot;requestTime&quot;: &quot;A String&quot;, # The time at which the data transfer was requested (Read-only).
+  &quot;overallTransferStatusCode&quot;: &quot;A String&quot;, # Read-only. Overall transfer status.
+  &quot;requestTime&quot;: &quot;A String&quot;, # Read-only. The time at which the data transfer was requested.
 }</pre>
 </div>
 
 <div class="method">
     <code class="details" id="insert">insert(body=None, x__xgafv=None)</code>
-  <pre>Inserts a data transfer request.
+  <pre>Inserts a data transfer request. See the [Transfer parameters](/admin-sdk/data-transfer/v1/parameters) reference for specific application requirements.
 
 Args:
   body: object, The request body.
     The object takes the form of:
 
 { # A Transfer resource represents the transfer of the ownership of user data between users.
-  &quot;applicationDataTransfers&quot;: [ # 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.
+  &quot;applicationDataTransfers&quot;: [ # 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.
     { # Template to map fields of ApplicationDataTransfer resource.
       &quot;applicationId&quot;: &quot;A String&quot;, # The application&#x27;s ID.
-      &quot;applicationTransferParams&quot;: [ # The transfer parameters for the application. These parameters are used to select the data which will get transferred in context of this application.
+      &quot;applicationTransferParams&quot;: [ # 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.
         { # Template for application transfer parameters.
-          &quot;key&quot;: &quot;A String&quot;, # The type of the transfer parameter. eg: &#x27;PRIVACY_LEVEL&#x27;
-          &quot;value&quot;: [ # The value of the corresponding transfer parameter. eg: &#x27;PRIVATE&#x27; or &#x27;SHARED&#x27;
+          &quot;key&quot;: &quot;A String&quot;, # The type of the transfer parameter, such as `PRIVACY_LEVEL`.
+          &quot;value&quot;: [ # The value of the transfer parameter, such as `PRIVATE` or `SHARED`.
             &quot;A String&quot;,
           ],
         },
       ],
-      &quot;applicationTransferStatus&quot;: &quot;A String&quot;, # Current status of transfer for this application. (Read-only)
+      &quot;applicationTransferStatus&quot;: &quot;A String&quot;, # Read-only. Current status of transfer for this application.
     },
   ],
   &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
-  &quot;id&quot;: &quot;A String&quot;, # The transfer&#x27;s ID (Read-only).
+  &quot;id&quot;: &quot;A String&quot;, # Read-only. The transfer&#x27;s ID.
   &quot;kind&quot;: &quot;admin#datatransfer#DataTransfer&quot;, # Identifies the resource as a DataTransfer request.
   &quot;newOwnerUserId&quot;: &quot;A String&quot;, # ID of the user to whom the data is being transferred.
   &quot;oldOwnerUserId&quot;: &quot;A String&quot;, # ID of the user whose data is being transferred.
-  &quot;overallTransferStatusCode&quot;: &quot;A String&quot;, # Overall transfer status (Read-only).
-  &quot;requestTime&quot;: &quot;A String&quot;, # The time at which the data transfer was requested (Read-only).
+  &quot;overallTransferStatusCode&quot;: &quot;A String&quot;, # Read-only. Overall transfer status.
+  &quot;requestTime&quot;: &quot;A String&quot;, # Read-only. The time at which the data transfer was requested.
 }
 
   x__xgafv: string, V1 error format.
@@ -175,27 +175,27 @@ <h3>Method Details</h3>
   An object of the form:
 
     { # A Transfer resource represents the transfer of the ownership of user data between users.
-  &quot;applicationDataTransfers&quot;: [ # 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.
+  &quot;applicationDataTransfers&quot;: [ # 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.
     { # Template to map fields of ApplicationDataTransfer resource.
       &quot;applicationId&quot;: &quot;A String&quot;, # The application&#x27;s ID.
-      &quot;applicationTransferParams&quot;: [ # The transfer parameters for the application. These parameters are used to select the data which will get transferred in context of this application.
+      &quot;applicationTransferParams&quot;: [ # 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.
         { # Template for application transfer parameters.
-          &quot;key&quot;: &quot;A String&quot;, # The type of the transfer parameter. eg: &#x27;PRIVACY_LEVEL&#x27;
-          &quot;value&quot;: [ # The value of the corresponding transfer parameter. eg: &#x27;PRIVATE&#x27; or &#x27;SHARED&#x27;
+          &quot;key&quot;: &quot;A String&quot;, # The type of the transfer parameter, such as `PRIVACY_LEVEL`.
+          &quot;value&quot;: [ # The value of the transfer parameter, such as `PRIVATE` or `SHARED`.
             &quot;A String&quot;,
           ],
         },
       ],
-      &quot;applicationTransferStatus&quot;: &quot;A String&quot;, # Current status of transfer for this application. (Read-only)
+      &quot;applicationTransferStatus&quot;: &quot;A String&quot;, # Read-only. Current status of transfer for this application.
     },
   ],
   &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
-  &quot;id&quot;: &quot;A String&quot;, # The transfer&#x27;s ID (Read-only).
+  &quot;id&quot;: &quot;A String&quot;, # Read-only. The transfer&#x27;s ID.
   &quot;kind&quot;: &quot;admin#datatransfer#DataTransfer&quot;, # Identifies the resource as a DataTransfer request.
   &quot;newOwnerUserId&quot;: &quot;A String&quot;, # ID of the user to whom the data is being transferred.
   &quot;oldOwnerUserId&quot;: &quot;A String&quot;, # ID of the user whose data is being transferred.
-  &quot;overallTransferStatusCode&quot;: &quot;A String&quot;, # Overall transfer status (Read-only).
-  &quot;requestTime&quot;: &quot;A String&quot;, # The time at which the data transfer was requested (Read-only).
+  &quot;overallTransferStatusCode&quot;: &quot;A String&quot;, # Read-only. Overall transfer status.
+  &quot;requestTime&quot;: &quot;A String&quot;, # Read-only. The time at which the data transfer was requested.
 }</pre>
 </div>
 
@@ -221,32 +221,32 @@ <h3>Method Details</h3>
     { # Template for a collection of DataTransfer resources.
   &quot;dataTransfers&quot;: [ # List of data transfer requests.
     { # A Transfer resource represents the transfer of the ownership of user data between users.
-      &quot;applicationDataTransfers&quot;: [ # 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.
+      &quot;applicationDataTransfers&quot;: [ # 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.
         { # Template to map fields of ApplicationDataTransfer resource.
           &quot;applicationId&quot;: &quot;A String&quot;, # The application&#x27;s ID.
-          &quot;applicationTransferParams&quot;: [ # The transfer parameters for the application. These parameters are used to select the data which will get transferred in context of this application.
+          &quot;applicationTransferParams&quot;: [ # 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.
             { # Template for application transfer parameters.
-              &quot;key&quot;: &quot;A String&quot;, # The type of the transfer parameter. eg: &#x27;PRIVACY_LEVEL&#x27;
-              &quot;value&quot;: [ # The value of the corresponding transfer parameter. eg: &#x27;PRIVATE&#x27; or &#x27;SHARED&#x27;
+              &quot;key&quot;: &quot;A String&quot;, # The type of the transfer parameter, such as `PRIVACY_LEVEL`.
+              &quot;value&quot;: [ # The value of the transfer parameter, such as `PRIVATE` or `SHARED`.
                 &quot;A String&quot;,
               ],
             },
           ],
-          &quot;applicationTransferStatus&quot;: &quot;A String&quot;, # Current status of transfer for this application. (Read-only)
+          &quot;applicationTransferStatus&quot;: &quot;A String&quot;, # Read-only. Current status of transfer for this application.
         },
       ],
       &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
-      &quot;id&quot;: &quot;A String&quot;, # The transfer&#x27;s ID (Read-only).
+      &quot;id&quot;: &quot;A String&quot;, # Read-only. The transfer&#x27;s ID.
       &quot;kind&quot;: &quot;admin#datatransfer#DataTransfer&quot;, # Identifies the resource as a DataTransfer request.
       &quot;newOwnerUserId&quot;: &quot;A String&quot;, # ID of the user to whom the data is being transferred.
       &quot;oldOwnerUserId&quot;: &quot;A String&quot;, # ID of the user whose data is being transferred.
-      &quot;overallTransferStatusCode&quot;: &quot;A String&quot;, # Overall transfer status (Read-only).
-      &quot;requestTime&quot;: &quot;A String&quot;, # The time at which the data transfer was requested (Read-only).
+      &quot;overallTransferStatusCode&quot;: &quot;A String&quot;, # Read-only. Overall transfer status.
+      &quot;requestTime&quot;: &quot;A String&quot;, # Read-only. The time at which the data transfer was requested.
     },
   ],
   &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
   &quot;kind&quot;: &quot;admin#datatransfer#dataTransfersList&quot;, # Identifies the resource as a collection of data transfer requests.
-  &quot;nextPageToken&quot;: &quot;A String&quot;, # Continuation token which will be used to specify next page in list API.
+  &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to specify the next page in the list.
 }</pre>
 </div>