google-cloud-recaptcha_enterprise-v1 0.1.0

data/proto_docs/google/api/resource.rb

@@ -0,0 +1,247 @@
+# frozen_string_literal: true
+
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Api
+    # A simple descriptor of a resource type.
+    #
+    # ResourceDescriptor annotates a resource message (either by means of a
+    # protobuf annotation or use in the service config), and associates the
+    # resource's schema, the resource type, and the pattern of the resource name.
+    #
+    # Example:
+    #
+    #     message Topic {
+    #       // Indicates this message defines a resource schema.
+    #       // Declares the resource type in the format of {service}/{kind}.
+    #       // For Kubernetes resources, the format is {api group}/{kind}.
+    #       option (google.api.resource) = {
+    #         type: "pubsub.googleapis.com/Topic"
+    #         name_descriptor: {
+    #           pattern: "projects/{project}/topics/{topic}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #           parent_name_extractor: "projects/{project}"
+    #         }
+    #       };
+    #     }
+    #
+    # The ResourceDescriptor Yaml config will look like:
+    #
+    #    resources:
+    #    - type: "pubsub.googleapis.com/Topic"
+    #      name_descriptor:
+    #        - pattern: "projects/\\{project}/topics/\\{topic}"
+    #          parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #          parent_name_extractor: "projects/\\{project}"
+    #
+    # Sometimes, resources have multiple patterns, typically because they can
+    # live under multiple parents.
+    #
+    # Example:
+    #
+    #     message LogEntry {
+    #       option (google.api.resource) = {
+    #         type: "logging.googleapis.com/LogEntry"
+    #         name_descriptor: {
+    #           pattern: "projects/{project}/logs/{log}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #           parent_name_extractor: "projects/{project}"
+    #         }
+    #         name_descriptor: {
+    #           pattern: "folders/{folder}/logs/{log}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
+    #           parent_name_extractor: "folders/{folder}"
+    #         }
+    #         name_descriptor: {
+    #           pattern: "organizations/{organization}/logs/{log}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Organization"
+    #           parent_name_extractor: "organizations/{organization}"
+    #         }
+    #         name_descriptor: {
+    #           pattern: "billingAccounts/{billing_account}/logs/{log}"
+    #           parent_type: "billing.googleapis.com/BillingAccount"
+    #           parent_name_extractor: "billingAccounts/{billing_account}"
+    #         }
+    #       };
+    #     }
+    #
+    # The ResourceDescriptor Yaml config will look like:
+    #
+    #     resources:
+    #     - type: 'logging.googleapis.com/LogEntry'
+    #       name_descriptor:
+    #         - pattern: "projects/{project}/logs/{log}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #           parent_name_extractor: "projects/{project}"
+    #         - pattern: "folders/{folder}/logs/{log}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
+    #           parent_name_extractor: "folders/{folder}"
+    #         - pattern: "organizations/{organization}/logs/{log}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Organization"
+    #           parent_name_extractor: "organizations/{organization}"
+    #         - pattern: "billingAccounts/{billing_account}/logs/{log}"
+    #           parent_type: "billing.googleapis.com/BillingAccount"
+    #           parent_name_extractor: "billingAccounts/{billing_account}"
+    #
+    # For flexible resources, the resource name doesn't contain parent names, but
+    # the resource itself has parents for policy evaluation.
+    #
+    # Example:
+    #
+    #     message Shelf {
+    #       option (google.api.resource) = {
+    #         type: "library.googleapis.com/Shelf"
+    #         name_descriptor: {
+    #           pattern: "shelves/{shelf}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #         }
+    #         name_descriptor: {
+    #           pattern: "shelves/{shelf}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
+    #         }
+    #       };
+    #     }
+    #
+    # The ResourceDescriptor Yaml config will look like:
+    #
+    #     resources:
+    #     - type: 'library.googleapis.com/Shelf'
+    #       name_descriptor:
+    #         - pattern: "shelves/{shelf}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #         - pattern: "shelves/{shelf}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
+    # @!attribute [rw] type
+    #   @return [String]
+    #     The resource type. It must be in the format of
+    #     \\{service_name}/\\{resource_type_kind}. The `resource_type_kind` must be
+    #     singular and must not include version numbers.
+    #
+    #     Example: `storage.googleapis.com/Bucket`
+    #
+    #     The value of the resource_type_kind must follow the regular expression
+    #     /[A-Za-z][a-zA-Z0-9]+/. It should start with an upper case character and
+    #     should use PascalCase (UpperCamelCase). The maximum number of
+    #     characters allowed for the `resource_type_kind` is 100.
+    # @!attribute [rw] pattern
+    #   @return [Array<String>]
+    #     Optional. The relative resource name pattern associated with this resource
+    #     type. The DNS prefix of the full resource name shouldn't be specified here.
+    #
+    #     The path pattern must follow the syntax, which aligns with HTTP binding
+    #     syntax:
+    #
+    #         Template = Segment { "/" Segment } ;
+    #         Segment = LITERAL | Variable ;
+    #         Variable = "{" LITERAL "}" ;
+    #
+    #     Examples:
+    #
+    #         - "projects/\\{project}/topics/\\{topic}"
+    #         - "projects/\\{project}/knowledgeBases/\\{knowledge_base}"
+    #
+    #     The components in braces correspond to the IDs for each resource in the
+    #     hierarchy. It is expected that, if multiple patterns are provided,
+    #     the same component name (e.g. "project") refers to IDs of the same
+    #     type of resource.
+    # @!attribute [rw] name_field
+    #   @return [String]
+    #     Optional. The field on the resource that designates the resource name
+    #     field. If omitted, this is assumed to be "name".
+    # @!attribute [rw] history
+    #   @return [Google::Api::ResourceDescriptor::History]
+    #     Optional. The historical or future-looking state of the resource pattern.
+    #
+    #     Example:
+    #
+    #         // The InspectTemplate message originally only supported resource
+    #         // names with organization, and project was added later.
+    #         message InspectTemplate {
+    #           option (google.api.resource) = {
+    #             type: "dlp.googleapis.com/InspectTemplate"
+    #             pattern:
+    #             "organizations/{organization}/inspectTemplates/{inspect_template}"
+    #             pattern: "projects/{project}/inspectTemplates/{inspect_template}"
+    #             history: ORIGINALLY_SINGLE_PATTERN
+    #           };
+    #         }
+    # @!attribute [rw] plural
+    #   @return [String]
+    #     The plural name used in the resource name, such as 'projects' for
+    #     the name of 'projects/\\{project}'. It is the same concept of the `plural`
+    #     field in k8s CRD spec
+    #     https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
+    # @!attribute [rw] singular
+    #   @return [String]
+    #     The same concept of the `singular` field in k8s CRD spec
+    #     https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
+    #     Such as "project" for the `resourcemanager.googleapis.com/Project` type.
+    class ResourceDescriptor
+      include Google::Protobuf::MessageExts
+      extend Google::Protobuf::MessageExts::ClassMethods
+
+      # A description of the historical or future-looking state of the
+      # resource pattern.
+      module History
+        # The "unset" value.
+        HISTORY_UNSPECIFIED = 0
+
+        # The resource originally had one pattern and launched as such, and
+        # additional patterns were added later.
+        ORIGINALLY_SINGLE_PATTERN = 1
+
+        # The resource has one pattern, but the API owner expects to add more
+        # later. (This is the inverse of ORIGINALLY_SINGLE_PATTERN, and prevents
+        # that from being necessary once there are multiple patterns.)
+        FUTURE_MULTI_PATTERN = 2
+      end
+    end
+
+    # Defines a proto annotation that describes a string field that refers to
+    # an API resource.
+    # @!attribute [rw] type
+    #   @return [String]
+    #     The resource type that the annotated field references.
+    #
+    #     Example:
+    #
+    #         message Subscription {
+    #           string topic = 2 [(google.api.resource_reference) = {
+    #             type: "pubsub.googleapis.com/Topic"
+    #           }];
+    #         }
+    # @!attribute [rw] child_type
+    #   @return [String]
+    #     The resource type of a child collection that the annotated field
+    #     references. This is useful for annotating the `parent` field that
+    #     doesn't have a fixed resource type.
+    #
+    #     Example:
+    #
+    #       message ListLogEntriesRequest {
+    #         string parent = 1 [(google.api.resource_reference) = {
+    #           child_type: "logging.googleapis.com/LogEntry"
+    #         };
+    #       }
+    class ResourceReference
+      include Google::Protobuf::MessageExts
+      extend Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

data/proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb

@@ -0,0 +1,404 @@
+# frozen_string_literal: true
+
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module RecaptchaEnterprise
+      module V1
+        # The create assessment request message.
+        # @!attribute [rw] parent
+        #   @return [String]
+        #     Required. The name of the project in which the assessment will be created,
+        #     in the format "projects/\\{project}".
+        # @!attribute [rw] assessment
+        #   @return [Google::Cloud::RecaptchaEnterprise::V1::Assessment]
+        #     Required. The assessment details.
+        class CreateAssessmentRequest
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The request message to annotate an Assessment.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     Required. The resource name of the Assessment, in the format
+        #     "projects/\\{project}/assessments/\\{assessment}".
+        # @!attribute [rw] annotation
+        #   @return [Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentRequest::Annotation]
+        #     Required. The annotation that will be assigned to the Event.
+        class AnnotateAssessmentRequest
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+
+          # Enum that reprensents the types of annotations.
+          module Annotation
+            # Default unspecified type.
+            ANNOTATION_UNSPECIFIED = 0
+
+            # Provides information that the event turned out to be legitimate.
+            LEGITIMATE = 1
+
+            # Provides information that the event turned out to be fraudulent.
+            FRAUDULENT = 2
+
+            # Provides information that the event was related to a login event in which
+            # the user typed the correct password.
+            PASSWORD_CORRECT = 3
+
+            # Provides information that the event was related to a login event in which
+            # the user typed the incorrect password.
+            PASSWORD_INCORRECT = 4
+          end
+        end
+
+        # Empty response for AnnotateAssessment.
+        class AnnotateAssessmentResponse
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A recaptcha assessment resource.
+        # @!attribute [r] name
+        #   @return [String]
+        #     Output only. The resource name for the Assessment in the format
+        #     "projects/\\{project}/assessments/\\{assessment}".
+        # @!attribute [rw] event
+        #   @return [Google::Cloud::RecaptchaEnterprise::V1::Event]
+        #     The event being assessed.
+        # @!attribute [r] risk_analysis
+        #   @return [Google::Cloud::RecaptchaEnterprise::V1::RiskAnalysis]
+        #     Output only. The risk analysis result for the event being assessed.
+        # @!attribute [r] token_properties
+        #   @return [Google::Cloud::RecaptchaEnterprise::V1::TokenProperties]
+        #     Output only. Properties of the provided event token.
+        class Assessment
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # @!attribute [rw] token
+        #   @return [String]
+        #     Optional. The user response token provided by the reCAPTCHA client-side integration
+        #     on your site.
+        # @!attribute [rw] site_key
+        #   @return [String]
+        #     Optional. The site key that was used to invoke reCAPTCHA on your site and generate
+        #     the token.
+        # @!attribute [rw] user_agent
+        #   @return [String]
+        #     Optional. The user agent present in the request from the user's device related to
+        #     this event.
+        # @!attribute [rw] user_ip_address
+        #   @return [String]
+        #     Optional. The IP address in the request from the user's device related to this event.
+        # @!attribute [rw] expected_action
+        #   @return [String]
+        #     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.
+        class Event
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Risk analysis result for an event.
+        # @!attribute [rw] score
+        #   @return [Float]
+        #     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).
+        # @!attribute [rw] reasons
+        #   @return [Array<Google::Cloud::RecaptchaEnterprise::V1::RiskAnalysis::ClassificationReason>]
+        #     Reasons contributing to the risk analysis verdict.
+        class RiskAnalysis
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+
+          # LINT.IfChange(classification_reason)
+          # Reasons contributing to the risk analysis verdict.
+          module ClassificationReason
+            # Default unspecified type.
+            CLASSIFICATION_REASON_UNSPECIFIED = 0
+
+            # Interactions matched the behavior of an automated agent.
+            AUTOMATION = 1
+
+            # The event originated from an illegitimate environment.
+            UNEXPECTED_ENVIRONMENT = 2
+
+            # Traffic volume from the event source is higher than normal.
+            TOO_MUCH_TRAFFIC = 3
+
+            # Interactions with the site were significantly different than expected
+            # patterns.
+            UNEXPECTED_USAGE_PATTERNS = 4
+
+            # Too little traffic has been received from this site thus far to generate
+            # quality risk analysis.
+            LOW_CONFIDENCE_SCORE = 5
+          end
+        end
+
+        # @!attribute [rw] valid
+        #   @return [Boolean]
+        #     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).
+        # @!attribute [rw] invalid_reason
+        #   @return [Google::Cloud::RecaptchaEnterprise::V1::TokenProperties::InvalidReason]
+        #     Reason associated with the response when valid = false.
+        # @!attribute [rw] create_time
+        #   @return [Google::Protobuf::Timestamp]
+        #     The timestamp corresponding to the generation of the token.
+        # @!attribute [rw] hostname
+        #   @return [String]
+        #     The hostname of the page on which the token was generated.
+        # @!attribute [rw] action
+        #   @return [String]
+        #     Action name provided at token generation.
+        class TokenProperties
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+
+          # LINT.IfChange
+          # Enum that represents the types of invalid token reasons.
+          module InvalidReason
+            # Default unspecified type.
+            INVALID_REASON_UNSPECIFIED = 0
+
+            # If the failure reason was not accounted for.
+            UNKNOWN_INVALID_REASON = 1
+
+            # The provided user verification token was malformed.
+            MALFORMED = 2
+
+            # The user verification token had expired.
+            EXPIRED = 3
+
+            # The user verification had already been seen.
+            DUPE = 4
+
+            # The user verification token was not present.
+            MISSING = 5
+          end
+        end
+
+        # The create key request message.
+        # @!attribute [rw] parent
+        #   @return [String]
+        #     Required. The name of the project in which the key will be created, in the
+        #     format "projects/\\{project}".
+        # @!attribute [rw] key
+        #   @return [Google::Cloud::RecaptchaEnterprise::V1::Key]
+        #     Required. Information to create a reCAPTCHA Enterprise key.
+        class CreateKeyRequest
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The list keys request message.
+        # @!attribute [rw] parent
+        #   @return [String]
+        #     Required. The name of the project that contains the keys that will be
+        #     listed, in the format "projects/\\{project}".
+        # @!attribute [rw] page_size
+        #   @return [Integer]
+        #     Optional. The maximum number of keys to return. Default is 10. Max limit is
+        #     1000.
+        # @!attribute [rw] page_token
+        #   @return [String]
+        #     Optional. The next_page_token value returned from a previous.
+        #     ListKeysRequest, if any.
+        class ListKeysRequest
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response to request to list keys in a project.
+        # @!attribute [rw] keys
+        #   @return [Array<Google::Cloud::RecaptchaEnterprise::V1::Key>]
+        #     Key details.
+        # @!attribute [rw] next_page_token
+        #   @return [String]
+        #     Token to retrieve the next page of results. It is set to empty if no keys
+        #     remain in results.
+        class ListKeysResponse
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The get key request message.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     Required. The name of the requested key, in the format
+        #     "projects/\\{project}/keys/\\{key}".
+        class GetKeyRequest
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The update key request message.
+        # @!attribute [rw] key
+        #   @return [Google::Cloud::RecaptchaEnterprise::V1::Key]
+        #     Required. The key to update.
+        # @!attribute [rw] update_mask
+        #   @return [Google::Protobuf::FieldMask]
+        #     Optional. The mask to control which field of the key get updated. If the mask is not
+        #     present, all fields will be updated.
+        class UpdateKeyRequest
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The delete key request message.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     Required. The name of the key to be deleted, in the format
+        #     "projects/\\{project}/keys/\\{key}".
+        class DeleteKeyRequest
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A key used to identify and configure applications (web and/or mobile) that
+        # use reCAPTCHA Enterprise.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     The resource name for the Key in the format
+        #     "projects/\\{project}/keys/\\{key}".
+        # @!attribute [rw] display_name
+        #   @return [String]
+        #     Human-readable display name of this key. Modifiable by user.
+        # @!attribute [rw] web_settings
+        #   @return [Google::Cloud::RecaptchaEnterprise::V1::WebKeySettings]
+        #     Settings for keys that can be used by websites.
+        # @!attribute [rw] android_settings
+        #   @return [Google::Cloud::RecaptchaEnterprise::V1::AndroidKeySettings]
+        #     Settings for keys that can be used by Android apps.
+        # @!attribute [rw] ios_settings
+        #   @return [Google::Cloud::RecaptchaEnterprise::V1::IOSKeySettings]
+        #     Settings for keys that can be used by iOS apps.
+        # @!attribute [rw] labels
+        #   @return [Google::Protobuf::Map{String => String}]
+        #     Optional. See <a href="https://cloud.google.com/recaptcha-enterprise/docs/labels">
+        #     Creating and managing labels</a>.
+        # @!attribute [rw] create_time
+        #   @return [Google::Protobuf::Timestamp]
+        #     The timestamp corresponding to the creation of this Key.
+        class Key
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [String]
+          # @!attribute [rw] value
+          #   @return [String]
+          class LabelsEntry
+            include Google::Protobuf::MessageExts
+            extend Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Settings specific to keys that can be used by websites.
+        # @!attribute [rw] allow_all_domains
+        #   @return [Boolean]
+        #     If set to true, it means allowed_domains will not be enforced.
+        # @!attribute [rw] allowed_domains
+        #   @return [Array<String>]
+        #     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'
+        # @!attribute [rw] allow_amp_traffic
+        #   @return [Boolean]
+        #     Required. Whether this key can be used on AMP (Accelerated Mobile Pages) websites.
+        # @!attribute [rw] integration_type
+        #   @return [Google::Cloud::RecaptchaEnterprise::V1::WebKeySettings::IntegrationType]
+        #     Required. Describes how this key is integrated with the website.
+        # @!attribute [rw] challenge_security_preference
+        #   @return [Google::Cloud::RecaptchaEnterprise::V1::WebKeySettings::ChallengeSecurityPreference]
+        #     Settings for the frequency and difficulty at which this key triggers
+        #     captcha challenges. This should only be specified for IntegrationTypes
+        #     CHECKBOX and INVISIBLE.
+        class WebKeySettings
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+
+          # Enum that represents the integration types for web keys.
+          module IntegrationType
+            # 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.
+            INTEGRATION_TYPE_UNSPECIFIED = 0
+
+            # Only used to produce scores. It doesn't display the "I'm not a robot"
+            # checkbox and never shows captcha challenges.
+            SCORE = 1
+
+            # Displays the "I'm not a robot" checkbox and may show captcha challenges
+            # after it is checked.
+            CHECKBOX = 2
+
+            # Doesn't display the "I'm not a robot" checkbox, but may show captcha
+            # challenges after risk analysis.
+            INVISIBLE = 3
+          end
+
+          # Enum that represents the possible challenge frequency and difficulty
+          # configurations for a web key.
+          module ChallengeSecurityPreference
+            # Default type that indicates this enum hasn't been specified.
+            CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED = 0
+
+            # Key tends to show fewer and easier challenges.
+            USABILITY = 1
+
+            # Key tends to show balanced (in amount and difficulty) challenges.
+            BALANCE = 2
+
+            # Key tends to show more and harder challenges.
+            SECURITY = 3
+          end
+        end
+
+        # Settings specific to keys that can be used by Android apps.
+        # @!attribute [rw] allowed_package_names
+        #   @return [Array<String>]
+        #     Android package names of apps allowed to use the key.
+        #     Example: 'com.companyname.appname'
+        class AndroidKeySettings
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Settings specific to keys that can be used by iOS apps.
+        # @!attribute [rw] allowed_bundle_ids
+        #   @return [Array<String>]
+        #     iOS bundle ids of apps allowed to use the key.
+        #     Example: 'com.companyname.productname.appname'
+        class IOSKeySettings
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end