Class: Google::Shopping::Merchant::Reviews::V1beta::MerchantReviewAttributes

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

Overview

Attributes.

Defined Under Namespace

Modules: CollectionMethod

Instance Attribute Summary collapse

Instance Attribute Details

#collection_method ⇒ ::Google::Shopping::Merchant::Reviews::V1beta::MerchantReviewAttributes::CollectionMethod

Returns Optional. The method used to collect the review.

Returns:



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/shopping/merchant/reviews/v1beta/merchantreviews_common.rb', line 87

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

  # The method used to collect the review.
  module CollectionMethod
    # Collection method unspecified.
    COLLECTION_METHOD_UNSPECIFIED = 0

    # The user was not responding to a specific solicitation when they
    # submitted the review.
    MERCHANT_UNSOLICITED = 1

    # The user submitted the review in response to a solicitation when the
    # user placed an order.
    POINT_OF_SALE = 2

    # The user submitted the review in response to a solicitation after
    # fulfillment of the user's order.
    AFTER_FULFILLMENT = 3
  end
end

#content ⇒ ::String

Returns Required. This should be any freeform text provided by the user and should not be truncated. If multiple responses to different questions are provided, all responses should be included, with the minimal context for the responses to make sense. Context should not be provided if questions were left unanswered.

Returns:

  • (::String) —

    Required. This should be any freeform text provided by the user and should not be truncated. If multiple responses to different questions are provided, all responses should be included, with the minimal context for the responses to make sense. Context should not be provided if questions were left unanswered.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/shopping/merchant/reviews/v1beta/merchantreviews_common.rb', line 87

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

  # The method used to collect the review.
  module CollectionMethod
    # Collection method unspecified.
    COLLECTION_METHOD_UNSPECIFIED = 0

    # The user was not responding to a specific solicitation when they
    # submitted the review.
    MERCHANT_UNSOLICITED = 1

    # The user submitted the review in response to a solicitation when the
    # user placed an order.
    POINT_OF_SALE = 2

    # The user submitted the review in response to a solicitation after
    # fulfillment of the user's order.
    AFTER_FULFILLMENT = 3
  end
end

#is_anonymous ⇒ ::Boolean

Returns Optional. Set to true if the reviewer should remain anonymous.

Returns:

  • (::Boolean) —

    Optional. Set to true if the reviewer should remain anonymous.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/shopping/merchant/reviews/v1beta/merchantreviews_common.rb', line 87

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

  # The method used to collect the review.
  module CollectionMethod
    # Collection method unspecified.
    COLLECTION_METHOD_UNSPECIFIED = 0

    # The user was not responding to a specific solicitation when they
    # submitted the review.
    MERCHANT_UNSOLICITED = 1

    # The user submitted the review in response to a solicitation when the
    # user placed an order.
    POINT_OF_SALE = 2

    # The user submitted the review in response to a solicitation after
    # fulfillment of the user's order.
    AFTER_FULFILLMENT = 3
  end
end

#max_rating ⇒ ::Integer

Returns Optional. The maximum possible number for the rating. The value of the max rating must be greater than the value of the min rating.

Returns:

  • (::Integer) —

    Optional. The maximum possible number for the rating. The value of the max rating must be greater than the value of the min rating.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/shopping/merchant/reviews/v1beta/merchantreviews_common.rb', line 87

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

  # The method used to collect the review.
  module CollectionMethod
    # Collection method unspecified.
    COLLECTION_METHOD_UNSPECIFIED = 0

    # The user was not responding to a specific solicitation when they
    # submitted the review.
    MERCHANT_UNSOLICITED = 1

    # The user submitted the review in response to a solicitation when the
    # user placed an order.
    POINT_OF_SALE = 2

    # The user submitted the review in response to a solicitation after
    # fulfillment of the user's order.
    AFTER_FULFILLMENT = 3
  end
end

#merchant_display_name ⇒ ::String

Returns Optional. Human-readable display name for the merchant.

Returns:

  • (::String) —

    Optional. Human-readable display name for the merchant.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/shopping/merchant/reviews/v1beta/merchantreviews_common.rb', line 87

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

  # The method used to collect the review.
  module CollectionMethod
    # Collection method unspecified.
    COLLECTION_METHOD_UNSPECIFIED = 0

    # The user was not responding to a specific solicitation when they
    # submitted the review.
    MERCHANT_UNSOLICITED = 1

    # The user submitted the review in response to a solicitation when the
    # user placed an order.
    POINT_OF_SALE = 2

    # The user submitted the review in response to a solicitation after
    # fulfillment of the user's order.
    AFTER_FULFILLMENT = 3
  end
end

#merchant_id ⇒ ::String

Returns Required. Must be unique and stable across all requests. In other words, if a request today and another 90 days ago refer to the same merchant, they must have the same id.

Returns:

  • (::String) —

    Required. Must be unique and stable across all requests. In other words, if a request today and another 90 days ago refer to the same merchant, they must have the same id.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/shopping/merchant/reviews/v1beta/merchantreviews_common.rb', line 87

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

  # The method used to collect the review.
  module CollectionMethod
    # Collection method unspecified.
    COLLECTION_METHOD_UNSPECIFIED = 0

    # The user was not responding to a specific solicitation when they
    # submitted the review.
    MERCHANT_UNSOLICITED = 1

    # The user submitted the review in response to a solicitation when the
    # user placed an order.
    POINT_OF_SALE = 2

    # The user submitted the review in response to a solicitation after
    # fulfillment of the user's order.
    AFTER_FULFILLMENT = 3
  end
end

#merchant_link ⇒ ::String

Returns Optional. URL to the merchant's main website. Do not use a redirect URL for this value. In other words, the value should point directly to the merchant's site.

Returns:

  • (::String) —

    Optional. URL to the merchant's main website. Do not use a redirect URL for this value. In other words, the value should point directly to the merchant's site.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/shopping/merchant/reviews/v1beta/merchantreviews_common.rb', line 87

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

  # The method used to collect the review.
  module CollectionMethod
    # Collection method unspecified.
    COLLECTION_METHOD_UNSPECIFIED = 0

    # The user was not responding to a specific solicitation when they
    # submitted the review.
    MERCHANT_UNSOLICITED = 1

    # The user submitted the review in response to a solicitation when the
    # user placed an order.
    POINT_OF_SALE = 2

    # The user submitted the review in response to a solicitation after
    # fulfillment of the user's order.
    AFTER_FULFILLMENT = 3
  end
end

#merchant_rating_link ⇒ ::String

Returns Optional. URL to the landing page that hosts the reviews for this merchant. Do not use a redirect URL.

Returns:

  • (::String) —

    Optional. URL to the landing page that hosts the reviews for this merchant. Do not use a redirect URL.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/shopping/merchant/reviews/v1beta/merchantreviews_common.rb', line 87

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

  # The method used to collect the review.
  module CollectionMethod
    # Collection method unspecified.
    COLLECTION_METHOD_UNSPECIFIED = 0

    # The user was not responding to a specific solicitation when they
    # submitted the review.
    MERCHANT_UNSOLICITED = 1

    # The user submitted the review in response to a solicitation when the
    # user placed an order.
    POINT_OF_SALE = 2

    # The user submitted the review in response to a solicitation after
    # fulfillment of the user's order.
    AFTER_FULFILLMENT = 3
  end
end

#min_rating ⇒ ::Integer

Returns Optional. The minimum possible number for the rating. This should be the worst possible rating and should not be a value for no rating.

Returns:

  • (::Integer) —

    Optional. The minimum possible number for the rating. This should be the worst possible rating and should not be a value for no rating.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/shopping/merchant/reviews/v1beta/merchantreviews_common.rb', line 87

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

  # The method used to collect the review.
  module CollectionMethod
    # Collection method unspecified.
    COLLECTION_METHOD_UNSPECIFIED = 0

    # The user was not responding to a specific solicitation when they
    # submitted the review.
    MERCHANT_UNSOLICITED = 1

    # The user submitted the review in response to a solicitation when the
    # user placed an order.
    POINT_OF_SALE = 2

    # The user submitted the review in response to a solicitation after
    # fulfillment of the user's order.
    AFTER_FULFILLMENT = 3
  end
end

#rating ⇒ ::Float

Returns Optional. The reviewer's overall rating of the merchant.

Returns:

  • (::Float) —

    Optional. The reviewer's overall rating of the merchant.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/shopping/merchant/reviews/v1beta/merchantreviews_common.rb', line 87

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

  # The method used to collect the review.
  module CollectionMethod
    # Collection method unspecified.
    COLLECTION_METHOD_UNSPECIFIED = 0

    # The user was not responding to a specific solicitation when they
    # submitted the review.
    MERCHANT_UNSOLICITED = 1

    # The user submitted the review in response to a solicitation when the
    # user placed an order.
    POINT_OF_SALE = 2

    # The user submitted the review in response to a solicitation after
    # fulfillment of the user's order.
    AFTER_FULFILLMENT = 3
  end
end

#review_country ⇒ ::String

Returns Optional. The country where the reviewer made the order defined by ISO 3166-1 Alpha-2 Country Code.

Returns:

  • (::String) —

    Optional. The country where the reviewer made the order defined by ISO 3166-1 Alpha-2 Country Code.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/shopping/merchant/reviews/v1beta/merchantreviews_common.rb', line 87

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

  # The method used to collect the review.
  module CollectionMethod
    # Collection method unspecified.
    COLLECTION_METHOD_UNSPECIFIED = 0

    # The user was not responding to a specific solicitation when they
    # submitted the review.
    MERCHANT_UNSOLICITED = 1

    # The user submitted the review in response to a solicitation when the
    # user placed an order.
    POINT_OF_SALE = 2

    # The user submitted the review in response to a solicitation after
    # fulfillment of the user's order.
    AFTER_FULFILLMENT = 3
  end
end

#review_language ⇒ ::String

Returns Optional. The language of the review defined by BCP-47 language code.

Returns:

  • (::String) —

    Optional. The language of the review defined by BCP-47 language code.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/shopping/merchant/reviews/v1beta/merchantreviews_common.rb', line 87

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

  # The method used to collect the review.
  module CollectionMethod
    # Collection method unspecified.
    COLLECTION_METHOD_UNSPECIFIED = 0

    # The user was not responding to a specific solicitation when they
    # submitted the review.
    MERCHANT_UNSOLICITED = 1

    # The user submitted the review in response to a solicitation when the
    # user placed an order.
    POINT_OF_SALE = 2

    # The user submitted the review in response to a solicitation after
    # fulfillment of the user's order.
    AFTER_FULFILLMENT = 3
  end
end

#review_time ⇒ ::Google::Protobuf::Timestamp

Returns Required. The timestamp indicating when the review was written.

Returns:



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/shopping/merchant/reviews/v1beta/merchantreviews_common.rb', line 87

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

  # The method used to collect the review.
  module CollectionMethod
    # Collection method unspecified.
    COLLECTION_METHOD_UNSPECIFIED = 0

    # The user was not responding to a specific solicitation when they
    # submitted the review.
    MERCHANT_UNSOLICITED = 1

    # The user submitted the review in response to a solicitation when the
    # user placed an order.
    POINT_OF_SALE = 2

    # The user submitted the review in response to a solicitation after
    # fulfillment of the user's order.
    AFTER_FULFILLMENT = 3
  end
end

#reviewer_id ⇒ ::String

Returns Optional. A permanent, unique identifier for the author of the review in the publisher's system.

Returns:

  • (::String) —

    Optional. A permanent, unique identifier for the author of the review in the publisher's system.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/shopping/merchant/reviews/v1beta/merchantreviews_common.rb', line 87

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

  # The method used to collect the review.
  module CollectionMethod
    # Collection method unspecified.
    COLLECTION_METHOD_UNSPECIFIED = 0

    # The user was not responding to a specific solicitation when they
    # submitted the review.
    MERCHANT_UNSOLICITED = 1

    # The user submitted the review in response to a solicitation when the
    # user placed an order.
    POINT_OF_SALE = 2

    # The user submitted the review in response to a solicitation after
    # fulfillment of the user's order.
    AFTER_FULFILLMENT = 3
  end
end

#reviewer_username ⇒ ::String

Returns Optional. Display name of the review author.

Returns:

  • (::String) —

    Optional. Display name of the review author.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/shopping/merchant/reviews/v1beta/merchantreviews_common.rb', line 87

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

  # The method used to collect the review.
  module CollectionMethod
    # Collection method unspecified.
    COLLECTION_METHOD_UNSPECIFIED = 0

    # The user was not responding to a specific solicitation when they
    # submitted the review.
    MERCHANT_UNSOLICITED = 1

    # The user submitted the review in response to a solicitation when the
    # user placed an order.
    POINT_OF_SALE = 2

    # The user submitted the review in response to a solicitation after
    # fulfillment of the user's order.
    AFTER_FULFILLMENT = 3
  end
end

#title ⇒ ::String

Returns Optional. The title of the review.

Returns:

  • (::String) —

    Optional. The title of the review.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/shopping/merchant/reviews/v1beta/merchantreviews_common.rb', line 87

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

  # The method used to collect the review.
  module CollectionMethod
    # Collection method unspecified.
    COLLECTION_METHOD_UNSPECIFIED = 0

    # The user was not responding to a specific solicitation when they
    # submitted the review.
    MERCHANT_UNSOLICITED = 1

    # The user submitted the review in response to a solicitation when the
    # user placed an order.
    POINT_OF_SALE = 2

    # The user submitted the review in response to a solicitation after
    # fulfillment of the user's order.
    AFTER_FULFILLMENT = 3
  end
end