Erweiterter Drive-Label-Dienst

Mit dem erweiterten Dienst „Google Drive-Labels“ können Sie Labels für Ihre Drive-Dateien und -Ordner erstellen und verwalten. Mit diesem erweiterten Dienst können Sie alle Funktionen der Drive Labels API in Apps Script verwenden.

Wenn Sie Drive-Labels anwenden oder entfernen möchten, verwenden Sie den Advanced Drive Service.

Hinweis :Dies ist ein erweiterter Dienst, den Sie vor der Verwendung aktivieren müssen.

Referenz

Weitere Informationen zu diesem Dienst finden Sie in der Dokumentation zur Google Drive Labels API. Wie alle erweiterten Dienste in Apps Script verwendet der Dienst „Drive Labels API“ dieselben Objekte, Methoden und Parameter wie die öffentliche API.

Informationen zum Melden von Problemen und zum Finden von anderem Support finden Sie im Supportleitfaden zur Google Drive Labels API.

Beispielcode

Im folgenden Beispielcode wird Version 2 der API verwendet.

Labels auflisten

Das folgende Codebeispiel zeigt, wie Sie eine Liste der Labels abrufen, die für den Nutzer verfügbar sind, der die Anfrage stellt.

advanced/driveLabels.gs

Auf GitHub ansehen

/**
 * List labels available to the user.
 */
function listLabels() {
  let pageToken = null;
  let labels = [];
  do {
    try {
      const response = DriveLabels.Labels.list({
        publishedOnly: true,
        pageToken: pageToken
      });
      pageToken = response.nextPageToken;
      labels = labels.concat(response.labels);
    } catch (err) {
      // TODO (developer) - Handle exception
      console.log('Failed to list labels with error %s', err.message);
    }
  } while (pageToken != null);

  console.log('Found %d labels', labels.length);
}

Label erhalten

Im folgenden Codebeispiel wird gezeigt, wie Sie ein einzelnes Label anhand seines Ressourcennamens (dem Stringwert des Labels) abrufen. Rufen Sie die Liste der Labels über die API ab oder verwenden Sie den Drive-Label-Manager, um den Labelnamen zu ermitteln. Weitere Informationen zum Label-Manager finden Sie unter Google Drive-Labels verwalten.

advanced/driveLabels.gs

Auf GitHub ansehen

/**
 * Get a label by name.
 * @param {string} labelName The label name.
 */
function getLabel(labelName) {
  try {
    const label = DriveLabels.Labels.get(labelName, {view: 'LABEL_VIEW_FULL'});
    const title = label.properties.title;
    const fieldsLength = label.fields.length;
    console.log(`Fetched label with title: '${title}' and ${fieldsLength} fields.`);
  } catch (err) {
    // TODO (developer) - Handle exception
    console.log('Failed to get label with error %s', err.message);
  }
}

Labels für ein Drive-Element auflisten

Das folgende Codebeispiel zeigt, wie Sie ein Drive-Element abrufen und alle auf dieses Element angewendeten Labels auflisten.

advanced/driveLabels.gs

Auf GitHub ansehen

/**
 * List Labels on a Drive Item
 * Fetches a Drive Item and prints all applied values along with their to their
 * human-readable names.
 *
 * @param {string} fileId The Drive File ID
 */
function listLabelsOnDriveItem(fileId) {
  try {
    const appliedLabels = Drive.Files.listLabels(fileId);

    console.log('%d label(s) are applied to this file', appliedLabels.labels.length);

    appliedLabels.labels.forEach((appliedLabel) => {
      // Resource name of the label at the applied revision.
      const labelName = 'labels/' + appliedLabel.id + '@' + appliedLabel.revisionId;

      console.log('Fetching Label: %s', labelName);
      const label = DriveLabels.Labels.get(labelName, {view: 'LABEL_VIEW_FULL'});

      console.log('Label Title: %s', label.properties.title);

      Object.keys(appliedLabel.fields).forEach((fieldId) => {
        const fieldValue = appliedLabel.fields[fieldId];
        const field = label.fields.find((f) => f.id == fieldId);

        console.log(`Field ID: ${field.id}, Display Name: ${field.properties.displayName}`);
        switch (fieldValue.valueType) {
          case 'text':
            console.log('Text: %s', fieldValue.text[0]);
            break;
          case 'integer':
            console.log('Integer: %d', fieldValue.integer[0]);
            break;
          case 'dateString':
            console.log('Date: %s', fieldValue.dateString[0]);
            break;
          case 'user':
            const user = fieldValue.user.map((user) => {
              return `${user.emailAddress}: ${user.displayName}`;
            }).join(', ');
            console.log(`User: ${user}`);
            break;
          case 'selection':
            const choices = fieldValue.selection.map((choiceId) => {
              return field.selectionOptions.choices.find((choice) => choice.id === choiceId);
            });
            const selection = choices.map((choice) => {
              return `${choice.id}: ${choice.properties.displayName}`;
            }).join(', ');
            console.log(`Selection: ${selection}`);
            break;
          default:
            console.log('Unknown: %s', fieldValue.valueType);
            console.log(fieldValue.value);
        }
      });
    });
  } catch (err) {
    // TODO (developer) - Handle exception
    console.log('Failed with error %s', err.message);
  }
}