feat: add AssessmentEnvironment for CreateAssessement to explicitly describe the environment of the assessment

Google APIs · copybara-github · commit 14d1fe2996a0 · 2024-08-27T08:36:31.000-07:00
PiperOrigin-RevId: 668000366
diff --git a/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.proto b/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.proto
@@ -667,6 +667,12 @@ message Assessment {
   // protection need to be enabled.
   PhoneFraudAssessment phone_fraud_assessment = 12
       [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Optional. The environment creating the assessment. This describes your
+  // environment (the system invoking CreateAssessment), NOT the environment of
+  // your user.
+  AssessmentEnvironment assessment_environment = 14
+      [(google.api.field_behavior) = OPTIONAL];
 }
 
 // The event being assessed.
@@ -2046,6 +2052,22 @@ message WafSettings {
   WafFeature waf_feature = 2 [(google.api.field_behavior) = REQUIRED];
 }
 
+// The environment creating the assessment. This describes your environment
+// (the system invoking CreateAssessment), NOT the environment of your user.
+message AssessmentEnvironment {
+  // Optional. Identifies the client module initiating the CreateAssessment
+  // request. This can be the link to the client module's project. Examples
+  // include:
+  // - "github.com/GoogleCloudPlatform/recaptcha-enterprise-google-tag-manager"
+  // - "cloud.google.com/recaptcha/docs/implement-waf-akamai"
+  // - "cloud.google.com/recaptcha/docs/implement-waf-cloudflare"
+  // - "wordpress.org/plugins/recaptcha-something"
+  string client = 1 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. The version of the client module. For example, "1.0.0".
+  string version = 2 [(google.api.field_behavior) = OPTIONAL];
+}
+
 // Information about the IP or IP range override.
 message IpOverrideData {
   // Enum that represents the type of IP override.
