- YAML 表現
- ハンドラ
<ph type="x-smartling-placeholder">
- </ph>
- YAML 表現
- HttpsEndpoint
<ph type="x-smartling-placeholder">
- </ph>
- YAML 表現
- InlineCloudFunction
<ph type="x-smartling-placeholder">
- </ph>
- YAML 表現
さまざまなタイプの Webhook のメタデータ。inlineCloudFunction
を使用している場合、ソースコードは executeFunction
キーの値と同じ名前のディレクトリに置く必要があります。たとえば、executeFunction
キーの値が my_webhook
の場合、次のようなコード構造になります。- /webhooks/my_webhook.yaml
- /webhooks/my_webhook/index.js
- /webhooks/my_webhook/package.json
YAML 表現 | |
---|---|
handlers: - object ( |
フィールド | ||
---|---|---|
handlers[] |
この Webhook のハンドラのリスト。 |
|
共用体フィールド webhook_type 。サポートされている Webhook タイプは 1 つのみです。webhook_type は次のいずれかになります。 |
||
httpsEndpoint |
カスタム Webhook HTTPS エンドポイント。 |
|
inlineCloudFunction |
Webhooks フォルダ内のコードからデプロイされた Cloud Functions の関数のメタデータ。 |
Handler
Webhoook ハンドラの名前を宣言します。Webhook には複数のハンドラを登録できます。これらのハンドラは、アクション プロジェクトの複数の場所から呼び出すことができます。
YAML 表現 | |
---|---|
name: string |
フィールド | |
---|---|
name |
必須。ハンドラの名前。Actions プロジェクトのすべてのハンドラで一意である必要があります。このハンドラの名前を確認することで、フルフィルメントのソースコード内で正しい関数を呼び出すことができます。 |
HttpsEndpoint
インライン エディタを使用していない場合に通知する REST エンドポイント。
YAML 表現 | |
---|---|
baseUrl: string httpHeaders: string: string endpointApiVersion: integer |
フィールド | |
---|---|
baseUrl |
フルフィルメント エンドポイントの HTTPS ベース URL(HTTP はサポートされていません)。ハンドラ名は、ベース URL パスのコロンの後に追加されます(https://cloud.google.com/apis/design/custom_methods) のスタイルガイドに従います)。例: ベース URL が「https://gactions.service.com/api」URL「https://gactions.service.com/api:{method}」のリクエストを受け取ります。 |
httpHeaders |
POST リクエストに含まれる HTTP パラメータのマップ。
|
endpointApiVersion |
エンドポイントで使用されるプロトコルのバージョン。これはすべてのフルフィルメント タイプで共有されるプロトコルであり、Google フルフィルメント タイプに固有のものではありません。 |
InlineCloudFunction
Webhooks フォルダからデプロイされたインライン Cloud Functions のメタデータを保持します。
YAML 表現 | |
---|---|
executeFunction: string |
フィールド | |
---|---|
executeFunction |
Cloud Functions の関数のエントリ ポイントの名前。このフィールドの値は、ソースコードからエクスポートしたメソッドの名前と一致する必要があります。 |