Class RecaptchaEnterpriseServiceClient (1.4.1)

RecaptchaEnterpriseServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.transports.base.RecaptchaEnterpriseServiceTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Service to determine the likelihood an event is legitimate.

Properties

transport

Returns the transport used by the client instance.

Returns
Type	Description
`RecaptchaEnterpriseServiceTransport`	The transport used by the client instance.

Methods

RecaptchaEnterpriseServiceClient

RecaptchaEnterpriseServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.transports.base.RecaptchaEnterpriseServiceTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the recaptcha enterprise service client.

Parameters
Name	Description
`credentials`	`Optional[google.auth.credentials.Credentials]` The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
`transport`	`Union[str, RecaptchaEnterpriseServiceTransport]` The transport to use. If set to None, a transport is chosen automatically.
`client_options`	`google.api_core.client_options.ClientOptions` Custom options for the client. It won't take effect if a `transport` instance is provided. (1) The `api_endpoint` property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the `api_endpoint` property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.
`client_info`	`google.api_core.gapic_v1.client_info.ClientInfo` The client info used to send a user-agent string along with API requests. If `None`, then default info will be used. Generally, you only need to set this if you're developing your own client library.

Exceptions
Type	Description
`google.auth.exceptions.MutualTLSChannelError`	If mutual TLS transport creation failed for any reason.

exit

__exit__(type, value, traceback)

Releases underlying transport's resources.

annotate_assessment

annotate_assessment(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.AnnotateAssessmentRequest, dict]] = None, *, name: Optional[str] = None, annotation: Optional[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.AnnotateAssessmentRequest.Annotation] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Annotates a previously created Assessment to provide additional information on whether the event turned out to be authentic or fraudulent.

Parameters
Name	Description
`request`	`Union[google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentRequest, dict]` The request object. The request message to annotate an Assessment.
`name`	`str` Required. The resource name of the Assessment, in the format "projects/{project}/assessments/{assessment}". This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`annotation`	`google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentRequest.Annotation` 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. This corresponds to the `annotation` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentResponse`	Empty response for AnnotateAssessment.

assessment_path

assessment_path(project: str, assessment: str)

Returns a fully-qualified assessment string.

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

create_assessment

create_assessment(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.CreateAssessmentRequest, dict]] = None, *, parent: Optional[str] = None, assessment: Optional[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.Assessment] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates an Assessment of the likelihood an event is legitimate.

Parameters
Name	Description
`request`	`Union[google.cloud.recaptchaenterprise_v1.types.CreateAssessmentRequest, dict]` The request object. The create assessment request message.
`parent`	`str` Required. The name of the project in which the assessment will be created, in the format "projects/{project}". This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`assessment`	`google.cloud.recaptchaenterprise_v1.types.Assessment` Required. The assessment details. This corresponds to the `assessment` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.recaptchaenterprise_v1.types.Assessment`	A recaptcha assessment resource.

create_key

create_key(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.CreateKeyRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a new reCAPTCHA Enterprise key.

Parameters
Name	Description
`request`	`Union[google.cloud.recaptchaenterprise_v1.types.CreateKeyRequest, dict]` The request object. The create key request message.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.recaptchaenterprise_v1.types.Key`	A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise.

delete_key

delete_key(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.DeleteKeyRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes the specified key.

Parameters
Name	Description
`request`	`Union[google.cloud.recaptchaenterprise_v1.types.DeleteKeyRequest, dict]` The request object. The delete key request message.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name	Description
`filename`	`str` The path to the service account private key json file.

Returns
Type	Description
`RecaptchaEnterpriseServiceClient`	The constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameter
Name	Description
`info`	`dict` The service account private key info.

Returns
Type	Description
`RecaptchaEnterpriseServiceClient`	The constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name	Description
`filename`	`str` The path to the service account private key json file.

Returns
Type	Description
`RecaptchaEnterpriseServiceClient`	The constructed client.

get_key

get_key(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.GetKeyRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Returns the specified key.

Parameters
Name	Description
`request`	`Union[google.cloud.recaptchaenterprise_v1.types.GetKeyRequest, dict]` The request object. The get key request message.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.recaptchaenterprise_v1.types.Key`	A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise.

get_metrics

get_metrics(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.GetMetricsRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Get some aggregated metrics for a Key. This data can be used to build dashboards.

Parameters
Name	Description
`request`	`Union[google.cloud.recaptchaenterprise_v1.types.GetMetricsRequest, dict]` The request object. The get metrics request message.
`name`	`str` Required. The name of the requested metrics, in the format "projects/{project}/keys/{key}/metrics". This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.recaptchaenterprise_v1.types.Metrics`	Metrics for a single Key.

key_path

key_path(project: str, key: str)

Returns a fully-qualified key string.

list_keys

list_keys(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListKeysRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Returns the list of all keys that belong to a project.

Parameters
Name	Description
`request`	`Union[google.cloud.recaptchaenterprise_v1.types.ListKeysRequest, dict]` The request object. The list keys request message.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListKeysPager`	Response to request to list keys in a project. Iterating over this object will yield results and resolve additional pages automatically.

list_related_account_group_memberships

list_related_account_group_memberships(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListRelatedAccountGroupMembershipsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Get the memberships in a group of related accounts.

Parameters
Name	Description
`request`	`Union[google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupMembershipsRequest, dict]` The request object. The request message to list memberships in a related account group.
`parent`	`str` Required. The resource name for the related account group in the format `projects/{project}/relatedaccountgroups/{relatedaccountgroup}`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListRelatedAccountGroupMembershipsPager`	The response to a ListRelatedAccountGroupMemberships call. Iterating over this object will yield results and resolve additional pages automatically.

list_related_account_groups

list_related_account_groups(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListRelatedAccountGroupsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

List groups of related accounts.

Parameters
Name	Description
`request`	`Union[google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupsRequest, dict]` The request object. The request message to list related account groups.
`parent`	`str` Required. The name of the project to list related account groups from, in the format "projects/{project}". This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListRelatedAccountGroupsPager`	The response to a ListRelatedAccountGroups call. Iterating over this object will yield results and resolve additional pages automatically.

metrics_path

metrics_path(project: str, key: str)

Returns a fully-qualified metrics string.

migrate_key

migrate_key(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.MigrateKeyRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Migrates an existing key from reCAPTCHA to reCAPTCHA Enterprise. Once a key is migrated, it can be used from either product. SiteVerify requests are billed as CreateAssessment calls. You must be authenticated as one of the current owners of the reCAPTCHA Site Key, and your user must have the reCAPTCHA Enterprise Admin IAM role in the destination project.

Parameters
Name	Description
`request`	`Union[google.cloud.recaptchaenterprise_v1.types.MigrateKeyRequest, dict]` The request object. The migrate key request message.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.recaptchaenterprise_v1.types.Key`	A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise.

parse_assessment_path

parse_assessment_path(path: str)

Parses a assessment path into its component segments.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

parse_key_path

parse_key_path(path: str)

Parses a key path into its component segments.

parse_metrics_path

parse_metrics_path(path: str)

Parses a metrics path into its component segments.

parse_related_account_group_membership_path

parse_related_account_group_membership_path(path: str)

Parses a related_account_group_membership path into its component segments.

parse_related_account_group_path

parse_related_account_group_path(path: str)

Parses a related_account_group path into its component segments.

related_account_group_membership_path

related_account_group_membership_path(
    project: str, relatedaccountgroup: str, membership: str
)

Returns a fully-qualified related_account_group_membership string.

related_account_group_path

related_account_group_path(project: str, relatedaccountgroup: str)

Returns a fully-qualified related_account_group string.

search_related_account_group_memberships

search_related_account_group_memberships(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.SearchRelatedAccountGroupMembershipsRequest, dict]] = None, *, parent: Optional[str] = None, hashed_account_id: Optional[bytes] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Search group memberships related to a given account.

Parameters
Name	Description
`request`	`Union[google.cloud.recaptchaenterprise_v1.types.SearchRelatedAccountGroupMembershipsRequest, dict]` The request object. The request message to search related account group memberships.
`parent`	`str` Required. The name of the project to search related account group memberships from, in the format "projects/{project}". This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`hashed_account_id`	`bytes` Optional. The unique stable hashed user identifier we should search connections to. The identifier should correspond to a `hashed_account_id` provided in a previous CreateAssessment or AnnotateAssessment call. This corresponds to the `hashed_account_id` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.SearchRelatedAccountGroupMembershipsPager`	The response to a SearchRelatedAccountGroupMemberships call. Iterating over this object will yield results and resolve additional pages automatically.

update_key

update_key(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.UpdateKeyRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates the specified key.

Parameters
Name	Description
`request`	`Union[google.cloud.recaptchaenterprise_v1.types.UpdateKeyRequest, dict]` The request object. The update key request message.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.recaptchaenterprise_v1.types.Key`	A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise.