Miniaturansichten aktivieren

Miniaturansichten werden für Dokumente angezeigt, die in den Suchergebnissen zurückgegeben werden. Mit Thumbnails können Nutzer die Relevanz der zurückgegebenen Dokumente besser erkennen. Thumbnails haben folgende Eigenschaften:

  • Breite von 1.024 Pixeln.
  • Die URL für Google Workspace-Datei-Miniaturansichten ist ACL-geschützt. Die URL für andere Dateitypen ist nicht ACL-geschützt
  • URLs laufen nach 5 Minuten ab.
  • Für Dateien, die größer als 50 MB sind, werden keine Miniaturansichten generiert.
  • Wenn keine Miniaturansicht generiert werden kann, wird ein Platzhaltersymbol verwendet. Wenn für ein Google Workspace-Element keine Miniaturansicht generiert werden kann, wird in der Thumbnail-URL „404 – Nicht gefunden“ zurückgegeben. Ihre Anwendung muss mit diesem Verhalten umgehen können.

Miniaturansichten werden automatisch für Google Drive-Dateien erstellt, die Miniaturansichten unterstützen, z. B. Google Workspace-Dokumenttypen (Google Docs, Google Tabellen, Google Präsentationen usw.). Außerdem erstellt Cloud Search automatisch Miniaturansichten für die folgenden Dateitypen:

  • Microsoft Word (DOC)
  • Microsoft Word (DOCX)
  • Microsoft Excel (XLS)
  • Microsoft Excel (XLSX)
  • Microsoft PowerPoint (PPT)
  • Microsoft PowerPoint (PPTX)
  • Adobe Portable Document Format (PDF)
  • Rich Text Format (RTF)
  • Textformat (TXT)
  • Hypertext Markup Language (HTML)
  • Extensible Markup Language (XML)

Thumbnails werden nur für Elemente zurückgegeben, für die sie in der Datenquelle und in den Suchanwendungen aktiviert sind.

Miniaturansicht-URLs für eine Datenquelle aktivieren

Ihr Projekt für die Cloud Search Platform enthält Anmeldedaten für ein Dienstkonto. Wenn du jedoch Miniaturansicht-URLs aktivieren möchtest, musst du einen API-Schlüssel und Anmeldedaten für die Webanwendung erstellen und mit den Anmeldedaten für die Webanwendung ein Zugriffstoken abrufen. Anschließend verwenden Sie diese Anmeldedaten, um eine Datenquelle abzurufen und zu aktualisieren.

  1. Erstellen oder wählen Sie ein Projekt für Ihre App aus und aktivieren Sie die API. Informationen zu diesen beiden Schritten finden Sie unter Schritt 1 und 2 des Leitfadens Zugriff auf die Google Cloud Search API konfigurieren.
  2. Erstellen Sie einen API-Schlüssel:
    1. Klicken Sie in der Google Cloud Console auf das Drop-down-Menü „Anmeldedaten erstellen“ und wählen Sie „API-Schlüssel“ aus. Die Seite „API-Schlüssel erstellt“ wird angezeigt.
    2. Notieren Sie sich den API-Schlüssel.
    3. Klicken Sie auf "Schließen". Die neu erstellten Anmeldedaten werden unter „API-Schlüssel“ angezeigt.
  3. Erstellen Sie Anmeldedaten für die Webanwendung. Verwenden Sie https://developers.google.com/oauthplayground als Weiterleitungs-URI. . Eine entsprechende Anleitung finden Sie unter Anmeldedaten für Webanwendungen erstellen (clientseitiges JavaScript).
  4. Klicken Sie in der OAuth 2.0 Playground auf OAuth 2.0-Konfiguration .
  5. Setzen Sie ein Häkchen bei Eigene Anmeldedaten verwenden.
  6. Geben Sie die in Schritt 3 generierte Client-ID und den Clientschlüssel ein.
  7. Geben Sie im Feld „Scopes“ (Bereiche) https://www.googleapis.com/auth/cloud_search.settings ein und klicken Sie auf Authorize APIs (APIs autorisieren).
  8. Optional: Wenn ein Anmeldebildschirm angezeigt wird, wählen Sie das gewünschte Konto aus.
  9. Optional: Wenn ein Autorisierungsbildschirm angezeigt wird, klicken Sie auf Akzeptieren.
  10. Klicken Sie auf Autorisierungscode für Tokens austauschen. Ein Token wird zurückgegeben.
  11. Wählen Sie die Datenquelle aus, für die Sie die Miniaturansichtsteuerung aktivieren möchten.
  12. Rufen Sie settings.datasources.get auf, um die ID der Datenquelle abzurufen:

    curl
    'https://cloudsearch.googleapis.com/v1/settings/datasource_id?key=[YOUR_API_KEY]' \
    --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]'\
    --header 'Accept: application/json'  \
    --compressed
    

    Wobei:

    • „datasource_id“ ist der Name der abzurufenden Datenquelle.
    • YOUR_API_KEY ist der API-Schlüssel für dein Projekt, den du in Schritt 2 erhalten hast.
    • YOUR_ACCESS_TOKEN ist das OAuth 2.0-Zugriffstoken für Ihr Projekt, das Sie in Schritt 10 abgerufen haben.

    Das erfolgreiche Ergebnis dieses Befehls sieht in etwa so aus:

    {
     "source": {
       "name": "datasources/datasource_id",
       "displayName": "DataSource_Display_Name",
       "itemsVisibility": [
         {
           "gsuiteDomain": true
         }
       ]
     }
    }
    
  13. Rufe setting.datasource.update auf und setze returnThumbnailUrls auf true, um Miniaturansicht-URLs für die Datenquelle zu aktivieren:

    curl --request PUT \  'https://cloudsearch.googleapis.com/v1/settings/datasources/datasource_id?key=[YOUR_API_KEY]' \
      --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \
      --header 'Accept: application/json' \
      --header 'Content-Type: application/json' \
      --data '{"source":{"name":"datasources/datasource_id","displayName":"DataSource_Display_Name","itemsVisibility":
        [{"gsuiteDomain":true}],"returnThumbnailUrls":true}}' \
      --compressed
    

    Wobei:

    • „datasource_id“ ist die ID der abzurufenden Datenquelle.
    • YOUR_API_KEY ist der API-Schlüssel für dein Projekt, den du in Schritt 2 erhalten hast.
    • YOUR_ACCESS_TOKEN ist das OAuth 2.0-Zugriffstoken für Ihr Projekt, das Sie in Schritt 10 abgerufen haben.
    • DataSource_DisplayName ist der Anzeigename, der vom vorherigen cURL-Befehl zurückgegeben wurde.
    • "returnThumbnailsUrls":true aktiviert Thumbnails.

    Das erfolgreiche Ergebnis dieses Befehls sieht in etwa so aus:

    {
      "source": {
        "name": "datasources/datasource_id",
        "displayName": "DataSource_Display_Name",
        "itemsVisibility": [
          {
            "gsuiteDomain": true
          }
        ],
        "returnThumbnailUrls": true
      }
    }
    

Miniaturansichten-URLs für eine Suchanwendung aktivieren

Ihr Projekt für die Cloud Search Platform enthält Anmeldedaten für ein Dienstkonto. Wenn du jedoch Miniaturansicht-URLs aktivieren möchtest, musst du einen API-Schlüssel und Anmeldedaten für die Webanwendung erstellen und mit den Anmeldedaten für die Webanwendung ein Zugriffstoken abrufen. Schließlich verwenden Sie diese Anmeldedaten, um eine Suchanwendung abzurufen und zu aktualisieren.

  1. Erstellen oder wählen Sie ein Projekt für Ihre App aus und aktivieren Sie die API. Informationen zu diesen beiden Schritten finden Sie unter Schritt 1 und 2 des Leitfadens Zugriff auf die Google Cloud Search API konfigurieren.
  2. Erstellen Sie einen API-Schlüssel:
    1. Klicken Sie in der Cloud Console auf das Drop-down-Menü „Anmeldedaten erstellen“ und wählen Sie „API-Schlüssel“ aus. Die Seite „API-Schlüssel erstellt“ wird angezeigt.
    2. Notieren Sie sich den API-Schlüssel.
    3. Klicken Sie auf "Schließen". Die neu erstellten Anmeldedaten werden unter „API-Schlüssel“ angezeigt.
  3. Erstellen Sie Anmeldedaten für die Webanwendung. Verwenden Sie https://developers.google.com/oauthplayground als Weiterleitungs-URI. . Eine entsprechende Anleitung finden Sie unter Anmeldedaten für Webanwendungen erstellen (clientseitiges JavaScript).
  4. Klicken Sie in der OAuth 2.0 Playground auf OAuth 2.0-Konfiguration .
  5. Setzen Sie ein Häkchen bei Eigene Anmeldedaten verwenden.
  6. Geben Sie die in Schritt 3 generierte Client-ID und den Clientschlüssel ein.
  7. Geben Sie im Feld „Scopes“ (Bereiche) https://www.googleapis.com/auth/cloud_search.settings ein und klicken Sie auf Authorize APIs (APIs autorisieren).
  8. Optional: Wenn ein Anmeldebildschirm angezeigt wird, wählen Sie das gewünschte Konto aus.
  9. Optional: Wenn ein Autorisierungsbildschirm angezeigt wird, klicken Sie auf Akzeptieren.
  10. Klicken Sie auf Autorisierungscode für Tokens austauschen. Ein Token wird zurückgegeben.
  11. Wählen Sie die Suchanwendung aus, für die Sie die Miniaturansichten steuern möchten.
  12. Rufen Sie settings.searchapplications.get auf, um die ID der Suchanwendung abzurufen:

    curl \ 'https://cloudsearch.googleapis.com/v1/settings/searchapplications/search_application_id?key=[YOUR_API_KEY]' \
     --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \
     --header 'Accept: application/json' \
     --compressed
    

    Wobei:

    • ist die ID der Suchanwendung, die abgerufen werden soll.
    • YOUR_API_KEY ist der API-Schlüssel für dein Projekt, den du in Schritt 2 erhalten hast.
    • YOUR_ACCESS_TOKEN ist das OAuth 2.0-Zugriffstoken für Ihr Projekt, das Sie in Schritt 10 abgerufen haben.

    Das erfolgreiche Ergebnis dieses Befehls sieht in etwa so aus:

    {
     "name": "searchapplications/search_application_id",
     "displayName": "SearchApp_Display_Name",
     "dataSourceRestrictions": [
       {
         "source": {
           "name": "datasources/datasource_id"
         }
       }
     ]
    }
    
  13. Rufe setting.searchapplications.update auf und setze returnResultThumbnailUrls auf true, um Miniatur-URLs für die Suchanwendung zu aktivieren:

    curl --request PUT \  'https://cloudsearch.googleapis.com/v1/settings/searchapplications/search_application_id?key=[YOUR_API_KEY]' \
      --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \
      --header 'Accept: application/json' \
      --header 'Content-Type: application/json' \
      --data '{"name":"searchapplications/search_application_id","displayName":"SearchApp_Display_Name","dataSourceRestrictions":[{"source":
        {"name":"datasources/datasource_id"}}],"returnResultThumbnailUrls":true}' \
      --compressed
    

    Wobei:

    • ist die ID der Suchanwendung, die abgerufen werden soll.
    • YOUR_API_KEY ist der API-Schlüssel für dein Projekt, den du in Schritt 2 erhalten hast.
    • YOUR_ACCESS_TOKEN ist das OAuth 2.0-Zugriffstoken für Ihr Projekt, das Sie in Schritt 10 abgerufen haben.
    • SearchApp_DisplayName ist der Anzeigename, der vom vorherigen cURL-Befehl zurückgegeben wurde.
    • "returnResultThumbnailUrls":true aktiviert Miniaturansichten.

    Das erfolgreiche Ergebnis dieses Befehls sieht in etwa so aus:

    {
      "name": "searchapplications/search_application_id",
      "displayName": "SearchApp_Display_Name",
      "dataSourceRestrictions": [
        {
          "source": {
            "name": "datasources/datasource_id"
          }
        }
      ],
      "returnResultThumbnailUrls": true
    }
    

Auf Thumbnails zugreifen

Wenn ein Nutzer oder eine Anwendung auf ein Thumbnail für eine Google Workspace-Datei in Drive zugreifen möchte, muss er bzw. sie dieselben Anmeldedaten für das Konto verwenden, mit dem er bzw. sie auf das Element in Google Drive zugreift.