Class: Google::Shopping::Merchant::IssueResolution::V1beta::Action

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

An actionable step that can be executed to solve the issue.

Defined Under Namespace

Classes: Reason

Instance Attribute Summary collapse

Instance Attribute Details

#builtin_simple_action ⇒ ::Google::Shopping::Merchant::IssueResolution::V1beta::BuiltInSimpleAction

Returns Action implemented and performed in (your) third-party application. The application should point the business to the place, where they can access the corresponding functionality or provide instructions, if the specific functionality is not available.

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

Returns:

  • (::Google::Shopping::Merchant::IssueResolution::V1beta::BuiltInSimpleAction) —

    Action implemented and performed in (your) third-party application. The application should point the business to the place, where they can access the corresponding functionality or provide instructions, if the specific functionality is not available.

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



364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'proto_docs/google/shopping/merchant/issueresolution/v1beta/issueresolution.rb', line 364

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

  # A single reason why the action is not available.
  # @!attribute [rw] message
  #   @return [::String]
  #     Messages summarizing the reason, why the action is not available.
  #     For example: "Review requested on Jan 03. Review requests can take a few
  #     days to complete."
  # @!attribute [rw] detail
  #   @return [::String]
  #     Detailed explanation of the reason. Should be displayed as a hint if
  #     present.
  # @!attribute [rw] action
  #   @return [::Google::Shopping::Merchant::IssueResolution::V1beta::Action]
  #     Optional. An action that needs to be performed to solve the problem
  #     represented by this reason. This action will always be available. Should
  #     be rendered as a link or button next to the summarizing message.
  #
  #     For example, the review may be available only once the business configure
  #     all required attributes. In such a situation this action can be a link to
  #     the form, where they can fill the missing attribute to unblock the main
  #     action.
  class Reason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#builtin_user_input_action ⇒ ::Google::Shopping::Merchant::IssueResolution::V1beta::BuiltInUserInputAction

Returns Action implemented and performed in (your) third-party application. The application needs to show an additional content and input form to the business as specified for given action. They can trigger the action only when they provided all required inputs.

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

Returns:

  • (::Google::Shopping::Merchant::IssueResolution::V1beta::BuiltInUserInputAction) —

    Action implemented and performed in (your) third-party application. The application needs to show an additional content and input form to the business as specified for given action. They can trigger the action only when they provided all required inputs.

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



364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'proto_docs/google/shopping/merchant/issueresolution/v1beta/issueresolution.rb', line 364

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

  # A single reason why the action is not available.
  # @!attribute [rw] message
  #   @return [::String]
  #     Messages summarizing the reason, why the action is not available.
  #     For example: "Review requested on Jan 03. Review requests can take a few
  #     days to complete."
  # @!attribute [rw] detail
  #   @return [::String]
  #     Detailed explanation of the reason. Should be displayed as a hint if
  #     present.
  # @!attribute [rw] action
  #   @return [::Google::Shopping::Merchant::IssueResolution::V1beta::Action]
  #     Optional. An action that needs to be performed to solve the problem
  #     represented by this reason. This action will always be available. Should
  #     be rendered as a link or button next to the summarizing message.
  #
  #     For example, the review may be available only once the business configure
  #     all required attributes. In such a situation this action can be a link to
  #     the form, where they can fill the missing attribute to unblock the main
  #     action.
  class Reason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#button_label ⇒ ::String

Returns Label of the action button.

Returns:

  • (::String) —

    Label of the action button.



364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'proto_docs/google/shopping/merchant/issueresolution/v1beta/issueresolution.rb', line 364

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

  # A single reason why the action is not available.
  # @!attribute [rw] message
  #   @return [::String]
  #     Messages summarizing the reason, why the action is not available.
  #     For example: "Review requested on Jan 03. Review requests can take a few
  #     days to complete."
  # @!attribute [rw] detail
  #   @return [::String]
  #     Detailed explanation of the reason. Should be displayed as a hint if
  #     present.
  # @!attribute [rw] action
  #   @return [::Google::Shopping::Merchant::IssueResolution::V1beta::Action]
  #     Optional. An action that needs to be performed to solve the problem
  #     represented by this reason. This action will always be available. Should
  #     be rendered as a link or button next to the summarizing message.
  #
  #     For example, the review may be available only once the business configure
  #     all required attributes. In such a situation this action can be a link to
  #     the form, where they can fill the missing attribute to unblock the main
  #     action.
  class Reason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#external_action ⇒ ::Google::Shopping::Merchant::IssueResolution::V1beta::ExternalAction

Returns Action that is implemented and performed outside of (your) third-party application. The application needs to redirect the business to the external location where they can perform the action.

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

Returns:

  • (::Google::Shopping::Merchant::IssueResolution::V1beta::ExternalAction) —

    Action that is implemented and performed outside of (your) third-party application. The application needs to redirect the business to the external location where they can perform the action.

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



364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'proto_docs/google/shopping/merchant/issueresolution/v1beta/issueresolution.rb', line 364

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

  # A single reason why the action is not available.
  # @!attribute [rw] message
  #   @return [::String]
  #     Messages summarizing the reason, why the action is not available.
  #     For example: "Review requested on Jan 03. Review requests can take a few
  #     days to complete."
  # @!attribute [rw] detail
  #   @return [::String]
  #     Detailed explanation of the reason. Should be displayed as a hint if
  #     present.
  # @!attribute [rw] action
  #   @return [::Google::Shopping::Merchant::IssueResolution::V1beta::Action]
  #     Optional. An action that needs to be performed to solve the problem
  #     represented by this reason. This action will always be available. Should
  #     be rendered as a link or button next to the summarizing message.
  #
  #     For example, the review may be available only once the business configure
  #     all required attributes. In such a situation this action can be a link to
  #     the form, where they can fill the missing attribute to unblock the main
  #     action.
  class Reason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#is_available ⇒ ::Boolean

Returns Controlling whether the button is active or disabled. The value is 'false' when the action was already requested or is not available. If the action is not available then a reason will be present. If (your) third-party application shows a disabled button for action that is not available, then it should also show reasons.

Returns:

  • (::Boolean) —

    Controlling whether the button is active or disabled. The value is 'false' when the action was already requested or is not available. If the action is not available then a reason will be present. If (your) third-party application shows a disabled button for action that is not available, then it should also show reasons.



364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'proto_docs/google/shopping/merchant/issueresolution/v1beta/issueresolution.rb', line 364

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

  # A single reason why the action is not available.
  # @!attribute [rw] message
  #   @return [::String]
  #     Messages summarizing the reason, why the action is not available.
  #     For example: "Review requested on Jan 03. Review requests can take a few
  #     days to complete."
  # @!attribute [rw] detail
  #   @return [::String]
  #     Detailed explanation of the reason. Should be displayed as a hint if
  #     present.
  # @!attribute [rw] action
  #   @return [::Google::Shopping::Merchant::IssueResolution::V1beta::Action]
  #     Optional. An action that needs to be performed to solve the problem
  #     represented by this reason. This action will always be available. Should
  #     be rendered as a link or button next to the summarizing message.
  #
  #     For example, the review may be available only once the business configure
  #     all required attributes. In such a situation this action can be a link to
  #     the form, where they can fill the missing attribute to unblock the main
  #     action.
  class Reason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#reasons ⇒ ::Array<::Google::Shopping::Merchant::IssueResolution::V1beta::Action::Reason>

Returns List of reasons why the action is not available. The list of reasons is empty if the action is available. If there is only one reason, it can be displayed next to the disabled button. If there are more reasons, all of them should be displayed, for example in a pop-up dialog.

Returns:

  • (::Array<::Google::Shopping::Merchant::IssueResolution::V1beta::Action::Reason>) —

    List of reasons why the action is not available. The list of reasons is empty if the action is available. If there is only one reason, it can be displayed next to the disabled button. If there are more reasons, all of them should be displayed, for example in a pop-up dialog.



364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'proto_docs/google/shopping/merchant/issueresolution/v1beta/issueresolution.rb', line 364

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

  # A single reason why the action is not available.
  # @!attribute [rw] message
  #   @return [::String]
  #     Messages summarizing the reason, why the action is not available.
  #     For example: "Review requested on Jan 03. Review requests can take a few
  #     days to complete."
  # @!attribute [rw] detail
  #   @return [::String]
  #     Detailed explanation of the reason. Should be displayed as a hint if
  #     present.
  # @!attribute [rw] action
  #   @return [::Google::Shopping::Merchant::IssueResolution::V1beta::Action]
  #     Optional. An action that needs to be performed to solve the problem
  #     represented by this reason. This action will always be available. Should
  #     be rendered as a link or button next to the summarizing message.
  #
  #     For example, the review may be available only once the business configure
  #     all required attributes. In such a situation this action can be a link to
  #     the form, where they can fill the missing attribute to unblock the main
  #     action.
  class Reason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end