Metadados para diferentes tipos de webhooks. Se você estiver usando inlineCloudFunction
, seu código-fonte precisará estar em um diretório com o mesmo nome do valor da chave executeFunction
. Por exemplo, um valor de my_webhook
para a chave executeFunction
teria uma estrutura de código como esta: - /webhooks/my_webhook.yaml
- /webhooks/my_webhook/index.js
- /webhooks/my_webhook/package.json
Representação YAML | |
---|---|
handlers: - object ( |
Campos | ||
---|---|---|
handlers[] |
Lista de gerenciadores deste webhook. |
|
Campo de união webhook_type . Há suporte para apenas um tipo de webhook. webhook_type pode ser apenas de um dos tipos a seguir: |
||
httpsEndpoint |
Endpoint HTTPS de webhook personalizado. |
|
inlineCloudFunction |
Metadados da função do Cloud implantada a partir do código na pasta de webhooks. |
Handler
Declara o nome do gerenciador webhoook. Um webhook pode ter vários gerenciadores registrados. Esses gerenciadores podem ser chamados de vários locais no projeto do Actions.
Representação YAML | |
---|---|
name: string |
Campos | |
---|---|
name |
Obrigatório. Nome do gerenciador. Precisa ser exclusivo em todos os gerenciadores do projeto de ações. É possível verificar o nome desse gerenciador para invocar a função correta no código-fonte do fulfillment. |
HttpsEndpoint
Endpoint REST para notificar se você não estiver usando o editor in-line.
Representação YAML | |
---|---|
baseUrl: string httpHeaders: string: string endpointApiVersion: integer |
Campos | |
---|---|
baseUrl |
O URL base de HTTPS para o endpoint de fulfillment (HTTP não é compatível). Os nomes de manipulador são anexados ao caminho do URL base após dois-pontos (seguindo o guia de estilo em https://cloud.google.com/apis/design/custom_methods). Por exemplo, um URL base de "https://gactions.service.com/api" receberia solicitações com o URL "https://gactions.service.com/api:{method}". |
httpHeaders |
Mapa de parâmetros HTTP a serem incluídos na solicitação POST. Um objeto com uma lista de pares |
endpointApiVersion |
Versão do protocolo usado pelo endpoint. Esse é o protocolo compartilhado por todos os tipos de fulfillment e não específico do tipo de fulfillment do Google. |
InlineCloudFunction
Mantém os metadados de uma Função do Cloud inline implantada da pasta de webhooks.
Representação YAML | |
---|---|
executeFunction: string |
Campos | |
---|---|
executeFunction |
O nome do ponto de entrada da função do Cloud. O valor desse campo precisa corresponder ao nome do método exportado do código-fonte. |