deployments

Creates, updates, deletes, gets or lists a deployments resource.

Overview

Name	`deployments`
Type	Resource
Id	`google.ces.deployments`

Fields

The following fields are returned by SELECT queries:

get
list

Name	Datatype	Description
`name`	`string`	Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`
`appVersion`	`string`	Optional. The resource name of the app version to deploy. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` Use `projects/{project}/locations/{location}/apps/{app}/versions/-` to use the draft app.
`channelProfile`	`object`	Required. The channel profile used in the deployment. (id: ChannelProfile)
`createTime`	`string (google-datetime)`	Output only. Timestamp when this deployment was created.
`displayName`	`string`	Required. Display name of the deployment.
`etag`	`string`	Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
`experimentConfig`	`object`	Optional. Experiment configuration for the deployment. (id: ExperimentConfig)
`instagramCredentials`	`object`	Optional. Input only. Ephemeral Instagram credentials required when configuring a Instagram channel profile. (id: InstagramCredentials)
`modality`	`string`	Optional. The modality of the deployment. Note: Deployment-level modality override is gated behind an allowlist. Contact the CXAS team to enable this field. (MODALITY_UNSPECIFIED, MODALITY_TEXT, MODALITY_VOICE, MODALITY_VIDEO)
`modelSettings`	`object`	Optional. Model settings for the deployment. Overrides model settings configured at the app/agent levels. Note: Deployment-level model settings override is gated behind an allowlist. Contact the CXAS team to enable this field. (id: ModelSettings)
`updateTime`	`string (google-datetime)`	Output only. Timestamp when this deployment was last updated.
`whatsappCredentials`	`object`	Optional. Input only. Ephemeral WhatsApp credentials required when configuring a WhatsApp channel profile. (id: WhatsAppCredentials)

Name	Datatype	Description
`name`	`string`	Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`
`appVersion`	`string`	Optional. The resource name of the app version to deploy. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` Use `projects/{project}/locations/{location}/apps/{app}/versions/-` to use the draft app.
`channelProfile`	`object`	Required. The channel profile used in the deployment. (id: ChannelProfile)
`createTime`	`string (google-datetime)`	Output only. Timestamp when this deployment was created.
`displayName`	`string`	Required. Display name of the deployment.
`etag`	`string`	Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
`experimentConfig`	`object`	Optional. Experiment configuration for the deployment. (id: ExperimentConfig)
`instagramCredentials`	`object`	Optional. Input only. Ephemeral Instagram credentials required when configuring a Instagram channel profile. (id: InstagramCredentials)
`modality`	`string`	Optional. The modality of the deployment. Note: Deployment-level modality override is gated behind an allowlist. Contact the CXAS team to enable this field. (MODALITY_UNSPECIFIED, MODALITY_TEXT, MODALITY_VOICE, MODALITY_VIDEO)
`modelSettings`	`object`	Optional. Model settings for the deployment. Overrides model settings configured at the app/agent levels. Note: Deployment-level model settings override is gated behind an allowlist. Contact the CXAS team to enable this field. (id: ModelSettings)
`updateTime`	`string (google-datetime)`	Output only. Timestamp when this deployment was last updated.
`whatsappCredentials`	`object`	Optional. Input only. Ephemeral WhatsApp credentials required when configuring a WhatsApp channel profile. (id: WhatsAppCredentials)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get`	`select`	`projectsId`, `locationsId`, `appsId`, `deploymentsId`		Gets details of the specified deployment.
`list`	`select`	`projectsId`, `locationsId`, `appsId`	`orderBy`, `pageSize`, `pageToken`	Lists deployments in the given app.
`create`	`insert`	`projectsId`, `locationsId`, `appsId`	`deploymentId`	Creates a new deployment in the given app.
`patch`	`update`	`projectsId`, `locationsId`, `appsId`, `deploymentsId`	`updateMask`	Updates the specified deployment.
`delete`	`delete`	`projectsId`, `locationsId`, `appsId`, `deploymentsId`	`etag`	Deletes the specified deployment.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`appsId`	`string`
`deploymentsId`	`string`
`locationsId`	`string`
`projectsId`	`string`
`deploymentId`	`string`
`etag`	`string`
`orderBy`	`string`
`pageSize`	`integer (int32)`
`pageToken`	`string`
`updateMask`	`string (google-fieldmask)`

`SELECT` examples

get
list

Gets details of the specified deployment.

SELECT
name,
appVersion,
channelProfile,
createTime,
displayName,
etag,
experimentConfig,
instagramCredentials,
modality,
modelSettings,
updateTime,
whatsappCredentials
FROM google.ces.deployments
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND appsId = '{{ appsId }}' -- required
AND deploymentsId = '{{ deploymentsId }}' -- required
;

Lists deployments in the given app.

SELECT
name,
appVersion,
channelProfile,
createTime,
displayName,
etag,
experimentConfig,
instagramCredentials,
modality,
modelSettings,
updateTime,
whatsappCredentials
FROM google.ces.deployments
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND appsId = '{{ appsId }}' -- required
AND orderBy = '{{ orderBy }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

`INSERT` examples

create
Manifest

Creates a new deployment in the given app.

INSERT INTO google.ces.deployments (
data__appVersion,
data__channelProfile,
data__displayName,
data__experimentConfig,
data__instagramCredentials,
data__modality,
data__modelSettings,
data__name,
data__whatsappCredentials,
projectsId,
locationsId,
appsId,
deploymentId
)
SELECT 
'{{ appVersion }}',
'{{ channelProfile }}',
'{{ displayName }}',
'{{ experimentConfig }}',
'{{ instagramCredentials }}',
'{{ modality }}',
'{{ modelSettings }}',
'{{ name }}',
'{{ whatsappCredentials }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ appsId }}',
'{{ deploymentId }}'
RETURNING
name,
appVersion,
channelProfile,
createTime,
displayName,
etag,
experimentConfig,
instagramCredentials,
modality,
modelSettings,
updateTime,
whatsappCredentials
;

# Description fields are for documentation purposes
- name: deployments
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the deployments resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the deployments resource.
  - name: appsId
    value: "{{ appsId }}"
    description: Required parameter for the deployments resource.
  - name: appVersion
    value: "{{ appVersion }}"
    description: |
      Optional. The resource name of the app version to deploy. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` Use `projects/{project}/locations/{location}/apps/{app}/versions/-` to use the draft app.
  - name: channelProfile
    description: |
      Required. The channel profile used in the deployment.
    value:
      channelType: "{{ channelType }}"
      disableBargeInControl: {{ disableBargeInControl }}
      disableDtmf: {{ disableDtmf }}
      instagramConfig:
        description: "{{ description }}"
        displayName: "{{ displayName }}"
        instagramAccountId: "{{ instagramAccountId }}"
        thumbnailUrl: "{{ thumbnailUrl }}"
      noiseSuppressionLevel: "{{ noiseSuppressionLevel }}"
      personaProperty:
        persona: "{{ persona }}"
      profileId: "{{ profileId }}"
      webWidgetConfig:
        modality: "{{ modality }}"
        securitySettings:
          allowedOrigins:
            - "{{ allowedOrigins }}"
          enableOriginCheck: {{ enableOriginCheck }}
          enablePublicAccess: {{ enablePublicAccess }}
          enableRecaptcha: {{ enableRecaptcha }}
        theme: "{{ theme }}"
        webWidgetTitle: "{{ webWidgetTitle }}"
      whatsappConfig:
        description: "{{ description }}"
        displayName: "{{ displayName }}"
        phoneNumber: "{{ phoneNumber }}"
        phoneNumberId: "{{ phoneNumberId }}"
        thumbnailUrl: "{{ thumbnailUrl }}"
        wabaId: "{{ wabaId }}"
  - name: displayName
    value: "{{ displayName }}"
    description: |
      Required. Display name of the deployment.
  - name: experimentConfig
    description: |
      Optional. Experiment configuration for the deployment.
    value:
      versionRelease:
        state: "{{ state }}"
        trafficAllocations:
          - appVersion: "{{ appVersion }}"
            id: "{{ id }}"
            trafficPercentage: {{ trafficPercentage }}
  - name: instagramCredentials
    description: |
      Optional. Input only. Ephemeral Instagram credentials required when configuring a Instagram channel profile.
    value:
      authCode: "{{ authCode }}"
      conversationProfileId: "{{ conversationProfileId }}"
  - name: modality
    value: "{{ modality }}"
    description: |
      Optional. The modality of the deployment. Note: Deployment-level modality override is gated behind an allowlist. Contact the CXAS team to enable this field.
    valid_values: ['MODALITY_UNSPECIFIED', 'MODALITY_TEXT', 'MODALITY_VOICE', 'MODALITY_VIDEO']
  - name: modelSettings
    description: |
      Optional. Model settings for the deployment. Overrides model settings configured at the app/agent levels. Note: Deployment-level model settings override is gated behind an allowlist. Contact the CXAS team to enable this field.
    value:
      model: "{{ model }}"
      temperature: {{ temperature }}
  - name: name
    value: "{{ name }}"
    description: |
      Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`
  - name: whatsappCredentials
    description: |
      Optional. Input only. Ephemeral WhatsApp credentials required when configuring a WhatsApp channel profile.
    value:
      authCode: "{{ authCode }}"
      businessAccountId: "{{ businessAccountId }}"
      conversationProfileId: "{{ conversationProfileId }}"
      phoneNumber: "{{ phoneNumber }}"
      pin: "{{ pin }}"
      wabaId: "{{ wabaId }}"
  - name: deploymentId
    value: "{{ deploymentId }}"

`UPDATE` examples

patch

Updates the specified deployment.

UPDATE google.ces.deployments
SET 
data__appVersion = '{{ appVersion }}',
data__channelProfile = '{{ channelProfile }}',
data__displayName = '{{ displayName }}',
data__experimentConfig = '{{ experimentConfig }}',
data__instagramCredentials = '{{ instagramCredentials }}',
data__modality = '{{ modality }}',
data__modelSettings = '{{ modelSettings }}',
data__name = '{{ name }}',
data__whatsappCredentials = '{{ whatsappCredentials }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND appsId = '{{ appsId }}' --required
AND deploymentsId = '{{ deploymentsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
appVersion,
channelProfile,
createTime,
displayName,
etag,
experimentConfig,
instagramCredentials,
modality,
modelSettings,
updateTime,
whatsappCredentials;

`DELETE` examples

delete

Deletes the specified deployment.

DELETE FROM google.ces.deployments
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND appsId = '{{ appsId }}' --required
AND deploymentsId = '{{ deploymentsId }}' --required
AND etag = '{{ etag }}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​