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

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

  • Ширина 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. Нажмите «Код авторизации Exchange для токенов» . Токен возвращается.
  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. Нажмите «Код авторизации Exchange для токенов» . Токен возвращается.
  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 Диске.