Reference documentation and code samples for the Google Cloud Recaptcha Enterprise V1 Client class RiskAnalysis.
Risk analysis result for an event.
Generated from protobuf message google.cloud.recaptchaenterprise.v1.RiskAnalysis
Namespace
Google \ Cloud \ RecaptchaEnterprise \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ score |
float
Output only. Legitimate event score from 0.0 to 1.0. (1.0 means very likely legitimate traffic while 0.0 means very likely non-legitimate traffic). |
↳ reasons |
int[]
Output only. Reasons contributing to the risk analysis verdict. |
↳ extended_verdict_reasons |
string[]
Output only. Additional reasons contributing to the risk analysis verdict. These reasons are available to Enterprise tier projects only. Contact sales for more information. The set of reasons is subject to change. |
↳ last_challenge_type |
int
Output only. Type of the last challenge presented to the user for Universal, |
↳ challenge |
int
Output only. Challenge information for Universal, |
↳ verified_bots |
array<Bot>
Output only. Bots with identities that have been verified by reCAPTCHA and detected in the event. |
getScore
Output only. Legitimate event score from 0.0 to 1.0.
(1.0 means very likely legitimate traffic while 0.0 means very likely non-legitimate traffic).
| Returns | |
|---|---|
| Type | Description |
float |
|
setScore
Output only. Legitimate event score from 0.0 to 1.0.
(1.0 means very likely legitimate traffic while 0.0 means very likely non-legitimate traffic).
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getReasons
Output only. Reasons contributing to the risk analysis verdict.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<int> |
|
setReasons
Output only. Reasons contributing to the risk analysis verdict.
| Parameter | |
|---|---|
| Name | Description |
var |
int[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getExtendedVerdictReasons
Output only. Additional reasons contributing to the risk analysis verdict.
These reasons are available to Enterprise tier projects only. Contact sales for more information. The set of reasons is subject to change.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<string> |
|
setExtendedVerdictReasons
Output only. Additional reasons contributing to the risk analysis verdict.
These reasons are available to Enterprise tier projects only. Contact sales for more information. The set of reasons is subject to change.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLastChallengeType
Output only. Type of the last challenge presented to the user for
Universal, POLICY_BASED_CHALLENGE and INVISIBLE keys. The field is only
set when a challenge was presented to the user.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type ChallengeType. |
setLastChallengeType
Output only. Type of the last challenge presented to the user for
Universal, POLICY_BASED_CHALLENGE and INVISIBLE keys. The field is only
set when a challenge was presented to the user.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type ChallengeType. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getChallenge
Output only. Challenge information for Universal, POLICY_BASED_CHALLENGE
and INVISIBLE keys.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type Challenge. |
setChallenge
Output only. Challenge information for Universal, POLICY_BASED_CHALLENGE
and INVISIBLE keys.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type Challenge. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getVerifiedBots
Output only. Bots with identities that have been verified by reCAPTCHA and detected in the event.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<Bot> |
|
setVerifiedBots
Output only. Bots with identities that have been verified by reCAPTCHA and detected in the event.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Bot>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|