Implementa la compatibilidad con unidades compartidas

En este documento, se describe cómo implementar la compatibilidad con unidades compartidas en tu app con la API de Google Drive.

Las unidades compartidas siguen diferentes modelos de organización, uso compartido y propiedad que Mi unidad. Si tu app creará y administrará archivos en unidades compartidas, debes implementar la compatibilidad con unidades compartidas en tu app. La complejidad de tu implementación depende de la funcionalidad de tu app.

Para comenzar, debes incluir el parámetro de consulta supportsAllDrives=true en tus solicitudes cuando tu app realice las siguientes operaciones:

El parámetro supportsAllDrives=true informa a Google Drive que tu app está diseñada para controlar archivos en unidades compartidas.

Las apps que leen o modifican permisos, realizan un seguimiento de los cambios o buscan en varios corpus requieren capacidades adicionales de unidades compartidas. En el resto de este documento, se destacan los cambios adicionales necesarios para realizar estas tareas.

Cómo buscar contenido en una unidad compartida

Usa el list método en el files recurso para encontrar archivos de usuario en unidades compartidas. Para buscar una unidad compartida, consulta Cómo buscar unidades compartidas.

El método list contiene los siguientes parámetros de consulta específicos de la unidad compartida:

• driveId: Es el ID de la unidad compartida que se buscará.

• corpora: Son los cuerpos de los elementos (archivos o documentos) a los que se aplica la consulta. Los cuerpos admitidos son user, domain, drive y allDrives. Prefiere user o drive a allDrives para lograr eficiencia. De forma predeterminada, el corpus se establece en user.

• includeItemsFromAllDrives: Indica si se deben incluir elementos de Mi unidad y de unidades compartidas en los resultados. Si no está presente o se establece como falso, no se muestran los elementos de la unidad compartida.

• supportsAllDrives: Indica si la aplicación solicitante admite Mi unidad y la unidad compartida. Si es falso, los elementos de la unidad compartida no se incluyen en la respuesta.

Los siguientes modos de consulta son específicos de las unidades compartidas:

En los siguientes ejemplos de código, se muestra cómo buscar archivos en todas las unidades compartidas y en Mi unidad:

files = []
page_token = None
while True:
    response = drive_service.files().list(
        q="mimeType='application/vnd.google-apps.folder'",
        spaces='drive',
        corpora='allDrives',
        supportsAllDrives=True,
        includeItemsFromAllDrives=True,
        fields='nextPageToken, files(id, name)',
        pageToken=page_token
    ).execute()
    files.extend(response.get('files', []))
    page_token = response.get('nextPageToken', None)
    if not page_token:
        break

let files = [];
let pageToken = null;
do {
  const response = await drive_service.files.list({
    q: "mimeType='application/vnd.google-apps.folder'",
    spaces: 'drive',
    corpora: 'allDrives',
    supportsAllDrives: true,
    includeItemsFromAllDrives: true,
    fields: 'nextPageToken, files(id, name)',
    pageToken: pageToken
  });
  files = files.concat(response.data.files);
  pageToken = response.data.nextPageToken;
} while (pageToken);

List<File> files = new ArrayList<>();
String pageToken = null;
do {
  FileList result = driveService.files().list()
      .setQ("mimeType='application/vnd.google-apps.folder'")
      .setSpaces("drive")
      .setCorpora("allDrives")
      .setSupportsAllDrives(true)
      .setIncludeItemsFromAllDrives(true)
      .setFields("nextPageToken, files(id, name)")
      .setPageToken(pageToken)
      .execute();
  files.addAll(result.getFiles());
  pageToken = result.getNextPageToken();
} while (pageToken != null);

curl -X GET \
  'https://www.googleapis.com/drive/v3/files?corpora=allDrives&includeItemsFromAllDrives=true&supportsAllDrives=true&fields=nextPageToken%2Cfiles(id%2Cname)' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Accept: application/json'

Cómo realizar un seguimiento de los cambios en una unidad compartida

Usa el list método en el changes recurso para realizar un seguimiento de los cambios en una unidad compartida. Para obtener más información, consulta Realiza un seguimiento de los cambios para los usuarios y las unidades compartidas.

El método list contiene los siguientes parámetros de consulta específicos de la unidad compartida:

• driveId: Es la unidad compartida de la que se muestran los cambios. Si se especifica, los IDs de cambio hacen referencia a los cambios en los elementos dentro de la unidad compartida que proporciona el estado actual de un archivo. Para hacer referencia a un cambio específico de la unidad compartida, se deben usar el ID de la unidad compartida y el ID de cambio como identificador.

• includeItemsFromAllDrives: Indica si los archivos o los cambios de la unidad compartida deben incluirse en la lista de cambios.

• supportsAllDrives: Indica si la aplicación solicitante admite unidades compartidas. Si es falso, no se muestran los elementos de la unidad compartida, incluidas las unidades compartidas y los archivos dentro de una unidad compartida.

Los siguientes modos de consulta son específicos de las unidades compartidas:

En los siguientes ejemplos de código, se muestra cómo realizar un seguimiento de los cambios en una unidad compartida:

# 1. Get the start page token for the shared drive.
response = drive_service.changes().getStartPageToken(
    supportsAllDrives=True,
    driveId='SHARED_DRIVE_ID'
).execute()
start_page_token = response.get('startPageToken')

# 2. List changes starting from the page token.
response = drive_service.changes().list(
    pageToken=start_page_token,
    supportsAllDrives=True,
    includeItemsFromAllDrives=True,
    driveId='SHARED_DRIVE_ID'
).execute()
changes = response.get('changes', [])

// 1. Get the start page token for the shared drive.
const tokenResponse = await drive_service.changes.getStartPageToken({
  supportsAllDrives: true,
  driveId: 'SHARED_DRIVE_ID'
});
const startPageToken = tokenResponse.data.startPageToken;

// 2. List changes starting from the page token.
const response = await drive_service.changes.list({
  pageToken: startPageToken,
  supportsAllDrives: true,
  includeItemsFromAllDrives: true,
  driveId: 'SHARED_DRIVE_ID'
});
const changes = response.data.changes;

// 1. Get the start page token for the shared drive.
StartPageToken tokenResult = driveService.changes().getStartPageToken()
    .setSupportsAllDrives(true)
    .setDriveId("SHARED_DRIVE_ID")
    .execute();
String startPageToken = tokenResult.getStartPageToken();

// 2. List changes starting from the page token.
ChangeList changesResult = driveService.changes().list(startPageToken)
    .setSupportsAllDrives(true)
    .setIncludeItemsFromAllDrives(true)
    .setDriveId("SHARED_DRIVE_ID")
    .execute();
List<Change> changes = changesResult.getChanges();

# 1. Get the start page token for the shared drive.
curl -X GET \
  'https://www.googleapis.com/drive/v3/changes/startPageToken?supportsAllDrives=true&driveId=SHARED_DRIVE_ID' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Accept: application/json'

# 2. List changes starting from the page token.
curl -X GET \
  'https://www.googleapis.com/drive/v3/changes?pageToken=START_PAGE_TOKEN&supportsAllDrives=true&includeItemsFromAllDrives=true&driveId=SHARED_DRIVE_ID' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Accept: application/json'

Reemplaza SHARED_DRIVE_ID por el ID de la unidad compartida.

Cómo habilitar la compatibilidad con unidades compartidas en la IU de Drive

Para acceder al contenido de la unidad compartida con la IU de Drive, asegúrate de que has marcado la casilla Compatibilidad con unidades compartidas en la pestaña Integración de la IU de Drive de la API de Google Drive en la consola de Google Cloud. Para obtener más información, consulta Cómo configurar una integración de la IU de Drive.

Cómo usar Google Picker con unidades compartidas

El Google Picker admite la selección de elementos en unidades compartidas. Para obtener detalles sobre cómo habilitar la compatibilidad con unidades compartidas y agregar vistas de unidades compartidas en el selector, consulta la API de Google Picker.

Temas relacionados

• Administra unidades compartidas
• Descripción general de Google Picker