Эта страница переведена с помощью Cloud Translation API.

Краткое руководство по Python

В кратких руководствах объясняется, как настроить и запустить приложение, вызывающее API Google Workspace.

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

Создайте приложение командной строки Python, которое отправляет запросы к API Postmaster Tools.

Цели

Настройте свою среду.
Установите клиентскую библиотеку.
Настройте образец.
Запустите образец.

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

Для запуска этого краткого руководства необходимы следующие предварительные условия:

Python 3.10.7 или новее
Инструмент управления пакетами pip
Проект Google Cloud .

Аккаунт Google с включенной Gmail.

Настройте свою среду

Чтобы завершить это краткое руководство, настройте свою среду.

Включить API

Прежде чем использовать API Google, вам необходимо включить их в проекте Google Cloud. Вы можете включить один или несколько API в одном проекте Google Cloud.

В консоли Google Cloud включите API Postmaster Tools.
Включить API

Настройка экрана согласия OAuth

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

В консоли Google Cloud перейдите в Меню > > Брендинг .
Перейти к Брендингу
Если вы уже настроили вы можете настроить следующие параметры экрана согласия OAuth в разделах «Брендинг» , «Аудитория» и «Доступ к данным» . Если вы видите сообщение, в котором говорится еще не настроено , нажмите «Начать» :

В разделе «Информация о приложении» в поле «Имя приложения» введите имя приложения.
В разделе «Электронная почта поддержки пользователей» выберите адрес электронной почты службы поддержки, по которому пользователи смогут связаться с вами, если у них возникнут вопросы относительно их согласия.
Нажмите Далее .
В разделе «Аудитория» выберите «Внутренняя» .
Нажмите Далее .
В разделе «Контактная информация » введите адрес электронной почты , по которому вы сможете получать уведомления о любых изменениях в вашем проекте.
Нажмите Далее .
В разделе «Готово » ознакомьтесь с Политикой пользовательских данных служб Google API и, если вы согласны, выберите Я согласен с Политикой пользовательских данных служб Google API: Политика пользовательских данных .
Нажмите Продолжить .
Нажмите Создать .

На данный момент вы можете пропустить добавление областей. В будущем, когда вы создадите приложение для использования за пределами вашей организации Google Workspace, вам необходимо изменить тип пользователя на Внешний . Затем добавьте области авторизации, необходимые вашему приложению. Дополнительные сведения см. в полном руководстве по настройке согласия OAuth .

Авторизация учетных данных для настольного приложения

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

В консоли Google Cloud перейдите в Меню > > Клиенты .
Перейти к Клиентам
Нажмите Создать клиента .
Нажмите Тип приложения > Приложение для ПК .
В поле Имя введите имя учетных данных. Это имя отображается только в консоли Google Cloud.
Нажмите Создать .
Вновь созданные учетные данные появятся в разделе «Идентификаторы клиентов OAuth 2.0».
Сохраните загруженный файл JSON как credentials.json и переместите его в свой рабочий каталог.

Установите клиентскую библиотеку Google

Установите клиентскую библиотеку Google для Python:

pip install --upgrade google-api-python-client google-auth-httplib2 google-auth-oauthlib

Настройте образец

В своем рабочем каталоге создайте файл с именем quickstart.py .

Включите следующий код в quickstart.py :

from __future__ import print_function
import pickle
import os.path
from googleapiclient.discovery import build
from google_auth_oauthlib.flow import InstalledAppFlow
from google.auth.transport.requests import Request
from googleapiclient import errors

# If modifying these scopes, delete the file token.pickle.
SCOPES = ['https://www.googleapis.com/auth/postmaster.readonly']

def main():
    """Shows basic usage of the PostmasterTools v1beta1 API.
    Prints the visible domains on user's domain dashboard in https://postmaster.google.com/managedomains.
    """
    creds = None
    # The file token.pickle stores the user's access and refresh tokens, and is
    # created automatically when the authorization flow completes for the first
    # time.
    if os.path.exists('token.pickle'):
        with open('token.pickle', 'rb') as token:
            creds = pickle.load(token)
    # If there are no (valid) credentials available, let the user log in.
    if not creds or not creds.valid:
        if creds and creds.expired and creds.refresh_token:
            creds.refresh(Request())
        else:
            flow = InstalledAppFlow.from_client_secrets_file(
                'credentials.json', SCOPES)
            creds = flow.run_local_server(port=0)
        # Save the credentials for the next run
        with open('token.pickle', 'wb') as token:
            pickle.dump(creds, token)

    service = build('gmailpostmastertools', 'v1beta1', credentials=creds)

    domains = service.domains().list().execute()
    if not domains:
        print('No domains found.')
    else:
        print('Domains:')
        for domain in domains['domains']:
            print(domain)

if __name__ == '__main__':
  main()

Запустите образец

В своем рабочем каталоге соберите и запустите пример:
```
python3 quickstart.py
```

При первом запуске примера вам будет предложено авторизовать доступ:
1. Если вы еще не вошли в свою учетную запись Google, войдите в систему, когда будет предложено. Если вы вошли в несколько учетных записей, выберите одну учетную запись, которая будет использоваться для авторизации.
2. Нажмите Принять .
Ваше приложение Python запускается и вызывает API Postmaster Tools.
Информация об авторизации хранится в файловой системе, поэтому при следующем запуске примера кода вам не будет предложено авторизоваться.