REST Resource: projects.locations.apps.deployments

Ressource: Bereitstellung

Ein Deployment stellt eine unveränderliche, abfragbare Version der App dar. Es wird verwendet, um eine App-Version mit einem bestimmten Channelprofil bereitzustellen.

JSON-Darstellung 
{
  "name": string,
  "displayName": string,
  "appVersion": string,
  "channelProfile": {
    object (ChannelProfile)
  },
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "experimentConfig": {
    object (ExperimentConfig)
  },
  "whatsappCredentials": {
    object (WhatsAppCredentials)
  },
  "instagramCredentials": {
    object (InstagramCredentials)
  },
  "modelSettings": {
    object (ModelSettings)
  },
  "modality": enum (Deployment.Modality)
}
Felder
name

string

ID. Der Ressourcenname der Bereitstellung. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
displayName

string

Erforderlich. Der Anzeigename der Bereitstellung.
appVersion

string

Optional. Der Ressourcenname der bereitzustellenden App-Version. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version} Verwenden Sie projects/{project}/locations/{location}/apps/{app}/versions/-, um die App-Version zu verwenden.
channelProfile

object (ChannelProfile)

Erforderlich. Das im Einsatz verwendete Kanalprofil.
createTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel für die Erstellung dieser Bereitstellung.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30"
updateTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel der letzten Aktualisierung dieser Bereitstellung.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30"
etag

string

Nur Ausgabe. Etag, das verwendet wird, um sicherzustellen, dass sich das Objekt während eines Read-Modify-Write-Vorgangs nicht geändert hat. Wenn das ETag leer ist, werden alle gleichzeitigen Änderungen durch das Update überschrieben.
experimentConfig

object (ExperimentConfig)

Optional. Testkonfiguration für die Bereitstellung.
whatsappCredentials

object (WhatsAppCredentials)

Optional. Nur Eingabe. Beim Konfigurieren eines WhatsApp-Channelprofils sind temporäre WhatsApp-Anmeldedaten erforderlich.
instagramCredentials

object (InstagramCredentials)

Optional. Nur Eingabe. Bei der Konfiguration eines Instagram-Kanalprofils sind temporäre Instagram-Anmeldedaten erforderlich.
modelSettings

object (ModelSettings)

Optional. Modelleinstellungen für die Bereitstellung. Überschreibt die Modelleinstellungen, die auf App-/Agent-Ebene konfiguriert wurden. Hinweis: Das Überschreiben von Modelleinstellungen auf Bereitstellungsebene ist nur über eine Zulassungsliste möglich. Wenden Sie sich an das CXAS-Team, um dieses Feld zu aktivieren.
modality

enum (Deployment.Modality)

Optional. Die Modalität der Bereitstellung. Hinweis: Das Überschreiben der Modalität auf Bereitstellungsebene ist nur über eine Zulassungsliste möglich. Wenden Sie sich an das CXAS-Team, um dieses Feld zu aktivieren.

ExperimentConfig

Test für die Bereitstellung

JSON-Darstellung 
{
  "versionRelease": {
    object (ExperimentConfig.VersionRelease)
  }
}
Felder
versionRelease

object (ExperimentConfig.VersionRelease)

Optional. Version für den Test.

ExperimentConfig.VersionRelease

Version für den Test.

JSON-Darstellung 
{
  "state": enum (ExperimentConfig.State),
  "trafficAllocations": [
    {
      object (ExperimentConfig.VersionRelease.TrafficAllocation)
    }
  ]
}
Felder
state

enum (ExperimentConfig.State)

Optional. Status der Versionsveröffentlichung.
trafficAllocations[]

object (ExperimentConfig.VersionRelease.TrafficAllocation)

Optional. Traffic-Zuweisungen für die Versionsveröffentlichung.

ExperimentConfig.State

Status des Tests.

Enums
STATE_UNSPECIFIED Nicht angegebener Zustand.
PENDING Eingestellt: Dieser Status wird nicht mehr verwendet.
RUNNING Ausführungsstatus. Der Test läuft und ist gültig.
DONE Eingestellt: Dieser Status wird nicht mehr verwendet.
EXPIRED Eingestellt: Dieser Status wird nicht mehr verwendet.

ExperimentConfig.VersionRelease.TrafficAllocation

Traffic-Zuordnung für die Version.

JSON-Darstellung 
{
  "id": string,
  "trafficPercentage": integer,
  "appVersion": string
}
Felder
id

string

Optional. Die ID der Traffic-Zuordnung. Freiformatierter String mit bis zu 128 Zeichen.
trafficPercentage

integer

Optional. Traffic-Prozentsatz der Traffic-Zuordnung. muss zwischen 0 und 100 liegen.
appVersion

string

Optional. App-Version der Traffic-Zuordnung. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version}

WhatsAppCredentials

Temporäre Meta-Anmeldedaten für die native WhatsApp-Integration.

JSON-Darstellung 
{
  "authCode": string,
  "pin": string,
  "phoneNumber": string,
  "businessAccountId": string,
  "wabaId": string,
  "conversationProfileId": string
}
Felder
authCode

string

Erforderlich. Der Meta-Autorisierungscode, der vom eingebetteten Registrierungsvorgang bereitgestellt wird.
pin

string

Erforderlich. Die sechsstellige PIN, die vom Nutzer für die Bestätigung in zwei Schritten erstellt wurde.
phoneNumber

string

Erforderlich. Die Telefonnummer, mit der Sie sich bei WhatsApp registrieren.
businessAccountId

string

Erforderlich. Die ID des Geschäftskontos, die für die Telefonnummer verwendet werden soll.
wabaId

string

Erforderlich. Die WhatsApp Business-Konto-ID.
conversationProfileId

string

Optional. Die ID des Unterhaltungsprofils, das für die Bereitstellung verwendet werden soll.

InstagramCredentials

Sitzungsspezifische Meta-Anmeldedaten für die native Instagram-Integration.

JSON-Darstellung 
{
  "authCode": string,
  "conversationProfileId": string
}
Felder
authCode

string

Erforderlich. Der Meta-Autorisierungscode, der vom eingebetteten Registrierungsvorgang bereitgestellt wird.
conversationProfileId

string

Optional. Die ID des Unterhaltungsprofils, das für die Bereitstellung verwendet werden soll.

Deployment.Modality

Die Modalität der Bereitstellung.

Enums
MODALITY_UNSPECIFIED Unbekannte Modalität.
MODALITY_TEXT Textmodalität.
MODALITY_VOICE Sprachmodalität
MODALITY_VIDEO Videomodalität.

Methoden

create

 Erstellt ein neues Deployment in der angegebenen App.

delete

 Löscht die angegebene Bereitstellung.

get

 Ruft Details zur angegebenen Bereitstellung ab.

getExtendedAgentCard

 Ruft die erweiterte Agentenkarte für den authentifizierten Agent ab.

list

 Listet Bereitstellungen in der angegebenen App auf.

patch

 Aktualisiert die angegebene Bereitstellung.