API documentation for recaptchaenterprise_v1.types package.
Classes
AndroidKeySettings
Settings specific to keys that can be used by Android apps. .. attribute:: allow_all_package_names
If set to true, it means allowed_package_names will not be enforced.
:type: bool
AnnotateAssessmentRequest
The request message to annotate an Assessment. .. attribute:: name
Required. The resource name of the Assessment, in the format "projects/{project}/assessments/{assessment}".
:type: str
AnnotateAssessmentResponse
Empty response for AnnotateAssessment.
Assessment
A recaptcha assessment resource. .. attribute:: name
Output only. The resource name for the Assessment in the format "projects/{project}/assessments/{assessment}".
:type: str
ChallengeMetrics
Metrics related to challenges. .. attribute:: pageload_count
Count of reCAPTCHA checkboxes or badges rendered. This is mostly equivalent to a count of pageloads for pages that include reCAPTCHA.
:type: int
CreateAssessmentRequest
The create assessment request message. .. attribute:: parent
Required. The name of the project in which the assessment will be created, in the format "projects/{project}".
:type: str
CreateKeyRequest
The create key request message. .. attribute:: parent
Required. The name of the project in which the key will be created, in the format "projects/{project}".
:type: str
DeleteKeyRequest
The delete key request message. .. attribute:: name
Required. The name of the key to be deleted, in the format "projects/{project}/keys/{key}".
:type: str
Event
GetKeyRequest
The get key request message. .. attribute:: name
Required. The name of the requested key, in the format "projects/{project}/keys/{key}".
:type: str
GetMetricsRequest
The get metrics request message. .. attribute:: name
Required. The name of the requested metrics, in the format "projects/{project}/keys/{key}/metrics".
:type: str
IOSKeySettings
Settings specific to keys that can be used by iOS apps. .. attribute:: allow_all_bundle_ids
If set to true, it means allowed_bundle_ids will not be enforced.
:type: bool
Key
A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise.
ListKeysRequest
The list keys request message. .. attribute:: parent
Required. The name of the project that contains the keys that will be listed, in the format "projects/{project}".
:type: str
ListKeysResponse
Response to request to list keys in a project. .. attribute:: keys
Key details.
:type: Sequence[google.cloud.recaptchaenterprise_v1.types.Key]
Metrics
Metrics for a single Key. .. attribute:: name
Output only. The name of the metrics, in the format "projects/{project}/keys/{key}/metrics".
:type: str
MigrateKeyRequest
The migrate key request message. .. attribute:: name
Required. The name of the key to be migrated, in the format "projects/{project}/keys/{key}".
:type: str
RiskAnalysis
Risk analysis result for an event. .. attribute:: score
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).
:type: float
ScoreDistribution
Score distribution. .. attribute:: score_buckets
Map key is score value multiplied by 100. The scores are discrete values between [0, 1]. The maximum number of buckets is on order of a few dozen, but typically much lower (ie. 10).
:type: Sequence[google.cloud.recaptchaenterprise_v1.types.ScoreDistribution.ScoreBucketsEntry]
ScoreMetrics
Metrics related to scoring. .. attribute:: overall_metrics
Aggregated score metrics for all traffic.
:type: google.cloud.recaptchaenterprise_v1.types.ScoreDistribution
TestingOptions
Options for user acceptance testing. .. attribute:: testing_score
All assessments for this Key will return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.
:type: float
TokenProperties
UpdateKeyRequest
The update key request message. .. attribute:: key
Required. The key to update.
WebKeySettings
Settings specific to keys that can be used by websites. .. attribute:: allow_all_domains
If set to true, it means allowed_domains will not be enforced.
:type: bool