Vertex AI Search for retail is being renamed to Vertex AI Search for commerce. We're updating content to reflect the new branding.

AlertConfig

JSON representation
AlertPolicy
- JSON representation
EnrollStatus
Recipient
- JSON representation

Project level alert config.

JSON representation
{ "name" : string , "alertPolicies" : [ { object ( `AlertPolicy` ) } ] }

Fields

Fields
`name`	`string` Required. Immutable. The name of the AlertConfig singleton resource. Format: projects/*/alertConfig
`alertPolicies[]`	`object ( AlertPolicy )` Alert policies for a customer. They must be unique by [AlertPolicy.alert_group]

name

string

Required. Immutable. The name of the AlertConfig singleton resource. Format: projects/*/alertConfig

alertPolicies[]

object ( AlertPolicy )

Alert policies for a customer. They must be unique by [AlertPolicy.alert_group]

AlertPolicy

Alert policy for a customer.

JSON representation
{ "alertGroup" : string , "enrollStatus" : enum ( `EnrollStatus` ) , "recipients" : [ { object ( `Recipient` ) } ] }

Fields

Fields
`alertGroup`	`string` The feature that provides alerting capability. Supported value: - `search-data-quality` for retail search customers. - `conv-data-quality` for retail conversation customers.
`enrollStatus`	`enum ( EnrollStatus )` The enrollment status of a customer.
`recipients[]`	`object ( Recipient )` Recipients for the alert policy. One alert policy should not exceed 20 recipients.

alertGroup

string

The feature that provides alerting capability. Supported value: - search-data-quality for retail search customers. - conv-data-quality for retail conversation customers.

enrollStatus

enum ( EnrollStatus )

The enrollment status of a customer.

recipients[]

object ( Recipient )

Recipients for the alert policy. One alert policy should not exceed 20 recipients.

EnrollStatus

The enrollment status enum for alert policy.

Enums
`ENROLL_STATUS_UNSPECIFIED`	Default value. Used for customers who have not responded to the alert policy.
`ENROLLED`	Customer is enrolled in this policy.
`DECLINED`	Customer declined this policy.

Recipient

Recipient contact information.

JSON representation
{ "emailAddress" : string }

Fields

Fields
`emailAddress`	`string` Email address of the recipient.

emailAddress

string

Email address of the recipient.

AlertConfig Stay organized with collections Save and categorize content based on your preferences.

AlertPolicy

EnrollStatus

Recipient

AlertConfig