Отправка сообщения на главной карточке приложения Google Chat

На этой странице объясняется, как создать и отправить сообщение на главной карточке приложения Chat. Домашняя страница приложения — это настраиваемое сообщение-карточка, которое приложение Chat отправляет пользователю, когда он открывает прямое сообщение в приложении Chat. Например, вы можете настроить сообщение на главной карточке приложения, включив в него советы по взаимодействию с приложением Chat с помощью команд с косой чертой .

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


Создавайте и просматривайте карты с помощью Card Builder.

Откройте конструктор карточек

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

Питон

Скрипт приложений

Настройте в консоли Google Cloud

Питон

  1. В Google Cloud выберите Меню > Другие продукты > Google Workspace > Библиотека продуктов > Google Chat API .

    Перейти к API чата Google

  2. Нажмите «Управление» , а затем перейдите на вкладку «Конфигурация» .

  3. Включите главную страницу приложения поддержки .

  4. Установите флажок «Домашняя страница приложения поддержки» .

  5. В поле «Домашний URL-адрес приложения» добавьте URL-адрес. Обычно это значение совпадает с URL -адресом приложения . Этот URL-адрес вызывается для событий APP_HOME .

  6. Нажмите Сохранить .

Скрипт приложений

  1. В Google Cloud выберите Меню > Другие продукты > Google Workspace > Библиотека продуктов > Google Chat API .

    Перейти к API чата Google

  2. Нажмите «Управление» , а затем перейдите на вкладку «Конфигурация» .

  3. Установите флажок «Домашняя страница приложения поддержки» .

  4. Нажмите Сохранить .

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

Настройте приложение чата для отправки нового карточного сообщения на главную страницу приложения.

Питон

Когда пользователь открывает прямое сообщение из приложения Chat, в ваше приложение Chat отправляется событие APP_HOME . Когда приложение получает это событие, JSON-экземпляр RenderActions возвращается с навигацией push_card .

В следующем примере показано событие:

@app.route('/', methods=['POST'])
def on_event():
  event = request.get_json()
  chat = event.get('chat')
  if chat is not None:
    return handle_chat_event(event)

def handle_chat_event(event):
  if event['chat'].get('type') == 'APP_HOME':
    return get_app_home_card()

def get_app_home_card:
  // Return "Card v2" representing App Home.

В следующем примере показана карточка, настроенная для включения кнопки со ссылкой на документацию:

{
  action: {
    navigations: [
      {
        push_card: {
          sections: [
            {
              widgets: [
                {
                  buttonList: {
                    buttons: [
                      {
                        text: "Open documentation",
                        onClick: {
                          openLink: {
                            url: "https://developers.google.com/chat"
                          }
                        }
                      }
                    ]
                  }
                }
              ]
            }
          ]
        }
      }
    ]
  }
}

Скрипт приложений

Реализуйте функцию onAppHome для возврата экземпляра JSON RenderActions с навигацией push_card :

// "onAppHome" is the pre-defined name of the callback that the Chat servers
// execute.
function onAppHome() {
  return {
    action: {
      navigations: [
        {
          push_card: getCard()
        }
      ]
    }
  };
}

function getCard() {
  return {
    sections: [
      {
        widgets: [
          {
            buttonList: {
              buttons: [
                {
                  text: "Open documentation",
                  onClick: {
                    openLink: {
                      url: "https://developers.google.com/chat"
                    }
                  }
                }
              ]
            }
          }
        ]
      }
    ]
  };
}

Обновление сообщения на главной карточке приложения

Сообщение домашней карточки приложения может быть обновлено, когда пользователь отправляет информацию в сообщении карточки или закрывает диалоговое окно. Например, исходное сообщение с домашней карточкой приложения представляет собой приветственное сообщение, в котором пользователю предлагается заполнить форму с информацией. После того как пользователь заполнит форму, будет отправлено обновленное сообщение с главной карточкой приложения. Обновление должно быть возвращено с экземпляром RenderActions , содержащим навигацию update_card .

Питон

Для HTTP-приложений обновление сообщения домашней карточки приложения аналогично процессу обработки информации, введенной пользователями , но вы должны вернуть RenderActions . invokedFunction представляет имя вызванной функции, связанной с виджетом Card . Дополнительные сведения см. в разделе CommonEventObject . В следующем примере submitForm показывает, что пользователь отправил данные формы:

@app.route('/', methods=['POST'])
def on_event():
  event = request.get_json()
  chat = event.get('chat')
  if chat is not None:
    return handle_chat_event(event)

def handle_chat_event(event):
  if event['chat'].get('type') == 'SUBMIT_FORM':
    event_object = event.get('commonEventObject')
    if event_object is not None:
      // Forms
      if 'submitForm' == event_object.get('invokedFunction'):
        return {
          'render_actions': {
            'action': {
              'navigations': [{
                'update_card': get_update_card
              }]
            }
          }
        }

def get_update_card:
  // Return "Card v2" representing App Home.
  ...

Скрипт приложений

// Called from elsewhere (i.e. on button press).
function updateAppHomeCard(event) {
  return {
    render_actions: {
      action: {
        navigations: [
          {
            update_card: getCard()
          }
        ]
      }
    }
  }
}

function getCard() {
  // Return "Card v2" representing App Home.
  ...
}