Actions API'sı

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

İstemci Kitaplığı (Node.js)

Sunucuya doğrudan HTTP istekleri göndererek Actions API RESTful hizmetini kullanabilirsiniz. Ancak Node.js'den uç noktalara erişimi kolaylaştıran bir istemci kitaplığı sunuyoruz. Actions API istemci kitaplığı, çeşitli uç noktaları kullanarak İşleminizi yönetip test etmenize olanak tanır.

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

   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'si Node.js istemci kitaplığına yönelik yükleme talimatları ve referans materyalleri için kitaplık ve Actions API REST referansı dokümanlarına bakın.

Koşullar

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

İstek yük boyutu

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

Yükünüz 10 MB'ı aşarsa Actions SDK sunucusundan 400 hatası alırsınız.

En iyi uygulamalar

Actions API'yi kullanırken aşağıdaki en iyi uygulamalar kesinlikle önerilir.

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

Kullanıcılarınız için bir araç veya uygulama oluştururken istemci projeniz yerine bir kullanıcının projesinin faturalandırılmasını ve kota sınırları için kullanılmasını isteyebilirsiniz. Faturalandırma ve kota amacıyla bir proje belirtmek için x-goog-user-project istek başlığını ayarlayın.

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

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'sinin bilinen sınırlamaları açıklanmaktadır.

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

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

WritePreview, CreateVersion veya WriteDraft yöntemini çağırmak için HTTP istekleri kullanıyorsanız, başarısız olan istekleri ele almak için zaman aşımı uygulamanızı öneririz.

200 dışında bir durum kodu belirten yanıt başlığı alırsanız kodunuzun belirli bir süre sonra akışı sonlandırması gerekir. Bu sorun yalnızca istemci akışı uç noktalarını etkiler. Örneğin, Actions API'yi kullanan gactions aracının 5 saniyelik zaman aşımı vardır.