Class: Google::Cloud::RecaptchaEnterprise::V1beta1::AnnotateAssessmentRequest
- Inherits:
-
Object
- Object
- Google::Cloud::RecaptchaEnterprise::V1beta1::AnnotateAssessmentRequest
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.rb
Overview
The request message to annotate an Assessment.
Defined Under Namespace
Modules: Annotation, Reason
Instance Attribute Summary collapse
-
#annotation ⇒ ::Google::Cloud::RecaptchaEnterprise::V1beta1::AnnotateAssessmentRequest::Annotation
Optional.
-
#hashed_account_id ⇒ ::String
Optional.
-
#name ⇒ ::String
Required.
-
#reasons ⇒ ::Array<::Google::Cloud::RecaptchaEnterprise::V1beta1::AnnotateAssessmentRequest::Reason>
Optional.
-
#transaction_event ⇒ ::Google::Cloud::RecaptchaEnterprise::V1beta1::TransactionEvent
Optional.
Instance Attribute Details
#annotation ⇒ ::Google::Cloud::RecaptchaEnterprise::V1beta1::AnnotateAssessmentRequest::Annotation
Returns Optional. The annotation that will be assigned to the Event. This field can be left empty to provide reasons that apply to an event without concluding whether the event is legitimate or fraudulent.
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 |
# File 'proto_docs/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.rb', line 182 class AnnotateAssessmentRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Enum that represents the types of annotations. module Annotation # Default unspecified type. ANNOTATION_UNSPECIFIED = 0 # Provides information that the event turned out to be legitimate. LEGITIMATE = 1 # Provides information that the event turned out to be fraudulent. FRAUDULENT = 2 # Provides information that the event was related to a login event in which # the user typed the correct password. Deprecated, prefer indicating # CORRECT_PASSWORD through the reasons field instead. PASSWORD_CORRECT = 3 # Provides information that the event was related to a login event in which # the user typed the incorrect password. Deprecated, prefer indicating # INCORRECT_PASSWORD through the reasons field instead. PASSWORD_INCORRECT = 4 end # Enum that represents potential reasons for annotating an assessment. module Reason # Default unspecified reason. REASON_UNSPECIFIED = 0 # Indicates that the transaction had a chargeback issued with no other # details. When possible, specify the type by using CHARGEBACK_FRAUD or # CHARGEBACK_DISPUTE instead. CHARGEBACK = 1 # Indicates that the transaction had a chargeback issued related to an # alleged unauthorized transaction from the cardholder's perspective (for # example, the card number was stolen). CHARGEBACK_FRAUD = 8 # Indicates that the transaction had a chargeback issued related to the # cardholder having provided their card details but allegedly not being # satisfied with the purchase (for example, misrepresentation, attempted # cancellation). CHARGEBACK_DISPUTE = 9 # Indicates that the completed payment transaction was refunded by the # seller. REFUND = 10 # Indicates that the completed payment transaction was determined to be # fraudulent by the seller, and was cancelled and refunded as a result. REFUND_FRAUD = 11 # Indicates that the payment transaction was accepted, and the user was # charged. TRANSACTION_ACCEPTED = 12 # Indicates that the payment transaction was declined, for example due to # invalid card details. TRANSACTION_DECLINED = 13 # Indicates the transaction associated with the assessment is suspected of # being fraudulent based on the payment method, billing details, shipping # address or other transaction information. PAYMENT_HEURISTICS = 2 # Indicates that the user was served a 2FA challenge. An old assessment # with `ENUM_VALUES.INITIATED_TWO_FACTOR` reason that has not been # overwritten with `PASSED_TWO_FACTOR` is treated as an abandoned 2FA flow. # This is equivalent to `FAILED_TWO_FACTOR`. INITIATED_TWO_FACTOR = 7 # Indicates that the user passed a 2FA challenge. PASSED_TWO_FACTOR = 3 # Indicates that the user failed a 2FA challenge. FAILED_TWO_FACTOR = 4 # Indicates the user provided the correct password. CORRECT_PASSWORD = 5 # Indicates the user provided an incorrect password. INCORRECT_PASSWORD = 6 # Indicates that the user sent unwanted and abusive messages to other users # of the platform, such as spam, scams, phishing, or social engineering. SOCIAL_SPAM = 14 end end |
#hashed_account_id ⇒ ::String
Returns Optional. Unique stable hashed user identifier to apply to the assessment.
This is an alternative to setting the hashed_account_id
in
CreateAssessment
, for example, when the account identifier is not yet
known in the initial request. It is recommended that the identifier is
hashed using hmac-sha256 with stable secret.
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 |
# File 'proto_docs/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.rb', line 182 class AnnotateAssessmentRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Enum that represents the types of annotations. module Annotation # Default unspecified type. ANNOTATION_UNSPECIFIED = 0 # Provides information that the event turned out to be legitimate. LEGITIMATE = 1 # Provides information that the event turned out to be fraudulent. FRAUDULENT = 2 # Provides information that the event was related to a login event in which # the user typed the correct password. Deprecated, prefer indicating # CORRECT_PASSWORD through the reasons field instead. PASSWORD_CORRECT = 3 # Provides information that the event was related to a login event in which # the user typed the incorrect password. Deprecated, prefer indicating # INCORRECT_PASSWORD through the reasons field instead. PASSWORD_INCORRECT = 4 end # Enum that represents potential reasons for annotating an assessment. module Reason # Default unspecified reason. REASON_UNSPECIFIED = 0 # Indicates that the transaction had a chargeback issued with no other # details. When possible, specify the type by using CHARGEBACK_FRAUD or # CHARGEBACK_DISPUTE instead. CHARGEBACK = 1 # Indicates that the transaction had a chargeback issued related to an # alleged unauthorized transaction from the cardholder's perspective (for # example, the card number was stolen). CHARGEBACK_FRAUD = 8 # Indicates that the transaction had a chargeback issued related to the # cardholder having provided their card details but allegedly not being # satisfied with the purchase (for example, misrepresentation, attempted # cancellation). CHARGEBACK_DISPUTE = 9 # Indicates that the completed payment transaction was refunded by the # seller. REFUND = 10 # Indicates that the completed payment transaction was determined to be # fraudulent by the seller, and was cancelled and refunded as a result. REFUND_FRAUD = 11 # Indicates that the payment transaction was accepted, and the user was # charged. TRANSACTION_ACCEPTED = 12 # Indicates that the payment transaction was declined, for example due to # invalid card details. TRANSACTION_DECLINED = 13 # Indicates the transaction associated with the assessment is suspected of # being fraudulent based on the payment method, billing details, shipping # address or other transaction information. PAYMENT_HEURISTICS = 2 # Indicates that the user was served a 2FA challenge. An old assessment # with `ENUM_VALUES.INITIATED_TWO_FACTOR` reason that has not been # overwritten with `PASSED_TWO_FACTOR` is treated as an abandoned 2FA flow. # This is equivalent to `FAILED_TWO_FACTOR`. INITIATED_TWO_FACTOR = 7 # Indicates that the user passed a 2FA challenge. PASSED_TWO_FACTOR = 3 # Indicates that the user failed a 2FA challenge. FAILED_TWO_FACTOR = 4 # Indicates the user provided the correct password. CORRECT_PASSWORD = 5 # Indicates the user provided an incorrect password. INCORRECT_PASSWORD = 6 # Indicates that the user sent unwanted and abusive messages to other users # of the platform, such as spam, scams, phishing, or social engineering. SOCIAL_SPAM = 14 end end |
#name ⇒ ::String
Returns Required. The resource name of the Assessment, in the format
projects/{project_number}/assessments/{assessment_id}
.
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 |
# File 'proto_docs/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.rb', line 182 class AnnotateAssessmentRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Enum that represents the types of annotations. module Annotation # Default unspecified type. ANNOTATION_UNSPECIFIED = 0 # Provides information that the event turned out to be legitimate. LEGITIMATE = 1 # Provides information that the event turned out to be fraudulent. FRAUDULENT = 2 # Provides information that the event was related to a login event in which # the user typed the correct password. Deprecated, prefer indicating # CORRECT_PASSWORD through the reasons field instead. PASSWORD_CORRECT = 3 # Provides information that the event was related to a login event in which # the user typed the incorrect password. Deprecated, prefer indicating # INCORRECT_PASSWORD through the reasons field instead. PASSWORD_INCORRECT = 4 end # Enum that represents potential reasons for annotating an assessment. module Reason # Default unspecified reason. REASON_UNSPECIFIED = 0 # Indicates that the transaction had a chargeback issued with no other # details. When possible, specify the type by using CHARGEBACK_FRAUD or # CHARGEBACK_DISPUTE instead. CHARGEBACK = 1 # Indicates that the transaction had a chargeback issued related to an # alleged unauthorized transaction from the cardholder's perspective (for # example, the card number was stolen). CHARGEBACK_FRAUD = 8 # Indicates that the transaction had a chargeback issued related to the # cardholder having provided their card details but allegedly not being # satisfied with the purchase (for example, misrepresentation, attempted # cancellation). CHARGEBACK_DISPUTE = 9 # Indicates that the completed payment transaction was refunded by the # seller. REFUND = 10 # Indicates that the completed payment transaction was determined to be # fraudulent by the seller, and was cancelled and refunded as a result. REFUND_FRAUD = 11 # Indicates that the payment transaction was accepted, and the user was # charged. TRANSACTION_ACCEPTED = 12 # Indicates that the payment transaction was declined, for example due to # invalid card details. TRANSACTION_DECLINED = 13 # Indicates the transaction associated with the assessment is suspected of # being fraudulent based on the payment method, billing details, shipping # address or other transaction information. PAYMENT_HEURISTICS = 2 # Indicates that the user was served a 2FA challenge. An old assessment # with `ENUM_VALUES.INITIATED_TWO_FACTOR` reason that has not been # overwritten with `PASSED_TWO_FACTOR` is treated as an abandoned 2FA flow. # This is equivalent to `FAILED_TWO_FACTOR`. INITIATED_TWO_FACTOR = 7 # Indicates that the user passed a 2FA challenge. PASSED_TWO_FACTOR = 3 # Indicates that the user failed a 2FA challenge. FAILED_TWO_FACTOR = 4 # Indicates the user provided the correct password. CORRECT_PASSWORD = 5 # Indicates the user provided an incorrect password. INCORRECT_PASSWORD = 6 # Indicates that the user sent unwanted and abusive messages to other users # of the platform, such as spam, scams, phishing, or social engineering. SOCIAL_SPAM = 14 end end |
#reasons ⇒ ::Array<::Google::Cloud::RecaptchaEnterprise::V1beta1::AnnotateAssessmentRequest::Reason>
Returns Optional. Reasons for the annotation that are assigned to the event.
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 |
# File 'proto_docs/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.rb', line 182 class AnnotateAssessmentRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Enum that represents the types of annotations. module Annotation # Default unspecified type. ANNOTATION_UNSPECIFIED = 0 # Provides information that the event turned out to be legitimate. LEGITIMATE = 1 # Provides information that the event turned out to be fraudulent. FRAUDULENT = 2 # Provides information that the event was related to a login event in which # the user typed the correct password. Deprecated, prefer indicating # CORRECT_PASSWORD through the reasons field instead. PASSWORD_CORRECT = 3 # Provides information that the event was related to a login event in which # the user typed the incorrect password. Deprecated, prefer indicating # INCORRECT_PASSWORD through the reasons field instead. PASSWORD_INCORRECT = 4 end # Enum that represents potential reasons for annotating an assessment. module Reason # Default unspecified reason. REASON_UNSPECIFIED = 0 # Indicates that the transaction had a chargeback issued with no other # details. When possible, specify the type by using CHARGEBACK_FRAUD or # CHARGEBACK_DISPUTE instead. CHARGEBACK = 1 # Indicates that the transaction had a chargeback issued related to an # alleged unauthorized transaction from the cardholder's perspective (for # example, the card number was stolen). CHARGEBACK_FRAUD = 8 # Indicates that the transaction had a chargeback issued related to the # cardholder having provided their card details but allegedly not being # satisfied with the purchase (for example, misrepresentation, attempted # cancellation). CHARGEBACK_DISPUTE = 9 # Indicates that the completed payment transaction was refunded by the # seller. REFUND = 10 # Indicates that the completed payment transaction was determined to be # fraudulent by the seller, and was cancelled and refunded as a result. REFUND_FRAUD = 11 # Indicates that the payment transaction was accepted, and the user was # charged. TRANSACTION_ACCEPTED = 12 # Indicates that the payment transaction was declined, for example due to # invalid card details. TRANSACTION_DECLINED = 13 # Indicates the transaction associated with the assessment is suspected of # being fraudulent based on the payment method, billing details, shipping # address or other transaction information. PAYMENT_HEURISTICS = 2 # Indicates that the user was served a 2FA challenge. An old assessment # with `ENUM_VALUES.INITIATED_TWO_FACTOR` reason that has not been # overwritten with `PASSED_TWO_FACTOR` is treated as an abandoned 2FA flow. # This is equivalent to `FAILED_TWO_FACTOR`. INITIATED_TWO_FACTOR = 7 # Indicates that the user passed a 2FA challenge. PASSED_TWO_FACTOR = 3 # Indicates that the user failed a 2FA challenge. FAILED_TWO_FACTOR = 4 # Indicates the user provided the correct password. CORRECT_PASSWORD = 5 # Indicates the user provided an incorrect password. INCORRECT_PASSWORD = 6 # Indicates that the user sent unwanted and abusive messages to other users # of the platform, such as spam, scams, phishing, or social engineering. SOCIAL_SPAM = 14 end end |
#transaction_event ⇒ ::Google::Cloud::RecaptchaEnterprise::V1beta1::TransactionEvent
Returns Optional. If the assessment is part of a payment transaction, provide details on payment lifecycle events that occur in the transaction.
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 |
# File 'proto_docs/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.rb', line 182 class AnnotateAssessmentRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Enum that represents the types of annotations. module Annotation # Default unspecified type. ANNOTATION_UNSPECIFIED = 0 # Provides information that the event turned out to be legitimate. LEGITIMATE = 1 # Provides information that the event turned out to be fraudulent. FRAUDULENT = 2 # Provides information that the event was related to a login event in which # the user typed the correct password. Deprecated, prefer indicating # CORRECT_PASSWORD through the reasons field instead. PASSWORD_CORRECT = 3 # Provides information that the event was related to a login event in which # the user typed the incorrect password. Deprecated, prefer indicating # INCORRECT_PASSWORD through the reasons field instead. PASSWORD_INCORRECT = 4 end # Enum that represents potential reasons for annotating an assessment. module Reason # Default unspecified reason. REASON_UNSPECIFIED = 0 # Indicates that the transaction had a chargeback issued with no other # details. When possible, specify the type by using CHARGEBACK_FRAUD or # CHARGEBACK_DISPUTE instead. CHARGEBACK = 1 # Indicates that the transaction had a chargeback issued related to an # alleged unauthorized transaction from the cardholder's perspective (for # example, the card number was stolen). CHARGEBACK_FRAUD = 8 # Indicates that the transaction had a chargeback issued related to the # cardholder having provided their card details but allegedly not being # satisfied with the purchase (for example, misrepresentation, attempted # cancellation). CHARGEBACK_DISPUTE = 9 # Indicates that the completed payment transaction was refunded by the # seller. REFUND = 10 # Indicates that the completed payment transaction was determined to be # fraudulent by the seller, and was cancelled and refunded as a result. REFUND_FRAUD = 11 # Indicates that the payment transaction was accepted, and the user was # charged. TRANSACTION_ACCEPTED = 12 # Indicates that the payment transaction was declined, for example due to # invalid card details. TRANSACTION_DECLINED = 13 # Indicates the transaction associated with the assessment is suspected of # being fraudulent based on the payment method, billing details, shipping # address or other transaction information. PAYMENT_HEURISTICS = 2 # Indicates that the user was served a 2FA challenge. An old assessment # with `ENUM_VALUES.INITIATED_TWO_FACTOR` reason that has not been # overwritten with `PASSED_TWO_FACTOR` is treated as an abandoned 2FA flow. # This is equivalent to `FAILED_TWO_FACTOR`. INITIATED_TWO_FACTOR = 7 # Indicates that the user passed a 2FA challenge. PASSED_TWO_FACTOR = 3 # Indicates that the user failed a 2FA challenge. FAILED_TWO_FACTOR = 4 # Indicates the user provided the correct password. CORRECT_PASSWORD = 5 # Indicates the user provided an incorrect password. INCORRECT_PASSWORD = 6 # Indicates that the user sent unwanted and abusive messages to other users # of the platform, such as spam, scams, phishing, or social engineering. SOCIAL_SPAM = 14 end end |