Actions API cung cấp các điểm cuối để giúp bạn xây dựng, quản lý và kiểm thử Hành động của bạn.
Thư viện ứng dụng (Node.js)
Mặc dù bạn có thể sử dụng dịch vụ RESTful của Actions API 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 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ã dưới đây 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 Actions API Node.js, 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 Actions API.
Yêu cầu kích thước tải trọng
Yêu cầu gửi đến Actions API không được vượt quá 10 MB. Dung lượng này bao gồm cả các điểm cuối truyền trực tuyến của ứng dụng, trong đó mỗi yêu cầu trong luồng phải có kích thước từ 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 từ máy chủ SDK Hành động.
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 sử dụng Actions API.
Đặt tiêu đề cho yêu cầu x-goog-user-project
Khi xây dựng công cụ hoặc ứng dụng cho người dùng, có thể bạn muốn dự án của người dùng được lập hoá đơn và sử dụng theo hạn mức, thay vì dự án ứng dụng.
Để 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.
| Giá trị hợp lệ | Mã dự án của một dự án hiện có trên Google Cloud |
| Ví dụ: | x-goog-user-project: my-project |
| Thông tin chi tiết | Dự án được chỉ định trong tiêu đề sẽ được dùng để tính hạn mức và thanh toán cho các khoản phí liên quan đến yêu cầu. |
Đặt tiêu đề yêu cầu tác nhân người dùng
Đặt một tác nhân người dùng thích hợp bằng cách sử dụng tiêu đề của yêu cầu user-agent. Điều 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 điểm hạn chế đã biết của Actions API.
Thời gian chờ đối với các điểm cuối truyền trực tuyến của ứng dụng
Giới hạn này chỉ áp dụng cho các yêu cầu HTTP mà bạn thực hiện đến các điểm cuối truyền phát của ứng dụng. Các yêu cầu được đưa ra bằng thư viện ứng dụng không chịu ảnh hưởng của giới hạn này.
Nếu đang sử dụng các yêu cầu HTTP để gọi WritePreview, CreateVersion hoặc WriteDraft, 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ột mã trạng thái không phải là 200, thì mã của bạn sẽ chấm dứt quá trình truyền phát 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 Actions API có thời gian chờ là 5 giây.