Context

Contextual data associated with a message.

JSON representation
 { 
 "entryPoint" 
 : 
 enum (  EntryPoint 
 
) 
 , 
 "userInfo" 
 : 
 { 
 object (  UserInfo 
 
) 
 } 
 , 
 "widget" 
 : 
 { 
 object (  Widget 
 
) 
 } 
 , 
 "resolvedLocale" 
 : 
 string 
 , 
 "customContext" 
 : 
 string 
 , 
 // Union field place 
can be only one of the following: 
 "placeId" 
 : 
 string 
 , 
 "nearPlaceId" 
 : 
 string 
 // End of list of possible types for union field place 
. 
 } 
Fields
entryPoint

enum ( EntryPoint )

The entry point that the user clicked.

userInfo

object ( UserInfo )

Identity of the user who wrote the message.

widget

object ( Widget )

Information about the widget used to start the conversation.

resolvedLocale

string

Resolved locale. A match of user and supported agent locales based on location, likely language preference, and other factors. The locale value is a well-formed IETF BCP 47 language tag.

customContext

string

Context data specified by the partner.

Union field place . Either placeId or nearPlaceId can be set. place can be only one of the following:
placeId

string

The Place ID , or unique identifier used in Google Places, for the location.

nearPlaceId

string

The Place ID , or unique identifier used in Google Places, of the nearest location to the user.

UserInfo

User identity data associated with a message.

JSON representation
 { 
 "displayName" 
 : 
 string 
 , 
 "userDeviceLocale" 
 : 
 string 
 } 
Fields
displayName

string

User's display name.

userDeviceLocale

string

User's locale. Determined by the device's language settings.

Widget

Widget information associated with a message.

JSON representation
 { 
 "url" 
 : 
 string 
 , 
 "widgetContext" 
 : 
 string 
 } 
Fields
url

string

URL where the widget was integrated.

widgetContext

string

Context string associated with the widget. Specified by the widget's data-bm-widget-context attribute.