با مجموعهها، منظم بمانید
ذخیره و طبقهبندی محتوا براساس اولویتهای شما.
این راهنما شما را در راه‌اندازی محیط خود برای ایجاد Actions با استفاده از Actions SDK و Actions Builder راهنمایی می‌کند. شما وظایف زیر را انجام خواهید داد:
Node.js را نصب کنید: برای استفاده از کتابخانه تکمیل Node.js ما به این محیط زمان اجرا نیاز دارید.
Firebase CLI را نصب کنید: این ابزار خط فرمان به شما امکان می‌دهد وابستگی‌های Firebase، مانند برنامه‌های وب برای Interactive Canvas را برای میزبانی Firebase توسعه و استقرار دهید.
ابزار خط فرمان gactions را نصب کنید: هنگام توسعه با Actions SDK، از این ابزار برای ایجاد، مدیریت و استقرار بسته Action برای Action خود استفاده می کنید.
ایجاد یک پروژه Actions:پروژه Actions محفظه منطقی برای کنش های مکالمه شما است. قبل از اینکه بتوانید شروع به ساخت کنید، باید یکی را در کنسول Actions ایجاد کنید.
یک نمونه را راه‌اندازی و اجرا کنید: این نمونه ساده به شما نشان می‌دهد چگونه شروع به ساخت اکشن‌هایی کنید که توسط Interactive Canvas طراحی شده‌اند.
پس از تکمیل این شروع سریع، می توانید پروژه Actions خود را بین محیط توسعه محلی خود و تجربه وب Actions Builder همگام کنید.
Node.js و Firebase CLI را نصب کنید
Node.js را طبق مستندات Node.js دانلود و نصب کنید تا از کتابخانه تکمیل ما استفاده کنید. نصب Node.js شما همچنین به شما این امکان را می دهد که Firebase CLI را با npm نصب کنید، و بعداً، پیاده سازی انجام مکالمه خود را به صورت محلی اجرا کنید.
Firebase CLI را طبق مستندات Firebase نصب و راه اندازی کنید. Firebase CLI به شما امکان می دهد یک برنامه وب Interactive Canvas را در میزبانی Firebase مستقر کنید و در صورت لزوم، به صورت دستی اجرای را در Cloud Functions برای Firebase اجرا کنید.
ابزار خط فرمان gactions را نصب کنید
ابزار رابط خط فرمان gactions (CLI) را با دانلود بسته نصب، باز کردن بسته بندی آن و پیکربندی مسیر اجرای خود نصب کنید.
برای نصب و پیکربندی gaction ها، مراحل زیر را دنبال کنید:
بسته را در مکانی دلخواه استخراج کنید و باینری را به متغیر PATH محیط خود اضافه کنید. از طرف دیگر، بسته را به مکانی استخراج کنید که از قبل در متغیر PATH شما قرار دارد (به عنوان مثال /usr/local/bin ).
در لینوکس و مک، در صورت لزوم، مجوزهای اجرا را فعال کنید:
chmod +x PATH_TO/gactions
دستور زیر را برای احراز هویت CLI اجرا کنید. این دستور یک جریان احراز هویت را شروع می کند و به یک مرورگر وب نیاز دارد:
gactions login
هنگامی که جریان کامل شد، CLI به طور خودکار احراز هویت می شود.
ایجاد و راه اندازی یک پروژه
قبل از اینکه بتوانید از ابزار خط فرمان gactions استفاده کنید، باید یک پروژه در کنسول Actions ایجاد کنید و به gactionها اجازه دسترسی به پروژه را بدهید. برای ایجاد و راه اندازی یک پروژه، موارد زیر را انجام دهید:
پروژه جدید را کلیک کنید، نام پروژه را وارد کنید و روی ایجاد پروژه کلیک کنید.
یک دسته را انتخاب کنید و روی Next کلیک کنید.
پروژه خالی را انتخاب کنید و روی Start building کلیک کنید.
Action API را در کنسول Google Cloud با دنبال کردن دستورالعمل‌های موجود در Enable and disable APIs فعال کنید. این به بازی‌ها اجازه می‌دهد تا با پروژه شما تعامل داشته باشند.
نمونه سلام جهان را دریافت کنید
نمونه تعاملی hello world به شما نشان می دهد که چگونه یک پروژه اکشن ساده با یک اکشن که توسط Interactive Canvas طراحی شده است بسازید.
یک پوشه خالی ایجاد کنید و نمونه Interactive Canvas را در آن دایرکتوری مقداردهی کنید. به عنوان مثال، کد زیر نمونه را در یک دایرکتوری interactive-canvas-sample/ مقداردهی اولیه می کند، که به عنوان نمونه در سراسر این سند استفاده می شود:
فایل interactive-canvas-sample/sdk/settings/settings.yaml را باز کنید و مقدار فیلد projectId را به شناسه پروژه خود تغییر دهید.
نمونه را مستقر و آزمایش کنید
پس از راه‌اندازی نمونه، می‌توانید برنامه وب Interactive Canvas و پروژه Actions خود را اجرا کنید. این فرآیند یک نسخه پیش نویس از پروژه Actions شما ایجاد می کند که می توانید آن را برای پیش نمایش و آزمایش در شبیه ساز Actions مستقر کنید:
از دایرکتوری interactive-canvas-sample/ ، دستور زیر را برای استقرار برنامه وب Interactive Canvas (محتوای دایرکتوری public/ ) اجرا کنید.
می‌توانید نسخه ارائه‌شده برنامه وب را در نشانی اینترنتی بازگردانده شده توسط Firebase CLI در مرورگر ببینید: https:// PROJECT_ID .web.app .
فایل interactive-canvas-sample/sdk/webhooks/ActionsOnGoogleFulfillment/index.js را باز کنید و مقدار متغیر CANVAS_URL را به URL برنامه وب پروژه خود تغییر دهید.
const CANVAS_URL = 'https://PROJECT_ID.web.app';
از دایرکتوری interactive-canvas-sample/sdk/ ، دستور زیر را اجرا کنید تا نسخه محلی پروژه Actions خود را به عنوان نسخه پیش نویس به کنسول منتقل کنید:
gactions push
از دایرکتوری interactive-canvas-sample/sdk/ ، دستور زیر را اجرا کنید تا پروژه Actions خود را در شبیه ساز آزمایش کنید:
gactions deploy preview
پیوندی را که ابزار خط فرمان برمی گرداند را باز کنید تا به شبیه ساز بروید.
در شبیه ساز، "Talk to Interactive canvas sample" را وارد کنید تا Action شروع شود. شما باید یک مثلث چرخان را ببینید که توسط برنامه وب مستقر در https:// PROJECT_ID .web.app طراحی شده است.
تاریخ آخرین بهروزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی."],[[["\u003cp\u003eThis guide helps you set up your environment for building Google Actions using the Actions SDK and Actions Builder.\u003c/p\u003e\n"],["\u003cp\u003eYou'll install necessary tools like Node.js, Firebase CLI, and the \u003ccode\u003egactions\u003c/code\u003e command-line tool.\u003c/p\u003e\n"],["\u003cp\u003eThe guide includes steps to create an Actions project, initialize a sample, and deploy it for testing in the Actions simulator.\u003c/p\u003e\n"],["\u003cp\u003eYou'll learn to deploy the Interactive Canvas web app to Firebase Hosting and push your local Actions project to the console.\u003c/p\u003e\n"],["\u003cp\u003eAfter completing the setup, you can preview and test your Action in the Actions simulator by invoking it with a specific phrase.\u003c/p\u003e\n"]]],["To set up for building Actions, install Node.js and the Firebase CLI for fulfillment and web app deployment. Install the `gactions` CLI by downloading and configuring the appropriate package, then authenticate using `gactions login`. In the Actions console, create a new project, enable the Actions API, and use `gactions init` to set up the Interactive Canvas sample. Deploy the web app with `firebase deploy`, update the `CANVAS_URL` and push the Action using `gactions push`. Finally, preview and test the action in the simulator using `gactions deploy preview`.\n"],null,["# Actions SDK and Builder quick start guide\n\nThis guide walks you through setting up your environment to build Actions using\nboth the Actions SDK and Actions Builder. You'll carry out the following tasks:\n\n- **Install Node.js:** You need this runtime environment to use our Node.js fulfillment library.\n- **Install the Firebase CLI:** This command-line tool lets you develop and deploy Firebase dependencies, such as web apps for [Interactive Canvas](/assistant/interactivecanvas), to Firebase Hosting.\n- **Install the gactions command-line tool:** When developing with the Actions SDK, you use this tool to create, manage, and deploy the Action package for your Action.\n- **Create an Actions project:** An [Actions project](/assistant/conversational/build/projects) is the logical container for your Conversational Actions. You have to create one in the Actions console before you can start building.\n- **Initialize and deploy a sample:** This simple sample shows you how to get started building Actions powered by Interactive Canvas.\n\nOnce you complete this quick start, you can sync your Actions project between\nyour local development environment and the web experience of Actions Builder.\n\nInstall Node.js and the Firebase CLI\n------------------------------------\n\nDownload and install [Node.js](https://nodejs.org/) according to the Node.js\ndocumentation to use our fulfillment library. Your installation of Node.js also\nallows you to install the Firebase CLI with [npm](https://www.npmjs.com/), and later, to run your\nconversational fulfillment implementation locally.\n\nInstall and set up the [Firebase CLI](https://firebase.google.com/docs/cli#setup_update_cli) according\nto the Firebase documentation. The Firebase CLI lets you deploy an Interactive\nCanvas web app to Firebase Hosting and, if necessary, manually deploy\nfulfillment to Cloud Functions for Firebase.\n\nInstall the gactions command-line tool\n--------------------------------------\n\nInstall the gactions command line interface (CLI) tool by downloading an\ninstallation package, unpacking it, and configuring your execution path.\n\nTo install and configure gactions, follow these steps:\n\n1. Download the appropriate package for your operating system:\n\n | Platform | Package | Checksum |\n |----------|----------------------------------------------------------------------------------|---------------------------------------------------------------------------------------|\n | Windows | [Download](https://dl.google.com/gactions/v3/release/gactions-sdk_windows.zip) | [SHA256](https://dl.google.com/gactions/v3/release/gactions-sdk_windows.zip.sha256) |\n | Linux | [Download](https://dl.google.com/gactions/v3/release/gactions-sdk_linux.tar.gz) | [SHA256](https://dl.google.com/gactions/v3/release/gactions-sdk_linux.tar.gz.sha256) |\n | Mac OS | [Download](https://dl.google.com/gactions/v3/release/gactions-sdk_darwin.tar.gz) | [SHA256](https://dl.google.com/gactions/v3/release/gactions-sdk_darwin.tar.gz.sha256) |\n\n2. Extract the package to a location of your choice and add the binary to your\n environment's `PATH` variable. Alternatively, extract the package to a\n location that's already in your `PATH` variable (for example, `/usr/local/bin`).\n\n3. On Linux and Mac, enable execute permissions if necessary:\n\n ```scdoc\n chmod +x PATH_TO/gactions\n ```\n4. Run the following command to authenticate the CLI. This command\n starts an authentication flow and requires a web browser:\n\n ```text\n gactions login\n ```\n\n When the flow is complete, the CLI automatically authenticates.\n\nCreate and set up a project\n---------------------------\n\n| **Note:** Actions project creation is not supported in the gactions CLI.\n\nBefore you can use the gactions command-line tool, you must create a project in\nthe Actions console and give gactions access to the project. To create and set\nup a project, do the following:\n\n1. Go to the [Actions console](https://console.actions.google.com).\n2. Click **New project** , enter a project name, and click **Create project**.\n3. Select a category and click **Next**.\n4. Select **Blank project** and click **Start building**.\n5. Enable the **Actions API** in the Google Cloud console by following the instructions in [Enable and disable\n APIs](https://support.google.com/googleapi/answer/6158841). This allows gactions to interact with your project.\n\nGet the hello world sample\n--------------------------\n\nThe hello world interactive sample shows you how to build a simple Actions\nproject with a single Action powered by Interactive Canvas.\n\n1. Create an empty directory and initialize the Interactive Canvas sample in\n that directory. For example, the following code initializes the sample in an\n `interactive-canvas-sample/` directory, which is used as an example\n throughout this document:\n\n gactions init interactive-canvas --dest interactive-canvas-sample\n cd interactive-canvas-sample\n\n2. Open the `interactive-canvas-sample/sdk/settings/settings.yaml` file and\n change the value of the `projectId` field to your project's ID.\n\n | **Note:** To get your project's ID, first open your project in the Actions console and click the more *more_vert* icon. Then, select **Project settings** and copy the string in the **Project ID** field.\n\nDeploy and test the sample\n--------------------------\n\nAfter you set up the sample, you can deploy the Interactive Canvas web app and\nyour Actions project. This process creates a draft version of your Actions\nproject that you can deploy to the Actions simulator for previewing and testing:\n\n1. From the `interactive-canvas-sample/` directory, run the following command\n to deploy the Interactive Canvas web app (the contents of the `public/`\n directory).\n\n firebase deploy --project \u003cvar translate=\"no\"\u003ePROJECT_ID\u003c/var\u003e --only hosting\n\n You can see a rendered version of the web app at the URL returned by the\n Firebase CLI in a browser:\n `https://`\u003cvar translate=\"no\"\u003ePROJECT_ID\u003c/var\u003e`.web.app`.\n2. Open the `interactive-canvas-sample/sdk/webhooks/ActionsOnGoogleFulfillment/index.js` file and\n change the value of the `CANVAS_URL` variable to your project's web app URL.\n\n const CANVAS_URL = 'https://\u003cvar translate=\"no\"\u003ePROJECT_ID\u003c/var\u003e.web.app';\n\n3. From the `interactive-canvas-sample/sdk/` directory, run the following\n command to push the local version of your Actions project to the console as a\n draft version:\n\n gactions push\n\n | **Note:** You'll see some warnings related to not having some project settings and resources defined. You can safely ignore them or now.\n4. From the `interactive-canvas-sample/sdk/` directory, run the following\n command to test your Actions project in the simulator:\n\n gactions deploy preview\n\n | **Note:** If you are using a new project, you need to enable the [Cloud Functions\n | API](https://console.cloud.google.com/apis/library/cloudfunctions.googleapis.com) and associate a billing account with your project in Google Cloud. You can enable the Cloud Functions API by visiting the [Cloud Console](https://console.cloud.google.com/billing).\n5. Open the link that the command-line tool returns to go to the simulator.\n\n6. In the simulator, enter *\"Talk to Interactive canvas sample\"* to start the Action. You\n should see a spinning triangle powered by the web app deployed at\n `https://`\u003cvar translate=\"no\"\u003ePROJECT_ID\u003c/var\u003e`.web.app`\n\n **Figure 1**. The simulator previewing the Actions project"]]
