Panduan memulai cepat Action SDK dan Builder

Panduan ini memandu Anda menyiapkan lingkungan untuk membuat Action menggunakan Action SDK dan Action Builder. Anda akan melakukan tugas berikut:

  • Instal Node.js: Anda memerlukan lingkungan runtime ini untuk menggunakan library fulfillment Node.js kami.
  • Instal Firebase CLI: Alat command line ini memungkinkan Anda mengembangkan dan men-deploy dependensi Firebase, seperti aplikasi web untuk Interactive Canvas, ke Firebase Hosting.
  • Instal alat command line gaction: Saat mengembangkan dengan Actions SDK, Anda menggunakan alat ini untuk membuat, mengelola, dan men-deploy paket Action untuk Action Anda.
  • Membuat project Action: Project Action adalah penampung logis untuk Action Percakapan Anda. Anda harus membuatnya di konsol Actions sebelum dapat mulai mem-build.
  • Melakukan inisialisasi dan men-deploy contoh: Contoh sederhana ini menunjukkan cara mulai membuat Action yang didukung oleh Interactive Canvas.

Setelah menyelesaikan proses memulai cepat ini, Anda dapat menyinkronkan project Action antara lingkungan pengembangan lokal Anda dan pengalaman web Actions Builder.

Menginstal Node.js dan Firebase CLI

Download dan instal Node.js sesuai dengan dokumentasi Node.js untuk menggunakan library fulfillment kami. Penginstalan Node.js juga memungkinkan Anda menginstal Firebase CLI dengan npm, dan yang lebih baru, untuk menjalankan implementasi fulfillment percakapan secara lokal.

Instal dan siapkan Firebase CLI sesuai dengan dokumentasi Firebase. Dengan Firebase CLI, Anda dapat men-deploy aplikasi web Canvas Interaktif ke Firebase Hosting dan, jika perlu, men-deploy fulfillment secara manual ke Cloud Functions for Firebase.

Menginstal alat command line gaction

Instal alat antarmuka command line (CLI) gaction dengan mendownload paket penginstalan, mengekstraknya, dan mengonfigurasi jalur eksekusi Anda.

Untuk menginstal dan mengonfigurasi gaction, ikuti langkah-langkah berikut:

  1. Unduh paket yang sesuai untuk sistem operasi Anda:

    Platform Package (Paket) Checksum
    Windows Download SHA256
    Linux Download SHA256
    OS Mac Download SHA256

  2. Ekstrak paket ke lokasi pilihan Anda dan tambahkan biner ke variabel PATH lingkungan. Atau, ekstrak paket ke lokasi yang sudah ada dalam variabel PATH Anda (misalnya, /usr/local/bin).

  3. Di Linux dan Mac, aktifkan izin eksekusi jika diperlukan:

    chmod +x PATH_TO/gactions

  4. Jalankan perintah berikut untuk mengautentikasi CLI. Perintah ini memulai alur autentikasi dan memerlukan browser web:

    gactions login

    Setelah alurnya selesai, CLI akan otomatis melakukan autentikasi.

Membuat dan menyiapkan project

Sebelum dapat menggunakan alat command line gaction, Anda harus membuat project di konsol Actions dan memberi gaction akses ke project. Untuk membuat dan menyiapkan project, lakukan hal berikut:

  1. Buka Konsol Actions.
  2. Klik Project baru, masukkan nama project, lalu klik Buat project.
  3. Pilih kategori, lalu klik Berikutnya.
  4. Pilih Blank project, lalu klik Start building.
  5. Aktifkan Actions API di Konsol Google Cloud dengan mengikuti petunjuk di bagian Mengaktifkan dan menonaktifkan API. Hal ini memungkinkan gaction untuk berinteraksi dengan project Anda.

Dapatkan contoh hello world

Contoh interaktif halo dunia menunjukkan cara membuat project Action sederhana dengan satu Action yang didukung oleh Canvas Interaktif.

  1. Buat direktori kosong dan inisialisasi contoh Canvas Interaktif di direktori tersebut. Misalnya, kode berikut menginisialisasi sampel dalam direktori interactive-canvas-sample/, yang digunakan sebagai contoh di seluruh dokumen ini:

    gactions init interactive-canvas --dest interactive-canvas-sample
cd interactive-canvas-sample

  2. Buka file interactive-canvas-sample/sdk/settings/settings.yaml dan ubah nilai kolom projectId menjadi ID project Anda.

Men-deploy dan menguji sampel

Setelah menyiapkan contoh, Anda dapat men-deploy aplikasi web Interactive Canvas dan project Action Anda. Proses ini akan membuat versi draf project Action yang dapat Anda deploy ke simulator Action untuk melihat pratinjau dan menguji:

  1. Dari direktori interactive-canvas-sample/, jalankan perintah berikut untuk men-deploy aplikasi web Interactive Canvas (konten direktori public/).

    firebase deploy --project PROJECT_ID --only hosting

    Anda dapat melihat versi aplikasi web yang dirender di URL yang ditampilkan oleh Firebase CLI di browser: https://PROJECT_ID.web.app.

  2. Buka file interactive-canvas-sample/sdk/webhooks/ActionsOnGoogleFulfillment/index.js dan ubah nilai variabel CANVAS_URL ke URL aplikasi web project Anda.

    const CANVAS_URL = 'https://PROJECT_ID.web.app';

  3. Dari direktori interactive-canvas-sample/sdk/, jalankan perintah berikut untuk mengirim versi lokal project Action Anda ke konsol sebagai versi draf:

    gactions push

  4. Dari direktori interactive-canvas-sample/sdk/, jalankan perintah berikut untuk menguji project Action Anda di simulator:

    gactions deploy preview

  5. Buka link yang ditampilkan alat command line untuk membuka simulator.

  6. Di simulator, masukkan "Bicara dengan contoh kanvas interaktif" untuk memulai Action. Anda akan melihat segitiga berputar yang didukung oleh aplikasi web yang di-deploy di https://PROJECT_ID.web.app

    Gambar 1. Simulator yang melihat pratinjau project Action