Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class UIComponentField.
Facet field that maps to a UI Component.
Generated from protobuf message google.cloud.discoveryengine.v1.WidgetConfig.UIComponentField
Namespace
Google \ Cloud \ DiscoveryEngine \ V1 \ WidgetConfigMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ field |
string
Required. Registered field name. The format is |
↳ device_visibility |
int[]
The field visibility on different types of devices. |
↳ display_template |
string
The template to customize how the field is displayed. An example value would be a string that looks like: "Price: {value}". |
getField
Required. Registered field name. The format is field.abc.
| Returns | |
|---|---|
| Type | Description |
string |
|
setField
Required. Registered field name. The format is field.abc.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDeviceVisibility
The field visibility on different types of devices.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<int> |
|
setDeviceVisibility
The field visibility on different types of devices.
| Parameter | |
|---|---|
| Name | Description |
var |
int[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayTemplate
The template to customize how the field is displayed. An example value would be a string that looks like: "Price: {value}".
| Returns | |
|---|---|
| Type | Description |
string |
|
setDisplayTemplate
The template to customize how the field is displayed. An example value would be a string that looks like: "Price: {value}".
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|