Integration der Drive-Benutzeroberfläche konfigurieren

Damit Ihre App in Google Drive angezeigt wird, wenn ein Nutzer eine Datei erstellt oder öffnet, müssen Sie zuerst eine Einbindung der Drive-Benutzeroberfläche (UI) einrichten. Die Konfiguration ist auch erforderlich, um Ihre Anwendung im Google Workspace Marketplace aufzulisten.

Drive API aktivieren

Bevor Sie Google APIs verwenden können, müssen Sie sie in einem Google Cloud-Projekt aktivieren. Sie können eine oder mehrere APIs in einem einzelnen Google Cloud-Projekt aktivieren.

Für die Einbindung in die Google Drive-UI müssen Sie die Drive API aktivieren. Dadurch erhalten Sie Zugriff auf die API und die Funktionen zur UI-Integration.

• Aktivieren Sie in der Google Cloud Console die Google Drive API.

  API aktivieren

Drive-UI-Integration einrichten

1. Klicken Sie in der Google API Console auf das Dreistrich-Menü  > APIs und Dienste > Aktivierte APIs und Dienste.

   Zu „Aktivierung von APIs und Dienste“

2. Klicken Sie unten im Dashboard „APIs und Dienste“ auf Google Drive API. Die Konfigurationsseite der Google Drive API wird angezeigt.
3. Wählen Sie den Tab Drive UI-Integration aus.
4. Optional: Geben Sie im Feld Name der Anwendung einen Namen ein. Der Anwendungsname wird Nutzern in den Drive-Einstellungen auf dem Tab „Apps verwalten“ angezeigt.
5. Optional: Geben Sie im Feld Kurze Beschreibung eine kurze Beschreibung in einer Zeile ein. Die Kurzbeschreibung wird Nutzern auf dem Tab „Apps verwalten“ in den Drive-Einstellungen angezeigt.
6. Optional: Geben Sie im Feld Lange Beschreibung eine vollständige Beschreibung ein.

7. Laden Sie ein oder mehrere App-Symbole hoch, die in der Liste der verbundenen Drive-Apps eines Nutzers und im Kontextmenü „Mit öffnen“ angezeigt werden sollen. Symbole sollten im PNG-Format mit transparentem Hintergrund vorliegen. Es kann bis zu 24 Stunden dauern, bis Symbole in Drive angezeigt werden.

   Hinweis: Dokumentsymbole werden nicht mehr unterstützt. Das Symbol Ihrer Anwendung wird neben Verknüpfungs- und Drittanbieterverknüpfungsdateien angezeigt. Für andere Dateitypen werden Standardsymbole verwendet.

8. Geben Sie im Feld URL öffnen die URL zu Ihrer Anwendung ein, um den Menüpunkt "Öffnen mit" der Drive-UI zu verwenden. Diese URL wird vom Kontextmenü „Öffnen mit“ verwendet.

   • Diese URL muss einen voll qualifizierten Domainnamen enthalten. localhost funktioniert nicht.
   • Diese URL sollte für die vorgesehenen Nutzer Ihrer Anwendung zugänglich sein. Wenn Sie mehrere Anwendungsversionen haben, z. B. eine für die öffentliche Version und eine für die eingeschränkte Version für ausgewählte Nutzer, sollte für jede Version eine eindeutige URL verwendet werden. Anschließend können Sie für jede Version unterschiedliche App-Konfigurationen erstellen.
   • Sie müssen bestätigen, wer der Eigentümer dieser URL ist, bevor Sie Ihre App im Google Workspace Marketplace anbieten können.
   • Standardmäßig wird dieser URL ein state-Suchparameter angehängt, um Daten von der Drive-Benutzeroberfläche an Ihre App zu übergeben. Informationen zum Inhalt des state-Parameters finden Sie unter Der state-Parameter.
   Warnung :Die Option zum automatischen Anzeigen des OAuth 2.0-Zustimmungsbildschirms wird eingestellt. Klicken Sie dieses Kästchen nicht an. Die Anwendung muss alle Autorisierungsanfragen starten.

9. Optional: Geben Sie in den Feldern Standard-MIME-Typen und Standarddateiendung Standard-MIME-Typen und Standarddateiendungen ein. Standard-MIME-Typen und Dateierweiterungen stehen für Dateien, die Ihre App speziell zum Öffnen konzipiert wurde. Ihre App kann beispielsweise ein integriertes Format zum Hinzufügen von Ebenen und Bearbeiten von Bildern öffnen. Geben Sie nur standardmäßige Medientypen an und achten Sie darauf, dass sie keine Tippfehler enthalten. Wenn Ihre App nur Verknüpfungsdateien oder Verknüpfungsdateien von Drittanbietern öffnet, können Sie den MIME-Typ leer lassen.

10. Optional: Geben Sie in den Feldern Sekundäre MIME-Typen und Sekundäre Dateiendungen sekundäre MIME-Typen und Dateiendungen ein. Sekundäre MIME-Typen und Dateiendungen stehen für Dateien, die Ihre App öffnen kann, aber nicht für Ihre App spezifisch sind. Ihre App kann beispielsweise eine Bildbearbeitungs-App sein, die PNG- und JPG-Bilder öffnet. Geben Sie nur standardmäßige Medientypen an und achten Sie darauf, dass sie keine Tippfehler enthalten. Wenn Ihre App nur Verknüpfungsdateien oder Verknüpfungsdateien von Drittanbietern öffnet, können Sie den MIME-Typ leer lassen.

    Hinweis :Wenn ein Nutzer mehrere Drive-Apps installiert, mit denen eine Datei geöffnet werden kann, wird die zuletzt installierte App verwendet, bis der Nutzer eine andere App auswählt.

11. Wenn Sie die Schaltfläche „Neu“ in der Drive-Benutzeroberfläche verwenden und Nutzer Dateien mit Ihrer App erstellen lassen möchten, setzen Sie ein Häkchen in das Kästchen Dateien erstellen. Die Felder Neue URL und optional Name des Dokuments werden angezeigt.

    • Diese URL muss einen voll qualifizierten Domainnamen enthalten. localhost funktioniert nicht.
    • Sie müssen bestätigen, wer der Eigentümer dieser URL ist, bevor Sie Ihre App im Google Workspace Marketplace anbieten können.
    • Standardmäßig wird der Abfrageparameter state an diese URL angehängt, um Daten von der Drive-UI an die Anwendung zu übergeben. Weitere Informationen zum Inhalt des Parameters state finden Sie unter Parameter state.

12. Geben Sie im Feld Neue URL eine URL ein. Über diese URL wird der Nutzer über die Schaltfläche „Neu“ zu Ihrer Anwendung weitergeleitet.

    Hinweis: Lassen Sie das Feld „Dokumentname“ leer. Dieses Feld wird nicht mehr verwendet.

13. Optional: Wenn Ihre App von Google Workspace unterstützte Dateien öffnen soll, klicken Sie das Kästchen Importieren an.

14. Optional: Wenn Ihre App Dateien in geteilten Ablagen verwalten muss, klicken Sie auf das Kästchen Unterstützung für geteilte Ablagen. Weitere Informationen zur Unterstützung von geteilten Ablagen in Ihrer App finden Sie unter Unterstützung für geteilte Ablagen implementieren.

15. Klicken Sie auf Senden.

Umfang drive.install anfordern

Damit Anwendungen als Option im Menü „Öffnen mit“ oder „Neu“ angezeigt werden können, fordern Sie den Bereich https://www.googleapis.com/auth/drive.install für die Einbindung in die Drive-UI an. Wenn Nutzer diesen Umfang anfordern, wird ihnen ein Dialogfeld ähnlich dem folgenden angezeigt:

Abbildung 1. Das Installationsdialogfeld bei Verwendung von Bereichen für die Drive-Benutzeroberfläche.

Weitere Informationen zu Bereichen, die Sie für Drive-Apps anfordern können, und dazu, wie Sie sie anfordern, finden Sie unter API-spezifische Autorisierungs- und Authentifizierungsinformationen.

Hinweis :Wenn Sie Ihre Drive-App im Google Workspace Marketplace veröffentlichen, können Nutzer und Domainadministratoren die App direkt im Google Workspace Marketplace suchen und installieren.

Der Parameter state

Standardmäßig wird sowohl der Open URL als auch der neuen URL ein state-Parameter angehängt, um Daten von der Drive-Benutzeroberfläche an Ihre App zu übergeben. Dieser Parameter enthält einen JSON-codierten String mit Vorlagenvariablen und Daten zur Anfrage an Ihre App. Welche Variablen enthalten sind, hängt vom verwendeten URL-Typ (Offene URL oder neue URL) ab:

Vorlagenvariable	Beschreibung	URL-Anwendung
{ids}	Eine durch Kommas getrennte Liste der Datei-IDs, die geöffnet werden.	URL öffnen
{exportIds}	Eine durch Kommas getrennte Liste der exportierten Datei-IDs (wird nur beim Öffnen von integrierten Google-Dokumenten verwendet).	URL öffnen
{resourceKeys}	Ein JSON-Wörterbuch mit Datei-IDs, die ihren jeweiligen Ressourcenschlüsseln zugeordnet sind.	URL öffnen
{folderId}	Die ID des übergeordneten Ordners.	Neue URL
{folderResourceKey}	Der Ressourcenschlüssel des übergeordneten Ordners.	Neue URL
{userId}	Die Profil-ID, die den Nutzer identifiziert.	„URL öffnen“ und „Neue URL“
{action}	Die ausgeführte Aktion. Der Wert ist open, wenn eine „Öffnen-URL“ verwendet wird, und create, wenn eine „Neue URL“ verwendet wird.	„URL öffnen“ und „Neue URL“

Der Parameter state ist URL-codiert. Ihre Anwendung muss also die Escapezeichen verarbeiten und als JSON parsen. Apps können den Wert create im Parameter state erkennen, um eine Anfrage zum Erstellen einer Datei zu überprüfen.

Beispielstatusinformationen in JSON für eine neue URL

Die state-Informationen für eine neue URL sind:

{
  "action":"create",
  "folderId":"FOLDER_ID",
  "folderResourceKey":"FOLDER_RESOURCE_KEY",
  "userId":"USER_ID"
}

Beispiel für Statusinformationen in JSON für eine geöffnete URL

Die state-Informationen für eine geöffnete URL sind:

{
  "ids": ["ID"],
  "resourceKeys":{"RESOURCE_KEYS":"RESOURCE_KEYS"},
  "action":"open",
  "userId":"USER_ID"
}

Die IDs und Ressourcenschlüssel werden verwendet, um Dateimetadaten abzurufen und Dateiinhalte herunterzuladen. Sobald deine App die Datei-ID und ein Zugriffstoken hat, kann sie Berechtigungen prüfen, die Dateimetadaten abrufen und den Dateiinhalt wie in der Methode files.get beschrieben herunterladen.

Hinweis: Alle Apps, einschließlich Apps, die Dateien über Verknüpfungen und Drittanbieterverknüpfungen öffnen, sollten die Methode files.get aufrufen, um die Berechtigungen des Nutzers für ein Dokument zu prüfen. Apps sollten Nutzer mit Lesezugriff warnen, wenn sie eine Datei öffnen, die sie nicht bearbeiten oder speichern können, anstatt sie Zeit für die Bearbeitung verschwenden zu lassen und dann beim Speichern eine Fehlermeldung anzuzeigen.

Weitere Informationen

Eine installierte App muss Aktionen erstellen, verwalten und öffnen können, die über die Drive-Benutzeroberfläche gestartet werden. Weitere Informationen finden Sie unter Schaltfläche „Neu“ in der Drive-Benutzeroberfläche einbinden oder „Mit“-Kontextmenü in der Drive-Benutzeroberfläche einbinden.