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

Как описано в разделе «Объявление действий» , когда пользователь взаимодействует с действием внутри приложения, 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-запрос вашему сервису, регистрируя подтверждение. Ваш сервис получает от Google следующий HTTP-запрос:

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-urlencoded . Эта информация задается в свойствах, имена которых соответствуют свойствам действия. Например, у ConfirmAction есть свойство confirmed .

Шаг 3: Верните код ответа.

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

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

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

Дополнительная информация