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

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

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)
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	pageSize, pageToken, orderBy	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

Gets details of the specified deployment.

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

list

Lists deployments in the given app.

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

INSERT examples

create

Creates a new deployment in the given app.

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

Manifest

# 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: experimentConfig
    description: |
      Optional. Experiment configuration for the deployment.
    value:
      versionRelease:
        state: "{{ state }}"
        trafficAllocations:
          - id: "{{ id }}"
            trafficPercentage: {{ trafficPercentage }}
            appVersion: "{{ appVersion }}"
  - name: whatsappCredentials
    description: |
      Optional. Input only. Ephemeral WhatsApp credentials required when configuring a WhatsApp channel profile.
    value:
      authCode: "{{ authCode }}"
      pin: "{{ pin }}"
      wabaId: "{{ wabaId }}"
      conversationProfileId: "{{ conversationProfileId }}"
      businessAccountId: "{{ businessAccountId }}"
      phoneNumber: "{{ phoneNumber }}"
  - name: instagramCredentials
    description: |
      Optional. Input only. Ephemeral Instagram credentials required when configuring a Instagram channel profile.
    value:
      conversationProfileId: "{{ conversationProfileId }}"
      authCode: "{{ authCode }}"
  - name: channelProfile
    description: |
      Required. The channel profile used in the deployment.
    value:
      channelType: "{{ channelType }}"
      disableBargeInControl: {{ disableBargeInControl }}
      webWidgetConfig:
        theme: "{{ theme }}"
        webWidgetTitle: "{{ webWidgetTitle }}"
        modality: "{{ modality }}"
        securitySettings:
          enableRecaptcha: {{ enableRecaptcha }}
          allowedOrigins:
            - "{{ allowedOrigins }}"
          enablePublicAccess: {{ enablePublicAccess }}
          enableOriginCheck: {{ enableOriginCheck }}
      noiseSuppressionLevel: "{{ noiseSuppressionLevel }}"
      profileId: "{{ profileId }}"
      whatsappConfig:
        phoneNumber: "{{ phoneNumber }}"
        displayName: "{{ displayName }}"
        wabaId: "{{ wabaId }}"
        phoneNumberId: "{{ phoneNumberId }}"
        thumbnailUrl: "{{ thumbnailUrl }}"
        description: "{{ description }}"
      instagramConfig:
        instagramAccountId: "{{ instagramAccountId }}"
        thumbnailUrl: "{{ thumbnailUrl }}"
        description: "{{ description }}"
        displayName: "{{ displayName }}"
      personaProperty:
        persona: "{{ persona }}"
      disableDtmf: {{ disableDtmf }}
  - name: name
    value: "{{ name }}"
    description: |
      Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`
  - name: displayName
    value: "{{ displayName }}"
    description: |
      Required. Display name of the deployment.
  - 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: deploymentId
    value: "{{ deploymentId }}"

UPDATE examples

patch

Updates the specified deployment.

UPDATE google.ces.deployments
SET 
data__experimentConfig = '{{ experimentConfig }}',
data__whatsappCredentials = '{{ whatsappCredentials }}',
data__instagramCredentials = '{{ instagramCredentials }}',
data__channelProfile = '{{ channelProfile }}',
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__appVersion = '{{ appVersion }}'
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,
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 }}'
;