Włącz miniatury

W przypadku dokumentów zwracanych przez wyniki wyszukiwania wyświetlane są miniatury. Miniatury pozwalają użytkownikowi lepiej ocenić trafność zwróconych dokumentów. Miniatury mają te cechy:

  • Szerokość: 1024 piksele.
  • Adres URL miniatur plików Google Workspace jest zabezpieczony przez listę kontroli dostępu (ACL). Adres URL innych typów plików nie jest zabezpieczony listą kontroli dostępu
  • Adresy URL wygasają po 5 minutach.
  • Miniatury nie są generowane w przypadku plików większych niż 50 MB.
  • Jeśli nie można wygenerować miniatury, używana jest ikona symbolu zastępczego. Jeśli nie można wygenerować miniatury elementu Google Workspace, adres URL miniatury zwraca wartość „404 Not found” (Nie znaleziono). Aplikacja musi obsługiwać to zachowanie.

Miniatury są automatycznie tworzone w przypadku plików na Dysku Google, które naturalnie obsługują miniatury, np. w przypadku dokumentów w Google Workspace (takich jak Dokumenty, Arkusze czy Prezentacje). Dodatkowo Cloud Search automatycznie tworzy miniatury tych typów plików:

  • Plik programu Microsoft Word (dokument DOC)
  • pliki programu Microsoft Word (DOCX),
  • Microsoft Excel (XLS)
  • Microsoft Excel (XLSX),
  • Microsoft Powerpoint (PPT)
  • Microsoft Powerpoint (PPTX)
  • Adobe Portable Document Format (PDF).
  • RTF (Rich Text Format)
  • Format tekstowy (TXT)
  • Hypertext Markup Language (HTML)
  • Extensible Markup Language (XML)

Miniatury są zwracane tylko w przypadku elementów, dla których włączono źródło danych i wyszukiwarki.

Włączanie adresów URL miniaturek dla źródła danych

Twój projekt platformy Cloud Search zawiera dane logowania do konta usługi. Aby jednak włączyć adresy URL miniaturek, musisz utworzyć klucz interfejsu API i dane logowania do aplikacji internetowej oraz użyć danych logowania do aplikacji internetowej w celu uzyskania tokena dostępu. Na koniec przy użyciu tych danych logowania możesz pobrać i zaktualizować źródło danych.

  1. Jeśli nie masz jeszcze projektu, utwórz lub wybierz projekt dla swojej aplikacji i włącz interfejs API. Informacje o tych 2 krokach znajdziesz w krokach 1 i 2 w artykule Konfigurowanie dostępu do interfejsu Google Cloud Search API.
  2. Utwórz klucz interfejsu API:
    1. W konsoli Google Cloud kliknij listę „Utwórz dane logowania” i wybierz klucz interfejsu API. Pojawi się strona „Utworzono klucz interfejsu API”.
    2. Zapisz klucz interfejsu API.
    3. Kliknij „Zamknij”. Nowo utworzone dane logowania pojawią się w sekcji „Klucze interfejsu API”.
  3. Utwórz dane logowania do aplikacji internetowej. Jako identyfikatora URI przekierowania użyj https://developers.google.com/oauthplayground. . Instrukcje tworzenia tych danych logowania znajdziesz w artykule Tworzenie danych logowania do aplikacji internetowej (JavaScript po stronie klienta).
  4. W OAuth 2.0 Playground kliknij Konfiguracja OAuth 2.0 .
  5. Zaznacz Użyj własnych danych logowania.
  6. Wpisz identyfikator klienta i tajny klucz klienta wygenerowane w kroku 3.
  7. W polu zakresów wpisz https://www.googleapis.com/auth/cloud_search.settings i kliknij Autoryzuj interfejsy API.
  8. (opcjonalnie) Jeśli pojawi się ekran logowania, wybierz konto, którego chcesz używać.
  9. (Opcjonalnie) Jeśli wyświetli się ekran autoryzacji, kliknij Accept (Zaakceptuj).
  10. Kliknij Exchange authorization code for tokens (Kod autoryzacji wymiany dla tokenów). Zwracany jest token.
  11. Wskaż źródło danych, dla którego chcesz włączyć ustawienia miniatury.
  12. Wywołaj settings.datasources.get, aby uzyskać identyfikator źródła danych:

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

    Gdzie:

    • datasource_id to nazwa źródła danych do pobrania.
    • YOUR_API_KEY to klucz interfejsu API dla Twojego projektu (uzyskany w kroku 2).
    • YOUR_ACCESS_TOKEN to token dostępu OAuth 2.0 dla Twojego projektu (uzyskany z kroku 10).

    Pomyślny wynik wykonania tego polecenia jest podobny do tego:

    {
     "source": {
       "name": "datasources/datasource_id",
       "displayName": "DataSource_Display_Name",
       "itemsVisibility": [
         {
           "gsuiteDomain": true
         }
       ]
     }
    }
    
  13. Wywołaj metodę setting.datasource.update z parametrem returnThumbnailUrls ustawionym jako true, aby włączyć adresy URL miniatur dla źródła danych:

    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
    

    Gdzie:

    • datasource_id to identyfikator źródła danych do pobrania.
    • YOUR_API_KEY to klucz interfejsu API dla Twojego projektu (uzyskany w kroku 2).
    • YOUR_ACCESS_TOKEN to token dostępu OAuth 2.0 dla Twojego projektu (uzyskany z kroku 10).
    • DataSource_DisplayName to wyświetlana nazwa zwrócona w poprzednim poleceniu cURL.
    • "returnThumbnailsUrls":true włącza miniatury.

    Pomyślny wynik wykonania tego polecenia jest podobny do tego:

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

Włączanie adresów URL miniaturek w wyszukiwarce

Twój projekt platformy Cloud Search zawiera dane logowania do konta usługi. Aby jednak włączyć adresy URL miniaturek, musisz utworzyć klucz interfejsu API i dane logowania do aplikacji internetowej oraz użyć danych logowania do aplikacji internetowej w celu uzyskania tokena dostępu. Dane te pozwalają pobrać i zaktualizować wyszukiwarkę.

  1. Jeśli nie masz jeszcze projektu, utwórz lub wybierz projekt dla swojej aplikacji i włącz interfejs API. Informacje o tych 2 krokach znajdziesz w krokach 1 i 2 w artykule Konfigurowanie dostępu do interfejsu Google Cloud Search API.
  2. Utwórz klucz interfejsu API:
    1. W konsoli Cloud kliknij listę „Utwórz dane logowania” i wybierz klucz interfejsu API. Pojawi się strona „Utworzono klucz interfejsu API”.
    2. Zapisz klucz interfejsu API.
    3. Kliknij „Zamknij”. Nowo utworzone dane logowania pojawią się w sekcji „Klucze interfejsu API”.
  3. Utwórz dane logowania do aplikacji internetowej. Jako identyfikatora URI przekierowania użyj https://developers.google.com/oauthplayground. . Instrukcje tworzenia tych danych logowania znajdziesz w artykule Tworzenie danych logowania do aplikacji internetowej (JavaScript po stronie klienta).
  4. W OAuth 2.0 Playground kliknij Konfiguracja OAuth 2.0 .
  5. Zaznacz Użyj własnych danych logowania.
  6. Wpisz identyfikator klienta i tajny klucz klienta wygenerowane w kroku 3.
  7. W polu zakresów wpisz https://www.googleapis.com/auth/cloud_search.settings i kliknij Autoryzuj interfejsy API.
  8. (opcjonalnie) Jeśli pojawi się ekran logowania, wybierz konto, którego chcesz używać.
  9. (Opcjonalnie) Jeśli wyświetli się ekran autoryzacji, kliknij Accept (Zaakceptuj).
  10. Kliknij Exchange authorization code for tokens (Kod autoryzacji wymiany dla tokenów). Zwracany jest token.
  11. Wskaż wyszukiwarkę, dla której chcesz włączyć elementy sterujące miniaturką.
  12. Wywołaj settings.searchapplications.get, aby uzyskać identyfikator wyszukiwarki:

    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
    

    Gdzie:

    • to identyfikator wyszukiwarki, którą chcesz pobrać.
    • YOUR_API_KEY to klucz interfejsu API dla Twojego projektu (uzyskany w kroku 2).
    • YOUR_ACCESS_TOKEN to token dostępu OAuth 2.0 dla Twojego projektu (uzyskany z kroku 10).

    Pomyślny wynik wykonania tego polecenia jest podobny do tego:

    {
     "name": "searchapplications/search_application_id",
     "displayName": "SearchApp_Display_Name",
     "dataSourceRestrictions": [
       {
         "source": {
           "name": "datasources/datasource_id"
         }
       }
     ]
    }
    
  13. Wywołaj metodę setting.searchapplications.update z parametrem returnResultThumbnailUrls ustawionym na true, aby włączyć adresy URL miniaturek dla wyszukiwarki:

    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
    

    Gdzie:

    • to identyfikator wyszukiwarki, którą chcesz pobrać.
    • YOUR_API_KEY to klucz interfejsu API dla Twojego projektu (uzyskany w kroku 2).
    • YOUR_ACCESS_TOKEN to token dostępu OAuth 2.0 dla Twojego projektu (uzyskany z kroku 10).
    • SearchApp_DisplayName to wyświetlana nazwa zwrócona w poprzednim poleceniu cURL.
    • "returnResultThumbnailUrls":true włącza miniatury.

    Pomyślny wynik wykonania tego polecenia jest podobny do tego:

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

Dostęp do miniatur

Aby uzyskać dostęp do miniatury pliku Google Workspace na Dysku, użytkownik lub aplikacja musi przekazać te same dane logowania na konto, które pozwalają uzyskać dostęp do elementu na Dysku Google.