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

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

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

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

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

Цели

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

Предпосылки

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

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

Учетная запись Google Workspace Business или Enterprise с доступом к Google Chat .

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

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

Включить API

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

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

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

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

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

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

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

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

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

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

Настройте приложение Google Chat

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

В консоли Google Cloud перейдите на страницу конфигурации API чата:
Перейти на страницу конфигурации API чата
В разделе «Информация о приложении» введите следующую информацию:
1. В поле «Имя приложения» введите Chat API quickstart app .
2. В поле URL-адрес аватара введите https://developers.google.com/chat/images/quickstart-app-avatar.png .
3. В поле Описание введите Quickstart for calling the Chat API .
В разделе «Интерактивные функции» переведите переключатель «Включить интерактивные функции» в положение «Выкл.», чтобы отключить интерактивные функции для приложения «Чат».
Нажмите «Сохранить» .

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

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

pip install --upgrade google-apps-chat google-auth-httplib2 google-auth-oauthlib

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

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

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

chat/quickstart/quickstart.py

Посмотреть на GitHub

from __future__ import print_function

import os.path

from google.auth.transport.requests import Request
from google.oauth2.credentials import Credentials
from google_auth_oauthlib.flow import InstalledAppFlow
from google.apps import chat_v1 as google_chat


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


def main():
    """Shows basic usage of the Google Chat API.
    """
    creds = None
    # The file token.json 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.json'):
        creds = Credentials.from_authorized_user_file('token.json', SCOPES)
    # 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.json', 'w') as token:
            token.write(creds.to_json())

    try:
        # Create a client
        client = google_chat.ChatServiceClient(
            credentials = creds,
            client_options = {
                "scopes" : SCOPES
            }
        )

        # Initialize request argument(s)
        request = google_chat.ListSpacesRequest(
            # Filter spaces by space type (SPACE or GROUP_CHAT or DIRECT_MESSAGE)
            filter = 'space_type = "SPACE"'
        )

        # Make the request
        page_result = client.list_spaces(request)

        # Handle the response. Iterating over page_result will yield results and
        # resolve additional pages automatically.
        for response in page_result:
            print(response)
    except Exception as error:
        # TODO(developer) - Handle errors from Chat API.
        print(f'An error occurred: {error}')


if __name__ == '__main__':
    main()

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

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

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

Следующие шаги

Документация клиентской библиотеки

Краткое руководство по Python Оптимизируйте свои подборки Сохраняйте и классифицируйте контент в соответствии со своими настройками.