Reference documentation and code samples for the Google Analytics Data V1alpha Client class ChatRequest.
Request message for the Chat method.
Generated from protobuf message google.analytics.data.v1alpha.ChatRequest
Namespace
Google \ Analytics \ Data \ V1alphaMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ property |
string
Required. The property to chat about. Format: properties/{property} |
↳ user_query |
string
Required. The user's query. |
↳ session_id |
string
Optional. Provide this session ID to continue an existing conversation and maintain context. If this field is empty or unset, a new chat session is created. Invalid session IDs will result in an error. |
↳ return_property_quota |
bool
Optional. If true, the response will include the current state of this Analytics Property's quota. Quota is returned in PropertyChatQuota. |
getProperty
Required. The property to chat about.
Format: properties/{property}
| Returns | |
|---|---|
| Type | Description |
string |
|
setProperty
Required. The property to chat about.
Format: properties/{property}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUserQuery
Required. The user's query.
| Returns | |
|---|---|
| Type | Description |
string |
|
setUserQuery
Required. The user's query.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSessionId
Optional. Provide this session ID to continue an existing conversation and maintain context. If this field is empty or unset, a new chat session is created. Invalid session IDs will result in an error.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasSessionId
clearSessionId
setSessionId
Optional. Provide this session ID to continue an existing conversation and maintain context. If this field is empty or unset, a new chat session is created. Invalid session IDs will result in an error.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getReturnPropertyQuota
Optional. If true, the response will include the current state of this Analytics Property's quota. Quota is returned in PropertyChatQuota.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setReturnPropertyQuota
Optional. If true, the response will include the current state of this Analytics Property's quota. Quota is returned in PropertyChatQuota.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|