Package recaptchaenterprise is an auto-generated package for the reCAPTCHA Enterprise API.
Example usage
To get started with this package, create a client.
ctx := context . Background () c , err := recaptchaenterprise . NewClient ( ctx ) if err != nil { // TODO: Handle error. } defer c . Close ()
The client will use your default application credentials. Clients should be reused instead of created as needed. The methods of Client are safe for concurrent use by multiple goroutines. The returned client must be Closed when it is done being used.
Using the Client
The following is an example of making an API call with the newly created client.
ctx := context . Background () c , err := recaptchaenterprise . NewClient ( ctx ) if err != nil { // TODO: Handle error. } defer c . Close () req := & recaptchaenterprisepb . CreateAssessmentRequest { // TODO: Fill request struct fields. // See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/recaptchaenterprise/v1#CreateAssessmentRequest. } resp , err := c . CreateAssessment ( ctx , req ) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp
Use of Context
The ctx passed to NewClient is used for authentication requests and for creating the underlying connection, but is not used for subsequent calls. Individual methods on the client use the ctx given to them.
To close the open connection, use the Close() method.
For information about setting deadlines, reusing contexts, and more please visit https://pkg.go.dev/cloud.google.com/go .
Functions
func DefaultAuthScopes
func
DefaultAuthScopes
()
[]
string
DefaultAuthScopes reports the default set of authentication scopes to use with this package.
CallOptions
type
CallOptions
struct
{
CreateAssessment
[]
gax
.
CallOption
AnnotateAssessment
[]
gax
.
CallOption
CreateKey
[]
gax
.
CallOption
ListKeys
[]
gax
.
CallOption
GetKey
[]
gax
.
CallOption
UpdateKey
[]
gax
.
CallOption
DeleteKey
[]
gax
.
CallOption
MigrateKey
[]
gax
.
CallOption
GetMetrics
[]
gax
.
CallOption
ListRelatedAccountGroups
[]
gax
.
CallOption
ListRelatedAccountGroupMemberships
[]
gax
.
CallOption
SearchRelatedAccountGroupMemberships
[]
gax
.
CallOption
}
CallOptions contains the retry settings for each method of Client.
Client
type
Client
struct
{
// The call options for this service.
CallOptions
*
CallOptions
// contains filtered or unexported fields
}
Client is a client for interacting with reCAPTCHA Enterprise API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
Service to determine the likelihood an event is legitimate.
func NewClient
NewClient creates a new recaptcha enterprise service client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
Service to determine the likelihood an event is legitimate.
Example
package
main
import
(
"context"
recaptchaenterprise
"cloud.google.com/go/recaptchaenterprise/v2/apiv1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
recaptchaenterprise
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
// TODO: Use client.
_
=
c
}
func (*Client) AnnotateAssessment
func
(
c
*
Client
)
AnnotateAssessment
(
ctx
context
.
Context
,
req
*
recaptchaenterprisepb
.
AnnotateAssessmentRequest
,
opts
...
gax
.
CallOption
)
(
*
recaptchaenterprisepb
.
AnnotateAssessmentResponse
,
error
)
AnnotateAssessment annotates a previously created Assessment to provide additional information on whether the event turned out to be authentic or fraudulent.
Example
package
main
import
(
"context"
recaptchaenterprise
"cloud.google.com/go/recaptchaenterprise/v2/apiv1"
recaptchaenterprisepb
"google.golang.org/genproto/googleapis/cloud/recaptchaenterprise/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
recaptchaenterprise
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& recaptchaenterprisepb
.
AnnotateAssessmentRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/recaptchaenterprise/v1#AnnotateAssessmentRequest.
}
resp
,
err
:=
c
.
AnnotateAssessment
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) Close
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*Client) Connection
func
(
c
*
Client
)
Connection
()
*
grpc
.
ClientConn
Connection returns a connection to the API service.
Deprecated.
func (*Client) CreateAssessment
func
(
c
*
Client
)
CreateAssessment
(
ctx
context
.
Context
,
req
*
recaptchaenterprisepb
.
CreateAssessmentRequest
,
opts
...
gax
.
CallOption
)
(
*
recaptchaenterprisepb
.
Assessment
,
error
)
CreateAssessment creates an Assessment of the likelihood an event is legitimate.
Example
package
main
import
(
"context"
recaptchaenterprise
"cloud.google.com/go/recaptchaenterprise/v2/apiv1"
recaptchaenterprisepb
"google.golang.org/genproto/googleapis/cloud/recaptchaenterprise/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
recaptchaenterprise
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& recaptchaenterprisepb
.
CreateAssessmentRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/recaptchaenterprise/v1#CreateAssessmentRequest.
}
resp
,
err
:=
c
.
CreateAssessment
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) CreateKey
func
(
c
*
Client
)
CreateKey
(
ctx
context
.
Context
,
req
*
recaptchaenterprisepb
.
CreateKeyRequest
,
opts
...
gax
.
CallOption
)
(
*
recaptchaenterprisepb
.
Key
,
error
)
CreateKey creates a new reCAPTCHA Enterprise key.
Example
package
main
import
(
"context"
recaptchaenterprise
"cloud.google.com/go/recaptchaenterprise/v2/apiv1"
recaptchaenterprisepb
"google.golang.org/genproto/googleapis/cloud/recaptchaenterprise/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
recaptchaenterprise
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& recaptchaenterprisepb
.
CreateKeyRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/recaptchaenterprise/v1#CreateKeyRequest.
}
resp
,
err
:=
c
.
CreateKey
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) DeleteKey
func
(
c
*
Client
)
DeleteKey
(
ctx
context
.
Context
,
req
*
recaptchaenterprisepb
.
DeleteKeyRequest
,
opts
...
gax
.
CallOption
)
error
DeleteKey deletes the specified key.
Example
package
main
import
(
"context"
recaptchaenterprise
"cloud.google.com/go/recaptchaenterprise/v2/apiv1"
recaptchaenterprisepb
"google.golang.org/genproto/googleapis/cloud/recaptchaenterprise/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
recaptchaenterprise
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& recaptchaenterprisepb
.
DeleteKeyRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/recaptchaenterprise/v1#DeleteKeyRequest.
}
err
=
c
.
DeleteKey
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
}
func (*Client) GetKey
func
(
c
*
Client
)
GetKey
(
ctx
context
.
Context
,
req
*
recaptchaenterprisepb
.
GetKeyRequest
,
opts
...
gax
.
CallOption
)
(
*
recaptchaenterprisepb
.
Key
,
error
)
GetKey returns the specified key.
Example
package
main
import
(
"context"
recaptchaenterprise
"cloud.google.com/go/recaptchaenterprise/v2/apiv1"
recaptchaenterprisepb
"google.golang.org/genproto/googleapis/cloud/recaptchaenterprise/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
recaptchaenterprise
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& recaptchaenterprisepb
.
GetKeyRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/recaptchaenterprise/v1#GetKeyRequest.
}
resp
,
err
:=
c
.
GetKey
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) GetMetrics
func
(
c
*
Client
)
GetMetrics
(
ctx
context
.
Context
,
req
*
recaptchaenterprisepb
.
GetMetricsRequest
,
opts
...
gax
.
CallOption
)
(
*
recaptchaenterprisepb
.
Metrics
,
error
)
GetMetrics get some aggregated metrics for a Key. This data can be used to build dashboards.
Example
package
main
import
(
"context"
recaptchaenterprise
"cloud.google.com/go/recaptchaenterprise/v2/apiv1"
recaptchaenterprisepb
"google.golang.org/genproto/googleapis/cloud/recaptchaenterprise/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
recaptchaenterprise
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& recaptchaenterprisepb
.
GetMetricsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/recaptchaenterprise/v1#GetMetricsRequest.
}
resp
,
err
:=
c
.
GetMetrics
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) ListKeys
func
(
c
*
Client
)
ListKeys
(
ctx
context
.
Context
,
req
*
recaptchaenterprisepb
.
ListKeysRequest
,
opts
...
gax
.
CallOption
)
*
KeyIterator
ListKeys returns the list of all keys that belong to a project.
Example
package
main
import
(
"context"
recaptchaenterprise
"cloud.google.com/go/recaptchaenterprise/v2/apiv1"
"google.golang.org/api/iterator"
recaptchaenterprisepb
"google.golang.org/genproto/googleapis/cloud/recaptchaenterprise/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
recaptchaenterprise
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& recaptchaenterprisepb
.
ListKeysRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/recaptchaenterprise/v1#ListKeysRequest.
}
it
:=
c
.
ListKeys
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*Client) ListRelatedAccountGroupMemberships
func
(
c
*
Client
)
ListRelatedAccountGroupMemberships
(
ctx
context
.
Context
,
req
*
recaptchaenterprisepb
.
ListRelatedAccountGroupMembershipsRequest
,
opts
...
gax
.
CallOption
)
*
RelatedAccountGroupMembershipIterator
ListRelatedAccountGroupMemberships get the memberships in a group of related accounts.
Example
package
main
import
(
"context"
recaptchaenterprise
"cloud.google.com/go/recaptchaenterprise/v2/apiv1"
"google.golang.org/api/iterator"
recaptchaenterprisepb
"google.golang.org/genproto/googleapis/cloud/recaptchaenterprise/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
recaptchaenterprise
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& recaptchaenterprisepb
.
ListRelatedAccountGroupMembershipsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/recaptchaenterprise/v1#ListRelatedAccountGroupMembershipsRequest.
}
it
:=
c
.
ListRelatedAccountGroupMemberships
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*Client) ListRelatedAccountGroups
func
(
c
*
Client
)
ListRelatedAccountGroups
(
ctx
context
.
Context
,
req
*
recaptchaenterprisepb
.
ListRelatedAccountGroupsRequest
,
opts
...
gax
.
CallOption
)
*
RelatedAccountGroupIterator
ListRelatedAccountGroups list groups of related accounts.
Example
package
main
import
(
"context"
recaptchaenterprise
"cloud.google.com/go/recaptchaenterprise/v2/apiv1"
"google.golang.org/api/iterator"
recaptchaenterprisepb
"google.golang.org/genproto/googleapis/cloud/recaptchaenterprise/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
recaptchaenterprise
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& recaptchaenterprisepb
.
ListRelatedAccountGroupsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/recaptchaenterprise/v1#ListRelatedAccountGroupsRequest.
}
it
:=
c
.
ListRelatedAccountGroups
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*Client) MigrateKey
func
(
c
*
Client
)
MigrateKey
(
ctx
context
.
Context
,
req
*
recaptchaenterprisepb
.
MigrateKeyRequest
,
opts
...
gax
.
CallOption
)
(
*
recaptchaenterprisepb
.
Key
,
error
)
MigrateKey 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.
Example
package
main
import
(
"context"
recaptchaenterprise
"cloud.google.com/go/recaptchaenterprise/v2/apiv1"
recaptchaenterprisepb
"google.golang.org/genproto/googleapis/cloud/recaptchaenterprise/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
recaptchaenterprise
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& recaptchaenterprisepb
.
MigrateKeyRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/recaptchaenterprise/v1#MigrateKeyRequest.
}
resp
,
err
:=
c
.
MigrateKey
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) SearchRelatedAccountGroupMemberships
func
(
c
*
Client
)
SearchRelatedAccountGroupMemberships
(
ctx
context
.
Context
,
req
*
recaptchaenterprisepb
.
SearchRelatedAccountGroupMembershipsRequest
,
opts
...
gax
.
CallOption
)
*
RelatedAccountGroupMembershipIterator
SearchRelatedAccountGroupMemberships search group memberships related to a given account.
Example
package
main
import
(
"context"
recaptchaenterprise
"cloud.google.com/go/recaptchaenterprise/v2/apiv1"
"google.golang.org/api/iterator"
recaptchaenterprisepb
"google.golang.org/genproto/googleapis/cloud/recaptchaenterprise/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
recaptchaenterprise
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& recaptchaenterprisepb
.
SearchRelatedAccountGroupMembershipsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/recaptchaenterprise/v1#SearchRelatedAccountGroupMembershipsRequest.
}
it
:=
c
.
SearchRelatedAccountGroupMemberships
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*Client) UpdateKey
func
(
c
*
Client
)
UpdateKey
(
ctx
context
.
Context
,
req
*
recaptchaenterprisepb
.
UpdateKeyRequest
,
opts
...
gax
.
CallOption
)
(
*
recaptchaenterprisepb
.
Key
,
error
)
UpdateKey updates the specified key.
Example
package
main
import
(
"context"
recaptchaenterprise
"cloud.google.com/go/recaptchaenterprise/v2/apiv1"
recaptchaenterprisepb
"google.golang.org/genproto/googleapis/cloud/recaptchaenterprise/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
recaptchaenterprise
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& recaptchaenterprisepb
.
UpdateKeyRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/recaptchaenterprise/v1#UpdateKeyRequest.
}
resp
,
err
:=
c
.
UpdateKey
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
KeyIterator
type
KeyIterator
struct
{
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response
interface
{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch
func
(
pageSize
int
,
pageToken
string
)
(
results
[]
*
recaptchaenterprisepb
.
Key
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
KeyIterator manages a stream of *recaptchaenterprisepb.Key.
func (*KeyIterator) Next
func
(
it
*
KeyIterator
)
Next
()
(
*
recaptchaenterprisepb
.
Key
,
error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*KeyIterator) PageInfo
func
(
it
*
KeyIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
RelatedAccountGroupIterator
type
RelatedAccountGroupIterator
struct
{
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response
interface
{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch
func
(
pageSize
int
,
pageToken
string
)
(
results
[]
*
recaptchaenterprisepb
.
RelatedAccountGroup
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
RelatedAccountGroupIterator manages a stream of *recaptchaenterprisepb.RelatedAccountGroup.
func (*RelatedAccountGroupIterator) Next
func
(
it
*
RelatedAccountGroupIterator
)
Next
()
(
*
recaptchaenterprisepb
.
RelatedAccountGroup
,
error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*RelatedAccountGroupIterator) PageInfo
func
(
it
*
RelatedAccountGroupIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
RelatedAccountGroupMembershipIterator
type
RelatedAccountGroupMembershipIterator
struct
{
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response
interface
{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch
func
(
pageSize
int
,
pageToken
string
)
(
results
[]
*
recaptchaenterprisepb
.
RelatedAccountGroupMembership
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
RelatedAccountGroupMembershipIterator manages a stream of *recaptchaenterprisepb.RelatedAccountGroupMembership.
func (*RelatedAccountGroupMembershipIterator) Next
func
(
it
*
RelatedAccountGroupMembershipIterator
)
Next
()
(
*
recaptchaenterprisepb
.
RelatedAccountGroupMembership
,
error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*RelatedAccountGroupMembershipIterator) PageInfo
func
(
it
*
RelatedAccountGroupMembershipIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
