Включить миниатюры

Миниатюры отображаются для документов, найденных в результатах поиска. Они позволяют пользователю лучше определить релевантность найденных документов. Миниатюры обладают следующими характеристиками:

  • Ширина 1024 пикселя.
  • URL-адрес миниатюр файлов Google Workspace защищён ACL. URL-адреса других типов файлов не защищён ACL.
  • Срок действия URL-адресов истекает через 5 минут.
  • Миниатюры не создаются для файлов размером более 50 МБ.
  • Если миниатюру создать не удаётся, используется значок-заполнитель. Если миниатюру для элемента Google Workspace создать не удаётся, URL-адрес миниатюры возвращает ошибку «404 Not Found». Ваше приложение должно обрабатывать это поведение.

Миниатюры автоматически создаются для файлов Google Диска, которые поддерживают их, например, для документов Google Workspace (документы, таблицы, слайды и т. д.). Кроме того, Cloud Search автоматически создаёт миниатюры для следующих типов файлов:

  • Microsoft Word (DOC)
  • Microsoft Word (DOCX)
  • Microsoft Excel (XLS)
  • Microsoft Excel (XLSX)
  • Microsoft PowerPoint (PPT)
  • Microsoft PowerPoint (PPTX)
  • Формат переносимых документов Adobe (PDF)
  • Формат расширенного текста (RTF)
  • Текстовый формат (TXT)
  • Язык разметки гипертекста (HTML)
  • Расширяемый язык разметки (XML)

Миниатюры возвращаются только для тех элементов, в источниках данных и поисковых приложениях которых они включены.

Включить URL-адреса миниатюр для источника данных

Ваш проект платформы Cloud Search содержит учётные данные сервисной учётной записи. Однако для включения URL-адресов миниатюр необходимо создать ключ API и учётные данные веб-приложения, а затем использовать их для получения токена доступа. Эти учётные данные используются для получения и обновления источника данных.

  1. Если вы ещё этого не сделали, создайте или выберите проект для своего приложения и включите API. Информация об этих двух шагах представлена в шагах 1 и 2 статьи «Настройка доступа к API Google Cloud Search» .
  2. Создайте ключ API:
    1. В консоли Google Cloud нажмите на раскрывающийся список «Создать учётные данные» и выберите «Ключ API». Откроется страница «Ключ API создан».
    2. Запишите ключ API.
    3. Нажмите «Закрыть». Новые учётные данные появятся в разделе «Ключи API».
  3. Создайте учётные данные веб-приложения. Используйте https://developers.google.com/oauthplayground в качестве URI перенаправления. Инструкции по созданию этих учётных данных см. в разделе Создание учётных данных веб-приложения (JavaScript на стороне клиента) .
  4. На игровой площадке OAuth 2.0 нажмите конфигурации OAuth 2.0 .
  5. Установите флажок Использовать собственные учетные данные .
  6. Введите идентификатор клиента и секретный код клиента, сгенерированные на шаге 3.
  7. В поле «Области действия» введите https://www.googleapis.com/auth/cloud_search.settings и нажмите «Авторизовать API» .
  8. (необязательно) Если появится экран входа, выберите учетную запись, которую хотите использовать.
  9. (необязательно) Если появится экран авторизации, нажмите Принять .
  10. Нажмите «Обменять код авторизации на токены» . Возвращается токен.
  11. Определите источник данных, для которого вы хотите включить элементы управления миниатюрами.

  12. Вызовите settings.datasources.get , чтобы получить идентификатор источника данных:

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

    Где:

    • datasource_id — имя источника данных, который нужно извлечь.
    • YOUR_API_KEY — ключ API для вашего проекта (полученный на шаге 2).
    • YOUR_ACCESS_TOKEN — токен доступа OAuth 2.0 для вашего проекта (полученный на шаге 10).

    Успешный результат этой команды аналогичен:

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

  13. Вызовите setting.datasource.update со значением returnThumbnailUrls , равным true , чтобы включить URL-адреса миниатюр для источника данных:

    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

    Где:

    • datasource_id — идентификатор источника данных, который необходимо извлечь.
    • YOUR_API_KEY — ключ API для вашего проекта (полученный на шаге 2).
    • YOUR_ACCESS_TOKEN — токен доступа OAuth 2.0 для вашего проекта (полученный на шаге 10).
    • DataSource_DisplayName — отображаемое имя, возвращенное предыдущей командой cURL.
    • "returnThumbnailsUrls":true включает миниатюры.

    Успешный результат этой команды аналогичен:

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

Включить миниатюрные URL-адреса для поискового приложения

Ваш проект платформы Cloud Search содержит учётные данные сервисной учётной записи. Однако для включения URL-адресов миниатюр необходимо создать ключ API и учётные данные веб-приложения, а затем использовать их для получения токена доступа. Эти учётные данные используются для получения и обновления поискового приложения.

  1. Если вы ещё этого не сделали, создайте или выберите проект для своего приложения и включите API. Информация об этих двух шагах представлена в шагах 1 и 2 статьи «Настройка доступа к API Google Cloud Search» .
  2. Создайте ключ API:
    1. В облачной консоли нажмите на раскрывающийся список «Создать учётные данные» и выберите «Ключ API». Откроется страница «Ключ API создан».
    2. Запишите ключ API.
    3. Нажмите «Закрыть». Новые учётные данные появятся в разделе «Ключи API».
  3. Создайте учётные данные веб-приложения. Используйте https://developers.google.com/oauthplayground в качестве URI перенаправления. Инструкции по созданию этих учётных данных см. в разделе Создание учётных данных веб-приложения (JavaScript на стороне клиента) .
  4. На игровой площадке OAuth 2.0 нажмите конфигурации OAuth 2.0 .
  5. Установите флажок Использовать собственные учетные данные .
  6. Введите идентификатор клиента и секретный код клиента, сгенерированные на шаге 3.
  7. В поле «Области действия» введите https://www.googleapis.com/auth/cloud_search.settings и нажмите «Авторизовать API» .
  8. (необязательно) Если появится экран входа, выберите учетную запись, которую хотите использовать.
  9. (необязательно) Если появится экран авторизации, нажмите Принять .
  10. Нажмите «Обменять код авторизации на токены» . Возвращается токен.
  11. Определите поисковое приложение, для которого вы хотите включить элементы управления миниатюрами.

  12. Вызовите settings.searchapplications.get , чтобы получить идентификатор поискового приложения:

    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

    Где:

    • — это идентификатор поискового приложения, который необходимо получить.
    • YOUR_API_KEY — ключ API для вашего проекта (полученный на шаге 2).
    • YOUR_ACCESS_TOKEN — токен доступа OAuth 2.0 для вашего проекта (полученный на шаге 10).

    Успешный результат этой команды аналогичен:

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

  13. Вызовите setting.searchapplications.update со значением returnResultThumbnailUrls , равным true , чтобы включить URL-адреса миниатюр для поискового приложения:

    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

    Где:

    • — это идентификатор поискового приложения, который необходимо получить.
    • YOUR_API_KEY — ключ API для вашего проекта (полученный на шаге 2).
    • YOUR_ACCESS_TOKEN — токен доступа OAuth 2.0 для вашего проекта (полученный на шаге 10).
    • SearchApp_DisplayName — отображаемое имя, возвращенное предыдущей командой cURL.
    • "returnResultThumbnailUrls":true включает миниатюры.

    Успешный результат этой команды аналогичен:

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

Доступ к миниатюрам

Чтобы получить доступ к миниатюре файла Google Workspace на Диске, пользователь или приложение должны передать те же учетные данные, которые они используют для доступа к элементу на Google Диске.