google-shopping-merchant-order_tracking-v1beta 0.a → 0.1.0

data/proto_docs/google/api/resource.rb

@@ -0,0 +1,227 @@
+# frozen_string_literal: true
+
+# Copyright 2025 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"
+    #         pattern: "projects/{project}/topics/{topic}"
+    #       };
+    #     }
+    #
+    # The ResourceDescriptor Yaml config will look like:
+    #
+    #     resources:
+    #     - type: "pubsub.googleapis.com/Topic"
+    #       pattern: "projects/{project}/topics/{topic}"
+    #
+    # 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"
+    #         pattern: "projects/{project}/logs/{log}"
+    #         pattern: "folders/{folder}/logs/{log}"
+    #         pattern: "organizations/{organization}/logs/{log}"
+    #         pattern: "billingAccounts/{billing_account}/logs/{log}"
+    #       };
+    #     }
+    #
+    # The ResourceDescriptor Yaml config will look like:
+    #
+    #     resources:
+    #     - type: 'logging.googleapis.com/LogEntry'
+    #       pattern: "projects/{project}/logs/{log}"
+    #       pattern: "folders/{folder}/logs/{log}"
+    #       pattern: "organizations/{organization}/logs/{log}"
+    #       pattern: "billingAccounts/{billing_account}/logs/{log}"
+    # @!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 and permission names, such as
+    #     'projects' for the resource name of 'projects/\\{project}' and the permission
+    #     name of 'cloudresourcemanager.googleapis.com/projects.get'. One exception
+    #     to this is for Nested Collections that have stuttering names, as defined
+    #     in [AIP-122](https://google.aip.dev/122#nested-collections), where the
+    #     collection ID in the resource name pattern does not necessarily directly
+    #     match the `plural` value.
+    #
+    #     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/
+    #
+    #     Note: The plural form is required even for singleton resources. See
+    #     https://aip.dev/156
+    # @!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.
+    # @!attribute [rw] style
+    #   @return [::Array<::Google::Api::ResourceDescriptor::Style>]
+    #     Style flag(s) for this resource.
+    #     These indicate that a resource is expected to conform to a given
+    #     style. See the specific style flags for additional information.
+    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
+
+      # A flag representing a specific style that a resource claims to conform to.
+      module Style
+        # The unspecified value. Do not use.
+        STYLE_UNSPECIFIED = 0
+
+        # This resource is intended to be "declarative-friendly".
+        #
+        # Declarative-friendly resources must be more strictly consistent, and
+        # setting this to true communicates to tools that this resource should
+        # adhere to declarative-friendly expectations.
+        #
+        # Note: This is used by the API linter (linter.aip.dev) to enable
+        # additional checks.
+        DECLARATIVE_FRIENDLY = 1
+      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"
+    #           }];
+    #         }
+    #
+    #     Occasionally, a field may reference an arbitrary resource. In this case,
+    #     APIs use the special value * in their resource reference.
+    #
+    #     Example:
+    #
+    #         message GetIamPolicyRequest {
+    #           string resource = 2 [(google.api.resource_reference) = {
+    #             type: "*"
+    #           }];
+    #         }
+    # @!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/protobuf/duration.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+# Copyright 2025 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 Protobuf
+    # A Duration represents a signed, fixed-length span of time represented
+    # as a count of seconds and fractions of seconds at nanosecond
+    # resolution. It is independent of any calendar and concepts like "day"
+    # or "month". It is related to Timestamp in that the difference between
+    # two Timestamp values is a Duration and it can be added or subtracted
+    # from a Timestamp. Range is approximately +-10,000 years.
+    #
+    # # Examples
+    #
+    # Example 1: Compute Duration from two Timestamps in pseudo code.
+    #
+    #     Timestamp start = ...;
+    #     Timestamp end = ...;
+    #     Duration duration = ...;
+    #
+    #     duration.seconds = end.seconds - start.seconds;
+    #     duration.nanos = end.nanos - start.nanos;
+    #
+    #     if (duration.seconds < 0 && duration.nanos > 0) {
+    #       duration.seconds += 1;
+    #       duration.nanos -= 1000000000;
+    #     } else if (duration.seconds > 0 && duration.nanos < 0) {
+    #       duration.seconds -= 1;
+    #       duration.nanos += 1000000000;
+    #     }
+    #
+    # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
+    #
+    #     Timestamp start = ...;
+    #     Duration duration = ...;
+    #     Timestamp end = ...;
+    #
+    #     end.seconds = start.seconds + duration.seconds;
+    #     end.nanos = start.nanos + duration.nanos;
+    #
+    #     if (end.nanos < 0) {
+    #       end.seconds -= 1;
+    #       end.nanos += 1000000000;
+    #     } else if (end.nanos >= 1000000000) {
+    #       end.seconds += 1;
+    #       end.nanos -= 1000000000;
+    #     }
+    #
+    # Example 3: Compute Duration from datetime.timedelta in Python.
+    #
+    #     td = datetime.timedelta(days=3, minutes=10)
+    #     duration = Duration()
+    #     duration.FromTimedelta(td)
+    #
+    # # JSON Mapping
+    #
+    # In JSON format, the Duration type is encoded as a string rather than an
+    # object, where the string ends in the suffix "s" (indicating seconds) and
+    # is preceded by the number of seconds, with nanoseconds expressed as
+    # fractional seconds. For example, 3 seconds with 0 nanoseconds should be
+    # encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should
+    # be expressed in JSON format as "3.000000001s", and 3 seconds and 1
+    # microsecond should be expressed in JSON format as "3.000001s".
+    # @!attribute [rw] seconds
+    #   @return [::Integer]
+    #     Signed seconds of the span of time. Must be from -315,576,000,000
+    #     to +315,576,000,000 inclusive. Note: these bounds are computed from:
+    #     60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+    # @!attribute [rw] nanos
+    #   @return [::Integer]
+    #     Signed fractions of a second at nanosecond resolution of the span
+    #     of time. Durations less than one second are represented with a 0
+    #     `seconds` field and a positive or negative `nanos` field. For durations
+    #     of one second or more, a non-zero value for the `nanos` field must be
+    #     of the same sign as the `seconds` field. Must be from -999,999,999
+    #     to +999,999,999 inclusive.
+    class Duration
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

data/proto_docs/google/shopping/merchant/ordertracking/v1beta/order_tracking_signals.rb

@@ -0,0 +1,211 @@
+# frozen_string_literal: true
+
+# Copyright 2025 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 Shopping
+    module Merchant
+      module OrderTracking
+        module V1beta
+          # Signals only can be created but not updated.
+          # Businesses need to call this API only when the order is completely shipped.
+          # Creates new order signal.
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. The account of the business for which the order signal is
+          #     created. Format: accounts/\\{account}
+          # @!attribute [r] order_tracking_signal_id
+          #   @return [::String]
+          #     Output only. The ID that uniquely identifies this order tracking signal.
+          # @!attribute [rw] order_tracking_signal
+          #   @return [::Google::Shopping::Merchant::OrderTracking::V1beta::OrderTrackingSignal]
+          #     Required. The order signal to be created.
+          class CreateOrderTrackingSignalRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Represents a business trade from which signals are extracted, such as
+          # shipping.
+          # @!attribute [r] order_tracking_signal_id
+          #   @return [::Integer]
+          #     Output only. The ID that uniquely identifies this order tracking signal.
+          # @!attribute [rw] merchant_id
+          #   @return [::Integer]
+          #     Optional. The Google Merchant Center ID of this order tracking signal. This
+          #     value is optional. If left unset, the caller's Merchant Center ID is used.
+          #     You must request access in order to provide data on behalf of another
+          #     business. For more information, see [Submitting Order Tracking
+          #     Signals](/shopping-content/guides/order-tracking-signals).
+          # @!attribute [rw] order_created_time
+          #   @return [::Google::Type::DateTime]
+          #     Required. The time when the order was created on the businesses side.
+          #     Include the year and timezone string, if available.
+          # @!attribute [rw] order_id
+          #   @return [::String]
+          #     Required. The ID of the order on the businesses side. This field will be
+          #     hashed in returned OrderTrackingSignal creation response.
+          # @!attribute [rw] shipping_info
+          #   @return [::Array<::Google::Shopping::Merchant::OrderTracking::V1beta::OrderTrackingSignal::ShippingInfo>]
+          #     Required. The shipping information for the order.
+          # @!attribute [rw] line_items
+          #   @return [::Array<::Google::Shopping::Merchant::OrderTracking::V1beta::OrderTrackingSignal::LineItemDetails>]
+          #     Required. Information about line items in the order.
+          # @!attribute [rw] shipment_line_item_mapping
+          #   @return [::Array<::Google::Shopping::Merchant::OrderTracking::V1beta::OrderTrackingSignal::ShipmentLineItemMapping>]
+          #     Optional. The mapping of the line items to the shipment information.
+          # @!attribute [rw] customer_shipping_fee
+          #   @return [::Google::Shopping::Type::Price]
+          #     Optional. The shipping fee of the order;
+          #     this value should be set to zero in the case of free shipping.
+          # @!attribute [rw] delivery_postal_code
+          #   @return [::String]
+          #     Optional. The delivery postal code, as a continuous string without spaces
+          #     or dashes, for example "95016". This field will be anonymized in returned
+          #     OrderTrackingSignal creation response.
+          # @!attribute [rw] delivery_region_code
+          #   @return [::String]
+          #     Optional. The [CLDR territory code]
+          #     (http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) for
+          #     the shipping destination.
+          class OrderTrackingSignal
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # The shipping information for the order.
+            # @!attribute [rw] shipment_id
+            #   @return [::String]
+            #     Required. The shipment ID. This field will be hashed in returned
+            #     OrderTrackingSignal creation response.
+            # @!attribute [rw] tracking_id
+            #   @return [::String]
+            #     Optional. The tracking ID of the shipment. This field is required if one
+            #     of the following fields is absent: earliest_delivery_promise_time,
+            #     latest_delivery_promise_time, and actual_delivery_time.
+            # @!attribute [rw] carrier
+            #   @return [::String]
+            #     Optional. The name of the shipping carrier for the delivery. This field
+            #     is required if one of the following fields is absent:
+            #     earliest_delivery_promise_time, latest_delivery_promise_time,
+            #     and actual_delivery_time.
+            # @!attribute [rw] carrier_service
+            #   @return [::String]
+            #     Optional. The service type for fulfillment, such as GROUND, FIRST_CLASS,
+            #     etc.
+            # @!attribute [rw] shipped_time
+            #   @return [::Google::Type::DateTime]
+            #     Optional. The time when the shipment was shipped.
+            #     Include the year and timezone string, if available.
+            # @!attribute [rw] earliest_delivery_promise_time
+            #   @return [::Google::Type::DateTime]
+            #     Optional. The earliest delivery promised time.
+            #     Include the year and timezone string, if available.
+            #     This field is required, if one of the following fields is absent:
+            #     tracking_id or carrier_name.
+            # @!attribute [rw] latest_delivery_promise_time
+            #   @return [::Google::Type::DateTime]
+            #     Optional. The latest delivery promised time.
+            #     Include the year and timezone string, if available.
+            #     This field is required, if one of the following fields is absent:
+            #     tracking_id or carrier_name.
+            # @!attribute [rw] actual_delivery_time
+            #   @return [::Google::Type::DateTime]
+            #     Optional. The time when the shipment was actually delivered.
+            #     Include the year and timezone string, if available.
+            #     This field is required, if one of the following fields is absent:
+            #     tracking_id or carrier_name.
+            # @!attribute [rw] shipping_status
+            #   @return [::Google::Shopping::Merchant::OrderTracking::V1beta::OrderTrackingSignal::ShippingInfo::ShippingState]
+            #     Required. The status of the shipment.
+            # @!attribute [rw] origin_postal_code
+            #   @return [::String]
+            #     Required. The origin postal code, as a continuous string without spaces
+            #     or dashes, for example "95016". This field will be anonymized in returned
+            #     OrderTrackingSignal creation response.
+            # @!attribute [rw] origin_region_code
+            #   @return [::String]
+            #     Required. The [CLDR territory code]
+            #     (http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) for
+            #     the shipping origin.
+            class ShippingInfo
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+
+              # The current status of the shipments.
+              module ShippingState
+                # The shipping status is not known to business.
+                SHIPPING_STATE_UNSPECIFIED = 0
+
+                # All items are shipped.
+                SHIPPED = 1
+
+                # The shipment is already delivered.
+                DELIVERED = 2
+              end
+            end
+
+            # The line items of the order.
+            # @!attribute [rw] line_item_id
+            #   @return [::String]
+            #     Required. The ID for this line item.
+            # @!attribute [rw] product_id
+            #   @return [::String]
+            #     Required. The Content API REST ID of the product, in the
+            #     form channel:contentLanguage:targetCountry:offerId.
+            # @!attribute [rw] gtin
+            #   @return [::String]
+            #     Optional. The Global Trade Item Number.
+            # @!attribute [rw] mpn
+            #   @return [::String]
+            #     Optional. The manufacturer part number.
+            # @!attribute [rw] product_title
+            #   @return [::String]
+            #     Optional. Plain text title of this product.
+            # @!attribute [rw] brand
+            #   @return [::String]
+            #     Optional. Brand of the product.
+            # @!attribute [rw] quantity
+            #   @return [::Integer]
+            #     Required. The quantity of the line item in the order.
+            class LineItemDetails
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # Represents how many items are in the shipment for the given shipment_id
+            # and line_item_id.
+            # @!attribute [rw] shipment_id
+            #   @return [::String]
+            #     Required. The shipment ID. This field will be hashed in returned
+            #     OrderTrackingSignal creation response.
+            # @!attribute [rw] line_item_id
+            #   @return [::String]
+            #     Required. The line item ID.
+            # @!attribute [rw] quantity
+            #   @return [::Integer]
+            #     Required. The line item quantity in the shipment.
+            class ShipmentLineItemMapping
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+        end
+      end
+    end
+  end
+end