API hành động

Actions API cung cấp các điểm cuối để giúp bạn xây dựng, quản lý và thử nghiệm Hành động của mình.

Thư viện ứng dụng (Node.js)

Mặc dù bạn có thể sử dụng dịch vụ RESTful API Actions bằng cách gửi các yêu cầu HTTP trực tiếp đến máy chủ, nhưng chúng tôi cung cấp một thư viện ứng dụng giúp bạn dễ dàng truy cập vào các điểm cuối từ Node.js. Thư viện ứng dụng Actions API cho phép bạn quản lý và kiểm thử Hành động của mình bằng nhiều điểm cuối.

Ví dụ: Mã bên dưới thực hiện lệnh gọi đến điểm cuối writePreview để cập nhật bản xem trước dự án của người dùng dựa trên mô hình được cung cấp:

   import {ActionsSdkClient} from '@assistant/actions';
   import { promisify } from 'util';
   import * as stream from 'stream';

   const PROJECT_ID = '<PROJECT_ID>';
   const VERSION = 123;

   const projectPath = `projects/${PROJECT_ID}`;
   const versionPath = `projects/${PROJECT_ID}/versions/${VERSION}`;

    async function publishPreview(projectPath, versionPath) {
      const request = {
        parent: projectPath,
        previewSettings: {sandbox: {value: true}},
        submittedVersion: {version: versionPath}
      };

      const client = new ActionsSdkClient();
      const stream = client.writePreview(()=>{});
      stream.write(request);
      stream.end();
      const finished = promisify(stream.finished);
      await finished(stream);
    }

Để biết hướng dẫn cài đặt và tài liệu tham khảo cho thư viện ứng dụng Node.js của API Actions, hãy xem tài liệu về thư viện và Tài liệu tham khảo về REST API của Actions API.

Yêu cầu

Các yêu cầu sau đây áp dụng cho các yêu cầu được gửi đến API Actions.

Yêu cầu kích thước tải trọng

Các yêu cầu gửi tới Actions API không được vượt quá 10 MB. bao gồm các điểm cuối truyền trực tuyến trên máy khách, trong đó mỗi yêu cầu trong luồng phải là 10 MB trở xuống.

Nếu tải trọng của bạn vượt quá 10 MB, bạn sẽ gặp lỗi 400 trong phần Actions Máy chủ SDK.

Các phương pháp hay nhất

Bạn nên áp dụng các phương pháp hay nhất sau đây khi mà bạn dùng API Actions (API Hành động).

Đặt tiêu đề của yêu cầu x-goog-user-project

Khi xây dựng một công cụ hoặc ứng dụng cho người dùng, có thể bạn muốn có sự dự án được lập hoá đơn và sử dụng cho giới hạn hạn mức, thay vì dự án khách hàng của bạn. Để chỉ định một dự án cho mục đích thanh toán và hạn mức, hãy đặt Tiêu đề của yêu cầu x-goog-user-project.

Đặt tiêu đề của yêu cầu tác nhân người dùng

Thiết lập một tác nhân người dùng phù hợp bằng cách sử dụng tiêu đề của yêu cầu user-agent. Chiến dịch này giúp API xác định xem các yêu cầu đó có bắt nguồn từ đối tác hay không.

Các hạn chế đã biết

Phần này mô tả các hạn chế đã biết của API Actions.

Thời gian chờ đối với các thiết bị đầu cuối truyền trực tuyến trên máy khách

Quy định hạn chế này chỉ áp dụng cho các yêu cầu HTTP mà bạn gửi cho luồng ứng dụng điểm cuối. Các yêu cầu được đưa ra qua thư viện ứng dụng sẽ không được bị ảnh hưởng bởi giới hạn này.

Nếu bạn đang sử dụng yêu cầu HTTP để gọi WritePreview, CreateVersion hoặc WriteDraft, chúng tôi bạn nên triển khai thời gian chờ để xử lý các yêu cầu không thành công.

Nếu bạn nhận được tiêu đề phản hồi chỉ định mã trạng thái không phải là 200, mã của bạn sẽ chấm dứt sự kiện phát trực tiếp sau một khoảng thời gian nhất định. Vấn đề này chỉ ảnh hưởng đến các điểm cuối truyền trực tuyến của ứng dụng. Ví dụ: công cụ gactions, sử dụng API Hành động, có thời gian chờ là 5 giây.