Google Cloud Recaptcha Enterprise V1 Client - Class RiskAnalysis (1.17.2)

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 \ V1

Methods

__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 array

Output only. Reasons contributing to the risk analysis verdict.

↳ extended_verdict_reasons array

Output only. Extended verdict reasons to be used for experimentation only. The set of possible reasons is subject to change.

↳ challenge int

Output only. Challenge information for SCORE_AND_CHALLENGE and INVISIBLE keys

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\Internal\RepeatedField

setReasons

Output only. Reasons contributing to the risk analysis verdict.

Parameter
Name Description
var int[]
Returns
Type Description
$this

getExtendedVerdictReasons

Output only. Extended verdict reasons to be used for experimentation only.

The set of possible reasons is subject to change.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setExtendedVerdictReasons

Output only. Extended verdict reasons to be used for experimentation only.

The set of possible reasons is subject to change.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getChallenge

Output only. Challenge information for SCORE_AND_CHALLENGE and INVISIBLE keys

Returns
Type Description
int

setChallenge

Output only. Challenge information for SCORE_AND_CHALLENGE and INVISIBLE keys

Parameter
Name Description
var int
Returns
Type Description
$this