تم إيقاف إجراءات المحادثات نهائيًا في 13 حزيران (يونيو) 2023. لمزيد من المعلومات، يُرجى الاطّلاع على
إنهاء إجراءات المحادثة.
Webhook
تنظيم صفحاتك في مجموعات
يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
البيانات الوصفية لأنواع مختلفة من الردود التلقائية على الويب. إذا كنت تستخدم inlineCloudFunction، يجب أن يكون رمز المصدر في دليل يحمل الاسم نفسه لقيمة المفتاح executeFunction. على سبيل المثال، يجب أن تكون قيمة المفتاح executeFunction باللغة my_webhook على النحو التالي: - /webhooks/my_webhook.yaml - /webhooks/my_webhook/index.js - /webhooks/my_webhook/package.json
| تمثيل YAML |
handlers:
- object (Handler)
# Union field webhook_type can be only one of the following:
httpsEndpoint:
object (HttpsEndpoint)
inlineCloudFunction:
object (InlineCloudFunction)
# End of list of possible types for union field webhook_type. |
| الحقول |
handlers[] |
object (Handler)
قائمة معالِجات هذا الرد التلقائي على الويب
|
حقل الاتحاد webhook_type. لا يتوفّر سوى نوع واحد فقط من الردود التلقائية على الويب. يمكن أن يكون webhook_type واحدًا فقط مما يلي: |
httpsEndpoint |
object (HttpsEndpoint)
نقطة نهاية HTTPS مخصّصة للردّ التلقائي على الويب.
|
inlineCloudFunction |
object (InlineCloudFunction)
البيانات الوصفية لدالة السحابة الإلكترونية المنشورة من الرمز البرمجي في مجلد الردود التلقائية على الويب
|
المعالج
يفصح عن اسم معالِج webhoook. يمكن أن يحتوي الرد التلقائي على الويب على معالِجات متعددة مسجَّلة. ويمكن استدعاء هذه المعالجات من أماكن متعددة في مشروع المهام.
| الحقول |
name |
string
مطلوب. اسم المعالج يجب أن يكون فريدًا على مستوى جميع معالِجات مشروع المهام. يمكنك التحقّق من اسم هذا المعالِج لاستدعاء الدالة الصحيحة في رمز مصدر التنفيذ.
|
HttpsEndpoint
نقطة نهاية REST للإشعار في حال عدم استخدام المحرِّر المضمّن.
| تمثيل YAML |
baseUrl: string
httpHeaders:
string: string
endpointApiVersion: integer |
| الحقول |
baseUrl |
string
عنوان URL الأساسي لبروتوكول HTTPS لنقطة نهاية التنفيذ (بروتوكول HTTP غير متوافق). يتم إلحاق أسماء المعالجات بمسار عنوان URL الأساسي بعد نقطتين (باتّباع دليل النمط في https://cloud.google.com/apis/design/custom_methods). على سبيل المثال، عنوان URL الأساسي هو "https://gactions.service.com/api" طلبات ذات عنوان URL التالي: "https://gactions.service.com/api:{method}".
|
endpointApiVersion |
integer
إصدار البروتوكول الذي تستخدمه نقطة النهاية. وهذا هو البروتوكول الذي تشاركه جميع أنواع طريقة التنفيذ، وليس خاصًا بنوع طريقة التنفيذ في Google.
|
InlineCloudFunction
يحتوي على البيانات الوصفية لدالة سحابية مضمّنة تم نشرها من مجلد الردود التلقائية على الويب.
| تمثيل YAML |
executeFunction: string |
| الحقول |
executeFunction |
string
اسم نقطة إدخال "دالة السحابة الإلكترونية". يجب أن تتطابق قيمة هذا الحقل مع اسم الطريقة التي تم تصديرها من رمز المصدر.
|
إنّ محتوى هذه الصفحة مرخّص بموجب ترخيص Creative Commons Attribution 4.0 ما لم يُنصّ على خلاف ذلك، ونماذج الرموز مرخّصة بموجب ترخيص Apache 2.0. للاطّلاع على التفاصيل، يُرجى مراجعة سياسات موقع Google Developers. إنّ Java هي علامة تجارية مسجَّلة لشركة Oracle و/أو شركائها التابعين.
تاريخ التعديل الأخير: 2025-07-26 (حسب التوقيت العالمي المتفَّق عليه)
[null,null,["تاريخ التعديل الأخير: 2025-07-26 (حسب التوقيت العالمي المتفَّق عليه)"],[[["\u003cp\u003eWebhooks use YAML to define metadata for different handler types like HTTPS endpoints and inline Cloud Functions.\u003c/p\u003e\n"],["\u003cp\u003eInline Cloud Functions require source code in a directory matching the \u003ccode\u003eexecuteFunction\u003c/code\u003e value.\u003c/p\u003e\n"],["\u003cp\u003eHandlers specify the webhook's name and can be invoked from various points in your Actions project.\u003c/p\u003e\n"],["\u003cp\u003eHTTPS endpoints define the base URL and optional HTTP headers for external fulfillment.\u003c/p\u003e\n"],["\u003cp\u003eInline Cloud Functions use the \u003ccode\u003eexecuteFunction\u003c/code\u003e field to identify the entry point in your source code.\u003c/p\u003e\n"]]],[],null,["# Webhook\n\n- [YAML representation](#SCHEMA_REPRESENTATION)\n- [Handler](#Handler)\n - [YAML representation](#Handler.SCHEMA_REPRESENTATION)\n- [HttpsEndpoint](#HttpsEndpoint)\n - [YAML representation](#HttpsEndpoint.SCHEMA_REPRESENTATION)\n- [InlineCloudFunction](#InlineCloudFunction)\n - [YAML representation](#InlineCloudFunction.SCHEMA_REPRESENTATION)\n\nMetadata for different types of webhooks. If you're using `inlineCloudFunction`, your source code must be in a directory with the same name as the value for the `executeFunction` key. For example, a value of `my_webhook` for the`executeFunction` key would have a code structure like this: - `/webhooks/my_webhook.yaml` - `/webhooks/my_webhook/index.js` - `/webhooks/my_webhook/package.json`\n\n| YAML representation ||\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| ``` handlers: - object (/assistant/actionssdk/reference/rest/Shared.Types/Webhook#Handler) # Union field `webhook_type` can be only one of the following: httpsEndpoint: object (/assistant/actionssdk/reference/rest/Shared.Types/Webhook#HttpsEndpoint) inlineCloudFunction: object (/assistant/actionssdk/reference/rest/Shared.Types/Webhook#InlineCloudFunction) # End of list of possible types for union field `webhook_type`. ``` |\n\n| Fields ||\n|-----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| `handlers[]` | `object (`[Handler](/assistant/actionssdk/reference/rest/Shared.Types/Webhook#Handler)`)` List of handlers for this webhook. |\n| Union field `webhook_type`. Only one webhook type is supported. `webhook_type` can be only one of the following: |||\n| `httpsEndpoint` | `object (`[HttpsEndpoint](/assistant/actionssdk/reference/rest/Shared.Types/Webhook#HttpsEndpoint)`)` Custom webhook HTTPS endpoint. |\n| `inlineCloudFunction` | `object (`[InlineCloudFunction](/assistant/actionssdk/reference/rest/Shared.Types/Webhook#InlineCloudFunction)`)` Metadata for cloud function deployed from code in the webhooks folder. |\n\nHandler\n-------\n\nDeclares the name of the webhoook handler. A webhook can have multiple handlers registered. These handlers can be called from multiple places in your Actions project.\n\n| YAML representation ||\n|----------------------|---|\n| ``` name: string ``` |\n\n| Fields ||\n|--------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Required. Name of the handler. Must be unique across all handlers the Actions project. You can check the name of this handler to invoke the correct function in your fulfillment source code. |\n\nHttpsEndpoint\n-------------\n\nREST endpoint to notify if you're not using the inline editor.\n\n| YAML representation ||\n|---------------------------------------------------------------------------------|---|\n| ``` baseUrl: string httpHeaders: string: string endpointApiVersion: integer ``` |\n\n| Fields ||\n|----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `baseUrl` | `string` The HTTPS base URL for your fulfillment endpoint (HTTP is not supported). Handler names are appended to the base URL path after a colon (following the style guide in \u003chttps://cloud.google.com/apis/design/custom_methods)\u003e. For example a base URL of 'https://gactions.service.com/api' would receive requests with URL 'https://gactions.service.com/api:{method}'. |\n| `httpHeaders` | `map (key: string, value: string)` Map of HTTP parameters to be included in the POST request. An object containing a list of `\"key\": value` pairs. Example: `{ \"name\": \"wrench\", \"mass\": \"1.3kg\", \"count\": \"3\" }`. |\n| `endpointApiVersion` | `integer` Version of the protocol used by the endpoint. This is the protocol shared by all fulfillment types and not specific to Google fulfillment type. |\n\nInlineCloudFunction\n-------------------\n\nHolds the metadata of an inline Cloud Function deployed from the webhooks folder.\n\n| YAML representation ||\n|---------------------------------|---|\n| ``` executeFunction: string ``` |\n\n| Fields ||\n|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|\n| `executeFunction` | `string` The name of the Cloud Function entry point. The value of this field should match the name of the method exported from the source code. |"]]
