feat: A new message SeasonalOverride is added

Google APIs · copybara-github · commit 24219fc472ed · 2025-03-04T10:12:25.000-08:00
feat:  A new field `seasonal_overrides` is added to message .google.shopping.merchant.accounts.v1beta.OnlineReturnPolicy

fix!: An existing optional field `type` is converted to required field in message .google.shopping.merchant.accounts.v1beta.OnlineReturnPolicy

fix!: An existing optional field `label` is converted to required field in message .google.shopping.merchant.accounts.v1beta.OnlineReturnPolicy

fix!: An existing optional field `countries` is converted to required field in message .google.shopping.merchant.accounts.v1beta.OnlineReturnPolicy

fix!: An existing optional field `return_policy_uri` is converted to required field in message .google.shopping.merchant.accounts.v1beta.OnlineReturnPolicy

docs: The documentation for method `GetOnlineReturnPolicy` in service `OnlineReturnPolicyService` is improved
docs: The documentation for method `ListOnlineReturnPolicies` in service `OnlineReturnPolicyService` is improved
docs: The documentation for field `parent` in message `.google.shopping.merchant.accounts.v1beta.ListOnlineReturnPoliciesRequest` is improved
docs: The documentation for field `type` in message `.google.shopping.merchant.accounts.v1beta.OnlineReturnPolicy` is improved
docs: The documentation for field `label` in message `.google.shopping.merchant.accounts.v1beta.OnlineReturnPolicy` is improved
docs: The documentation for field `countries` in message `.google.shopping.merchant.accounts.v1beta.OnlineReturnPolicy` is improved
docs: The documentation for field `return_policy_uri` in message `.google.shopping.merchant.accounts.v1beta.OnlineReturnPolicy` is improved
PiperOrigin-RevId: 733372649
diff --git a/google/shopping/merchant/accounts/v1beta/online_return_policy.proto b/google/shopping/merchant/accounts/v1beta/online_return_policy.proto
@@ -21,6 +21,7 @@ import "google/api/client.proto";
 import "google/api/field_behavior.proto";
 import "google/api/resource.proto";
 import "google/shopping/type/types.proto";
+import "google/type/date.proto";
 
 option go_package = "cloud.google.com/go/shopping/merchant/accounts/apiv1beta/accountspb;accountspb";
 option java_multiple_files = true;
@@ -36,7 +37,7 @@ service OnlineReturnPolicyService {
   option (google.api.default_host) = "merchantapi.googleapis.com";
   option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/content";
 
-  // Gets an existing return policy.
+  // Gets an existing return policy for a given business.
   rpc GetOnlineReturnPolicy(GetOnlineReturnPolicyRequest)
       returns (OnlineReturnPolicy) {
     option (google.api.http) = {
@@ -45,7 +46,7 @@ service OnlineReturnPolicyService {
     option (google.api.method_signature) = "name";
   }
 
-  // Lists all existing return policies.
+  // Lists all existing return policies for a given business.
   rpc ListOnlineReturnPolicies(ListOnlineReturnPoliciesRequest)
       returns (ListOnlineReturnPoliciesResponse) {
     option (google.api.http) = {
@@ -69,7 +70,7 @@ message GetOnlineReturnPolicyRequest {
 
 // Request message for the `ListOnlineReturnPolicies` method.
 message ListOnlineReturnPoliciesRequest {
-  // Required. The merchant account for which to list return policies.
+  // Required. The business account for which to list return policies.
   // Format: `accounts/{account}`
   string parent = 1 [
     (google.api.field_behavior) = REQUIRED,
@@ -132,8 +133,8 @@ message OnlineReturnPolicy {
       CUSTOMER_PAYING_ACTUAL_FEE = 2;
     }
 
-    // Type of return shipping fee.
-    Type type = 1;
+    // Required. Type of return shipping fee.
+    Type type = 1 [(google.api.field_behavior) = REQUIRED];
 
     // Fixed return shipping fee amount. This value is only applicable when type
     // is `FIXED`. We will treat the return shipping fee as free if type is
@@ -179,6 +180,31 @@ message OnlineReturnPolicy {
     int64 days = 2;
   }
 
+  message SeasonalOverride {
+    // ReturnWindow: Specifies either a fixed return date or the number of
+    // days (from the delivery date) until which a product can be returned.
+    // [Merchant Return Days](https://schema.org/merchantReturnDays)
+    oneof return_window {
+      // Number of days (from the delivery date) that the product can be
+      // returned.
+      int32 return_days = 5;
+
+      // Fixed end date until which the product can be returned.
+      google.type.Date return_until_date = 6;
+    }
+
+    // Required. Display name of this seasonal override in Merchant Center.
+    string label = 1 [(google.api.field_behavior) = REQUIRED];
+
+    // Required. Defines the date range when this seasonal override applies.
+    // Both start_date and end_date are inclusive.
+    // The dates of the seasonal overrides should not overlap.
+    google.type.Date start_date = 2 [(google.api.field_behavior) = REQUIRED];
+
+    // Required. seasonal override end date (inclusive).
+    google.type.Date end_date = 3 [(google.api.field_behavior) = REQUIRED];
+  }
+
   // The available return methods.
   enum ReturnMethod {
     // Default value. This value is unused.
@@ -213,23 +239,34 @@ message OnlineReturnPolicy {
   // Output only. Return policy ID generated by Google.
   string return_policy_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
 
-  // This field represents the unique user-defined label of the return policy.
-  // It is important to note that the same label cannot be used in different
-  // return policies for the same country. Unless a product specifies a specific
-  // label attribute, policies will be automatically labeled as 'default'.
-  // To assign a custom return policy to certain product groups, follow the
-  // instructions provided in the [Return policy label]
+  // Required. Immutable. This field represents the unique user-defined label of
+  // the return policy. It is important to note that the same label cannot be
+  // used in different return policies for the same country. Unless a product
+  // specifies a specific label attribute, policies will be automatically
+  // labeled as 'default'. To assign a custom return policy to certain product
+  // groups, follow the instructions provided in the [Return policy label]
   // (https://support.google.com/merchants/answer/9445425).
   // The label can contain up to 50 characters.
-  string label = 3;
+  string label = 3 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.field_behavior) = IMMUTABLE
+  ];
 
-  // The countries of sale where the return policy applies. The values
-  // must be a valid 2 letter ISO 3166 code.
-  repeated string countries = 4;
+  // Required. Immutable. The countries of sale where the return policy applies.
+  // The values must be a valid 2 letter ISO 3166 code.
+  repeated string countries = 4 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.field_behavior) = IMMUTABLE
+  ];
 
   // The return policy.
   Policy policy = 5;
 
+  // Optional. Overrides to the general policy for orders placed during a
+  // specific set of time intervals.
+  repeated SeasonalOverride seasonal_overrides = 14
+      [(google.api.field_behavior) = OPTIONAL];
+
   // The restocking fee that applies to all return reason categories. This would
   // be treated as a free restocking fee if the value is not set.
   RestockingFee restocking_fee = 6;
@@ -246,9 +283,9 @@ message OnlineReturnPolicy {
   // and print the return label.
   ReturnShippingFee return_shipping_fee = 9;
 
-  // The return policy uri. This can used by Google to do a sanity check for the
-  // policy. It must be a valid URL.
-  string return_policy_uri = 10;
+  // Required. The return policy uri. This can used by Google to do a sanity
+  // check for the policy. It must be a valid URL.
+  string return_policy_uri = 10 [(google.api.field_behavior) = REQUIRED];
 
   // This field specifies if merchant only accepts defective products for
   // returns, and this field is required.
