Reference documentation and code samples for the Google Shopping Merchant Issue Resolution V1 Client class InputField.
Input field that needs to be available to the business. If the field is marked as required, then a value needs to be provided for a successful processing of the request.
Generated from protobuf message google.shopping.merchant.issueresolution.v1.InputField
Namespace
Google \ Shopping \ Merchant \ IssueResolution \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ text_input |
InputField\TextInput
Input field to provide text information. Corresponds to the html input type=text or html textarea. |
↳ choice_input |
InputField\ChoiceInput
Input field to select one of the offered choices. Corresponds to the html input type=radio. |
↳ checkbox_input |
InputField\CheckboxInput
Input field to provide a boolean value. Corresponds to the html input type=checkbox. |
↳ id |
string
Not for display but need to be sent back for the given input field. |
↳ label |
TextWithTooltip
Input field label. There may be more information to be shown in a tooltip. |
↳ required |
bool
Whether the field is required. The action button needs to stay disabled till values for all required fields are provided. |
getTextInput
Input field to provide text information.
Corresponds to the html input type=text or html textarea.
| Returns | |
|---|---|
| Type | Description |
InputField\TextInput|null |
|
hasTextInput
setTextInput
Input field to provide text information.
Corresponds to the html input type=text or html textarea.
| Parameter | |
|---|---|
| Name | Description |
var |
InputField\TextInput
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getChoiceInput
Input field to select one of the offered choices.
Corresponds to the html input type=radio.
| Returns | |
|---|---|
| Type | Description |
InputField\ChoiceInput|null |
|
hasChoiceInput
setChoiceInput
Input field to select one of the offered choices.
Corresponds to the html input type=radio.
| Parameter | |
|---|---|
| Name | Description |
var |
InputField\ChoiceInput
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCheckboxInput
Input field to provide a boolean value.
Corresponds to the html input type=checkbox.
| Returns | |
|---|---|
| Type | Description |
InputField\CheckboxInput|null |
|
hasCheckboxInput
setCheckboxInput
Input field to provide a boolean value.
Corresponds to the html input type=checkbox.
| Parameter | |
|---|---|
| Name | Description |
var |
InputField\CheckboxInput
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getId
Not for display but need to be sent back for the given input field.
| Returns | |
|---|---|
| Type | Description |
string |
|
setId
Not for display but need to be sent back for the given input field.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLabel
Input field label. There may be more information to be shown in a tooltip.
| Returns | |
|---|---|
| Type | Description |
TextWithTooltip|null |
|
hasLabel
clearLabel
setLabel
Input field label. There may be more information to be shown in a tooltip.
| Parameter | |
|---|---|
| Name | Description |
var |
TextWithTooltip
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRequired
Whether the field is required. The action button needs to stay disabled till values for all required fields are provided.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setRequired
Whether the field is required. The action button needs to stay disabled till values for all required fields are provided.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getValueInput
| Returns | |
|---|---|
| Type | Description |
string |
|