OAuth2 scopes used by this API.
const (
// See, edit, configure, and delete your Google Cloud data and see the email
// address for your Google Account.
CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
)
GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment: Account defender risk assessment.
type GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment struct {
// Labels: Output only. Labels for this request.
//
// Possible values:
// "ACCOUNT_DEFENDER_LABEL_UNSPECIFIED" - Default unspecified type.
// "PROFILE_MATCH" - The request matches a known good profile for the user.
// "SUSPICIOUS_LOGIN_ACTIVITY" - The request is potentially a suspicious
// login event and must be further verified either through multi-factor
// authentication or another system.
// "SUSPICIOUS_ACCOUNT_CREATION" - The request matched a profile that
// previously had suspicious account creation behavior. This can mean that this
// is a fake account.
// "RELATED_ACCOUNTS_NUMBER_HIGH" - The account in the request has a high
// number of related accounts. It does not necessarily imply that the account
// is bad but can require further investigation.
Labels []string `json:"labels,omitempty"`
// ForceSendFields is a list of field names (e.g. "Labels") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Labels") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment) MarshalJSON() ([]byte, error)
GoogleCloudRecaptchaenterpriseV1AccountVerificationInfo: Information about account verification, used for identity verification.
type GoogleCloudRecaptchaenterpriseV1AccountVerificationInfo struct {
// Endpoints: Optional. Endpoints that can be used for identity verification.
Endpoints []*GoogleCloudRecaptchaenterpriseV1EndpointVerificationInfo `json:"endpoints,omitempty"`
// LanguageCode: Optional. Language code preference for the verification
// message, set as a IETF BCP 47 language code.
LanguageCode string `json:"languageCode,omitempty"`
// LatestVerificationResult: Output only. Result of the latest account
// verification challenge.
//
// Possible values:
// "RESULT_UNSPECIFIED" - No information about the latest account
// verification.
// "SUCCESS_USER_VERIFIED" - The user was successfully verified. This means
// the account verification challenge was successfully completed.
// "ERROR_USER_NOT_VERIFIED" - The user failed the verification challenge.
// "ERROR_SITE_ONBOARDING_INCOMPLETE" - The site is not properly onboarded to
// use the account verification feature.
// "ERROR_RECIPIENT_NOT_ALLOWED" - The recipient is not allowed for account
// verification. This can occur during integration but should not occur in
// production.
// "ERROR_RECIPIENT_ABUSE_LIMIT_EXHAUSTED" - The recipient has already been
// sent too many verification codes in a short amount of time.
// "ERROR_CRITICAL_INTERNAL" - The verification flow could not be completed
// due to a critical internal error.
// "ERROR_CUSTOMER_QUOTA_EXHAUSTED" - The client has exceeded their two
// factor request quota for this period of time.
// "ERROR_VERIFICATION_BYPASSED" - The request cannot be processed at the
// time because of an incident. This bypass can be restricted to a problematic
// destination email domain, a customer, or could affect the entire service.
// "ERROR_VERDICT_MISMATCH" - The request parameters do not match with the
// token provided and cannot be processed.
LatestVerificationResult string `json:"latestVerificationResult,omitempty"`
// Username: Username of the account that is being verified. Deprecated.
// Customers should now provide the `account_id` field in `event.user_info`.
Username string `json:"username,omitempty"`
// ForceSendFields is a list of field names (e.g. "Endpoints") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Endpoints") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudRecaptchaenterpriseV1AccountVerificationInfo) MarshalJSON() ([]byte, error)
GoogleCloudRecaptchaenterpriseV1AndroidKeySettings: Settings specific to keys that can be used by Android apps.
type GoogleCloudRecaptchaenterpriseV1AndroidKeySettings struct {
// AllowAllPackageNames: Optional. If set to true, allowed_package_names are
// not enforced.
AllowAllPackageNames bool `json:"allowAllPackageNames,omitempty"`
// AllowedPackageNames: Optional. Android package names of apps allowed to use
// the key. Example: 'com.companyname.appname'
AllowedPackageNames []string `json:"allowedPackageNames,omitempty"`
// SupportNonGoogleAppStoreDistribution: Optional. Set to true for keys that
// are used in an Android application that is available for download in app
// stores in addition to the Google Play Store.
SupportNonGoogleAppStoreDistribution bool `json:"supportNonGoogleAppStoreDistribution,omitempty"`
// ForceSendFields is a list of field names (e.g. "AllowAllPackageNames") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AllowAllPackageNames") to include
// in API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudRecaptchaenterpriseV1AndroidKeySettings) MarshalJSON() ([]byte, error)
GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentRequest: The request message to annotate an Assessment.
type GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentRequest struct {
// AccountId: Optional. A stable account identifier to apply to the assessment.
// This is an alternative to setting `account_id` in `CreateAssessment`, for
// example when a stable account identifier is not yet known in the initial
// request.
AccountId string `json:"accountId,omitempty"`
// 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.
//
// Possible values:
// "ANNOTATION_UNSPECIFIED" - Default unspecified type.
// "LEGITIMATE" - Provides information that the event turned out to be
// legitimate.
// "FRAUDULENT" - Provides information that the event turned out to be
// fraudulent.
// "PASSWORD_CORRECT" - Provides information that the event was related to a
// login event in which the user typed the correct password. Deprecated, prefer
// indicating CORRECT_PASSWORD through the reasons field instead.
// "PASSWORD_INCORRECT" - Provides information that the event was related to
// a login event in which the user typed the incorrect password. Deprecated,
// prefer indicating INCORRECT_PASSWORD through the reasons field instead.
Annotation string `json:"annotation,omitempty"`
// HashedAccountId: Optional. A stable hashed account identifier to apply to
// the assessment. This is an alternative to setting `hashed_account_id` in
// `CreateAssessment`, for example when a stable account identifier is not yet
// known in the initial request.
HashedAccountId string `json:"hashedAccountId,omitempty"`
// Reasons: Optional. Reasons for the annotation that are assigned to the
// event.
//
// Possible values:
// "REASON_UNSPECIFIED" - Default unspecified reason.
// "CHARGEBACK" - Indicates that the transaction had a chargeback issued with
// no other details. When possible, specify the type by using CHARGEBACK_FRAUD
// or CHARGEBACK_DISPUTE instead.
// "CHARGEBACK_FRAUD" - Indicates that the transaction had a chargeback
// issued related to an alleged unauthorized transaction from the cardholder's
// perspective (for example, the card number was stolen).
// "CHARGEBACK_DISPUTE" - Indicates that the transaction had a chargeback
// issued related to the cardholder having provided their card details but
// allegedly not being satisfied with the purchase (for example,
// misrepresentation, attempted cancellation).
// "REFUND" - Indicates that the completed payment transaction was refunded
// by the seller.
// "REFUND_FRAUD" - Indicates that the completed payment transaction was
// determined to be fraudulent by the seller, and was cancelled and refunded as
// a result.
// "TRANSACTION_ACCEPTED" - Indicates that the payment transaction was
// accepted, and the user was charged.
// "TRANSACTION_DECLINED" - Indicates that the payment transaction was
// declined, for example due to invalid card details.
// "PAYMENT_HEURISTICS" - Indicates the transaction associated with the
// assessment is suspected of being fraudulent based on the payment method,
// billing details, shipping address or other transaction information.
// "INITIATED_TWO_FACTOR" - Indicates that the user was served a 2FA
// challenge. An old assessment with `ENUM_VALUES.INITIATED_TWO_FACTOR` reason
// that has not been overwritten with `PASSED_TWO_FACTOR` is treated as an
// abandoned 2FA flow. This is equivalent to `FAILED_TWO_FACTOR`.
// "PASSED_TWO_FACTOR" - Indicates that the user passed a 2FA challenge.
// "FAILED_TWO_FACTOR" - Indicates that the user failed a 2FA challenge.
// "CORRECT_PASSWORD" - Indicates the user provided the correct password.
// "INCORRECT_PASSWORD" - Indicates the user provided an incorrect password.
// "SOCIAL_SPAM" - Indicates that the user sent unwanted and abusive messages
// to other users of the platform, such as spam, scams, phishing, or social
// engineering.
Reasons []string `json:"reasons,omitempty"`
// TransactionEvent: Optional. If the assessment is part of a payment
// transaction, provide details on payment lifecycle events that occur in the
// transaction.
TransactionEvent *GoogleCloudRecaptchaenterpriseV1TransactionEvent `json:"transactionEvent,omitempty"`
// ForceSendFields is a list of field names (e.g. "AccountId") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AccountId") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentRequest) MarshalJSON() ([]byte, error)
GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentResponse: Empty response for AnnotateAssessment.
type GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentResponse struct {
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
}
GoogleCloudRecaptchaenterpriseV1AppleDeveloperId: Contains fields that are required to perform Apple-specific integrity checks.
type GoogleCloudRecaptchaenterpriseV1AppleDeveloperId struct {
// KeyId: Required. The Apple developer key ID (10-character string).
KeyId string `json:"keyId,omitempty"`
// PrivateKey: Required. Input only. A private key (downloaded as a text file
// with a .p8 file extension) generated for your Apple Developer account.
// Ensure that Apple DeviceCheck is enabled for the private key.
PrivateKey string `json:"privateKey,omitempty"`
// TeamId: Required. The Apple team ID (10-character string) owning the
// provisioning profile used to build your application.
TeamId string `json:"teamId,omitempty"`
// ForceSendFields is a list of field names (e.g. "KeyId") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "KeyId") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudRecaptchaenterpriseV1AppleDeveloperId) MarshalJSON() ([]byte, error)
GoogleCloudRecaptchaenterpriseV1Assessment: A reCAPTCHA Enterprise assessment resource.
type GoogleCloudRecaptchaenterpriseV1Assessment struct {
// AccountDefenderAssessment: Output only. Assessment returned by account
// defender when an account identifier is provided.
AccountDefenderAssessment *GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment `json:"accountDefenderAssessment,omitempty"`
// AccountVerification: Optional. Account verification information for identity
// verification. The assessment event must include a token and site key to use
// this feature.
AccountVerification *GoogleCloudRecaptchaenterpriseV1AccountVerificationInfo `json:"accountVerification,omitempty"`
// Event: Optional. The event being assessed.
Event *GoogleCloudRecaptchaenterpriseV1Event `json:"event,omitempty"`
// FirewallPolicyAssessment: Output only. Assessment returned when firewall
// policies belonging to the project are evaluated using the field
// firewall_policy_evaluation.
FirewallPolicyAssessment *GoogleCloudRecaptchaenterpriseV1FirewallPolicyAssessment `json:"firewallPolicyAssessment,omitempty"`
// FraudPreventionAssessment: Output only. Assessment returned by Fraud
// Prevention when TransactionData is provided.
FraudPreventionAssessment *GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessment `json:"fraudPreventionAssessment,omitempty"`
// FraudSignals: Output only. Fraud Signals specific to the users involved in a
// payment transaction.
FraudSignals *GoogleCloudRecaptchaenterpriseV1FraudSignals `json:"fraudSignals,omitempty"`
// Name: Output only. Identifier. The resource name for the Assessment in the
// format `projects/{project}/assessments/{assessment}`.
Name string `json:"name,omitempty"`
// PrivatePasswordLeakVerification: Optional. The private password leak
// verification field contains the parameters that are used to to check for
// leaks privately without sharing user credentials.
PrivatePasswordLeakVerification *GoogleCloudRecaptchaenterpriseV1PrivatePasswordLeakVerification `json:"privatePasswordLeakVerification,omitempty"`
// RiskAnalysis: Output only. The risk analysis result for the event being
// assessed.
RiskAnalysis *GoogleCloudRecaptchaenterpriseV1RiskAnalysis `json:"riskAnalysis,omitempty"`
// TokenProperties: Output only. Properties of the provided event token.
TokenProperties *GoogleCloudRecaptchaenterpriseV1TokenProperties `json:"tokenProperties,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "AccountDefenderAssessment")
// to unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AccountDefenderAssessment") to
// include in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudRecaptchaenterpriseV1Assessment) MarshalJSON() ([]byte, error)
GoogleCloudRecaptchaenterpriseV1ChallengeMetrics: Metrics related to challenges.
type GoogleCloudRecaptchaenterpriseV1ChallengeMetrics struct {
// FailedCount: Count of submitted challenge solutions that were incorrect or
// otherwise deemed suspicious such that a subsequent challenge was triggered.
FailedCount int64 `json:"failedCount,omitempty,string"`
// NocaptchaCount: Count of nocaptchas (successful verification without a
// challenge) issued.
NocaptchaCount int64 `json:"nocaptchaCount,omitempty,string"`
// PageloadCount: Count of reCAPTCHA checkboxes or badges rendered. This is
// mostly equivalent to a count of pageloads for pages that include reCAPTCHA.
PageloadCount int64 `json:"pageloadCount,omitempty,string"`
// PassedCount: Count of nocaptchas (successful verification without a
// challenge) plus submitted challenge solutions that were correct and resulted
// in verification.
PassedCount int64 `json:"passedCount,omitempty,string"`
// ForceSendFields is a list of field names (e.g. "FailedCount") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "FailedCount") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudRecaptchaenterpriseV1ChallengeMetrics) MarshalJSON() ([]byte, error)
GoogleCloudRecaptchaenterpriseV1EndpointVerificationInfo: Information about a verification endpoint that can be used for 2FA.
type GoogleCloudRecaptchaenterpriseV1EndpointVerificationInfo struct {
// EmailAddress: Email address for which to trigger a verification request.
EmailAddress string `json:"emailAddress,omitempty"`
// LastVerificationTime: Output only. Timestamp of the last successful
// verification for the endpoint, if any.
LastVerificationTime string `json:"lastVerificationTime,omitempty"`
// PhoneNumber: Phone number for which to trigger a verification request.
// Should be given in E.164 format.
PhoneNumber string `json:"phoneNumber,omitempty"`
// RequestToken: Output only. Token to provide to the client to trigger
// endpoint verification. It must be used within 15 minutes.
RequestToken string `json:"requestToken,omitempty"`
// ForceSendFields is a list of field names (e.g. "EmailAddress") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "EmailAddress") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudRecaptchaenterpriseV1EndpointVerificationInfo) MarshalJSON() ([]byte, error)
GoogleCloudRecaptchaenterpriseV1Event: The event being assessed.
type GoogleCloudRecaptchaenterpriseV1Event struct {
// ExpectedAction: Optional. The expected action for this type of event. This
// should be the same action provided at token generation time on client-side
// platforms already integrated with recaptcha enterprise.
ExpectedAction string `json:"expectedAction,omitempty"`
// Express: Optional. Flag for a reCAPTCHA express request for an assessment
// without a token. If enabled, `site_key` must reference a SCORE key with WAF
// feature set to EXPRESS.
Express bool `json:"express,omitempty"`
// FirewallPolicyEvaluation: Optional. Flag for enabling firewall policy config
// assessment. If this flag is enabled, the firewall policy will be evaluated
// and a suggested firewall action will be returned in the response.
FirewallPolicyEvaluation bool `json:"firewallPolicyEvaluation,omitempty"`
// FraudPrevention: Optional. The Fraud Prevention setting for this assessment.
//
// Possible values:
// "FRAUD_PREVENTION_UNSPECIFIED" - Default, unspecified setting. If opted in
// for automatic detection, `fraud_prevention_assessment` is returned based on
// the request. Otherwise, `fraud_prevention_assessment` is returned if
// `transaction_data` is present in the `Event` and Fraud Prevention is enabled
// in the Google Cloud console.
// "ENABLED" - Enable Fraud Prevention for this assessment, if Fraud
// Prevention is enabled in the Google Cloud console.
// "DISABLED" - Disable Fraud Prevention for this assessment, regardless of
// opt-in status or Google Cloud console settings.
FraudPrevention string `json:"fraudPrevention,omitempty"`
// HashedAccountId: Optional. Deprecated: use `user_info.account_id` instead.
// Unique stable hashed user identifier for the request. The identifier must be
// hashed using hmac-sha256 with stable secret.
HashedAccountId string `json:"hashedAccountId,omitempty"`
// Headers: Optional. HTTP header information about the request.
Headers []string `json:"headers,omitempty"`
// Ja3: Optional. JA3 fingerprint for SSL clients.
Ja3 string `json:"ja3,omitempty"`
// RequestedUri: Optional. The URI resource the user requested that triggered
// an assessment.
RequestedUri string `json:"requestedUri,omitempty"`
// SiteKey: Optional. The site key that was used to invoke reCAPTCHA Enterprise
// on your site and generate the token.
SiteKey string `json:"siteKey,omitempty"`
// Token: Optional. The user response token provided by the reCAPTCHA
// Enterprise client-side integration on your site.
Token string `json:"token,omitempty"`
// TransactionData: Optional. Data describing a payment transaction to be
// assessed. Sending this data enables reCAPTCHA Enterprise Fraud Prevention
// and the FraudPreventionAssessment component in the response.
TransactionData *GoogleCloudRecaptchaenterpriseV1TransactionData `json:"transactionData,omitempty"`
// UserAgent: Optional. The user agent present in the request from the user's
// device related to this event.
UserAgent string `json:"userAgent,omitempty"`
// UserInfo: Optional. Information about the user that generates this event,
// when they can be identified. They are often identified through the use of an
// account for logged-in requests or login/registration requests, or by
// providing user identifiers for guest actions like checkout.
UserInfo *GoogleCloudRecaptchaenterpriseV1UserInfo `json:"userInfo,omitempty"`
// UserIpAddress: Optional. The IP address in the request from the user's
// device related to this event.
UserIpAddress string `json:"userIpAddress,omitempty"`
// WafTokenAssessment: Optional. Flag for running WAF token assessment. If
// enabled, the token must be specified, and have been created by a WAF-enabled
// key.
WafTokenAssessment bool `json:"wafTokenAssessment,omitempty"`
// ForceSendFields is a list of field names (e.g. "ExpectedAction") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ExpectedAction") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudRecaptchaenterpriseV1Event) MarshalJSON() ([]byte, error)
GoogleCloudRecaptchaenterpriseV1FirewallAction: An individual action. Each action represents what to do if a policy matches.
type GoogleCloudRecaptchaenterpriseV1FirewallAction struct {
// Allow: The user request did not match any policy and should be allowed
// access to the requested resource.
Allow *GoogleCloudRecaptchaenterpriseV1FirewallActionAllowAction `json:"allow,omitempty"`
// Block: This action will deny access to a given page. The user will get an
// HTTP error code.
Block *GoogleCloudRecaptchaenterpriseV1FirewallActionBlockAction `json:"block,omitempty"`
// IncludeRecaptchaScript: This action will inject reCAPTCHA JavaScript code
// into the HTML page returned by the site backend.
IncludeRecaptchaScript *GoogleCloudRecaptchaenterpriseV1FirewallActionIncludeRecaptchaScriptAction `json:"includeRecaptchaScript,omitempty"`
// Redirect: This action will redirect the request to a ReCaptcha interstitial
// to attach a token.
Redirect *GoogleCloudRecaptchaenterpriseV1FirewallActionRedirectAction `json:"redirect,omitempty"`
// SetHeader: This action will set a custom header but allow the request to
// continue to the customer backend.
SetHeader *GoogleCloudRecaptchaenterpriseV1FirewallActionSetHeaderAction `json:"setHeader,omitempty"`
// Substitute: This action will transparently serve a different page to an
// offending user.
Substitute *GoogleCloudRecaptchaenterpriseV1FirewallActionSubstituteAction `json:"substitute,omitempty"`
// ForceSendFields is a list of field names (e.g. "Allow") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Allow") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudRecaptchaenterpriseV1FirewallAction) MarshalJSON() ([]byte, error)
GoogleCloudRecaptchaenterpriseV1FirewallActionAllowAction: An allow action continues processing a request unimpeded.
type GoogleCloudRecaptchaenterpriseV1FirewallActionAllowAction struct {
}
GoogleCloudRecaptchaenterpriseV1FirewallActionBlockAction: A block action serves an HTTP error code a prevents the request from hitting the backend.
type GoogleCloudRecaptchaenterpriseV1FirewallActionBlockAction struct {
}
GoogleCloudRecaptchaenterpriseV1FirewallActionIncludeRecaptchaScriptAction: An include reCAPTCHA script action involves injecting reCAPTCHA JavaScript code into the HTML returned by the site backend. This reCAPTCHA script is tasked with collecting user signals on the requested web page, issuing tokens as a cookie within the site domain, and enabling their utilization in subsequent page requests.
type GoogleCloudRecaptchaenterpriseV1FirewallActionIncludeRecaptchaScriptAction struct {
}
GoogleCloudRecaptchaenterpriseV1FirewallActionRedirectAction: A redirect action returns a 307 (temporary redirect) response, pointing the user to a ReCaptcha interstitial page to attach a token.
type GoogleCloudRecaptchaenterpriseV1FirewallActionRedirectAction struct {
}
GoogleCloudRecaptchaenterpriseV1FirewallActionSetHeaderAction: A set header action sets a header and forwards the request to the backend. This can be used to trigger custom protection implemented on the backend.
type GoogleCloudRecaptchaenterpriseV1FirewallActionSetHeaderAction struct {
// Key: Optional. The header key to set in the request to the backend server.
Key string `json:"key,omitempty"`
// Value: Optional. The header value to set in the request to the backend
// server.
Value string `json:"value,omitempty"`
// ForceSendFields is a list of field names (e.g. "Key") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Key") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudRecaptchaenterpriseV1FirewallActionSetHeaderAction) MarshalJSON() ([]byte, error)
GoogleCloudRecaptchaenterpriseV1FirewallActionSubstituteAction: A substitute action transparently serves a different page than the one requested.
type GoogleCloudRecaptchaenterpriseV1FirewallActionSubstituteAction struct {
// Path: Optional. The address to redirect to. The target is a relative path in
// the current host. Example: "/blog/404.html".
Path string `json:"path,omitempty"`
// ForceSendFields is a list of field names (e.g. "Path") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Path") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudRecaptchaenterpriseV1FirewallActionSubstituteAction) MarshalJSON() ([]byte, error)
GoogleCloudRecaptchaenterpriseV1FirewallPolicy: A FirewallPolicy represents a single matching pattern and resulting actions to take.
type GoogleCloudRecaptchaenterpriseV1FirewallPolicy struct {
// Actions: Optional. The actions that the caller should take regarding user
// access. There should be at most one terminal action. A terminal action is
// any action that forces a response, such as `AllowAction`, `BlockAction` or
// `SubstituteAction`. Zero or more non-terminal actions such as `SetHeader`
// might be specified. A single policy can contain up to 16 actions.
Actions []*GoogleCloudRecaptchaenterpriseV1FirewallAction `json:"actions,omitempty"`
// Condition: Optional. A CEL (Common Expression Language) conditional
// expression that specifies if this policy applies to an incoming user
// request. If this condition evaluates to true and the requested path matched
// the path pattern, the associated actions should be executed by the caller.
// The condition string is checked for CEL syntax correctness on creation. For
// more information, see the CEL spec (https://github.com/google/cel-spec) and
// its language definition
// (https://github.com/google/cel-spec/blob/master/doc/langdef.md). A condition
// has a max length of 500 characters.
Condition string `json:"condition,omitempty"`
// Description: Optional. A description of what this policy aims to achieve,
// for convenience purposes. The description can at most include 256 UTF-8
// characters.
Description string `json:"description,omitempty"`
// Name: Identifier. The resource name for the FirewallPolicy in the format
// `projects/{project}/firewallpolicies/{firewallpolicy}`.
Name string `json:"name,omitempty"`
// Path: Optional. The path for which this policy applies, specified as a glob
// pattern. For more information on glob, see the manual page
// (https://man7.org/linux/man-pages/man7/glob.7.html). A path has a max length
// of 200 characters.
Path string `json:"path,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Actions") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Actions") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudRecaptchaenterpriseV1FirewallPolicy) MarshalJSON() ([]byte, error)
GoogleCloudRecaptchaenterpriseV1FirewallPolicyAssessment: Policy config assessment.
type GoogleCloudRecaptchaenterpriseV1FirewallPolicyAssessment struct {
// Error: Output only. If the processing of a policy config fails, an error
// will be populated and the firewall_policy will be left empty.
Error *GoogleRpcStatus `json:"error,omitempty"`
// FirewallPolicy: Output only. The policy that matched the request. If more
// than one policy may match, this is the first match. If no policy matches the
// incoming request, the policy field will be left empty.
FirewallPolicy *GoogleCloudRecaptchaenterpriseV1FirewallPolicy `json:"firewallPolicy,omitempty"`
// ForceSendFields is a list of field names (e.g. "Error") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Error") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudRecaptchaenterpriseV1FirewallPolicyAssessment) MarshalJSON() ([]byte, error)
GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessment: Assessment for Fraud Prevention.
type GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessment struct {
// BehavioralTrustVerdict: Output only. Assessment of this transaction for
// behavioral trust.
BehavioralTrustVerdict *GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentBehavioralTrustVerdict `json:"behavioralTrustVerdict,omitempty"`
// CardTestingVerdict: Output only. Assessment of this transaction for risk of
// being part of a card testing attack.
CardTestingVerdict *GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentCardTestingVerdict `json:"cardTestingVerdict,omitempty"`
// StolenInstrumentVerdict: Output only. Assessment of this transaction for
// risk of a stolen instrument.
StolenInstrumentVerdict *GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentStolenInstrumentVerdict `json:"stolenInstrumentVerdict,omitempty"`
// TransactionRisk: Output only. Probability of this transaction being
// fraudulent. Summarizes the combined risk of attack vectors below. Values are
// from 0.0 (lowest) to 1.0 (highest).
TransactionRisk float64 `json:"transactionRisk,omitempty"`
// ForceSendFields is a list of field names (e.g. "BehavioralTrustVerdict") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "BehavioralTrustVerdict") to
// include in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessment) MarshalJSON() ([]byte, error)
func (s *GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessment) UnmarshalJSON(data []byte) error
GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentBehavioralTrustVerdi ct: Information about behavioral trust of the transaction.
type GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentBehavioralTrustVerdict struct {
// Trust: Output only. Probability of this transaction attempt being executed
// in a behaviorally trustworthy way. Values are from 0.0 (lowest) to 1.0
// (highest).
Trust float64 `json:"trust,omitempty"`
// ForceSendFields is a list of field names (e.g. "Trust") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Trust") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentBehavioralTrustVerdict) MarshalJSON() ([]byte, error)
func (s *GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentBehavioralTrustVerdict) UnmarshalJSON(data []byte) error
GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentCardTestingVerdict: Information about card testing fraud, where an adversary is testing fraudulently obtained cards or brute forcing their details.
type GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentCardTestingVerdict struct {
// Risk: Output only. Probability of this transaction attempt being part of a
// card testing attack. Values are from 0.0 (lowest) to 1.0 (highest).
Risk float64 `json:"risk,omitempty"`
// ForceSendFields is a list of field names (e.g. "Risk") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Risk") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentCardTestingVerdict) MarshalJSON() ([]byte, error)
func (s *GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentCardTestingVerdict) UnmarshalJSON(data []byte) error
GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentStolenInstrumentVerd ict: Information about stolen instrument fraud, where the user is not the legitimate owner of the instrument being used for the purchase.
type GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentStolenInstrumentVerdict struct {
// Risk: Output only. Probability of this transaction being executed with a
// stolen instrument. Values are from 0.0 (lowest) to 1.0 (highest).
Risk float64 `json:"risk,omitempty"`
// ForceSendFields is a list of field names (e.g. "Risk") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Risk") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentStolenInstrumentVerdict) MarshalJSON() ([]byte, error)
func (s *GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentStolenInstrumentVerdict) UnmarshalJSON(data []byte) error
GoogleCloudRecaptchaenterpriseV1FraudSignals: Fraud signals describing users and cards involved in the transaction.
type GoogleCloudRecaptchaenterpriseV1FraudSignals struct {
// CardSignals: Output only. Signals describing the payment card or cards used
// in this transaction.
CardSignals *GoogleCloudRecaptchaenterpriseV1FraudSignalsCardSignals `json:"cardSignals,omitempty"`
// UserSignals: Output only. Signals describing the end user in this
// transaction.
UserSignals *GoogleCloudRecaptchaenterpriseV1FraudSignalsUserSignals `json:"userSignals,omitempty"`
// ForceSendFields is a list of field names (e.g. "CardSignals") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "CardSignals") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudRecaptchaenterpriseV1FraudSignals) MarshalJSON() ([]byte, error)
GoogleCloudRecaptchaenterpriseV1FraudSignalsCardSignals: Signals describing the payment card used in this transaction.
type GoogleCloudRecaptchaenterpriseV1FraudSignalsCardSignals struct {
// CardLabels: Output only. The labels for the payment card in this
// transaction.
//
// Possible values:
// "CARD_LABEL_UNSPECIFIED" - No label specified.
// "PREPAID" - This card has been detected as prepaid.
// "VIRTUAL" - This card has been detected as virtual, such as a card number
// generated for a single transaction or merchant.
// "UNEXPECTED_LOCATION" - This card has been detected as being used in an
// unexpected geographic location.
CardLabels []string `json:"cardLabels,omitempty"`
// ForceSendFields is a list of field names (e.g. "CardLabels") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "CardLabels") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudRecaptchaenterpriseV1FraudSignalsCardSignals) MarshalJSON() ([]byte, error)
GoogleCloudRecaptchaenterpriseV1FraudSignalsUserSignals: Signals describing the user involved in this transaction.
type GoogleCloudRecaptchaenterpriseV1FraudSignalsUserSignals struct {
// ActiveDaysLowerBound: Output only. This user (based on email, phone, and
// other identifiers) has been seen on the internet for at least this number of
// days.
ActiveDaysLowerBound int64 `json:"activeDaysLowerBound,omitempty"`
// SyntheticRisk: Output only. Likelihood (from 0.0 to 1.0) this user includes
// synthetic components in their identity, such as a randomly generated email
// address, temporary phone number, or fake shipping address.
SyntheticRisk float64 `json:"syntheticRisk,omitempty"`
// ForceSendFields is a list of field names (e.g. "ActiveDaysLowerBound") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ActiveDaysLowerBound") to include
// in API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudRecaptchaenterpriseV1FraudSignalsUserSignals) MarshalJSON() ([]byte, error)
func (s *GoogleCloudRecaptchaenterpriseV1FraudSignalsUserSignals) UnmarshalJSON(data []byte) error
GoogleCloudRecaptchaenterpriseV1IOSKeySettings: Settings specific to keys that can be used by iOS apps.
type GoogleCloudRecaptchaenterpriseV1IOSKeySettings struct {
// AllowAllBundleIds: Optional. If set to true, allowed_bundle_ids are not
// enforced.
AllowAllBundleIds bool `json:"allowAllBundleIds,omitempty"`
// AllowedBundleIds: Optional. iOS bundle ids of apps allowed to use the key.
// Example: 'com.companyname.productname.appname'
AllowedBundleIds []string `json:"allowedBundleIds,omitempty"`
// AppleDeveloperId: Optional. Apple Developer account details for the app that
// is protected by the reCAPTCHA Key. reCAPTCHA Enterprise leverages
// platform-specific checks like Apple App Attest and Apple DeviceCheck to
// protect your app from abuse. Providing these fields allows reCAPTCHA
// Enterprise to get a better assessment of the integrity of your app.
AppleDeveloperId *GoogleCloudRecaptchaenterpriseV1AppleDeveloperId `json:"appleDeveloperId,omitempty"`
// ForceSendFields is a list of field names (e.g. "AllowAllBundleIds") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AllowAllBundleIds") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudRecaptchaenterpriseV1IOSKeySettings) MarshalJSON() ([]byte, error)
GoogleCloudRecaptchaenterpriseV1Key: A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise.
type GoogleCloudRecaptchaenterpriseV1Key struct {
// AndroidSettings: Settings for keys that can be used by Android apps.
AndroidSettings *GoogleCloudRecaptchaenterpriseV1AndroidKeySettings `json:"androidSettings,omitempty"`
// CreateTime: Output only. The timestamp corresponding to the creation of this
// key.
CreateTime string `json:"createTime,omitempty"`
// DisplayName: Required. Human-readable display name of this key. Modifiable
// by user.
DisplayName string `json:"displayName,omitempty"`
// IosSettings: Settings for keys that can be used by iOS apps.
IosSettings *GoogleCloudRecaptchaenterpriseV1IOSKeySettings `json:"iosSettings,omitempty"`
// Labels: Optional. See [Creating and managing labels]
// (https://cloud.google.com/recaptcha-enterprise/docs/labels).
Labels map[string]string `json:"labels,omitempty"`
// Name: Identifier. The resource name for the Key in the format
// `projects/{project}/keys/{key}`.
Name string `json:"name,omitempty"`
// TestingOptions: Optional. Options for user acceptance testing.
TestingOptions *GoogleCloudRecaptchaenterpriseV1TestingOptions `json:"testingOptions,omitempty"`
// WafSettings: Optional. Settings for WAF
WafSettings *GoogleCloudRecaptchaenterpriseV1WafSettings `json:"wafSettings,omitempty"`
// WebSettings: Settings for keys that can be used by websites.
WebSettings *GoogleCloudRecaptchaenterpriseV1WebKeySettings `json:"webSettings,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "AndroidSettings") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AndroidSettings") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudRecaptchaenterpriseV1Key) MarshalJSON() ([]byte, error)
GoogleCloudRecaptchaenterpriseV1ListFirewallPoliciesResponse: Response to request to list firewall policies belonging to a project.
type GoogleCloudRecaptchaenterpriseV1ListFirewallPoliciesResponse struct {
// FirewallPolicies: Policy details.
FirewallPolicies []*GoogleCloudRecaptchaenterpriseV1FirewallPolicy `json:"firewallPolicies,omitempty"`
// NextPageToken: Token to retrieve the next page of results. It is set to
// empty if no policies remain in results.
NextPageToken string `json:"nextPageToken,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "FirewallPolicies") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "FirewallPolicies") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudRecaptchaenterpriseV1ListFirewallPoliciesResponse) MarshalJSON() ([]byte, error)
GoogleCloudRecaptchaenterpriseV1ListKeysResponse: Response to request to list keys in a project.
type GoogleCloudRecaptchaenterpriseV1ListKeysResponse struct {
// Keys: Key details.
Keys []*GoogleCloudRecaptchaenterpriseV1Key `json:"keys,omitempty"`
// NextPageToken: Token to retrieve the next page of results. It is set to
// empty if no keys remain in results.
NextPageToken string `json:"nextPageToken,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Keys") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Keys") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudRecaptchaenterpriseV1ListKeysResponse) MarshalJSON() ([]byte, error)
GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupMembershipsResponse: The response to a `ListRelatedAccountGroupMemberships` call.
type GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupMembershipsResponse struct {
// NextPageToken: A token, which can be sent as `page_token` to retrieve the
// next page. If this field is omitted, there are no subsequent pages.
NextPageToken string `json:"nextPageToken,omitempty"`
// RelatedAccountGroupMemberships: The memberships listed by the query.
RelatedAccountGroupMemberships []*GoogleCloudRecaptchaenterpriseV1RelatedAccountGroupMembership `json:"relatedAccountGroupMemberships,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "NextPageToken") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "NextPageToken") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupMembershipsResponse) MarshalJSON() ([]byte, error)
GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupsResponse: The response to a `ListRelatedAccountGroups` call.
type GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupsResponse struct {
// NextPageToken: A token, which can be sent as `page_token` to retrieve the
// next page. If this field is omitted, there are no subsequent pages.
NextPageToken string `json:"nextPageToken,omitempty"`
// RelatedAccountGroups: The groups of related accounts listed by the query.
RelatedAccountGroups []*GoogleCloudRecaptchaenterpriseV1RelatedAccountGroup `json:"relatedAccountGroups,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "NextPageToken") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "NextPageToken") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupsResponse) MarshalJSON() ([]byte, error)
GoogleCloudRecaptchaenterpriseV1Metrics: Metrics for a single Key.
type GoogleCloudRecaptchaenterpriseV1Metrics struct {
// ChallengeMetrics: Metrics will be continuous and in order by dates, and in
// the granularity of day. Only challenge-based keys (CHECKBOX, INVISIBLE),
// will have challenge-based data.
ChallengeMetrics []*GoogleCloudRecaptchaenterpriseV1ChallengeMetrics `json:"challengeMetrics,omitempty"`
// Name: Output only. Identifier. The name of the metrics, in the format
// `projects/{project}/keys/{key}/metrics`.
Name string `json:"name,omitempty"`
// ScoreMetrics: Metrics will be continuous and in order by dates, and in the
// granularity of day. All Key types should have score-based data.
ScoreMetrics []*GoogleCloudRecaptchaenterpriseV1ScoreMetrics `json:"scoreMetrics,omitempty"`
// StartTime: Inclusive start time aligned to a day (UTC).
StartTime string `json:"startTime,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "ChallengeMetrics") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ChallengeMetrics") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudRecaptchaenterpriseV1Metrics) MarshalJSON() ([]byte, error)
GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest: The migrate key request message.
type GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest struct {
// SkipBillingCheck: Optional. If true, skips the billing check. A reCAPTCHA
// Enterprise key or migrated key behaves differently than a reCAPTCHA
// (non-Enterprise version) key when you reach a quota limit (see
// https://cloud.google.com/recaptcha-enterprise/quotas#quota_limit). To avoid
// any disruption of your usage, we check that a billing account is present. If
// your usage of reCAPTCHA is under the free quota, you can safely skip the
// billing check and proceed with the migration. See
// https://cloud.google.com/recaptcha-enterprise/docs/billing-information.
SkipBillingCheck bool `json:"skipBillingCheck,omitempty"`
// ForceSendFields is a list of field names (e.g. "SkipBillingCheck") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "SkipBillingCheck") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest) MarshalJSON() ([]byte, error)
GoogleCloudRecaptchaenterpriseV1PrivatePasswordLeakVerification: Private password leak verification info.
type GoogleCloudRecaptchaenterpriseV1PrivatePasswordLeakVerification struct {
// EncryptedLeakMatchPrefixes: Output only. List of prefixes of the encrypted
// potential password leaks that matched the given parameters. They must be
// compared with the client-side decryption prefix of
// `reencrypted_user_credentials_hash`
EncryptedLeakMatchPrefixes []string `json:"encryptedLeakMatchPrefixes,omitempty"`
// EncryptedUserCredentialsHash: Optional. Encrypted Scrypt hash of the
// canonicalized username+password. It is re-encrypted by the server and
// returned through `reencrypted_user_credentials_hash`.
EncryptedUserCredentialsHash string `json:"encryptedUserCredentialsHash,omitempty"`
// LookupHashPrefix: Required. Exactly 26-bit prefix of the SHA-256 hash of the
// canonicalized username. It is used to look up password leaks associated with
// that hash prefix.
LookupHashPrefix string `json:"lookupHashPrefix,omitempty"`
// ReencryptedUserCredentialsHash: Output only. Corresponds to the
// re-encryption of the `encrypted_user_credentials_hash` field. It is used to
// match potential password leaks within `encrypted_leak_match_prefixes`.
ReencryptedUserCredentialsHash string `json:"reencryptedUserCredentialsHash,omitempty"`
// ForceSendFields is a list of field names (e.g. "EncryptedLeakMatchPrefixes")
// to unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "EncryptedLeakMatchPrefixes") to
// include in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudRecaptchaenterpriseV1PrivatePasswordLeakVerification) MarshalJSON() ([]byte, error)
GoogleCloudRecaptchaenterpriseV1RelatedAccountGroup: A group of related accounts.
type GoogleCloudRecaptchaenterpriseV1RelatedAccountGroup struct {
// Name: Required. Identifier. The resource name for the related account group
// in the format
// `projects/{project}/relatedaccountgroups/{related_account_group}`.
Name string `json:"name,omitempty"`
// ForceSendFields is a list of field names (e.g. "Name") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Name") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudRecaptchaenterpriseV1RelatedAccountGroup) MarshalJSON() ([]byte, error)
GoogleCloudRecaptchaenterpriseV1RelatedAccountGroupMembership: A membership in a group of related accounts.
type GoogleCloudRecaptchaenterpriseV1RelatedAccountGroupMembership struct {
// AccountId: The unique stable account identifier of the member. The
// identifier corresponds to an `account_id` provided in a previous
// `CreateAssessment` or `AnnotateAssessment` call.
AccountId string `json:"accountId,omitempty"`
// HashedAccountId: Deprecated: use `account_id` instead. The unique stable
// hashed account identifier of the member. The identifier corresponds to a
// `hashed_account_id` provided in a previous `CreateAssessment` or
// `AnnotateAssessment` call.
HashedAccountId string `json:"hashedAccountId,omitempty"`
// Name: Required. Identifier. The resource name for this membership in the
// format
// `projects/{project}/relatedaccountgroups/{relatedaccountgroup}/memberships/{m
// embership}`.
Name string `json:"name,omitempty"`
// ForceSendFields is a list of field names (e.g. "AccountId") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AccountId") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudRecaptchaenterpriseV1RelatedAccountGroupMembership) MarshalJSON() ([]byte, error)
GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesRequest: The reorder firewall policies request message.
type GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesRequest struct {
// Names: Required. A list containing all policy names, in the new order. Each
// name is in the format
// `projects/{project}/firewallpolicies/{firewallpolicy}`.
Names []string `json:"names,omitempty"`
// ForceSendFields is a list of field names (e.g. "Names") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Names") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesRequest) MarshalJSON() ([]byte, error)
GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesResponse: The reorder firewall policies response message.
type GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesResponse struct {
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
}
GoogleCloudRecaptchaenterpriseV1RetrieveLegacySecretKeyResponse: Secret key is used only in legacy reCAPTCHA. It must be used in a 3rd party integration with legacy reCAPTCHA.
type GoogleCloudRecaptchaenterpriseV1RetrieveLegacySecretKeyResponse struct {
// LegacySecretKey: The secret key (also known as shared secret) authorizes
// communication between your application backend and the reCAPTCHA Enterprise
// server to create an assessment. The secret key needs to be kept safe for
// security purposes.
LegacySecretKey string `json:"legacySecretKey,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "LegacySecretKey") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "LegacySecretKey") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudRecaptchaenterpriseV1RetrieveLegacySecretKeyResponse) MarshalJSON() ([]byte, error)
GoogleCloudRecaptchaenterpriseV1RiskAnalysis: Risk analysis result for an event.
type GoogleCloudRecaptchaenterpriseV1RiskAnalysis struct {
// ExtendedVerdictReasons: Output only. Extended verdict reasons to be used for
// experimentation only. The set of possible reasons is subject to change.
ExtendedVerdictReasons []string `json:"extendedVerdictReasons,omitempty"`
// Reasons: Output only. Reasons contributing to the risk analysis verdict.
//
// Possible values:
// "CLASSIFICATION_REASON_UNSPECIFIED" - Default unspecified type.
// "AUTOMATION" - Interactions matched the behavior of an automated agent.
// "UNEXPECTED_ENVIRONMENT" - The event originated from an illegitimate
// environment.
// "TOO_MUCH_TRAFFIC" - Traffic volume from the event source is higher than
// normal.
// "UNEXPECTED_USAGE_PATTERNS" - Interactions with the site were
// significantly different than expected patterns.
// "LOW_CONFIDENCE_SCORE" - Too little traffic has been received from this
// site thus far to generate quality risk analysis.
// "SUSPECTED_CARDING" - The request matches behavioral characteristics of a
// carding attack.
// "SUSPECTED_CHARGEBACK" - The request matches behavioral characteristics of
// chargebacks for fraud.
Reasons []string `json:"reasons,omitempty"`
// Score: 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).
Score float64 `json:"score,omitempty"`
// ForceSendFields is a list of field names (e.g. "ExtendedVerdictReasons") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ExtendedVerdictReasons") to
// include in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudRecaptchaenterpriseV1RiskAnalysis) MarshalJSON() ([]byte, error)
func (s *GoogleCloudRecaptchaenterpriseV1RiskAnalysis) UnmarshalJSON(data []byte) error
GoogleCloudRecaptchaenterpriseV1ScoreDistribution: Score distribution.
type GoogleCloudRecaptchaenterpriseV1ScoreDistribution struct {
// ScoreBuckets: 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).
ScoreBuckets map[string]string `json:"scoreBuckets,omitempty"`
// ForceSendFields is a list of field names (e.g. "ScoreBuckets") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ScoreBuckets") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudRecaptchaenterpriseV1ScoreDistribution) MarshalJSON() ([]byte, error)
GoogleCloudRecaptchaenterpriseV1ScoreMetrics: Metrics related to scoring.
type GoogleCloudRecaptchaenterpriseV1ScoreMetrics struct {
// ActionMetrics: Action-based metrics. The map key is the action name which
// specified by the site owners at time of the "execute" client-side call.
ActionMetrics map[string]GoogleCloudRecaptchaenterpriseV1ScoreDistribution `json:"actionMetrics,omitempty"`
// OverallMetrics: Aggregated score metrics for all traffic.
OverallMetrics *GoogleCloudRecaptchaenterpriseV1ScoreDistribution `json:"overallMetrics,omitempty"`
// ForceSendFields is a list of field names (e.g. "ActionMetrics") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ActionMetrics") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudRecaptchaenterpriseV1ScoreMetrics) MarshalJSON() ([]byte, error)
GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsRequest: The request message to search related account group memberships.
type GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsRequest struct {
// AccountId: Optional. The unique stable account identifier used to search
// connections. The identifier should correspond to an `account_id` provided in
// a previous `CreateAssessment` or `AnnotateAssessment` call. Either
// hashed_account_id or account_id must be set, but not both.
AccountId string `json:"accountId,omitempty"`
// HashedAccountId: Optional. Deprecated: use `account_id` instead. The unique
// stable hashed account identifier used to search connections. The identifier
// should correspond to a `hashed_account_id` provided in a previous
// `CreateAssessment` or `AnnotateAssessment` call. Either hashed_account_id or
// account_id must be set, but not both.
HashedAccountId string `json:"hashedAccountId,omitempty"`
// PageSize: Optional. The maximum number of groups to return. The service
// might return fewer than this value. If unspecified, at most 50 groups are
// returned. The maximum value is 1000; values above 1000 are coerced to 1000.
PageSize int64 `json:"pageSize,omitempty"`
// PageToken: Optional. A page token, received from a previous
// `SearchRelatedAccountGroupMemberships` call. Provide this to retrieve the
// subsequent page. When paginating, all other parameters provided to
// `SearchRelatedAccountGroupMemberships` must match the call that provided the
// page token.
PageToken string `json:"pageToken,omitempty"`
// ForceSendFields is a list of field names (e.g. "AccountId") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AccountId") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsRequest) MarshalJSON() ([]byte, error)
GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsResponse:
The response to a `SearchRelatedAccountGroupMemberships` call.
type GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsResponse struct {
// NextPageToken: A token, which can be sent as `page_token` to retrieve the
// next page. If this field is omitted, there are no subsequent pages.
NextPageToken string `json:"nextPageToken,omitempty"`
// RelatedAccountGroupMemberships: The queried memberships.
RelatedAccountGroupMemberships []*GoogleCloudRecaptchaenterpriseV1RelatedAccountGroupMembership `json:"relatedAccountGroupMemberships,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "NextPageToken") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "NextPageToken") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsResponse) MarshalJSON() ([]byte, error)
GoogleCloudRecaptchaenterpriseV1TestingOptions: Options for user acceptance testing.
type GoogleCloudRecaptchaenterpriseV1TestingOptions struct {
// TestingChallenge: Optional. For challenge-based keys only (CHECKBOX,
// INVISIBLE), all challenge requests for this site will return nocaptcha if
// NOCAPTCHA, or an unsolvable challenge if CHALLENGE.
//
// Possible values:
// "TESTING_CHALLENGE_UNSPECIFIED" - Perform the normal risk analysis and
// return either nocaptcha or a challenge depending on risk and trust factors.
// "NOCAPTCHA" - Challenge requests for this key always return a nocaptcha,
// which does not require a solution.
// "UNSOLVABLE_CHALLENGE" - Challenge requests for this key always return an
// unsolvable challenge.
TestingChallenge string `json:"testingChallenge,omitempty"`
// TestingScore: Optional. All assessments for this Key will return this score.
// Must be between 0 (likely not legitimate) and 1 (likely legitimate)
// inclusive.
TestingScore float64 `json:"testingScore,omitempty"`
// ForceSendFields is a list of field names (e.g. "TestingChallenge") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "TestingChallenge") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudRecaptchaenterpriseV1TestingOptions) MarshalJSON() ([]byte, error)
func (s *GoogleCloudRecaptchaenterpriseV1TestingOptions) UnmarshalJSON(data []byte) error
GoogleCloudRecaptchaenterpriseV1TokenProperties: Properties of the provided event token.
type GoogleCloudRecaptchaenterpriseV1TokenProperties struct {
// Action: Output only. Action name provided at token generation.
Action string `json:"action,omitempty"`
// AndroidPackageName: Output only. The name of the Android package with which
// the token was generated (Android keys only).
AndroidPackageName string `json:"androidPackageName,omitempty"`
// CreateTime: Output only. The timestamp corresponding to the generation of
// the token.
CreateTime string `json:"createTime,omitempty"`
// Hostname: Output only. The hostname of the page on which the token was
// generated (Web keys only).
Hostname string `json:"hostname,omitempty"`
// InvalidReason: Output only. Reason associated with the response when valid =
// false.
//
// Possible values:
// "INVALID_REASON_UNSPECIFIED" - Default unspecified type.
// "UNKNOWN_INVALID_REASON" - If the failure reason was not accounted for.
// "MALFORMED" - The provided user verification token was malformed.
// "EXPIRED" - The user verification token had expired.
// "DUPE" - The user verification had already been seen.
// "MISSING" - The user verification token was not present.
// "BROWSER_ERROR" - A retriable error (such as network failure) occurred on
// the browser. Could easily be simulated by an attacker.
InvalidReason string `json:"invalidReason,omitempty"`
// IosBundleId: Output only. The ID of the iOS bundle with which the token was
// generated (iOS keys only).
IosBundleId string `json:"iosBundleId,omitempty"`
// Valid: Output only. Whether the provided user response token is valid. When
// valid = false, the reason could be specified in invalid_reason or it could
// also be due to a user failing to solve a challenge or a sitekey mismatch
// (i.e the sitekey used to generate the token was different than the one
// specified in the assessment).
Valid bool `json:"valid,omitempty"`
// ForceSendFields is a list of field names (e.g. "Action") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Action") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudRecaptchaenterpriseV1TokenProperties) MarshalJSON() ([]byte, error)
GoogleCloudRecaptchaenterpriseV1TransactionData: Transaction data associated with a payment protected by reCAPTCHA Enterprise.
type GoogleCloudRecaptchaenterpriseV1TransactionData struct {
// BillingAddress: Optional. Address associated with the payment method when
// applicable.
BillingAddress *GoogleCloudRecaptchaenterpriseV1TransactionDataAddress `json:"billingAddress,omitempty"`
// CardBin: Optional. The Bank Identification Number - generally the first 6 or
// 8 digits of the card.
CardBin string `json:"cardBin,omitempty"`
// CardLastFour: Optional. The last four digits of the card.
CardLastFour string `json:"cardLastFour,omitempty"`
// CurrencyCode: Optional. The currency code in ISO-4217 format.
CurrencyCode string `json:"currencyCode,omitempty"`
// GatewayInfo: Optional. Information about the payment gateway's response to
// the transaction.
GatewayInfo *GoogleCloudRecaptchaenterpriseV1TransactionDataGatewayInfo `json:"gatewayInfo,omitempty"`
// Items: Optional. Items purchased in this transaction.
Items []*GoogleCloudRecaptchaenterpriseV1TransactionDataItem `json:"items,omitempty"`
// Merchants: Optional. Information about the user or users fulfilling the
// transaction.
Merchants []*GoogleCloudRecaptchaenterpriseV1TransactionDataUser `json:"merchants,omitempty"`
// PaymentMethod: Optional. The payment method for the transaction. The allowed
// values are: * credit-card * debit-card * gift-card * processor-{name} (If a
// third-party is used, for example, processor-paypal) * custom-{name} (If an
// alternative method is used, for example, custom-crypto)
PaymentMethod string `json:"paymentMethod,omitempty"`
// ShippingAddress: Optional. Destination address if this transaction involves
// shipping a physical item.
ShippingAddress *GoogleCloudRecaptchaenterpriseV1TransactionDataAddress `json:"shippingAddress,omitempty"`
// ShippingValue: Optional. The value of shipping in the specified currency. 0
// for free or no shipping.
ShippingValue float64 `json:"shippingValue,omitempty"`
// TransactionId: Unique identifier for the transaction. This custom identifier
// can be used to reference this transaction in the future, for example,
// labeling a refund or chargeback event. Two attempts at the same transaction
// should use the same transaction id.
TransactionId string `json:"transactionId,omitempty"`
// User: Optional. Information about the user paying/initiating the
// transaction.
User *GoogleCloudRecaptchaenterpriseV1TransactionDataUser `json:"user,omitempty"`
// Value: Optional. The decimal value of the transaction in the specified
// currency.
Value float64 `json:"value,omitempty"`
// ForceSendFields is a list of field names (e.g. "BillingAddress") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "BillingAddress") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudRecaptchaenterpriseV1TransactionData) MarshalJSON() ([]byte, error)
func (s *GoogleCloudRecaptchaenterpriseV1TransactionData) UnmarshalJSON(data []byte) error
GoogleCloudRecaptchaenterpriseV1TransactionDataAddress: Structured address format for billing and shipping addresses.
type GoogleCloudRecaptchaenterpriseV1TransactionDataAddress struct {
// Address: Optional. The first lines of the address. The first line generally
// contains the street name and number, and further lines may include
// information such as an apartment number.
Address []string `json:"address,omitempty"`
// AdministrativeArea: Optional. The state, province, or otherwise
// administrative area of the address.
AdministrativeArea string `json:"administrativeArea,omitempty"`
// Locality: Optional. The town/city of the address.
Locality string `json:"locality,omitempty"`
// PostalCode: Optional. The postal or ZIP code of the address.
PostalCode string `json:"postalCode,omitempty"`
// Recipient: Optional. The recipient name, potentially including information
// such as "care of".
Recipient string `json:"recipient,omitempty"`
// RegionCode: Optional. The CLDR country/region of the address.
RegionCode string `json:"regionCode,omitempty"`
// ForceSendFields is a list of field names (e.g. "Address") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Address") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudRecaptchaenterpriseV1TransactionDataAddress) MarshalJSON() ([]byte, error)
GoogleCloudRecaptchaenterpriseV1TransactionDataGatewayInfo: Details about the transaction from the gateway.
type GoogleCloudRecaptchaenterpriseV1TransactionDataGatewayInfo struct {
// AvsResponseCode: Optional. AVS response code from the gateway (available
// only when reCAPTCHA Enterprise is called after authorization).
AvsResponseCode string `json:"avsResponseCode,omitempty"`
// CvvResponseCode: Optional. CVV response code from the gateway (available
// only when reCAPTCHA Enterprise is called after authorization).
CvvResponseCode string `json:"cvvResponseCode,omitempty"`
// GatewayResponseCode: Optional. Gateway response code describing the state of
// the transaction.
GatewayResponseCode string `json:"gatewayResponseCode,omitempty"`
// Name: Optional. Name of the gateway service (for example, stripe, square,
// paypal).
Name string `json:"name,omitempty"`
// ForceSendFields is a list of field names (e.g. "AvsResponseCode") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AvsResponseCode") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudRecaptchaenterpriseV1TransactionDataGatewayInfo) MarshalJSON() ([]byte, error)
GoogleCloudRecaptchaenterpriseV1TransactionDataItem: Line items being purchased in this transaction.
type GoogleCloudRecaptchaenterpriseV1TransactionDataItem struct {
// MerchantAccountId: Optional. When a merchant is specified, its corresponding
// account_id. Necessary to populate marketplace-style transactions.
MerchantAccountId string `json:"merchantAccountId,omitempty"`
// Name: Optional. The full name of the item.
Name string `json:"name,omitempty"`
// Quantity: Optional. The quantity of this item that is being purchased.
Quantity int64 `json:"quantity,omitempty,string"`
// Value: Optional. The value per item that the user is paying, in the
// transaction currency, after discounts.
Value float64 `json:"value,omitempty"`
// ForceSendFields is a list of field names (e.g. "MerchantAccountId") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "MerchantAccountId") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudRecaptchaenterpriseV1TransactionDataItem) MarshalJSON() ([]byte, error)
func (s *GoogleCloudRecaptchaenterpriseV1TransactionDataItem) UnmarshalJSON(data []byte) error
GoogleCloudRecaptchaenterpriseV1TransactionDataUser: Details about a user's account involved in the transaction.
type GoogleCloudRecaptchaenterpriseV1TransactionDataUser struct {
// AccountId: Optional. Unique account identifier for this user. If using
// account defender, this should match the hashed_account_id field. Otherwise,
// a unique and persistent identifier for this account.
AccountId string `json:"accountId,omitempty"`
// CreationMs: Optional. The epoch milliseconds of the user's account creation.
CreationMs int64 `json:"creationMs,omitempty,string"`
// Email: Optional. The email address of the user.
Email string `json:"email,omitempty"`
// EmailVerified: Optional. Whether the email has been verified to be
// accessible by the user (OTP or similar).
EmailVerified bool `json:"emailVerified,omitempty"`
// PhoneNumber: Optional. The phone number of the user, with country code.
PhoneNumber string `json:"phoneNumber,omitempty"`
// PhoneVerified: Optional. Whether the phone number has been verified to be
// accessible by the user (OTP or similar).
PhoneVerified bool `json:"phoneVerified,omitempty"`
// ForceSendFields is a list of field names (e.g. "AccountId") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AccountId") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudRecaptchaenterpriseV1TransactionDataUser) MarshalJSON() ([]byte, error)
GoogleCloudRecaptchaenterpriseV1TransactionEvent: Describes an event in the lifecycle of a payment transaction.
type GoogleCloudRecaptchaenterpriseV1TransactionEvent struct {
// EventTime: Optional. Timestamp when this transaction event occurred;
// otherwise assumed to be the time of the API call.
EventTime string `json:"eventTime,omitempty"`
// EventType: Optional. The type of this transaction event.
//
// Possible values:
// "TRANSACTION_EVENT_TYPE_UNSPECIFIED" - Default, unspecified event type.
// "MERCHANT_APPROVE" - Indicates that the transaction is approved by the
// merchant. The accompanying reasons can include terms such as 'INHOUSE',
// 'ACCERTIFY', 'CYBERSOURCE', or 'MANUAL_REVIEW'.
// "MERCHANT_DENY" - Indicates that the transaction is denied and concluded
// due to risks detected by the merchant. The accompanying reasons can include
// terms such as 'INHOUSE', 'ACCERTIFY', 'CYBERSOURCE', or 'MANUAL_REVIEW'.
// "MANUAL_REVIEW" - Indicates that the transaction is being evaluated by a
// human, due to suspicion or risk.
// "AUTHORIZATION" - Indicates that the authorization attempt with the card
// issuer succeeded.
// "AUTHORIZATION_DECLINE" - Indicates that the authorization attempt with
// the card issuer failed. The accompanying reasons can include Visa's '54'
// indicating that the card is expired, or '82' indicating that the CVV is
// incorrect.
// "PAYMENT_CAPTURE" - Indicates that the transaction is completed because
// the funds were settled.
// "PAYMENT_CAPTURE_DECLINE" - Indicates that the transaction could not be
// completed because the funds were not settled.
// "CANCEL" - Indicates that the transaction has been canceled. Specify the
// reason for the cancellation. For example, 'INSUFFICIENT_INVENTORY'.
// "CHARGEBACK_INQUIRY" - Indicates that the merchant has received a
// chargeback inquiry due to fraud for the transaction, requesting additional
// information before a fraud chargeback is officially issued and a formal
// chargeback notification is sent.
// "CHARGEBACK_ALERT" - Indicates that the merchant has received a chargeback
// alert due to fraud for the transaction. The process of resolving the dispute
// without involving the payment network is started.
// "FRAUD_NOTIFICATION" - Indicates that a fraud notification is issued for
// the transaction, sent by the payment instrument's issuing bank because the
// transaction appears to be fraudulent. We recommend including TC40 or SAFE
// data in the `reason` field for this event type. For partial chargebacks, we
// recommend that you include an amount in the `value` field.
// "CHARGEBACK" - Indicates that the merchant is informed by the payment
// network that the transaction has entered the chargeback process due to
// fraud. Reason code examples include Discover's '6005' and '6041'. For
// partial chargebacks, we recommend that you include an amount in the `value`
// field.
// "CHARGEBACK_REPRESENTMENT" - Indicates that the transaction has entered
// the chargeback process due to fraud, and that the merchant has chosen to
// enter representment. Reason examples include Discover's '6005' and '6041'.
// For partial chargebacks, we recommend that you include an amount in the
// `value` field.
// "CHARGEBACK_REVERSE" - Indicates that the transaction has had a fraud
// chargeback which was illegitimate and was reversed as a result. For partial
// chargebacks, we recommend that you include an amount in the `value` field.
// "REFUND_REQUEST" - Indicates that the merchant has received a refund for a
// completed transaction. For partial refunds, we recommend that you include an
// amount in the `value` field. Reason example: 'TAX_EXEMPT' (partial refund of
// exempt tax)
// "REFUND_DECLINE" - Indicates that the merchant has received a refund
// request for this transaction, but that they have declined it. For partial
// refunds, we recommend that you include an amount in the `value` field.
// Reason example: 'TAX_EXEMPT' (partial refund of exempt tax)
// "REFUND" - Indicates that the completed transaction was refunded by the
// merchant. For partial refunds, we recommend that you include an amount in
// the `value` field. Reason example: 'TAX_EXEMPT' (partial refund of exempt
// tax)
// "REFUND_REVERSE" - Indicates that the completed transaction was refunded
// by the merchant, and that this refund was reversed. For partial refunds, we
// recommend that you include an amount in the `value` field.
EventType string `json:"eventType,omitempty"`
// Reason: Optional. The reason or standardized code that corresponds with this
// transaction event, if one exists. For example, a CHARGEBACK event with code
// 6005.
Reason string `json:"reason,omitempty"`
// Value: Optional. The value that corresponds with this transaction event, if
// one exists. For example, a refund event where $5.00 was refunded. Currency
// is obtained from the original transaction data.
Value float64 `json:"value,omitempty"`
// ForceSendFields is a list of field names (e.g. "EventTime") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "EventTime") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudRecaptchaenterpriseV1TransactionEvent) MarshalJSON() ([]byte, error)
func (s *GoogleCloudRecaptchaenterpriseV1TransactionEvent) UnmarshalJSON(data []byte) error
GoogleCloudRecaptchaenterpriseV1UserId: An identifier associated with a user.
type GoogleCloudRecaptchaenterpriseV1UserId struct {
// Email: Optional. An email address.
Email string `json:"email,omitempty"`
// PhoneNumber: Optional. A phone number. Should use the E.164 format.
PhoneNumber string `json:"phoneNumber,omitempty"`
// Username: Optional. A unique username, if different from all the other
// identifiers and `account_id` that are provided. Can be a unique login handle
// or display name for a user.
Username string `json:"username,omitempty"`
// ForceSendFields is a list of field names (e.g. "Email") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Email") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudRecaptchaenterpriseV1UserId) MarshalJSON() ([]byte, error)
GoogleCloudRecaptchaenterpriseV1UserInfo: User information associated with a request protected by reCAPTCHA Enterprise.
type GoogleCloudRecaptchaenterpriseV1UserInfo struct {
// AccountId: Optional. For logged-in requests or login/registration requests,
// the unique account identifier associated with this user. You can use the
// username if it is stable (meaning it is the same for every request
// associated with the same user), or any stable user ID of your choice. Leave
// blank for non logged-in actions or guest checkout.
AccountId string `json:"accountId,omitempty"`
// CreateAccountTime: Optional. Creation time for this account associated with
// this user. Leave blank for non logged-in actions, guest checkout, or when
// there is no account associated with the current user.
CreateAccountTime string `json:"createAccountTime,omitempty"`
// UserIds: Optional. Identifiers associated with this user or request.
UserIds []*GoogleCloudRecaptchaenterpriseV1UserId `json:"userIds,omitempty"`
// ForceSendFields is a list of field names (e.g. "AccountId") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AccountId") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudRecaptchaenterpriseV1UserInfo) MarshalJSON() ([]byte, error)
GoogleCloudRecaptchaenterpriseV1WafSettings: Settings specific to keys that can be used for WAF (Web Application Firewall).
type GoogleCloudRecaptchaenterpriseV1WafSettings struct {
// WafFeature: Required. The WAF feature for which this key is enabled.
//
// Possible values:
// "WAF_FEATURE_UNSPECIFIED" - Undefined feature.
// "CHALLENGE_PAGE" - Redirects suspicious traffic to reCAPTCHA.
// "SESSION_TOKEN" - Use reCAPTCHA session-tokens to protect the whole user
// session on the site's domain.
// "ACTION_TOKEN" - Use reCAPTCHA action-tokens to protect user actions.
// "EXPRESS" - Use reCAPTCHA WAF express protection to protect any content
// other than web pages, like APIs and IoT devices.
WafFeature string `json:"wafFeature,omitempty"`
// WafService: Required. The WAF service that uses this key.
//
// Possible values:
// "WAF_SERVICE_UNSPECIFIED" - Undefined WAF
// "CA" - Cloud Armor
// "FASTLY" - Fastly
// "CLOUDFLARE" - Cloudflare
WafService string `json:"wafService,omitempty"`
// ForceSendFields is a list of field names (e.g. "WafFeature") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "WafFeature") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudRecaptchaenterpriseV1WafSettings) MarshalJSON() ([]byte, error)
GoogleCloudRecaptchaenterpriseV1WebKeySettings: Settings specific to keys that can be used by websites.
type GoogleCloudRecaptchaenterpriseV1WebKeySettings struct {
// AllowAllDomains: Optional. If set to true, it means allowed_domains will not
// be enforced.
AllowAllDomains bool `json:"allowAllDomains,omitempty"`
// AllowAmpTraffic: Optional. If set to true, the key can be used on AMP
// (Accelerated Mobile Pages) websites. This is supported only for the SCORE
// integration type.
AllowAmpTraffic bool `json:"allowAmpTraffic,omitempty"`
// AllowedDomains: Optional. Domains or subdomains of websites allowed to use
// the key. All subdomains of an allowed domain are automatically allowed. A
// valid domain requires a host and must not include any path, port, query or
// fragment. Examples: 'example.com' or 'subdomain.example.com'
AllowedDomains []string `json:"allowedDomains,omitempty"`
// ChallengeSecurityPreference: Optional. Settings for the frequency and
// difficulty at which this key triggers captcha challenges. This should only
// be specified for IntegrationTypes CHECKBOX and INVISIBLE.
//
// Possible values:
// "CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED" - Default type that indicates
// this enum hasn't been specified.
// "USABILITY" - Key tends to show fewer and easier challenges.
// "BALANCE" - Key tends to show balanced (in amount and difficulty)
// challenges.
// "SECURITY" - Key tends to show more and harder challenges.
ChallengeSecurityPreference string `json:"challengeSecurityPreference,omitempty"`
// IntegrationType: Required. Describes how this key is integrated with the
// website.
//
// Possible values:
// "INTEGRATION_TYPE_UNSPECIFIED" - Default type that indicates this enum
// hasn't been specified. This is not a valid IntegrationType, one of the other
// types must be specified instead.
// "SCORE" - Only used to produce scores. It doesn't display the "I'm not a
// robot" checkbox and never shows captcha challenges.
// "CHECKBOX" - Displays the "I'm not a robot" checkbox and may show captcha
// challenges after it is checked.
// "INVISIBLE" - Doesn't display the "I'm not a robot" checkbox, but may show
// captcha challenges after risk analysis.
IntegrationType string `json:"integrationType,omitempty"`
// ForceSendFields is a list of field names (e.g. "AllowAllDomains") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AllowAllDomains") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudRecaptchaenterpriseV1WebKeySettings) MarshalJSON() ([]byte, error)
GoogleProtobufEmpty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
type GoogleProtobufEmpty struct {
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
}
GoogleRpcStatus: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors).
type GoogleRpcStatus struct {
// Code: The status code, which should be an enum value of google.rpc.Code.
Code int64 `json:"code,omitempty"`
// Details: A list of messages that carry the error details. There is a common
// set of message types for APIs to use.
Details []googleapi.RawMessage `json:"details,omitempty"`
// Message: A developer-facing error message, which should be in English. Any
// user-facing error message should be localized and sent in the
// google.rpc.Status.details field, or localized by the client.
Message string `json:"message,omitempty"`
// ForceSendFields is a list of field names (e.g. "Code") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Code") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleRpcStatus) MarshalJSON() ([]byte, error)
type ProjectsAssessmentsAnnotateCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsAssessmentsAnnotateCall) Context(ctx context.Context) *ProjectsAssessmentsAnnotateCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsAssessmentsAnnotateCall) Do(opts ...googleapi.CallOption) (*GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentResponse, error)
Do executes the "recaptchaenterprise.projects.assessments.annotate" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentResponse.ServerResponse.He ader or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsAssessmentsAnnotateCall) Fields(s ...googleapi.Field) *ProjectsAssessmentsAnnotateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsAssessmentsAnnotateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsAssessmentsCreateCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsAssessmentsCreateCall) Context(ctx context.Context) *ProjectsAssessmentsCreateCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsAssessmentsCreateCall) Do(opts ...googleapi.CallOption) (*GoogleCloudRecaptchaenterpriseV1Assessment, error)
Do executes the "recaptchaenterprise.projects.assessments.create" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecaptchaenterpriseV1Assessment.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsAssessmentsCreateCall) Fields(s ...googleapi.Field) *ProjectsAssessmentsCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsAssessmentsCreateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsAssessmentsService struct {
// contains filtered or unexported fields
}
func NewProjectsAssessmentsService(s *Service) *ProjectsAssessmentsService
func (r *ProjectsAssessmentsService) Annotate(name string, googlecloudrecaptchaenterprisev1annotateassessmentrequest *GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentRequest) *ProjectsAssessmentsAnnotateCall
Annotate: Annotates a previously created Assessment to provide additional information on whether the event turned out to be authentic or fraudulent.
func (r *ProjectsAssessmentsService) Create(parent string, googlecloudrecaptchaenterprisev1assessment *GoogleCloudRecaptchaenterpriseV1Assessment) *ProjectsAssessmentsCreateCall
Create: Creates an Assessment of the likelihood an event is legitimate.
type ProjectsFirewallpoliciesCreateCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsFirewallpoliciesCreateCall) Context(ctx context.Context) *ProjectsFirewallpoliciesCreateCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsFirewallpoliciesCreateCall) Do(opts ...googleapi.CallOption) (*GoogleCloudRecaptchaenterpriseV1FirewallPolicy, error)
Do executes the "recaptchaenterprise.projects.firewallpolicies.create" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecaptchaenterpriseV1FirewallPolicy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsFirewallpoliciesCreateCall) Fields(s ...googleapi.Field) *ProjectsFirewallpoliciesCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsFirewallpoliciesCreateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsFirewallpoliciesDeleteCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsFirewallpoliciesDeleteCall) Context(ctx context.Context) *ProjectsFirewallpoliciesDeleteCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsFirewallpoliciesDeleteCall) Do(opts ...googleapi.CallOption) (*GoogleProtobufEmpty, error)
Do executes the "recaptchaenterprise.projects.firewallpolicies.delete" call. Any non-2xx status code is an error. Response headers are in either *GoogleProtobufEmpty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsFirewallpoliciesDeleteCall) Fields(s ...googleapi.Field) *ProjectsFirewallpoliciesDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsFirewallpoliciesDeleteCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsFirewallpoliciesGetCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsFirewallpoliciesGetCall) Context(ctx context.Context) *ProjectsFirewallpoliciesGetCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsFirewallpoliciesGetCall) Do(opts ...googleapi.CallOption) (*GoogleCloudRecaptchaenterpriseV1FirewallPolicy, error)
Do executes the "recaptchaenterprise.projects.firewallpolicies.get" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecaptchaenterpriseV1FirewallPolicy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsFirewallpoliciesGetCall) Fields(s ...googleapi.Field) *ProjectsFirewallpoliciesGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsFirewallpoliciesGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsFirewallpoliciesGetCall) IfNoneMatch(entityTag string) *ProjectsFirewallpoliciesGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type ProjectsFirewallpoliciesListCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsFirewallpoliciesListCall) Context(ctx context.Context) *ProjectsFirewallpoliciesListCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsFirewallpoliciesListCall) Do(opts ...googleapi.CallOption) (*GoogleCloudRecaptchaenterpriseV1ListFirewallPoliciesResponse, error)
Do executes the "recaptchaenterprise.projects.firewallpolicies.list" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecaptchaenterpriseV1ListFirewallPoliciesResponse.ServerResponse. Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsFirewallpoliciesListCall) Fields(s ...googleapi.Field) *ProjectsFirewallpoliciesListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsFirewallpoliciesListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsFirewallpoliciesListCall) IfNoneMatch(entityTag string) *ProjectsFirewallpoliciesListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *ProjectsFirewallpoliciesListCall) PageSize(pageSize int64) *ProjectsFirewallpoliciesListCall
PageSize sets the optional parameter "pageSize": The maximum number of policies to return. Default is 10. Max limit is 1000.
func (c *ProjectsFirewallpoliciesListCall) PageToken(pageToken string) *ProjectsFirewallpoliciesListCall
PageToken sets the optional parameter "pageToken": The next_page_token value returned from a previous. ListFirewallPoliciesRequest, if any.
func (c *ProjectsFirewallpoliciesListCall) Pages(ctx context.Context, f func(*GoogleCloudRecaptchaenterpriseV1ListFirewallPoliciesResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type ProjectsFirewallpoliciesPatchCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsFirewallpoliciesPatchCall) Context(ctx context.Context) *ProjectsFirewallpoliciesPatchCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsFirewallpoliciesPatchCall) Do(opts ...googleapi.CallOption) (*GoogleCloudRecaptchaenterpriseV1FirewallPolicy, error)
Do executes the "recaptchaenterprise.projects.firewallpolicies.patch" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecaptchaenterpriseV1FirewallPolicy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsFirewallpoliciesPatchCall) Fields(s ...googleapi.Field) *ProjectsFirewallpoliciesPatchCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsFirewallpoliciesPatchCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsFirewallpoliciesPatchCall) UpdateMask(updateMask string) *ProjectsFirewallpoliciesPatchCall
UpdateMask sets the optional parameter "updateMask": The mask to control which fields of the policy get updated. If the mask is not present, all fields will be updated.
type ProjectsFirewallpoliciesReorderCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsFirewallpoliciesReorderCall) Context(ctx context.Context) *ProjectsFirewallpoliciesReorderCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsFirewallpoliciesReorderCall) Do(opts ...googleapi.CallOption) (*GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesResponse, error)
Do executes the "recaptchaenterprise.projects.firewallpolicies.reorder" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesResponse.ServerRespon se.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsFirewallpoliciesReorderCall) Fields(s ...googleapi.Field) *ProjectsFirewallpoliciesReorderCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsFirewallpoliciesReorderCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsFirewallpoliciesService struct {
// contains filtered or unexported fields
}
func NewProjectsFirewallpoliciesService(s *Service) *ProjectsFirewallpoliciesService
func (r *ProjectsFirewallpoliciesService) Create(parent string, googlecloudrecaptchaenterprisev1firewallpolicy *GoogleCloudRecaptchaenterpriseV1FirewallPolicy) *ProjectsFirewallpoliciesCreateCall
Create: Creates a new FirewallPolicy, specifying conditions at which reCAPTCHA Enterprise actions can be executed. A project may have a maximum of 1000 policies.
func (r *ProjectsFirewallpoliciesService) Delete(name string) *ProjectsFirewallpoliciesDeleteCall
Delete: Deletes the specified firewall policy.
func (r *ProjectsFirewallpoliciesService) Get(name string) *ProjectsFirewallpoliciesGetCall
Get: Returns the specified firewall policy.
func (r *ProjectsFirewallpoliciesService) List(parent string) *ProjectsFirewallpoliciesListCall
List: Returns the list of all firewall policies that belong to a project.
func (r *ProjectsFirewallpoliciesService) Patch(name string, googlecloudrecaptchaenterprisev1firewallpolicy *GoogleCloudRecaptchaenterpriseV1FirewallPolicy) *ProjectsFirewallpoliciesPatchCall
Patch: Updates the specified firewall policy.
func (r *ProjectsFirewallpoliciesService) Reorder(parent string, googlecloudrecaptchaenterprisev1reorderfirewallpoliciesrequest *GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesRequest) *ProjectsFirewallpoliciesReorderCall
Reorder: Reorders all firewall policies.
type ProjectsKeysCreateCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsKeysCreateCall) Context(ctx context.Context) *ProjectsKeysCreateCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsKeysCreateCall) Do(opts ...googleapi.CallOption) (*GoogleCloudRecaptchaenterpriseV1Key, error)
Do executes the "recaptchaenterprise.projects.keys.create" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecaptchaenterpriseV1Key.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsKeysCreateCall) Fields(s ...googleapi.Field) *ProjectsKeysCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsKeysCreateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsKeysDeleteCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsKeysDeleteCall) Context(ctx context.Context) *ProjectsKeysDeleteCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsKeysDeleteCall) Do(opts ...googleapi.CallOption) (*GoogleProtobufEmpty, error)
Do executes the "recaptchaenterprise.projects.keys.delete" call. Any non-2xx status code is an error. Response headers are in either *GoogleProtobufEmpty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsKeysDeleteCall) Fields(s ...googleapi.Field) *ProjectsKeysDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsKeysDeleteCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsKeysGetCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsKeysGetCall) Context(ctx context.Context) *ProjectsKeysGetCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsKeysGetCall) Do(opts ...googleapi.CallOption) (*GoogleCloudRecaptchaenterpriseV1Key, error)
Do executes the "recaptchaenterprise.projects.keys.get" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecaptchaenterpriseV1Key.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsKeysGetCall) Fields(s ...googleapi.Field) *ProjectsKeysGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsKeysGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsKeysGetCall) IfNoneMatch(entityTag string) *ProjectsKeysGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type ProjectsKeysGetMetricsCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsKeysGetMetricsCall) Context(ctx context.Context) *ProjectsKeysGetMetricsCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsKeysGetMetricsCall) Do(opts ...googleapi.CallOption) (*GoogleCloudRecaptchaenterpriseV1Metrics, error)
Do executes the "recaptchaenterprise.projects.keys.getMetrics" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecaptchaenterpriseV1Metrics.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsKeysGetMetricsCall) Fields(s ...googleapi.Field) *ProjectsKeysGetMetricsCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsKeysGetMetricsCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsKeysGetMetricsCall) IfNoneMatch(entityTag string) *ProjectsKeysGetMetricsCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type ProjectsKeysListCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsKeysListCall) Context(ctx context.Context) *ProjectsKeysListCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsKeysListCall) Do(opts ...googleapi.CallOption) (*GoogleCloudRecaptchaenterpriseV1ListKeysResponse, error)
Do executes the "recaptchaenterprise.projects.keys.list" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecaptchaenterpriseV1ListKeysResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsKeysListCall) Fields(s ...googleapi.Field) *ProjectsKeysListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsKeysListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsKeysListCall) IfNoneMatch(entityTag string) *ProjectsKeysListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *ProjectsKeysListCall) PageSize(pageSize int64) *ProjectsKeysListCall
PageSize sets the optional parameter "pageSize": The maximum number of keys to return. Default is 10. Max limit is 1000.
func (c *ProjectsKeysListCall) PageToken(pageToken string) *ProjectsKeysListCall
PageToken sets the optional parameter "pageToken": The next_page_token value returned from a previous. ListKeysRequest, if any.
func (c *ProjectsKeysListCall) Pages(ctx context.Context, f func(*GoogleCloudRecaptchaenterpriseV1ListKeysResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type ProjectsKeysMigrateCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsKeysMigrateCall) Context(ctx context.Context) *ProjectsKeysMigrateCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsKeysMigrateCall) Do(opts ...googleapi.CallOption) (*GoogleCloudRecaptchaenterpriseV1Key, error)
Do executes the "recaptchaenterprise.projects.keys.migrate" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecaptchaenterpriseV1Key.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsKeysMigrateCall) Fields(s ...googleapi.Field) *ProjectsKeysMigrateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsKeysMigrateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsKeysPatchCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsKeysPatchCall) Context(ctx context.Context) *ProjectsKeysPatchCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsKeysPatchCall) Do(opts ...googleapi.CallOption) (*GoogleCloudRecaptchaenterpriseV1Key, error)
Do executes the "recaptchaenterprise.projects.keys.patch" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecaptchaenterpriseV1Key.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsKeysPatchCall) Fields(s ...googleapi.Field) *ProjectsKeysPatchCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsKeysPatchCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsKeysPatchCall) UpdateMask(updateMask string) *ProjectsKeysPatchCall
UpdateMask sets the optional parameter "updateMask": The mask to control which fields of the key get updated. If the mask is not present, all fields will be updated.
type ProjectsKeysRetrieveLegacySecretKeyCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsKeysRetrieveLegacySecretKeyCall) Context(ctx context.Context) *ProjectsKeysRetrieveLegacySecretKeyCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsKeysRetrieveLegacySecretKeyCall) Do(opts ...googleapi.CallOption) (*GoogleCloudRecaptchaenterpriseV1RetrieveLegacySecretKeyResponse, error)
Do executes the "recaptchaenterprise.projects.keys.retrieveLegacySecretKey" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecaptchaenterpriseV1RetrieveLegacySecretKeyResponse.ServerRespon se.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsKeysRetrieveLegacySecretKeyCall) Fields(s ...googleapi.Field) *ProjectsKeysRetrieveLegacySecretKeyCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsKeysRetrieveLegacySecretKeyCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsKeysRetrieveLegacySecretKeyCall) IfNoneMatch(entityTag string) *ProjectsKeysRetrieveLegacySecretKeyCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type ProjectsKeysService struct {
// contains filtered or unexported fields
}
func NewProjectsKeysService(s *Service) *ProjectsKeysService
func (r *ProjectsKeysService) Create(parent string, googlecloudrecaptchaenterprisev1key *GoogleCloudRecaptchaenterpriseV1Key) *ProjectsKeysCreateCall
Create: Creates a new reCAPTCHA Enterprise key.
func (r *ProjectsKeysService) Delete(name string) *ProjectsKeysDeleteCall
Delete: Deletes the specified key.
func (r *ProjectsKeysService) Get(name string) *ProjectsKeysGetCall
Get: Returns the specified key.
func (r *ProjectsKeysService) GetMetrics(name string) *ProjectsKeysGetMetricsCall
GetMetrics: Get some aggregated metrics for a Key. This data can be used to build dashboards.
func (r *ProjectsKeysService) List(parent string) *ProjectsKeysListCall
List: Returns the list of all keys that belong to a project.
func (r *ProjectsKeysService) Migrate(name string, googlecloudrecaptchaenterprisev1migratekeyrequest *GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest) *ProjectsKeysMigrateCall
Migrate: 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 Key, and your user must have the reCAPTCHA Enterprise Admin IAM role in the destination project.
func (r *ProjectsKeysService) Patch(name string, googlecloudrecaptchaenterprisev1key *GoogleCloudRecaptchaenterpriseV1Key) *ProjectsKeysPatchCall
Patch: Updates the specified key.
func (r *ProjectsKeysService) RetrieveLegacySecretKey(key string) *ProjectsKeysRetrieveLegacySecretKeyCall
RetrieveLegacySecretKey: Returns the secret key related to the specified public key. You must use the legacy secret key only in a 3rd party integration with legacy reCAPTCHA.
type ProjectsRelatedaccountgroupmembershipsSearchCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsRelatedaccountgroupmembershipsSearchCall) Context(ctx context.Context) *ProjectsRelatedaccountgroupmembershipsSearchCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsRelatedaccountgroupmembershipsSearchCall) Do(opts ...googleapi.CallOption) (*GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsResponse, error)
Do executes the "recaptchaenterprise.projects.relatedaccountgroupmemberships.search" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsResponse .ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsRelatedaccountgroupmembershipsSearchCall) Fields(s ...googleapi.Field) *ProjectsRelatedaccountgroupmembershipsSearchCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsRelatedaccountgroupmembershipsSearchCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsRelatedaccountgroupmembershipsSearchCall) Pages(ctx context.Context, f func(*GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type ProjectsRelatedaccountgroupmembershipsService struct {
// contains filtered or unexported fields
}
func NewProjectsRelatedaccountgroupmembershipsService(s *Service) *ProjectsRelatedaccountgroupmembershipsService
func (r *ProjectsRelatedaccountgroupmembershipsService) Search(project string, googlecloudrecaptchaenterprisev1searchrelatedaccountgroupmembershipsrequest *GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsRequest) *ProjectsRelatedaccountgroupmembershipsSearchCall
Search: Search group memberships related to a given account.
type ProjectsRelatedaccountgroupsListCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsRelatedaccountgroupsListCall) Context(ctx context.Context) *ProjectsRelatedaccountgroupsListCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsRelatedaccountgroupsListCall) Do(opts ...googleapi.CallOption) (*GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupsResponse, error)
Do executes the "recaptchaenterprise.projects.relatedaccountgroups.list" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupsResponse.ServerRespo nse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsRelatedaccountgroupsListCall) Fields(s ...googleapi.Field) *ProjectsRelatedaccountgroupsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsRelatedaccountgroupsListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsRelatedaccountgroupsListCall) IfNoneMatch(entityTag string) *ProjectsRelatedaccountgroupsListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *ProjectsRelatedaccountgroupsListCall) PageSize(pageSize int64) *ProjectsRelatedaccountgroupsListCall
PageSize sets the optional parameter "pageSize": The maximum number of groups to return. The service might return fewer than this value. If unspecified, at most 50 groups are returned. The maximum value is 1000; values above 1000 are coerced to 1000.
func (c *ProjectsRelatedaccountgroupsListCall) PageToken(pageToken string) *ProjectsRelatedaccountgroupsListCall
PageToken sets the optional parameter "pageToken": A page token, received from a previous `ListRelatedAccountGroups` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRelatedAccountGroups` must match the call that provided the page token.
func (c *ProjectsRelatedaccountgroupsListCall) Pages(ctx context.Context, f func(*GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupsResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type ProjectsRelatedaccountgroupsMembershipsListCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsRelatedaccountgroupsMembershipsListCall) Context(ctx context.Context) *ProjectsRelatedaccountgroupsMembershipsListCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsRelatedaccountgroupsMembershipsListCall) Do(opts ...googleapi.CallOption) (*GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupMembershipsResponse, error)
Do executes the "recaptchaenterprise.projects.relatedaccountgroups.memberships.list" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupMembershipsResponse.S erverResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsRelatedaccountgroupsMembershipsListCall) Fields(s ...googleapi.Field) *ProjectsRelatedaccountgroupsMembershipsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsRelatedaccountgroupsMembershipsListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsRelatedaccountgroupsMembershipsListCall) IfNoneMatch(entityTag string) *ProjectsRelatedaccountgroupsMembershipsListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *ProjectsRelatedaccountgroupsMembershipsListCall) PageSize(pageSize int64) *ProjectsRelatedaccountgroupsMembershipsListCall
PageSize sets the optional parameter "pageSize": The maximum number of accounts to return. The service might return fewer than this value. If unspecified, at most 50 accounts are returned. The maximum value is 1000; values above 1000 are coerced to 1000.
func (c *ProjectsRelatedaccountgroupsMembershipsListCall) PageToken(pageToken string) *ProjectsRelatedaccountgroupsMembershipsListCall
PageToken sets the optional parameter "pageToken": A page token, received from a previous `ListRelatedAccountGroupMemberships` call. When paginating, all other parameters provided to `ListRelatedAccountGroupMemberships` must match the call that provided the page token.
func (c *ProjectsRelatedaccountgroupsMembershipsListCall) Pages(ctx context.Context, f func(*GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupMembershipsResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type ProjectsRelatedaccountgroupsMembershipsService struct {
// contains filtered or unexported fields
}
func NewProjectsRelatedaccountgroupsMembershipsService(s *Service) *ProjectsRelatedaccountgroupsMembershipsService
func (r *ProjectsRelatedaccountgroupsMembershipsService) List(parent string) *ProjectsRelatedaccountgroupsMembershipsListCall
List: Get memberships in a group of related accounts.
type ProjectsRelatedaccountgroupsService struct {
Memberships *ProjectsRelatedaccountgroupsMembershipsService
// contains filtered or unexported fields
}
func NewProjectsRelatedaccountgroupsService(s *Service) *ProjectsRelatedaccountgroupsService
func (r *ProjectsRelatedaccountgroupsService) List(parent string) *ProjectsRelatedaccountgroupsListCall
List: List groups of related accounts.
type ProjectsService struct {
Assessments *ProjectsAssessmentsService
Firewallpolicies *ProjectsFirewallpoliciesService
Keys *ProjectsKeysService
Relatedaccountgroupmemberships *ProjectsRelatedaccountgroupmembershipsService
Relatedaccountgroups *ProjectsRelatedaccountgroupsService
// contains filtered or unexported fields
}
func NewProjectsService(s *Service) *ProjectsService
type Service struct {
BasePath string // API endpoint base URL
UserAgent string // optional additional User-Agent fragment
Projects *ProjectsService
// contains filtered or unexported fields
}
func New(client *http.Client) (*Service, error)
New creates a new Service. It uses the provided http.Client for requests.
Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.
func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)
NewService creates a new Service.