Drive-UI-Integration konfigurieren

Damit Ihre App in Google Drive angezeigt wird, wenn ein Nutzer eine Datei erstellt oder öffnet, müssen Sie zuerst eine Drive-Benutzeroberfläche einrichten. Die Konfiguration ist auch erforderlich, um Ihre App 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.

Wenn Sie die Google Drive-Benutzeroberfläche einbinden möchten, müssen Sie die Drive API aktivieren. Dadurch erhalten Sie Zugriff auf die API und die UI-Integrationsfunktionen.

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

  API aktivieren

Integration in Drive-UI einrichten

1. Öffnen Sie in der Google API Console das Menü  > APIs und Dienste > Aktivierte APIs und Dienste.

   Zu „Aktivierte 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 (Integration der Drive-Benutzeroberfläche) aus.
4. Optional: Geben Sie einen Namen in das Feld Anwendungsname ein. Der Name der Anwendung wird Nutzern in den Drive-Einstellungen auf dem Tab „Apps verwalten“ angezeigt.
5. Optional: Geben Sie im Feld Kurzbeschreibung eine kurze, einzeilige Beschreibung ein. Die kurze Beschreibung wird Nutzern in den Drive-Einstellungen auf dem Tab „Apps verwalten“ angezeigt.
6. Optional: Geben Sie im Feld Lange Beschreibung eine vollständige Beschreibung ein.

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

   Hinweis: Dokumentsymbole werden nicht mehr unterstützt. Das Symbol Ihrer Anwendung wird neben Verknüpfungsdateien und Verknüpfungsdateien von Drittanbietern angezeigt. Für andere Dateitypen wird ein Satz Standardsymbole verwendet.

8. Wenn Sie den Menüpunkt „Öffnen mit“ der Drive-Benutzeroberfläche verwenden möchten, geben Sie die URL Ihrer Anwendung in das Feld URL öffnen ein. 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 Veröffentlichung und eine für die eingeschränkte Veröffentlichung für ausgewählte Nutzer, sollte jede Version eine eindeutige URL verwenden. Anschließend können Sie für jede Version unterschiedliche Anwendungskonfigurationen erstellen.
   • Sie müssen die Inhaberschaft dieser URL bestätigen, bevor Sie Ihre App im Google Workspace Marketplace anbieten können.
   • Standardmäßig wird an diese 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 nicht mehr unterstützt. Klicken Sie dieses Kästchen nicht an. Die Anwendung muss alle Autorisierungsanfragen starten.

9. (Optional) Geben Sie in den Feldern Standard-MIME-Typen und Standard-Dateiendungen die Standard-MIME-Typen und ‑Dateiendungen ein. Standard-MIME-Typen und ‑Dateiendungen stehen für Dateien, die speziell für Ihre App entwickelt wurden. Ihre App könnte beispielsweise ein integriertes Format zum Überlagern und Bearbeiten von Bildern öffnen. Verwenden Sie nur Standard-Medientypen und achten Sie darauf, dass sie keine Tipp- und Rechtschreibfehler enthalten. Wenn Ihre App nur Verknüpfungsdateien oder Verknüpfungsdateien von Drittanbietern öffnet, können Sie das Feld für den MIME-Typ leer lassen.

10. (Optional) Geben Sie sekundäre MIME-Typen und Dateiendungen in die Felder Sekundäre MIME-Typen und Sekundäre Dateiendungen ein. Sekundäre MIME-Typen und Dateiendungen stehen für Dateien, die Ihre App öffnen kann, die aber nicht spezifisch für Ihre App sind. Ihre App könnte beispielsweise eine Bildbearbeitungs-App sein, die PNG- und JPG-Bilder öffnet. Verwenden Sie nur Standard-Medientypen und achten Sie darauf, dass sie keine Tipp- und Rechtschreibfehler enthalten. Wenn Ihre App nur Verknüpfungsdateien oder Verknüpfungsdateien von Drittanbietern öffnet, können Sie das Feld „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“ der Drive-Benutzeroberfläche verwenden möchten, damit Nutzer eine Datei mit Ihrer App erstellen können, setzen Sie ein Häkchen bei Dateien erstellen. Die Felder Neue URL und optional Dokumentname werden angezeigt.

    • Diese URL muss einen voll qualifizierten Domainnamen enthalten. localhost funktioniert nicht.
    • Sie müssen die Inhaberschaft dieser URL bestätigen, bevor Sie Ihre App im Google Workspace Marketplace anbieten können.
    • Standardmäßig wird an diese 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.

12. Geben Sie im Feld Neue URL eine URL ein. Diese URL wird vom Button „Neu“ verwendet, um den Nutzer zu Ihrer Anwendung weiterzuleiten.

    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, setzen Sie ein Häkchen bei Importieren.

14. Optional: Wenn Ihre App Dateien in geteilten Ablagen verwalten muss, setzen Sie ein Häkchen bei 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.

Bereich drive.install anfordern

Wenn Apps als Option im Menü „Öffnen mit“ oder „Neu“ angezeigt werden sollen, fordern Sie den Bereich https://www.googleapis.com/auth/drive.install an, um sie in die Drive-Benutzeroberfläche einzubinden. Wenn Sie diesen Bereich anfordern, wird Nutzern ein Dialogfeld wie dieses angezeigt:

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

Weitere Informationen zu den Bereichen, die Sie für Drive-Apps anfordern können, und 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 an die Öffnungs-URL als auch an die Erstellungs-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. Die enthaltenen Variablen hängen vom verwendeten URL-Typ ab (Öffnungs-URL oder Erstellungs-URL):

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 Datei-IDs, die exportiert werden. Wird nur beim Öffnen von Google Workspace-Dateien verwendet.	URL öffnen
{resourceKeys}	Ein JSON-Dictionary mit Datei-IDs, die den 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 Open URL verwendet wird, oder create, wenn eine New URL verwendet wird.	URL öffnen und Neue URL

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

Beispiel für Statusinformationen im JSON-Format 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 Open URL

Die state-Informationen für eine Open 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 Ihre App die Datei-ID und ein Zugriffstoken hat, kann sie die Berechtigungen prüfen, die Dateimetadaten abrufen und den Dateiinhalt herunterladen, wie in der Methode files.get beschrieben.

Hinweis: Alle Apps, einschließlich Apps, die Dateien über Verknüpfungen und Drittanbieter-Verknü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 mit der Bearbeitung verbringen zu lassen und dann beim Speichern einen Fehler anzuzeigen.

Weitere Informationen

Eine installierte App muss in der Lage sein, Aktionen zu erstellen, zu verwalten und zu öffnen, die über die Drive-Benutzeroberfläche gestartet werden. Weitere Informationen finden Sie unter In die Schaltfläche „Neu“ der Drive-Benutzeroberfläche einbinden oder In das Kontextmenü „Öffnen mit“ der Drive-Benutzeroberfläche einbinden.