AgentLaunch

Details about an agent launch.

JSON representation 
{
  "name": string,

  // Union field launch_detail can be only one of the following:
  "businessMessages": {
    object (BusinessMessagesLaunch)
  },
  "rcsBusinessMessaging": {
    object (RcsBusinessMessagingLaunch)
  }
  // End of list of possible types for union field launch_detail.
}
Fields
name

string

Required. The identifier for launch.
Union field launch_detail. Allows launch based on agent type. launch_detail can be only one of the following:
businessMessages

object (BusinessMessagesLaunch)

Launch details for a Business Messages agent.
rcsBusinessMessaging

object (RcsBusinessMessagingLaunch)

Launch details for an RCS Business Messaging agent.

BusinessMessagesLaunch

Details about a Business Messages agent launch.

JSON representation 
{
  "launchDetails": {
    string: {
      object (BusinessMessagesEntryPointLaunch)
    },
    ...
  }
}
Fields
launchDetails

map (key: string, value: object (BusinessMessagesEntryPointLaunch))

Required. Launch details for each supported entry point. Key represented by BusinessMessagesEntryPointConfig.EntryPoint

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

BusinessMessagesEntryPointLaunch

Details about Business Messages agent launch for each entry point.

JSON representation 
{
  "entryPoint": enum (EntryPoint),
  "launchState": enum (LaunchState),
  "regionCodes": [
    string
  ]
}
Fields
entryPoint

enum (EntryPoint)

Entry point for which launch information is provided.
launchState

enum (LaunchState)

The launch state for entry point.
regionCodes[]

string

List of CLDR region codes for countries where the agent should launch NON_LOCAL entry points. Required for NON_LOCAL entry points. This must be a subset of the region codes specified in the agent's nonLocalConfig.

RcsBusinessMessagingLaunch

Details about an RCS Business Messaging agent launch.

JSON representation 
{
  "questionnaire": {
    object (Questionnaire)
  },
  "launchDetails": {
    string: {
      object (RcsBusinessMessagingRegionLaunch)
    },
    ...
  },
  "launchRegion": enum (LaunchRegion)
}
Fields
questionnaire

object (Questionnaire)

Required. Questionnaire about agent launch details.
launchDetails

map (key: string, value: object (RcsBusinessMessagingRegionLaunch))

Required. Launch details for each supported region. Key represented by RcsBusinessMessagingRegion.name.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
launchRegion
(deprecated)

enum (LaunchRegion)

Launch region for an agent. Optional: will be set as NORTH_AMERICA if not provided. This field is deprecated. Hosting region can only be specified during agent creation.

Questionnaire

If Google manages the launch region, questionnaire details are available to Google for the purpose of reviewing the agent's launch.

JSON representation 
{
  "contacts": [
    {
      object (Contact)
    }
  ],
  "optinDescription": string,
  "triggerDescription": string,
  "interactionsDescription": string,
  "optoutDescription": string,
  "agentAccessInstructions": string,
  "videoUris": [
    string
  ],
  "screenshotUris": [
    string
  ]
}
Fields
contacts[]

object (Contact)

Required. Point of contacts.
optinDescription

string

Required. Description of how you obtain opt-in to message users with the agent.
triggerDescription

string

Required. Description of actions that trigger messages to users.
interactionsDescription

string

Required. Description of interactions the agent will have with users.
optoutDescription

string

Required. Description of the message the agent sends when a user opts out.
agentAccessInstructions

string

Required. Agent access instructions.
videoUris[]

string

Optional. Publicly available URIs for videos of the agent. For review purposes only.
screenshotUris[]

string

Optional. Publicly available URIs for screenshots of the agent. For review purposes only.

Contact

Point of contact.

JSON representation 
{
  "name": string,
  "title": string,
  "email": string
}
Fields
name

string

Name of the contact.
title

string

Title of the contact.
email

string

Email address of the contact.

RcsBusinessMessagingRegionLaunch

Details about RCS Business Messaging agent launch for each region.

JSON representation 
{
  "launchState": enum (LaunchState),
  "comment": string,
  "updateTime": string
}
Fields
launchState

enum (LaunchState)

The launch state for a region.
comment

string

Comment from the carrier.
updateTime

string (Timestamp format)

Last updated time.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

LaunchRegion

Launch region. Region where an agent is launched. This enum matches the options available in the Region dropdown when creating a new RCS Business Messaging agent in the Developer Console.

Enums
LAUNCH_REGION_UNSPECIFIED Unspecified launch region.
NORTH_AMERICA North America.
EUROPE Europe.
ASIA_PACIFIC Asia Pacific.