Class: Google::Shopping::Merchant::IssueResolution::V1beta::InputField

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/shopping/merchant/issueresolution/v1beta/issueresolution.rb

Overview

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.

Defined Under Namespace

Classes: CheckboxInput, ChoiceInput, TextInput

Instance Attribute Summary collapse

Instance Attribute Details

#checkbox_input ⇒ ::Google::Shopping::Merchant::IssueResolution::V1beta::InputField::CheckboxInput

Returns Input field to provide a boolean value. Corresponds to the html input type=checkbox.

Note: The following fields are mutually exclusive: checkbox_input, text_input, choice_input. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
 
# File 'proto_docs/google/shopping/merchant/issueresolution/v1beta/issueresolution.rb', line 586

class InputField
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Text input allows the business to provide a text value.
  # @!attribute [rw] type
  #   @return [::Google::Shopping::Merchant::IssueResolution::V1beta::InputField::TextInput::TextInputType]
  #     Type of the text input
  # @!attribute [rw] additional_info
  #   @return [::Google::Shopping::Merchant::IssueResolution::V1beta::TextWithTooltip]
  #     Additional info regarding the field to be displayed to the business. For
  #     example, warning to not include personal identifiable information. There
  #     may be more information to be shown in a tooltip.
  # @!attribute [rw] format_info
  #   @return [::String]
  #     Information about the required format. If present, it should be shown
  #     close to the input field to help the business to provide a correct value.
  #     For example: "VAT numbers should be in a format similar to SK9999999999"
  # @!attribute [rw] aria_label
  #   @return [::String]
  #     Text to be used as the
  #     [aria-label](https://www.w3.org/TR/WCAG20-TECHS/ARIA14.html) for the
  #     input.
  class TextInput
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum specifying the type of the text input and how it should be rendered.
    module TextInputType
      # Default value. Will never be provided by the API.
      TEXT_INPUT_TYPE_UNSPECIFIED = 0

      # Used when a short text is expected. The field can be rendered as a
      # [text
      # field](https://www.w3.org/TR/2012/WD-html-markup-20121025/input.text.html#input.text).
      GENERIC_SHORT_TEXT = 1

      # Used when a longer text is expected. The field should be rendered as a
      # [textarea](https://www.w3.org/TR/2012/WD-html-markup-20121025/textarea.html#textarea).
      GENERIC_LONG_TEXT = 2
    end
  end

  # Choice input allows the business to select one of the offered choices. Some
  # choices may be linked to additional input fields that should be displayed
  # under or next to the choice option. The value for the additional input
  # field needs to be provided only when the specific choice is selected by the
  # the business. For example, additional input field can be hidden or disabled
  # until the business selects the specific choice.
  # @!attribute [rw] options
  #   @return [::Array<::Google::Shopping::Merchant::IssueResolution::V1beta::InputField::ChoiceInput::ChoiceInputOption>]
  #     A list of choices. Only one option can be selected.
  class ChoiceInput
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A choice that the business can select.
    # @!attribute [rw] id
    #   @return [::String]
    #     Not for display but need to be sent back for the selected choice
    #     option.
    # @!attribute [rw] label
    #   @return [::Google::Shopping::Merchant::IssueResolution::V1beta::TextWithTooltip]
    #     Short description of the choice option. There may be more information
    #     to be shown as a tooltip.
    # @!attribute [rw] additional_input
    #   @return [::Google::Shopping::Merchant::IssueResolution::V1beta::InputField]
    #     Input that should be displayed when this option is selected.
    #     The additional input will not contain a `ChoiceInput`.
    class ChoiceInputOption
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Checkbox input allows the business to provide a boolean value. Corresponds
  # to the [html input
  # type=checkbox](https://www.w3.org/TR/2012/WD-html-markup-20121025/input.checkbox.html#input.checkbox).
  #
  # If the business checks the box, the input value for the field is `true`,
  # otherwise it is `false`.
  #
  # This type of input is often used as a confirmation that the business
  # completed required steps before they are allowed to start the action. In
  # such a case, the input field is marked as
  # {::Google::Shopping::Merchant::IssueResolution::V1beta::InputField#required required}
  # and the button to trigger the action should stay disabled until the
  # business checks the box.
  class CheckboxInput
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#choice_input ⇒ ::Google::Shopping::Merchant::IssueResolution::V1beta::InputField::ChoiceInput

Returns Input field to select one of the offered choices. Corresponds to the html input type=radio.

Note: The following fields are mutually exclusive: choice_input, text_input, checkbox_input. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
 
# File 'proto_docs/google/shopping/merchant/issueresolution/v1beta/issueresolution.rb', line 586

class InputField
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Text input allows the business to provide a text value.
  # @!attribute [rw] type
  #   @return [::Google::Shopping::Merchant::IssueResolution::V1beta::InputField::TextInput::TextInputType]
  #     Type of the text input
  # @!attribute [rw] additional_info
  #   @return [::Google::Shopping::Merchant::IssueResolution::V1beta::TextWithTooltip]
  #     Additional info regarding the field to be displayed to the business. For
  #     example, warning to not include personal identifiable information. There
  #     may be more information to be shown in a tooltip.
  # @!attribute [rw] format_info
  #   @return [::String]
  #     Information about the required format. If present, it should be shown
  #     close to the input field to help the business to provide a correct value.
  #     For example: "VAT numbers should be in a format similar to SK9999999999"
  # @!attribute [rw] aria_label
  #   @return [::String]
  #     Text to be used as the
  #     [aria-label](https://www.w3.org/TR/WCAG20-TECHS/ARIA14.html) for the
  #     input.
  class TextInput
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum specifying the type of the text input and how it should be rendered.
    module TextInputType
      # Default value. Will never be provided by the API.
      TEXT_INPUT_TYPE_UNSPECIFIED = 0

      # Used when a short text is expected. The field can be rendered as a
      # [text
      # field](https://www.w3.org/TR/2012/WD-html-markup-20121025/input.text.html#input.text).
      GENERIC_SHORT_TEXT = 1

      # Used when a longer text is expected. The field should be rendered as a
      # [textarea](https://www.w3.org/TR/2012/WD-html-markup-20121025/textarea.html#textarea).
      GENERIC_LONG_TEXT = 2
    end
  end

  # Choice input allows the business to select one of the offered choices. Some
  # choices may be linked to additional input fields that should be displayed
  # under or next to the choice option. The value for the additional input
  # field needs to be provided only when the specific choice is selected by the
  # the business. For example, additional input field can be hidden or disabled
  # until the business selects the specific choice.
  # @!attribute [rw] options
  #   @return [::Array<::Google::Shopping::Merchant::IssueResolution::V1beta::InputField::ChoiceInput::ChoiceInputOption>]
  #     A list of choices. Only one option can be selected.
  class ChoiceInput
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A choice that the business can select.
    # @!attribute [rw] id
    #   @return [::String]
    #     Not for display but need to be sent back for the selected choice
    #     option.
    # @!attribute [rw] label
    #   @return [::Google::Shopping::Merchant::IssueResolution::V1beta::TextWithTooltip]
    #     Short description of the choice option. There may be more information
    #     to be shown as a tooltip.
    # @!attribute [rw] additional_input
    #   @return [::Google::Shopping::Merchant::IssueResolution::V1beta::InputField]
    #     Input that should be displayed when this option is selected.
    #     The additional input will not contain a `ChoiceInput`.
    class ChoiceInputOption
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Checkbox input allows the business to provide a boolean value. Corresponds
  # to the [html input
  # type=checkbox](https://www.w3.org/TR/2012/WD-html-markup-20121025/input.checkbox.html#input.checkbox).
  #
  # If the business checks the box, the input value for the field is `true`,
  # otherwise it is `false`.
  #
  # This type of input is often used as a confirmation that the business
  # completed required steps before they are allowed to start the action. In
  # such a case, the input field is marked as
  # {::Google::Shopping::Merchant::IssueResolution::V1beta::InputField#required required}
  # and the button to trigger the action should stay disabled until the
  # business checks the box.
  class CheckboxInput
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#id ⇒ ::String

Returns Not for display but need to be sent back for the given input field.

Returns:

  • (::String) —

    Not for display but need to be sent back for the given input field.



586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
 
# File 'proto_docs/google/shopping/merchant/issueresolution/v1beta/issueresolution.rb', line 586

class InputField
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Text input allows the business to provide a text value.
  # @!attribute [rw] type
  #   @return [::Google::Shopping::Merchant::IssueResolution::V1beta::InputField::TextInput::TextInputType]
  #     Type of the text input
  # @!attribute [rw] additional_info
  #   @return [::Google::Shopping::Merchant::IssueResolution::V1beta::TextWithTooltip]
  #     Additional info regarding the field to be displayed to the business. For
  #     example, warning to not include personal identifiable information. There
  #     may be more information to be shown in a tooltip.
  # @!attribute [rw] format_info
  #   @return [::String]
  #     Information about the required format. If present, it should be shown
  #     close to the input field to help the business to provide a correct value.
  #     For example: "VAT numbers should be in a format similar to SK9999999999"
  # @!attribute [rw] aria_label
  #   @return [::String]
  #     Text to be used as the
  #     [aria-label](https://www.w3.org/TR/WCAG20-TECHS/ARIA14.html) for the
  #     input.
  class TextInput
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum specifying the type of the text input and how it should be rendered.
    module TextInputType
      # Default value. Will never be provided by the API.
      TEXT_INPUT_TYPE_UNSPECIFIED = 0

      # Used when a short text is expected. The field can be rendered as a
      # [text
      # field](https://www.w3.org/TR/2012/WD-html-markup-20121025/input.text.html#input.text).
      GENERIC_SHORT_TEXT = 1

      # Used when a longer text is expected. The field should be rendered as a
      # [textarea](https://www.w3.org/TR/2012/WD-html-markup-20121025/textarea.html#textarea).
      GENERIC_LONG_TEXT = 2
    end
  end

  # Choice input allows the business to select one of the offered choices. Some
  # choices may be linked to additional input fields that should be displayed
  # under or next to the choice option. The value for the additional input
  # field needs to be provided only when the specific choice is selected by the
  # the business. For example, additional input field can be hidden or disabled
  # until the business selects the specific choice.
  # @!attribute [rw] options
  #   @return [::Array<::Google::Shopping::Merchant::IssueResolution::V1beta::InputField::ChoiceInput::ChoiceInputOption>]
  #     A list of choices. Only one option can be selected.
  class ChoiceInput
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A choice that the business can select.
    # @!attribute [rw] id
    #   @return [::String]
    #     Not for display but need to be sent back for the selected choice
    #     option.
    # @!attribute [rw] label
    #   @return [::Google::Shopping::Merchant::IssueResolution::V1beta::TextWithTooltip]
    #     Short description of the choice option. There may be more information
    #     to be shown as a tooltip.
    # @!attribute [rw] additional_input
    #   @return [::Google::Shopping::Merchant::IssueResolution::V1beta::InputField]
    #     Input that should be displayed when this option is selected.
    #     The additional input will not contain a `ChoiceInput`.
    class ChoiceInputOption
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Checkbox input allows the business to provide a boolean value. Corresponds
  # to the [html input
  # type=checkbox](https://www.w3.org/TR/2012/WD-html-markup-20121025/input.checkbox.html#input.checkbox).
  #
  # If the business checks the box, the input value for the field is `true`,
  # otherwise it is `false`.
  #
  # This type of input is often used as a confirmation that the business
  # completed required steps before they are allowed to start the action. In
  # such a case, the input field is marked as
  # {::Google::Shopping::Merchant::IssueResolution::V1beta::InputField#required required}
  # and the button to trigger the action should stay disabled until the
  # business checks the box.
  class CheckboxInput
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#label ⇒ ::Google::Shopping::Merchant::IssueResolution::V1beta::TextWithTooltip

Returns Input field label. There may be more information to be shown in a tooltip.

Returns:



586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
 
# File 'proto_docs/google/shopping/merchant/issueresolution/v1beta/issueresolution.rb', line 586

class InputField
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Text input allows the business to provide a text value.
  # @!attribute [rw] type
  #   @return [::Google::Shopping::Merchant::IssueResolution::V1beta::InputField::TextInput::TextInputType]
  #     Type of the text input
  # @!attribute [rw] additional_info
  #   @return [::Google::Shopping::Merchant::IssueResolution::V1beta::TextWithTooltip]
  #     Additional info regarding the field to be displayed to the business. For
  #     example, warning to not include personal identifiable information. There
  #     may be more information to be shown in a tooltip.
  # @!attribute [rw] format_info
  #   @return [::String]
  #     Information about the required format. If present, it should be shown
  #     close to the input field to help the business to provide a correct value.
  #     For example: "VAT numbers should be in a format similar to SK9999999999"
  # @!attribute [rw] aria_label
  #   @return [::String]
  #     Text to be used as the
  #     [aria-label](https://www.w3.org/TR/WCAG20-TECHS/ARIA14.html) for the
  #     input.
  class TextInput
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum specifying the type of the text input and how it should be rendered.
    module TextInputType
      # Default value. Will never be provided by the API.
      TEXT_INPUT_TYPE_UNSPECIFIED = 0

      # Used when a short text is expected. The field can be rendered as a
      # [text
      # field](https://www.w3.org/TR/2012/WD-html-markup-20121025/input.text.html#input.text).
      GENERIC_SHORT_TEXT = 1

      # Used when a longer text is expected. The field should be rendered as a
      # [textarea](https://www.w3.org/TR/2012/WD-html-markup-20121025/textarea.html#textarea).
      GENERIC_LONG_TEXT = 2
    end
  end

  # Choice input allows the business to select one of the offered choices. Some
  # choices may be linked to additional input fields that should be displayed
  # under or next to the choice option. The value for the additional input
  # field needs to be provided only when the specific choice is selected by the
  # the business. For example, additional input field can be hidden or disabled
  # until the business selects the specific choice.
  # @!attribute [rw] options
  #   @return [::Array<::Google::Shopping::Merchant::IssueResolution::V1beta::InputField::ChoiceInput::ChoiceInputOption>]
  #     A list of choices. Only one option can be selected.
  class ChoiceInput
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A choice that the business can select.
    # @!attribute [rw] id
    #   @return [::String]
    #     Not for display but need to be sent back for the selected choice
    #     option.
    # @!attribute [rw] label
    #   @return [::Google::Shopping::Merchant::IssueResolution::V1beta::TextWithTooltip]
    #     Short description of the choice option. There may be more information
    #     to be shown as a tooltip.
    # @!attribute [rw] additional_input
    #   @return [::Google::Shopping::Merchant::IssueResolution::V1beta::InputField]
    #     Input that should be displayed when this option is selected.
    #     The additional input will not contain a `ChoiceInput`.
    class ChoiceInputOption
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Checkbox input allows the business to provide a boolean value. Corresponds
  # to the [html input
  # type=checkbox](https://www.w3.org/TR/2012/WD-html-markup-20121025/input.checkbox.html#input.checkbox).
  #
  # If the business checks the box, the input value for the field is `true`,
  # otherwise it is `false`.
  #
  # This type of input is often used as a confirmation that the business
  # completed required steps before they are allowed to start the action. In
  # such a case, the input field is marked as
  # {::Google::Shopping::Merchant::IssueResolution::V1beta::InputField#required required}
  # and the button to trigger the action should stay disabled until the
  # business checks the box.
  class CheckboxInput
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#required ⇒ ::Boolean

Returns Whether the field is required. The action button needs to stay disabled till values for all required fields are provided.

Returns:

  • (::Boolean) —

    Whether the field is required. The action button needs to stay disabled till values for all required fields are provided.



586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
 
# File 'proto_docs/google/shopping/merchant/issueresolution/v1beta/issueresolution.rb', line 586

class InputField
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Text input allows the business to provide a text value.
  # @!attribute [rw] type
  #   @return [::Google::Shopping::Merchant::IssueResolution::V1beta::InputField::TextInput::TextInputType]
  #     Type of the text input
  # @!attribute [rw] additional_info
  #   @return [::Google::Shopping::Merchant::IssueResolution::V1beta::TextWithTooltip]
  #     Additional info regarding the field to be displayed to the business. For
  #     example, warning to not include personal identifiable information. There
  #     may be more information to be shown in a tooltip.
  # @!attribute [rw] format_info
  #   @return [::String]
  #     Information about the required format. If present, it should be shown
  #     close to the input field to help the business to provide a correct value.
  #     For example: "VAT numbers should be in a format similar to SK9999999999"
  # @!attribute [rw] aria_label
  #   @return [::String]
  #     Text to be used as the
  #     [aria-label](https://www.w3.org/TR/WCAG20-TECHS/ARIA14.html) for the
  #     input.
  class TextInput
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum specifying the type of the text input and how it should be rendered.
    module TextInputType
      # Default value. Will never be provided by the API.
      TEXT_INPUT_TYPE_UNSPECIFIED = 0

      # Used when a short text is expected. The field can be rendered as a
      # [text
      # field](https://www.w3.org/TR/2012/WD-html-markup-20121025/input.text.html#input.text).
      GENERIC_SHORT_TEXT = 1

      # Used when a longer text is expected. The field should be rendered as a
      # [textarea](https://www.w3.org/TR/2012/WD-html-markup-20121025/textarea.html#textarea).
      GENERIC_LONG_TEXT = 2
    end
  end

  # Choice input allows the business to select one of the offered choices. Some
  # choices may be linked to additional input fields that should be displayed
  # under or next to the choice option. The value for the additional input
  # field needs to be provided only when the specific choice is selected by the
  # the business. For example, additional input field can be hidden or disabled
  # until the business selects the specific choice.
  # @!attribute [rw] options
  #   @return [::Array<::Google::Shopping::Merchant::IssueResolution::V1beta::InputField::ChoiceInput::ChoiceInputOption>]
  #     A list of choices. Only one option can be selected.
  class ChoiceInput
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A choice that the business can select.
    # @!attribute [rw] id
    #   @return [::String]
    #     Not for display but need to be sent back for the selected choice
    #     option.
    # @!attribute [rw] label
    #   @return [::Google::Shopping::Merchant::IssueResolution::V1beta::TextWithTooltip]
    #     Short description of the choice option. There may be more information
    #     to be shown as a tooltip.
    # @!attribute [rw] additional_input
    #   @return [::Google::Shopping::Merchant::IssueResolution::V1beta::InputField]
    #     Input that should be displayed when this option is selected.
    #     The additional input will not contain a `ChoiceInput`.
    class ChoiceInputOption
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Checkbox input allows the business to provide a boolean value. Corresponds
  # to the [html input
  # type=checkbox](https://www.w3.org/TR/2012/WD-html-markup-20121025/input.checkbox.html#input.checkbox).
  #
  # If the business checks the box, the input value for the field is `true`,
  # otherwise it is `false`.
  #
  # This type of input is often used as a confirmation that the business
  # completed required steps before they are allowed to start the action. In
  # such a case, the input field is marked as
  # {::Google::Shopping::Merchant::IssueResolution::V1beta::InputField#required required}
  # and the button to trigger the action should stay disabled until the
  # business checks the box.
  class CheckboxInput
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#text_input ⇒ ::Google::Shopping::Merchant::IssueResolution::V1beta::InputField::TextInput

Returns Input field to provide text information. Corresponds to the html input type=text or html textarea.

Note: The following fields are mutually exclusive: text_input, choice_input, checkbox_input. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
 
# File 'proto_docs/google/shopping/merchant/issueresolution/v1beta/issueresolution.rb', line 586

class InputField
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Text input allows the business to provide a text value.
  # @!attribute [rw] type
  #   @return [::Google::Shopping::Merchant::IssueResolution::V1beta::InputField::TextInput::TextInputType]
  #     Type of the text input
  # @!attribute [rw] additional_info
  #   @return [::Google::Shopping::Merchant::IssueResolution::V1beta::TextWithTooltip]
  #     Additional info regarding the field to be displayed to the business. For
  #     example, warning to not include personal identifiable information. There
  #     may be more information to be shown in a tooltip.
  # @!attribute [rw] format_info
  #   @return [::String]
  #     Information about the required format. If present, it should be shown
  #     close to the input field to help the business to provide a correct value.
  #     For example: "VAT numbers should be in a format similar to SK9999999999"
  # @!attribute [rw] aria_label
  #   @return [::String]
  #     Text to be used as the
  #     [aria-label](https://www.w3.org/TR/WCAG20-TECHS/ARIA14.html) for the
  #     input.
  class TextInput
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum specifying the type of the text input and how it should be rendered.
    module TextInputType
      # Default value. Will never be provided by the API.
      TEXT_INPUT_TYPE_UNSPECIFIED = 0

      # Used when a short text is expected. The field can be rendered as a
      # [text
      # field](https://www.w3.org/TR/2012/WD-html-markup-20121025/input.text.html#input.text).
      GENERIC_SHORT_TEXT = 1

      # Used when a longer text is expected. The field should be rendered as a
      # [textarea](https://www.w3.org/TR/2012/WD-html-markup-20121025/textarea.html#textarea).
      GENERIC_LONG_TEXT = 2
    end
  end

  # Choice input allows the business to select one of the offered choices. Some
  # choices may be linked to additional input fields that should be displayed
  # under or next to the choice option. The value for the additional input
  # field needs to be provided only when the specific choice is selected by the
  # the business. For example, additional input field can be hidden or disabled
  # until the business selects the specific choice.
  # @!attribute [rw] options
  #   @return [::Array<::Google::Shopping::Merchant::IssueResolution::V1beta::InputField::ChoiceInput::ChoiceInputOption>]
  #     A list of choices. Only one option can be selected.
  class ChoiceInput
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A choice that the business can select.
    # @!attribute [rw] id
    #   @return [::String]
    #     Not for display but need to be sent back for the selected choice
    #     option.
    # @!attribute [rw] label
    #   @return [::Google::Shopping::Merchant::IssueResolution::V1beta::TextWithTooltip]
    #     Short description of the choice option. There may be more information
    #     to be shown as a tooltip.
    # @!attribute [rw] additional_input
    #   @return [::Google::Shopping::Merchant::IssueResolution::V1beta::InputField]
    #     Input that should be displayed when this option is selected.
    #     The additional input will not contain a `ChoiceInput`.
    class ChoiceInputOption
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Checkbox input allows the business to provide a boolean value. Corresponds
  # to the [html input
  # type=checkbox](https://www.w3.org/TR/2012/WD-html-markup-20121025/input.checkbox.html#input.checkbox).
  #
  # If the business checks the box, the input value for the field is `true`,
  # otherwise it is `false`.
  #
  # This type of input is often used as a confirmation that the business
  # completed required steps before they are allowed to start the action. In
  # such a case, the input field is marked as
  # {::Google::Shopping::Merchant::IssueResolution::V1beta::InputField#required required}
  # and the button to trigger the action should stay disabled until the
  # business checks the box.
  class CheckboxInput
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end