REST Resource: projects.locations.brands.channelConfigs

Resource: ChannelConfig

A channel configuration represents an operational strategy configuration. Channel configuration lifecycle: * DRAFT: A configuration is in a draft state when it has no associated config application rules and is not set as the default configuration for the brand. * ACTIVE: A configuration is in an active state when it is either associated with any config application rule or set as the brand's default. * When active, the runtime applies the channel configuration to matching stores. To ensure flexibility, the relationship between channel configuration and config application rule is one-to-many on each resource level: * On the brand level, there is a one-to-many relationship between channel configurations and config application rules. * On the store level, there is another one-to-many relationship between channel configurations and config application rules. When multiple channel configurations are applicable, the runtime determines the configuration to apply based on the following precedence order (latter overwrites former in case of conflict): 1. Brand-level default 2. Brand-level binding 3. Store-level default 4. Store-level binding

JSON representation
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string,
  "state": enum (State),
  "type": enum (Type),
  "tone": enum (Tone),
  "configApplicationRules": [
    {
      object (ConfigApplicationRule)
    }
  ]
}
Fields
name

string

Identifier. The channel configuration name. Format: projects/{project}/locations/{location}/brands/{brand}/channelConfigs/{channelConfig}

displayName

string

Optional. Optional display name for this channel configuration for user interfaces. Value is limited to 63 characters.

createTime

string (Timestamp format)

Output only. The time this channel configuration was created.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

Output only. The time this channel configuration was last updated.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

state

enum (State)

Output only. The status of the channel configuration.

type

enum (Type)

Required. The type of the channel configuration.

tone

enum (Tone)

Optional. The tone of the agent.

configApplicationRules[]

object (ConfigApplicationRule)

Output only. The config application rules associated with this channel configuration.

State

Status of the channel configuration.

Enums
STATE_UNSPECIFIED Status is unspecified.
DRAFT The channel configuration is a draft and not yet ready for use.
ACTIVE The channel configuration is active and can be used.
PROMOTED The channel configuration is promoted.

Type

The type of the channel configuration.

Enums
TYPE_UNSPECIFIED Type is unspecified.
UPSELL_STRATEGY The channel configuration is for upsell strategy.
AGENT_CUSTOMIZATION The channel configuration is for agent customization.

Tone

The tone of the agent.

Enums
TONE_UNSPECIFIED Tone is unspecified.
CONCISE_AND_DIRECT The agent's tone is concise and direct.
PROFESSIONAL_AND_FORMAL The agent's tone is professional and formal.
FRIENDLY The agent's tone is friendly.

Methods

create

Creates a ChannelConfig.

delete

Deletes the specified ChannelConfig.

get

Gets a ChannelConfig.

list

Lists ChannelConfigs.

patch

Updates the specified ChannelConfig.

promote

Promotes the specified channel config.