Настроить OAuth

Когда вы публикуете свое приложение, вам необходимо выполнить 4 основные задачи для аутентификации и авторизации:

  1. Заполните экран согласия OAuth .
  2. Создайте свои учетные данные OAuth 2.0 .
  3. Настройте все области, необходимые для запуска приложения, в SDK Google Workspace Marketplace.
  4. Отправьте свое приложение на проверку OAuth .

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

  • Области, добавленные на экран согласия OAuth, используются для проверки OAuth.
  • Области действия, добавленные в SDK Google Workspace Marketplace, используются для общедоменных и индивидуальных установок для авторизации вашего приложения при его установке из Google Workspace Marketplace.
  • Области, добавленные в манифест, необходимы для правильной работы вашего приложения.

Например, если вы публикуете приложение, которое включает надстройку Google Таблиц и надстройку Google Docs, манифест Apps Script каждой надстройки включает только области, специфичные для этой надстройки. В вашем проекте Google Cloud экран согласия OAuth и SDK Google Workspace Marketplace включают области действия для обоих надстроек.

Предварительные условия

Экран согласия OAuth — это запрос, который сообщает пользователям, которые запрашивают доступ к их данным, и к каким данным пользователи разрешают доступ вашему приложению.

  1. В консоли Google Cloud выберите > API и службы > Экран согласия OAuth .

    Перейдите на экран согласия OAuth.

  2. Выберите тип пользователя для вашего приложения, затем нажмите «Создать» .
  3. Заполните форму регистрации приложения, затем нажмите «Сохранить и продолжить» .

  4. Если вы создаете приложение для использования за пределами вашей организации Google Workspace, нажмите «Добавить или удалить области» . Мы рекомендуем следующие рекомендации при выборе областей:

    • Выберите области, обеспечивающие минимальный уровень доступа, необходимый вашему приложению. Список доступных областей см. в разделе «Области OAuth 2.0 для API Google ».
    • Просмотрите области, перечисленные в каждом из трех разделов: неконфиденциальные области, конфиденциальные области и области с ограниченным доступом. Для любых областей, перечисленных в разделах «Ваши конфиденциальные области» или «Ваши ограниченные области», попытайтесь определить альтернативные неконфиденциальные области, чтобы избежать ненужных дополнительных проверок.
    • Некоторые области требуют дополнительных проверок со стороны Google. Для приложений, которые используются только внутри вашей организации Google Workspace, области действия не отображаются на экране согласия, а использование ограниченных или конфиденциальных областей не требует дальнейшей проверки со стороны Google. Дополнительные сведения см. в разделе Категории областей .
  5. После выбора областей, необходимых вашему приложению, нажмите «Сохранить и продолжить» .
  6. Если в качестве типа пользователя вы выбрали Внешний , добавьте тестовых пользователей:
    1. В разделе «Тестовые пользователи» нажмите «Добавить пользователей» .
    2. Введите свой адрес электронной почты и адрес других авторизованных тестовых пользователей, затем нажмите «Сохранить и продолжить» .
  7. Просмотрите сводку регистрации приложения. Чтобы внести изменения, нажмите «Изменить» . Если регистрация приложения выглядит нормально, нажмите «Вернуться на панель управления» .

2. Создайте свои учетные данные OAuth 2.0.

В зависимости от того, как вы создали свое приложение, существует два разных способа создания учетных данных OAuth 2.0.

Если вы создали свое приложение с помощью Apps Script

Переключите проект Apps Script из проекта Google Cloud по умолчанию на новый стандартный проект. См. раздел «Переключение на другой стандартный проект» .

После того как вы свяжете проект Apps Script с проектом Google Cloud, ваши учетные данные OAuth 2.0 будут созданы автоматически.

Если вы не использовали Apps Script для создания своего приложения

Чтобы создать учетные данные OAuth 2.0, см. раздел Учетные данные идентификатора клиента OAuth .

3. Настройте области действия

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

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

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

4. Отправьте заявку на проверку OAuth (только общедоступные приложения)

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

  • Для проверки OAuth вы должны отправить демонстрационное видео, демонстрирующее путь или процесс, который объясняет пользователям использование запрошенных областей или данных.
  • Если ваше приложение использует ограниченные области действия, ему также может потребоваться пройти оценку безопасности. См . Зачем нужна оценка безопасности .

Чтобы отправить на проверку, выполните следующие действия:

  1. В консоли Google Cloud выберите > API и службы > Экран согласия OAuth .

    Перейдите на экран согласия OAuth.

  2. Нажмите «Выбор проекта» и выберите свой проект.
  3. Нажмите «Изменить приложение».
  4. Введите необходимую информацию и нажмите «Отправить на проверку» .
  5. В диалоговом окне «Требуется проверка» введите соответствующие обоснования, а затем нажмите «Отправить» , чтобы начать процесс проверки.

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

Чем проверка OAuth отличается от проверки приложения

Проверка OAuth — это отдельный процесс от проверки приложения. Он направлен на то, чтобы экран согласия точно отражал личность и намерения вашего приложения, а также на то, чтобы ваше приложение не использовало пользовательские данные не по назначению. Ваше приложение не может быть одобрено до тех пор, пока не будет завершена проверка OAuth вашего приложения. Дополнительную информацию о проверке OAuth см. в разделе Часто задаваемые вопросы по проверке OAuth API .

При проверке приложения основное внимание уделяется информации, которую вы предоставляете в API Google Workspace Marketplace , а также функциональности и удобству использования вашего приложения. Дополнительные сведения о критериях проверки приложения см. в разделе О проверке приложения .