Обработка запросов действий

Как описано в разделе «Объявление действий» , когда пользователь взаимодействует с действием в приложении, Google отправляет HTTP-запрос на URL-адрес, объявленный в действии.

В следующем примере в электронное письмо об отчете о расходах добавляется кнопка ConfirmAction :

JSON-LD

<script type="application/ld+json">
{
  "@context": "http://schema.org",
  "@type": "EmailMessage",
  "potentialAction": {
    "@type": "ConfirmAction",
    "name": "Approve Expense",
    "handler": {
      "@type": "HttpActionHandler",
      "url": "https://myexpenses.com/approve?expenseId=abc123"
    }
  },
  "description": "Approval request for John's $10.13 expense for office supplies"
}
</script>

Микроданные

<div itemscope itemtype="http://schema.org/EmailMessage">
  <div itemprop="potentialAction" itemscope itemtype="http://schema.org/ConfirmAction">
    <meta itemprop="name" content="Approve Expense"/>
    <div itemprop="handler" itemscope itemtype="http://schema.org/HttpActionHandler">
      <link itemprop="url" href="https://myexpenses.com/approve?expenseId=abc123"/>
    </div>
  </div>
  <meta itemprop="description" content="Approval request for John's $10.13 expense for office supplies"/>
</div>

Когда пользователь нажимает на кнопку, Google отправляет HTTP-запрос к вашему сервису с записью подтверждения. Ваша служба получает следующий HTTP-запрос от Google:

POST /approve?expenseId=abc123 HTTP/1.1
Host: your-domain.com
Authorization: Bearer AbCdEf123456
Content-Type: application/x-www-form-urlencoded
User-Agent: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/1.0 (KHTML, like Gecko; Gmail Actions)

confirmed=Approved

Оставшаяся часть этой страницы описывает, что должна сделать служба https://your-domain.com/approve?expenseId=abc123 для правильной обработки действия. Это включает в себя:

  • Проверка запроса
  • Обработка полезной нагрузки
  • Возврат кода ответа

Шаг 1. Подтвердите запрос

Службе https://your-domain.com/approve?expenseId=abc123 рекомендуется проверить:

Пользовательским агентом для всех запросов действий является Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/1.0 (KHTML, like Gecko; Gmail Actions) .

Если все проверки пройдены, сервис может перейти к следующему шагу.

Шаг 2. Обработка действия

Служба должна обрабатывать действие, указанное в параметрах URL-адреса, а также дополнительную информацию, полученную от пользователя.

Дополнительная информация от пользователя находится в теле запроса и кодируется с использованием кодировки x-www-form-urlecoded . Информация задается в свойствах, имена которых соответствуют свойствам Action. Например, ConfirmAction имеет свойство confirmed .

Шаг 3. Возврат кода ответа

После того как служба успешно обработала и записала действие, она должна вернуть код ответа 200 (OK) . В ситуациях возникновения ошибок можно использовать следующие коды ответов:

Код ответа Уход
400 (неверный запрос) Google не выполнит это действие.
401 (Несанкционированный) Google не выполнит это действие.
404 (не найден) Google не выполнит это действие.
408 (тайм-аут запроса) Google повторит попытку позже.

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

Дальнейшее чтение