Actions API'sı

Actions API, İşleminizi derlemenize, yönetmenize ve test etmenize yardımcı olacak uç noktalar sağlar.

İstemci Kitaplığı (Node.js)

Actions API RESTful hizmetini, sunucuya doğrudan HTTP istekleri göndererek kullanabilirsiniz. Ancak biz, uç noktalara Node.js'den erişimi kolaylaştıran bir istemci kitaplığı sağlarız. Actions API istemci kitaplığı, çeşitli uç noktalar kullanarak işleminizi yönetmenize ve test etmenize olanak tanır.

Örneğin, aşağıdaki kod sağlanan modele göre kullanıcının proje önizlemesini güncellemek için writePreview uç noktasına bir çağrıda bulunur:

   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);
    }

Actions API Node.js istemci kitaplığına yönelik yükleme talimatları ve referans materyal için kitaplık ve Actions API REST referansı belgelerine bakın.

Şartlar

Actions API'ye yapılan istekler için aşağıdaki şartlar geçerlidir.

İstek yükü boyutu

Actions API'ye yapılan istekler 10 MB veya daha küçük olmalıdır. Buna şunlar dâhildir: akıştaki her isteğin 10 MB olması gereken istemci akış uç noktaları veya daha az olmalıdır.

Yükünüz 10 MB'ı aşarsa Actionss bölümünden 400 hatası alırsınız. SDK sunucusu.

En iyi uygulamalar

Aşağıdaki en iyi uygulamaların Actions API'yi kullanmanız gerekir.

x-goog-user-project istek başlığını ayarlayın

Kullanıcılarınız için bir araç veya uygulama oluştururken kullanıcının kota sınırları için kullanılması ve faturalandırılması gerektiğini belirtir. Faturalandırma ve kota amacıyla bir projeyi belirtmek için x-goog-user-project istek başlığı.

Kullanıcı aracısı istek başlığını ayarlama

user-agent istek başlığını kullanarak uygun bir kullanıcı aracısı ayarlayın. Bu API'nin, isteklerin iş ortaklarından gelip gelmediğini belirlemesine yardımcı olur.

Bilinen sınırlamalar

Bu bölümde, Actions API'yle ilgili bilinen sınırlamalar açıklanmaktadır.

İstemci akışı uç noktaları için zaman aşımı

Bu sınırlama, yalnızca istemci akışına yaptığınız HTTP isteklerinde geçerlidir uç noktalar. İstemci kitaplığı kullanılarak yapılan istekler bu sınırlamadan etkilenir.

WritePreview, CreateVersion veya WriteDraft yöntemini çağırmak için HTTP istekleri kullanıyorsanız olmayan istekleri ele almak için bir zaman aşımı işidir.

200 dışında bir durum kodu belirten bir yanıt başlığı alırsanız kodunuz belirli bir süre sonra akışı sonlandırır. Bu sayı yalnızca istemci akış uç noktalarını etkiler. Örneğin, gactions aracı, 5 saniyelik bir zaman aşımı süresi vardır.