Выберите области действия API Google Диска

Этот документ содержит информацию об авторизации и аутентификации, специфичную для API Google Диска. Прежде чем читать этот документ, обязательно прочтите общую информацию об аутентификации и авторизации Google Workspace в разделе Подробнее об аутентификации и авторизации .

Настройте OAuth 2.0 для авторизации

Настройте экран согласия OAuth и выберите области, чтобы определить, какая информация будет отображаться пользователям и рецензентам приложений, а также зарегистрируйте свое приложение, чтобы можно было опубликовать его позже.

Области API Диска

Чтобы определить уровень доступа, предоставленный вашему приложению, вам необходимо определить и объявить области авторизации . Область авторизации – это строка URI OAuth 2.0, содержащая имя приложения Google Workspace, тип данных, к которым оно обращается, и уровень доступа. Области – это запросы вашего приложения на работу с данными Google Workspace, включая данные аккаунтов Google пользователей.

Когда ваше приложение установлено, пользователю предлагается проверить области, используемые приложением. Как правило, вам следует выбирать максимально узконаправленную область действия и избегать запроса областей, которые не требуются вашему приложению. Пользователи с большей готовностью предоставляют доступ к ограниченным, четко описанным областям.

По возможности мы рекомендуем использовать неконфиденциальные области, поскольку они предоставляют область доступа для каждого файла и сужают доступ к определенным функциям, необходимым приложению.

Drive API поддерживает следующие области:

Код области действия Описание Использование
https://www.googleapis.com/auth/drive.appdata
https://www.googleapis.com/auth/drive.appfolder
Просматривайте и управляйте собственными данными конфигурации приложения на своем Google Диске. Рекомендуется
Нечувствительный
https://www.googleapis.com/auth/drive.install Разрешить приложениям появляться в качестве опции в меню «Открыть с помощью» или «Новое». Рекомендуется
Нечувствительный
https://www.googleapis.com/auth/drive.file Создавайте новые файлы на Диске или изменяйте существующие файлы, которые вы открываете в приложении или которыми пользователь делится с приложением, используя API Google Picker или средство выбора файлов приложения. Рекомендуется
Нечувствительный
https://www.googleapis.com/auth/drive.apps.readonly Просмотрите приложения, которым разрешен доступ к вашему Диску. Чувствительный
https://www.googleapis.com/auth/drive Просматривайте и управляйте всеми файлами на Диске. Ограниченный
https://www.googleapis.com/auth/drive.readonly Просматривайте и скачивайте все файлы с Диска. Ограниченный
https://www.googleapis.com/auth/drive.activity Просматривайте и добавляйте записи активности файлов на вашем Диске. Ограниченный
https://www.googleapis.com/auth/drive.activity.readonly Просматривайте записи активности файлов на вашем Диске. Ограниченный
https://www.googleapis.com/auth/drive.meet.readonly Просматривайте файлы на Диске, созданные или отредактированные с помощью Google Meet. Ограниченный
https://www.googleapis.com/auth/drive.metadata Просматривайте метаданные файлов на вашем Диске и управляйте ими. Ограниченный
https://www.googleapis.com/auth/drive.metadata.readonly Просматривайте метаданные файлов на вашем Диске. Ограниченный
https://www.googleapis.com/auth/drive.scripts Измените поведение сценариев Google Apps Script. Ограниченный

Столбец «Использование» в таблице выше указывает чувствительность каждой области в соответствии со следующими определениями:

Если вашему приложению требуется доступ к каким-либо другим API Google, вы также можете добавить эти области. Дополнительную информацию об областях API Google см. в разделе Использование OAuth 2.0 для доступа к API Google .

Дополнительную информацию о конкретных областях действия OAuth 2.0 см. в разделе «Области действия OAuth 2.0 для API Google» .

Проверка OAuth

Использование определенных областей OAuth может потребовать, чтобы ваше приложение прошло через Справочный центр проверки приложений OAuth . Прочтите часто задаваемые вопросы о приложении OAuth, чтобы определить, когда ваше приложение должно проходить проверку и какой тип проверки требуется. См. также Условия использования Google Диска .

Когда использовать ограниченную область действия

Для Диска только следующие типы приложений могут иметь доступ к ограниченным областям:

  1. Платформенные и веб-приложения, которые обеспечивают локальную синхронизацию или автоматическое резервное копирование файлов пользователей на Диске.
  2. Приложения для повышения производительности и обучения, пользовательский интерфейс которых может включать взаимодействие с файлами Диска (или их метаданными или разрешениями). Приложения для повышения производительности включают в себя управление задачами, ведение заметок, общение в рабочих группах и приложения для совместной работы в классе.
  3. Приложения для отчетности и обеспечения безопасности, которые предоставляют пользователям или клиентам информацию о том, как осуществляется общий доступ к файлам.

Чтобы продолжать использовать ограниченные области, вам следует подготовить свое приложение к проверке ограниченной области .

Перенос существующего приложения из ограниченных областей

Если вы разработали приложение Диска с использованием какой-либо из ограниченных областей, мы рекомендуем перенести ваше приложение на использование неконфиденциальной области, поскольку она предоставляет область доступа для каждого файла и сужает доступ к определенным функциям, необходимым приложению. Многие приложения работают с пофайловым доступом без каких-либо изменений. Если вы используете собственный инструмент выбора файлов, мы рекомендуем перейти на API Google Picker, который полностью поддерживает различные области действия.

Преимущества области OAuth drive.file

Использование области OAuth drive.file и API Google Picker оптимизирует взаимодействие с пользователем и безопасность вашего приложения.

Область OAuth drive.file позволяет пользователям выбирать, какими файлами они хотят поделиться с вашим приложением. Это дает им больше контроля и уверенности в том, что доступ вашего приложения к их файлам ограничен и более безопасен. Напротив, требование широкого доступа ко всем файлам на Диске может отбить у пользователей желание взаимодействовать с вашим приложением. Ниже приведены некоторые причины, по которым вам следует использовать область действия drive.file :

  • Удобство использования : область drive.file работает со всеми ресурсами REST Drive API , что означает, что вы можете использовать ее так же, как и более широкие области действия OAuth.

  • Особенности : API Google Picker предоставляет интерфейс, аналогичный пользовательскому интерфейсу Диска. Сюда входит несколько представлений, показывающих предварительный просмотр и миниатюры файлов на Диске, а также встроенное модальное окно, позволяющее пользователям никогда не покидать основное приложение.

  • Удобство . Приложения могут применять фильтры к определенным типам файлов на Диске (например, Документам Google, Таблицам и фотографиям) при использовании фильтра к файлам Google Picker .

Кроме того, поскольку drive.file не является конфиденциальным, он позволяет упростить процесс проверки.

Сохраняйте токены обновления

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