Некоторые API Google (те, которые принимают области Sensitive или Restricted ) имеют требования к приложениям, запрашивающим разрешение на доступ к данным потребителей. Эти дополнительные требования для ограниченных областей требуют, чтобы приложение продемонстрировало, что оно является разрешенным типом приложения, и представило дополнительные проверки, которые включают возможную оценку безопасности.
Применимость ограниченных областей действия в API в основном зависит от степени доступа, необходимой для предоставления соответствующей функции в вашем приложении: только чтение, только запись, чтение и запись и т. д.
Когда вы используете OAuth 2.0 для получения разрешения от учетной записи Google на доступ к этим данным, вы используете строки, называемые областями , чтобы указать тип данных, к которым вы хотите получить доступ, и объем доступа, который вам нужен. Если ваше приложение запрашивает конфиденциальные или ограниченные области, вам необходимо завершить процесс проверки, если только использование вашего приложения не подпадает под исключение .
Ограниченных областей меньше по количеству по сравнению с чувствительными областями. FAQ по проверке API OAuth Verification содержит текущий список чувствительных и ограниченных областей. Эти области предоставляют широкий доступ к данным пользователей Google и требуют от вас пройти процесс проверки области, прежде чем вы запросите области из любой учетной записи Google. Для получения информации об этом требовании см. Политику данных пользователей служб API Google и Дополнительные требования для определенных областей API или страницу разработчика Google для конкретного продукта. Если вы храните или передаете данные ограниченной области на серверах, вам необходимо выполнить оценку безопасности .
Понимание ограниченных областей
Если ваше приложение запрашивает какие-либо ограниченные области действия и не соответствует требованиям для исключения , вам необходимо выполнить Дополнительные требования для определенных областей действия API Политики в отношении пользовательских данных служб API Google или особые требования к продукту на странице Google Developer продукта, что требует более тщательного процесса проверки.
Поймите, как вы используете область применения
- Просмотрите области действия, которые использует ваше приложение или которые вы хотите использовать. Чтобы найти существующее использование области действия, проверьте исходный код вашего приложения на предмет областей действия, отправленных с запросами авторизации.
- Определите, что каждая запрошенная область необходима для предполагаемых действий функции вашего приложения и использует минимальные привилегии, необходимые для предоставления функции. API Google обычно имеет справочную документацию на странице разработчика Google продукта для своих конечных точек, которая включает область, необходимую для вызова конечной точки или определенных свойств внутри. Для получения дополнительной информации о необходимых областях доступа для конечных точек API, которые вызывает ваше приложение, прочтите справочную документацию этих конечных точек. For example, for an app that only uses Gmail APIs to occasionally send emails on a user's behalf, don't request the scope that provides full access to the user's email data.
- Данные, которые вы получаете от API Google, должны использоваться только в соответствии с политиками API и тем способом, который вы представляете своим пользователям в действиях вашего приложения и в вашей политике конфиденциальности.
- Ознакомьтесь с документацией API, чтобы узнать больше о каждой области, включая ее потенциал. sensitive or restricted статус.
- Объявите все области действия, используемые вашим приложением, в 's . Указанные вами области группируются в конфиденциальные или ограниченные категории, чтобы выделить любую дополнительную проверку, которая требуется.
- Найдите наилучшую область действия, которая соответствует данным, используемым вашей интеграцией, разберитесь в ее использовании, подтвердите, что все по-прежнему работает в тестовой среде, а затем подготовьтесь к отправке на проверку.
Обязательно учтите время, необходимое для завершения проверки, в плане запуска вашего приложения или любых новых функций, требующих новой области действия. Одно из этих дополнительных требований возникает, если приложение получает доступ или имеет возможность получать доступ к данным пользователей Google с сервера или через него. В этих случаях система должна проходить ежегодную оценку безопасности от независимого стороннего оценщика, одобренного Google. По этой причине процесс проверки ограниченных областей действия может потенциально занять несколько недель. Обратите внимание, что все приложения должны сначала пройти этап проверки бренда , который обычно занимает 2–3 рабочих дня, если информация о бренде изменилась с момента последней одобренной проверки экрана согласия OAuth.
Разрешенные типы приложений
Определенные типы приложений могут получать доступ к ограниченным областям для каждого продукта. Вы можете найти типы приложений на странице разработчика Google для конкретного продукта (например, Gmail API Policy).
Вы несете ответственность за понимание и определение типа своего приложения. Однако, если вы действительно не уверены в типе приложения, вы можете не выбирать никаких вариантов для вопроса Какие функции вы будете использовать? при отправке приложения на проверку. Затем группа проверки API Google определит тип приложения.
Оценка безопасности
Каждое приложение, которое запрашивает доступ к ограниченным данным пользователей Google и имеет возможность доступа к данным с или через сторонний сервер, должно пройти оценку безопасности от экспертов по безопасности, работающих в Google. Эта оценка помогает обеспечить безопасность данных пользователей Google, проверяя, что все приложения, которые получают доступ к данным пользователей Google, демонстрируют способность безопасно обрабатывать данные и удалять данные пользователя по запросу пользователя.
Для стандартизации оценки безопасности мы используем App Defense Alliance и фреймворк оценки безопасности облачных приложений (CASA).
Как упоминалось ранее, чтобы сохранить доступ к любым проверенным ограниченным областям, приложения должны проходить повторную проверку на соответствие и проходить оценку безопасности не реже одного раза в 12 месяцев после даты утверждения Письма об оценке (LOA) вашего оценщика. Если ваше приложение добавляет новую ограниченную область, может потребоваться повторная оценка вашего приложения, чтобы охватить дополнительную область, если она не была включена в предыдущую оценку безопасности.
Команда проверки Google отправит вам электронное письмо, когда придет время повторной сертификации вашего приложения. Чтобы убедиться, что нужные члены вашей команды уведомлены об этом ежегодном принудительном применении, свяжите дополнительные учетные записи Google с вашим проект как владелец или редактор. Это также помогает поддерживать актуальность адресов электронной почты поддержки пользователей и разработчиков, которые указаны в Google OAuth .
Шаги по подготовке к проверке
Все приложения, использующие API Google для запроса доступа к данным, должны выполнить следующие шаги для завершения проверки бренда:
- Подтвердите, что ваше приложение не подпадает ни под один из вариантов использования, указанных в разделе «Исключения из требований проверки» .
- Убедитесь, что ваше приложение соответствует требованиям брендинга связанных API или продукта. Например, см. рекомендации по брендингу для областей Google Sign-In.
- Подтвердите право собственности на авторизованные домены вашего проекта в Google Search Console . Используйте учетную запись Google, связанную с вашим API Console проект в качестве владельца или редактора.
- Убедитесь, что вся информация о бренде на экране согласия OAuth, такая как название приложения, адрес электронной почты службы поддержки, URI домашней страницы, URI политики конфиденциальности и т. д., точно отражает идентификационные данные приложения.
Требования к домашней странице приложения
Убедитесь, что ваша домашняя страница соответствует следующим требованиям:
- Ваша домашняя страница должна быть общедоступной, а не только для зарегистрированных пользователей вашего сайта.
- Соответствие вашей домашней страницы рассматриваемому приложению должно быть очевидным.
- Ссылки на страницу вашего приложения в Google Play Store или на его страницу в Facebook не считаются действительными домашними страницами приложения.
Требования к ссылке на политику конфиденциальности приложений
Убедитесь, что политика конфиденциальности вашего приложения соответствует следующим требованиям:
- Политика конфиденциальности должна быть видна пользователям, размещена в том же домене, что и домашняя страница вашего приложения, и на нее должна быть ссылка на экране согласия OAuth Google API Console. Обратите внимание, что домашняя страница должна содержать описание функциональности приложения, а также ссылки на политику конфиденциальности и дополнительные условия обслуживания.
- Политика конфиденциальности должна раскрывать способ, которым ваше приложение получает доступ, использует, хранит или передает данные пользователей Google. The privacy policy must comply with the Google API Services User Data Policy and the Limited Use requirements for restricted scopes.Вы должны ограничить использование данных пользователей Google практиками, раскрытыми в вашей опубликованной политике конфиденциальности.
- Review example cases of privacy policies that don't meet the Limited Use requirements.
Как отправить приложение на проверку
А проект организует все ваши Ресурсы. Проект состоит из набора связанных учетных записей Google, имеющих разрешение на выполнение операций проекта, набора включенных API и настроек выставления счетов, аутентификации и мониторинга для этих API. Например, проект может содержать один или несколько клиентов OAuth, настраивать API для использования этими клиентами и настраивать экран согласия OAuth , который отображается пользователям перед тем, как они разрешат доступ к вашему приложению.
Если какие-либо из ваших клиентов OAuth не готовы к производству, мы предлагаем вам удалить их из проекта, который запрашивает проверку. Вы можете сделать это в .
Чтобы отправить заявку на проверку, выполните следующие действия:
- Убедитесь, что ваше приложение соответствует Условиям обслуживания API Google и Политике использования пользовательских данных API служб Google .
- Сохраняйте в актуальном состоянии роли владельца и редактора связанных с вашим проектом учетных записей, а также адрес электронной почты службы поддержки пользователей и контактную информацию разработчика на экране согласия OAuth. . Это гарантирует, что нужные члены вашей команды будут уведомлены о любых новых требованиях.
- Перейти к Центр проверки OAuth.
- Нажмите кнопку выбора проекта .
В появившемся диалоговом окне Select from выберите свой проект. Если вы не можете найти свой проект, но знаете его ID, вы можете создать URL в своем браузере в следующем формате:
?project=[PROJECT_ID]
Замените [PROJECT_ID] на идентификатор проекта, который вы хотите использовать.
- Нажмите кнопку «Изменить приложение» .
- Введите необходимую информацию на странице экрана согласия OAuth, а затем нажмите кнопку Сохранить и продолжить .
- Используйте кнопку Добавить или удалить области , чтобы объявить все области, запрошенные вашим приложением. Начальный набор областей, необходимых для входа в Google, предварительно заполнен в разделе Нечувствительные области . Добавленные области классифицируются как нечувствительные, sensitive, or restricted.
- Предоставьте до трех ссылок на любую соответствующую документацию по соответствующим функциям вашего приложения.
Предоставьте любую дополнительную информацию о вашем приложении, которая будет запрошена на последующих этапах.
- Ensure your app complies with the Additional requirements for specific API scopes, which includes undergoing an annual security assessment if your app accesses restricted scope Google users' data from or through a third-party server.
- Ensure your app is one of the allowed types specified in the Limited Use section of the Additional requirements for specific API scopes page.
- If your app is a task automation platform, your demonstration video must showcase how multiple API workflows are created and automated, and in which directions user data flows.
-
Prepare a video that fully demonstrates how a user initiates and grants access to the requested scopes and shows, in detail, the usage of the granted sensitive and restricted scopes in the app. Upload the video to YouTube Studio and set Visibility as Unlisted. You need to provide a link to the demonstration video in the YouTube link field.
- Show the OAuth grant process that users will experience, in English. This includes the consent flow and, if you use Google Sign-In, the sign-in flow.
- Show that the OAuth consent screen correctly displays the App Name.
- Show that the browser address bar of the OAuth consent screen correctly includes your app's OAuth client ID.
- To show how the data will be used, demonstrate the functionality that's enabled by each sensitive and restricted scope that you request.
- If you use multiple clients, and therefore have multiple OAuth client IDs, show how the data is accessed on each OAuth client.
- Select your permitted application type from the "What features will you use?" list.
- Describe how you will use the restricted scopes in your app and why more limited scopes aren't sufficient.
- Если конфигурация приложения, которую вы предоставляете, требует проверки, у вас есть возможность отправить приложение на проверку. Заполните необходимые поля, а затем нажмите «Отправить» , чтобы начать процесс проверки.
После отправки вашего приложения команда Google Trust & Safety отправит вам по электронной почте дополнительную информацию, которая им нужна, или шаги, которые вам необходимо выполнить. Проверьте свои адреса электронной почты в разделе «Контактная информация разработчика» и адрес электронной почты службы поддержки на экране согласия OAuth для запросов на дополнительную информацию. Вы также можете просмотреть страницу экрана согласия OAuth вашего проекта, чтобы подтвердить текущий статус проверки вашего проекта, включая то, приостановлен ли процесс проверки, пока мы ждем вашего ответа.
Исключения из требований проверки
Если ваше приложение будет использоваться в каком-либо из сценариев, описанных в следующих разделах, вам не нужно отправлять его на проверку.
Личное использование
Один из вариантов использования — если вы единственный пользователь своего приложения или если ваше приложение используют всего несколько пользователей, все из которых вам известны лично. Вам и вашему ограниченному числу пользователей может быть удобно продвигаться через экран непроверенного приложения и предоставлять вашим личным аккаунтам доступ к вашему приложению.
Проекты, используемые на этапах разработки, тестирования или подготовки
Чтобы соответствовать политикам Google OAuth 2.0, мы рекомендуем вам иметь разные проекты для тестовых и производственных сред. Мы рекомендуем вам отправлять приложение на проверку только в том случае, если вы хотите сделать его доступным для любого пользователя с учетной записью Google. Поэтому, если ваше приложение находится на этапе разработки, тестирования или подготовки, проверка не требуется.
Если ваше приложение находится на этапе разработки или тестирования, вы можете оставить Статус публикации в значении по умолчанию Тестирование . Эта настройка означает, что ваше приложение все еще находится в стадии разработки и доступно только пользователям, которых вы добавляете в список тестовых пользователей. Вы должны управлять списком учетных записей Google, которые участвуют в разработке или тестировании вашего приложения.
Только данные, принадлежащие сервису
Если ваше приложение использует учетную запись службы только для доступа к своим собственным данным и не имеет доступа к каким-либо пользовательским данным (связанным с учетной записью Google), то вам не нужно отправлять заявку на проверку.
Чтобы понять, что такое учетные записи служб, см. раздел Учетные записи служб в документации Google Cloud. Инструкции по использованию учетной записи службы см. в разделе Использование OAuth 2.0 для приложений «сервер-сервер» .
Только для внутреннего использования
Это означает, что приложение используется только людьми в вашей организации Google Workspace или Cloud Identity. Проект должен принадлежать организации, а его экран согласия OAuth должен быть настроен для типа внутреннего пользователя . В этом случае вашему приложению может потребоваться одобрение администратора организации. Для получения дополнительной информации см. Дополнительные соображения по Google Workspace .
- Узнайте больше о публичных и внутренних приложениях .
- Узнайте, как отметить свое приложение как внутреннее, в разделе часто задаваемых вопросов. Как отметить свое приложение как предназначенное только для внутреннего использования?
Установка на весь домен
Если вы планируете, что ваше приложение будет ориентировано только на пользователей организации Google Workspace или Cloud Identity и всегда использовать установку на уровне домена , то вашему приложению не потребуется проверка приложения. Это связано с тем, что установка на уровне домена позволяет администратору домена предоставлять сторонним и внутренним приложениям доступ к данным ваших пользователей. Администраторы организаций — единственные учетные записи, которые могут добавлять приложение в список разрешенных для использования в своих доменах.
Узнайте, как сделать приложение установкой на уровне домена, в разделе часто задаваемых вопросов. В моем приложении есть пользователи с корпоративными аккаунтами из другого домена Google Workspace .