Учетные данные используются для получения токена доступа с серверов авторизации Google, чтобы ваше приложение могло вызывать API Google Workspace. В этом руководстве описывается, как выбрать и настроить учетные данные, необходимые вашему приложению.
Определения терминов, найденных на этой странице, см. в разделе Обзор аутентификации и авторизации .
Выберите учетные данные доступа, которые подходят именно вам.
Требуемые учетные данные зависят от типа данных, платформы и методологии доступа вашего приложения. Доступны три типа учетных данных:
Вариант использования | Метод аутентификации | Об этом методе аутентификации |
---|---|---|
Доступ к общедоступным данным анонимно в вашем приложении. | Ключи API | Прежде чем использовать этот метод аутентификации, убедитесь, что API, который вы хотите использовать, поддерживает ключи API. |
Доступ к данным пользователя, таким как адрес электронной почты или возраст. | Идентификатор клиента OAuth | Требуется, чтобы ваше приложение запросило и получило согласие от пользователя. |
Получите доступ к данным, принадлежащим вашему собственному приложению, или к ресурсам от имени пользователей Google Workspace или Cloud Identity посредством делегирования на уровне домена. | Сервисный аккаунт | Когда приложение проходит аутентификацию как учетная запись службы, оно получает доступ ко всем ресурсам, к которым у учетной записи службы есть разрешение. |
Учетные данные ключа API
Ключ API — это длинная строка, содержащая буквы верхнего и нижнего регистра, цифры, символы подчеркивания и дефисы, например AIzaSyDaGmWKa4JsXZ-HjGw7ISLn_3namBGewQe
. Этот метод аутентификации используется для анонимного доступа к общедоступным данным, таким как файлы Google Workspace, к которым предоставлен доступ с помощью настройки общего доступа «Все в Интернете, у кого есть эта ссылка». Подробнее см. в разделе Использование ключей API .
Чтобы создать ключ API:
- В консоли Google Cloud выберите > API и службы > Учетные данные .
- Нажмите Создать учетные данные > Ключ API .
- Отобразится ваш новый ключ API.
- Нажмите «Копировать , чтобы скопировать ключ API для использования в коде вашего приложения. Ключ API также можно найти в разделе «Ключи API» учетных данных вашего проекта.
- Нажмите «Ограничить ключ» , чтобы обновить дополнительные настройки и ограничить использование вашего ключа API. Дополнительные сведения см. в разделе «Применение ограничений ключей API» .
Учетные данные идентификатора клиента OAuth
Чтобы аутентифицировать конечных пользователей и получить доступ к пользовательским данным в вашем приложении, вам необходимо создать один или несколько идентификаторов клиентов OAuth 2.0. Идентификатор клиента используется для идентификации одного приложения на серверах Google OAuth. Если ваше приложение работает на нескольких платформах, вам необходимо создать отдельный идентификатор клиента для каждой платформы.Выберите тип приложения для получения конкретных инструкций о том, как создать идентификатор клиента OAuth:
Веб-приложение
- В консоли Google Cloud выберите > API и службы > Учетные данные .
- Нажмите «Создать учетные данные» > «Идентификатор клиента OAuth» .
- Щелкните Тип приложения > Веб-приложение .
- В поле Имя введите имя учетных данных. Это имя отображается только в консоли Google Cloud.
- Добавьте авторизованные URI, связанные с вашим приложением:
- Клиентские приложения (JavaScript). В разделе «Авторизованные источники JavaScript» нажмите «Добавить URI» . Затем введите URI, который будет использоваться для запросов браузера. Это определяет домены, из которых ваше приложение может отправлять запросы API на сервер OAuth 2.0.
- Серверные приложения (Java, Python и т. д.) – в разделе «Авторизованные URI перенаправления » нажмите «Добавить URI» . Затем введите URI конечной точки, на который сервер OAuth 2.0 может отправлять ответы.
- Нажмите Создать . Появится экран создания клиента OAuth, показывающий ваш новый идентификатор клиента и секрет клиента.
Обратите внимание на идентификатор клиента. Секреты клиента не используются для веб-приложений.
- Нажмите ОК . Вновь созданные учетные данные появятся в разделе «Идентификаторы клиентов OAuth 2.0» .
Андроид
- В консоли Google Cloud выберите > API и службы > Учетные данные .
- Нажмите «Создать учетные данные» > «Идентификатор клиента OAuth» .
- Нажмите Тип приложения > Android .
- В поле «Имя» введите имя учетных данных. Это имя отображается только в консоли Google Cloud.
- В поле «Имя пакета» введите имя пакета из файла
AndroidManifest.xml
. - В поле «Отпечаток сертификата SHA-1» введите сгенерированный отпечаток сертификата SHA-1 .
- Нажмите Создать . Появится экран создания клиента OAuth, на котором будет показан ваш новый идентификатор клиента.
- Нажмите ОК . Вновь созданные учетные данные появятся в разделе «Идентификаторы клиентов OAuth 2.0».
iOS
- В консоли Google Cloud выберите > API и службы > Учетные данные .
- Нажмите «Создать учетные данные» > «Идентификатор клиента OAuth» .
- Нажмите Тип приложения > iOS .
- В поле «Имя» введите имя учетных данных. Это имя отображается только в консоли Google Cloud.
- В поле «Идентификатор пакета» введите идентификатор пакета, указанный в файле
Info.plist
приложения. - Необязательно: если ваше приложение появилось в Apple App Store, введите идентификатор App Store.
- Необязательно: в поле «Идентификатор команды» введите уникальную строку из 10 символов, созданную Apple и назначенную вашей команде.
- Нажмите Создать . Появится экран создания клиента OAuth, показывающий ваш новый идентификатор клиента и секрет клиента.
- Нажмите ОК . Вновь созданные учетные данные появятся в разделе «Идентификаторы клиентов OAuth 2.0».
Приложение Chrome
- В консоли Google Cloud выберите > API и службы > Учетные данные .
- Нажмите «Создать учетные данные» > «Идентификатор клиента OAuth» .
- Нажмите Тип приложения > Приложение Chrome .
- В поле «Имя» введите имя учетных данных. Это имя отображается только в консоли Google Cloud.
- В поле «Идентификатор приложения» введите уникальную 32-значную строку идентификатора вашего приложения. Это значение идентификатора можно найти в URL-адресе Интернет-магазина Chrome вашего приложения и на панели инструментов разработчика Интернет-магазина Chrome .
- Нажмите Создать . Появится экран создания клиента OAuth, показывающий ваш новый идентификатор клиента и секрет клиента.
- Нажмите ОК . Вновь созданные учетные данные появятся в разделе «Идентификаторы клиентов OAuth 2.0».
Настольное приложение
- В консоли Google Cloud выберите > API и службы > Учетные данные .
- Нажмите «Создать учетные данные» > «Идентификатор клиента OAuth» .
- Нажмите Тип приложения > Приложение для ПК .
- В поле Имя введите имя учетных данных. Это имя отображается только в консоли Google Cloud.
- Нажмите Создать . Появится экран создания клиента OAuth, показывающий ваш новый идентификатор клиента и секрет клиента.
- Нажмите ОК . Вновь созданные учетные данные появятся в разделе «Идентификаторы клиентов OAuth 2.0».
Телевизоры и ограниченные устройства ввода
- В консоли Google Cloud выберите > API и службы > Учетные данные .
- Нажмите «Создать учетные данные» > «Идентификатор клиента OAuth» .
- Нажмите «Тип приложения» > «Телевизоры и устройства с ограниченным вводом» .
- В поле «Имя» введите имя учетных данных. Это имя отображается только в консоли Google Cloud.
- Нажмите Создать . Появится экран создания клиента OAuth, показывающий ваш новый идентификатор клиента и секрет клиента.
- Нажмите ОК . Вновь созданные учетные данные появятся в разделе «Идентификаторы клиентов OAuth 2.0».
Универсальная платформа Windows (UWP)
- В консоли Google Cloud выберите > API и службы > Учетные данные .
- Нажмите «Создать учетные данные» > «Идентификатор клиента OAuth» .
- Щелкните Тип приложения > Универсальная платформа Windows (UWP) .
- В поле «Имя» введите имя учетных данных. Это имя отображается только в консоли Google Cloud.
- В поле «Идентификатор магазина» введите уникальное 12-значное значение идентификатора Microsoft Store вашего приложения. Этот идентификатор можно найти в URL-адресе вашего приложения в Microsoft Store и в Центре партнеров .
- Нажмите Создать . Появится экран создания клиента OAuth, показывающий ваш новый идентификатор клиента и секрет клиента.
- Нажмите ОК . Вновь созданные учетные данные появятся в разделе «Идентификаторы клиентов OAuth 2.0».
Учетные данные учетной записи службы
Учетная запись службы — это особый вид учетной записи, используемый приложением, а не человеком. Вы можете использовать сервисный аккаунт для доступа к данным или выполнения действий с помощью учетной записи робота, а также для доступа к данным от имени пользователей Google Workspace или Cloud Identity. Дополнительные сведения см. в разделе Общие сведения об учетных записях служб .Создать учетную запись службы
Консоль Google Cloud
- В консоли Google Cloud выберите > IAM и администрирование > Учетные записи служб .
- Нажмите Создать учетную запись службы .
- Заполните данные учетной записи службы, затем нажмите «Создать» и продолжите .
- Необязательно: назначьте роли своему сервисному аккаунту, чтобы предоставить доступ к ресурсам вашего проекта Google Cloud. Дополнительные сведения см. в разделе Предоставление, изменение и отзыв доступа к ресурсам .
- Нажмите Продолжить .
- Необязательно: укажите пользователей или группы, которые могут управлять этой учетной записью службы и выполнять действия с ней. Дополнительные сведения см. в разделе Управление олицетворением учетной записи службы .
- Нажмите Готово . Запишите адрес электронной почты для учетной записи службы.
интерфейс командной строки gcloud
- Создайте учетную запись службы:
gcloud iam service-accounts create
SERVICE_ACCOUNT_NAME
\ --display-name="SERVICE_ACCOUNT_NAME
" - Необязательно: назначьте роли своему сервисному аккаунту, чтобы предоставить доступ к ресурсам вашего проекта Google Cloud. Дополнительные сведения см. в разделе Предоставление, изменение и отзыв доступа к ресурсам .
Назначение роли сервисному аккаунту
Вы должны назначить заранее созданную или настраиваемую роль учетной записи службы с помощью учетной записи суперадминистратора.
В консоли администратора Google выберите > Учетная запись > Роли администратора .
Укажите роль, которую вы хотите назначить, и нажмите «Назначить администратора» .
Нажмите Назначить сервисные учетные записи .
Введите адрес электронной почты учетной записи службы.
Нажмите Добавить > Назначить роль .
Создайте учетные данные для учетной записи службы
Вам необходимо получить учетные данные в виде пары открытого/закрытого ключей. Эти учетные данные используются вашим кодом для авторизации действий учетной записи службы в вашем приложении.Чтобы получить учетные данные для вашей учетной записи службы:
- В консоли Google Cloud выберите > IAM и администрирование > Учетные записи служб .
- Выберите свою учетную запись службы.
- Нажмите «Ключи» > «Добавить ключ» > «Создать новый ключ» .
- Выберите JSON , затем нажмите «Создать» .
Ваша новая пара открытого/закрытого ключей генерируется и загружается на ваш компьютер в виде нового файла. Сохраните загруженный файл JSON как
credentials.json
в своем рабочем каталоге. Этот файл является единственной копией этого ключа. Информацию о том, как безопасно хранить ключ, см. в разделе Управление ключами учетной записи службы . - Нажмите Закрыть .
Необязательно: настройте делегирование на уровне домена для сервисного аккаунта.
Чтобы вызывать API от имени пользователей в организации Google Workspace, вашему сервисному аккаунту необходимо предоставить делегирование полномочий на уровне домена в консоли администратора Google Workspace от аккаунта суперадминистратора. Дополнительные сведения см. в разделе Делегирование полномочий на уровне домена сервисному аккаунту .Чтобы настроить делегирование полномочий для сервисного аккаунта на уровне домена:
- В консоли Google Cloud выберите > IAM и администрирование > Учетные записи служб .
- Выберите свою учетную запись службы.
- Нажмите «Показать дополнительные настройки» .
- В разделе «Делегирование на уровне домена» найдите «Идентификатор клиента» своего сервисного аккаунта. Нажмите «Копировать , чтобы скопировать значение идентификатора клиента в буфер обмена.
Если у вас есть доступ суперадминистратора к соответствующей учетной записи Google Workspace, нажмите «Просмотреть консоль администратора Google Workspace» , затем войдите в систему, используя учетную запись суперадминистратора, и продолжайте выполнять следующие действия.
Если у вас нет доступа суперадминистратора к соответствующему аккаунту Google Workspace, обратитесь к суперадминистратору этого аккаунта и отправьте ему идентификатор клиента вашего сервисного аккаунта и список областей OAuth, чтобы он мог выполнить следующие шаги в консоли администратора.
- В консоли администратора Google перейдите в > «Безопасность» > «Доступ и контроль данных » > «Управление API» . «Меню»
- Нажмите «Управление делегированием всего домена» .
- Нажмите Добавить новый .
- В поле «Идентификатор клиента» вставьте ранее скопированный идентификатор клиента.
- В поле «Области OAuth» введите через запятую список областей, необходимых вашему приложению. Это тот же набор областей, который вы определили при настройке экрана согласия OAuth.
- Нажмите «Авторизовать» .
Следующий шаг
Вы готовы к разработке в Google Workspace! Ознакомьтесь со списком продуктов для разработчиков Google Workspace и узнайте, где найти помощь .