Metadatos para diferentes tipos de webhooks Si usas inlineCloudFunction
, tu código fuente debe estar en un directorio con el mismo nombre que el valor de la clave executeFunction
. Por ejemplo, un valor de my_webhook
para la clave executeFunction
tendría una estructura de código como la siguiente: - /webhooks/my_webhook.yaml
- /webhooks/my_webhook/index.js
- /webhooks/my_webhook/package.json
Representación YAML | |
---|---|
handlers: - object ( |
Campos | ||
---|---|---|
handlers[] |
Lista de controladores para este webhook. |
|
Campo de unión webhook_type . Solo se admite un tipo de webhook. Las direcciones (webhook_type ) solo pueden ser una de las siguientes opciones: |
||
httpsEndpoint |
Extremo HTTPS de webhook personalizado. |
|
inlineCloudFunction |
Metadatos de la Cloud Function implementada a partir del código en la carpeta de webhooks. |
Handler
Declara el nombre del controlador de webhooks. Un webhook puede tener varios controladores registrados. Se puede llamar a estos controladores desde varios lugares en tu proyecto de acciones.
Representación YAML | |
---|---|
name: string |
Campos | |
---|---|
name |
Obligatorio. Nombre del controlador. Debe ser único entre todos los controladores del proyecto de acciones. Puedes verificar el nombre de este controlador para invocar la función correcta en tu código fuente de entrega. |
HttpsEndpoint
Extremo de REST para notificar si no estás usando el editor directo.
Representación YAML | |
---|---|
baseUrl: string httpHeaders: string: string endpointApiVersion: integer |
Campos | |
---|---|
baseUrl |
La URL base HTTPS de tu extremo de entrega (HTTP no es compatible). Los nombres de los controladores se agregan a la ruta de URL base después de los dos puntos (según la guía de estilo en https://cloud.google.com/apis/design/custom_methods). Por ejemplo, una URL base de “https://gactions.service.com/api” recibirían solicitudes con la URL "https://gactions.service.com/api:{method}". |
httpHeaders |
Mapa de los parámetros HTTP que se incluirán en la solicitud POST. Es un objeto que contiene una lista de pares |
endpointApiVersion |
Versión del protocolo que usa el extremo. Este es el protocolo que comparten todos los tipos de entrega y no es específico del tipo de entrega de Google. |
InlineCloudFunction
Contiene los metadatos de una Cloud Function intercalada que se implementó desde la carpeta de webhooks.
Representación YAML | |
---|---|
executeFunction: string |
Campos | |
---|---|
executeFunction |
El nombre del punto de entrada de Cloud Function. El valor de este campo debe coincidir con el nombre del método exportado desde el código fuente. |