google-shopping-merchant-products-v1 0.a → 0.1.0

data/proto_docs/google/protobuf/timestamp.rb

@@ -0,0 +1,127 @@
+# 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 Timestamp represents a point in time independent of any time zone or local
+    # calendar, encoded as a count of seconds and fractions of seconds at
+    # nanosecond resolution. The count is relative to an epoch at UTC midnight on
+    # January 1, 1970, in the proleptic Gregorian calendar which extends the
+    # Gregorian calendar backwards to year one.
+    #
+    # All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap
+    # second table is needed for interpretation, using a [24-hour linear
+    # smear](https://developers.google.com/time/smear).
+    #
+    # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
+    # restricting to that range, we ensure that we can convert to and from [RFC
+    # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.
+    #
+    # # Examples
+    #
+    # Example 1: Compute Timestamp from POSIX `time()`.
+    #
+    #     Timestamp timestamp;
+    #     timestamp.set_seconds(time(NULL));
+    #     timestamp.set_nanos(0);
+    #
+    # Example 2: Compute Timestamp from POSIX `gettimeofday()`.
+    #
+    #     struct timeval tv;
+    #     gettimeofday(&tv, NULL);
+    #
+    #     Timestamp timestamp;
+    #     timestamp.set_seconds(tv.tv_sec);
+    #     timestamp.set_nanos(tv.tv_usec * 1000);
+    #
+    # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
+    #
+    #     FILETIME ft;
+    #     GetSystemTimeAsFileTime(&ft);
+    #     UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
+    #
+    #     // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
+    #     // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
+    #     Timestamp timestamp;
+    #     timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
+    #     timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
+    #
+    # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
+    #
+    #     long millis = System.currentTimeMillis();
+    #
+    #     Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
+    #         .setNanos((int) ((millis % 1000) * 1000000)).build();
+    #
+    # Example 5: Compute Timestamp from Java `Instant.now()`.
+    #
+    #     Instant now = Instant.now();
+    #
+    #     Timestamp timestamp =
+    #         Timestamp.newBuilder().setSeconds(now.getEpochSecond())
+    #             .setNanos(now.getNano()).build();
+    #
+    # Example 6: Compute Timestamp from current time in Python.
+    #
+    #     timestamp = Timestamp()
+    #     timestamp.GetCurrentTime()
+    #
+    # # JSON Mapping
+    #
+    # In JSON format, the Timestamp type is encoded as a string in the
+    # [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the
+    # format is "\\{year}-\\{month}-\\{day}T\\{hour}:\\{min}:\\{sec}[.\\{frac_sec}]Z"
+    # where \\{year} is always expressed using four digits while \\{month}, \\{day},
+    # \\{hour}, \\{min}, and \\{sec} are zero-padded to two digits each. The fractional
+    # seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution),
+    # are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone
+    # is required. A proto3 JSON serializer should always use UTC (as indicated by
+    # "Z") when printing the Timestamp type and a proto3 JSON parser should be
+    # able to accept both UTC and other timezones (as indicated by an offset).
+    #
+    # For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past
+    # 01:30 UTC on January 15, 2017.
+    #
+    # In JavaScript, one can convert a Date object to this format using the
+    # standard
+    # [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString)
+    # method. In Python, a standard `datetime.datetime` object can be converted
+    # to this format using
+    # [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with
+    # the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use
+    # the Joda Time's [`ISODateTimeFormat.dateTime()`](
+    # http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime()
+    # ) to obtain a formatter capable of generating timestamps in this format.
+    # @!attribute [rw] seconds
+    #   @return [::Integer]
+    #     Represents seconds of UTC time since Unix epoch
+    #     1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
+    #     9999-12-31T23:59:59Z inclusive.
+    # @!attribute [rw] nanos
+    #   @return [::Integer]
+    #     Non-negative fractions of a second at nanosecond resolution. Negative
+    #     second values with fractions must still have non-negative nanos values
+    #     that count forward in time. Must be from 0 to 999,999,999
+    #     inclusive.
+    class Timestamp
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

data/proto_docs/google/shopping/merchant/products/v1/productinputs.rb

@@ -0,0 +1,221 @@
+# 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 Products
+        module V1
+          # This resource represents input data you submit for a product, not the
+          #  processed product that you see in Merchant Center, in Shopping ads, or
+          #  across Google surfaces. Product inputs, rules and supplemental data source
+          #  data are combined to create the processed
+          #  {::Google::Shopping::Merchant::Products::V1::Product Product}. For more
+          #  information, see [Manage products](/merchant/api/guides/products/overview).
+          #
+          #  Required product input attributes to pass data validation checks are
+          #  primarily defined in the [Products Data
+          #  Specification](https://support.google.com/merchants/answer/188494).
+          #
+          #  The following attributes are required:
+          #  {::Google::Shopping::Merchant::Products::V1::Product#feed_label feedLabel},
+          #  {::Google::Shopping::Merchant::Products::V1::Product#content_language contentLanguage}
+          #  and {::Google::Shopping::Merchant::Products::V1::Product#offer_id offerId}.
+          #
+          #  After inserting, updating, or deleting a product input, it may take several
+          #  minutes before the processed product can be retrieved.
+          #
+          #  All fields in the product input and its sub-messages match the English name
+          #  of their corresponding attribute in the [Products Data
+          #  Specification](https://support.google.com/merchants/answer/188494) with
+          #  [some exceptions](https://support.google.com/merchants/answer/7052112).
+          #  The following reference documentation lists the field names in the
+          #  **camelCase** casing style while the Products Data Specification lists the
+          #  names in the **snake_case** casing style.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Identifier. The name of the product input.
+          #     Format: `accounts/{account}/productInputs/{productinput}`
+          #     where the last section `productinput` consists of:
+          #     `content_language~feed_label~offer_id`
+          #     example for product input name is
+          #     `accounts/123/productInputs/en~US~sku123`. A legacy local product input
+          #     name would be `accounts/123/productInputs/local~en~US~sku123`.
+          #     Note: For calls to the v1beta version, the `productInput` section consists
+          #     of: `channel~content_language~feed_label~offer_id`, for example:
+          #     `accounts/123/productInputs/online~en~US~sku123`.
+          # @!attribute [r] product
+          #   @return [::String]
+          #     Output only. The name of the processed product.
+          #     Format: `accounts/{account}/products/{product}`
+          # @!attribute [rw] legacy_local
+          #   @return [::Boolean]
+          #     Immutable. Determines whether the product is **only** targeting
+          #     local destinations and whether the product name should be distinguished
+          #     with a `local~` prefix. For example,
+          #     `accounts/123/productInputs/local~en~US~sku123`. If a product that is not
+          #     `legacy_local` is already targeting local destinations,
+          #     creating a `legacy_local` product with an otherwise matching name will
+          #     fail.
+          # @!attribute [rw] offer_id
+          #   @return [::String]
+          #     Required. Immutable. Your unique identifier for the product. This is the
+          #     same for the product input and processed product. Leading and trailing
+          #     whitespaces are stripped and multiple whitespaces are replaced by a single
+          #     whitespace upon submission. See the [products data
+          #     specification](https://support.google.com/merchants/answer/188494#id) for
+          #     details.
+          # @!attribute [rw] content_language
+          #   @return [::String]
+          #     Required. Immutable. The two-letter [ISO
+          #     639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the
+          #     product.
+          # @!attribute [rw] feed_label
+          #   @return [::String]
+          #     Required. Immutable. The feed label that lets you categorize and identify
+          #     your products. The maximum allowed characters are 20, and the supported
+          #     characters are `A-Z`, `0-9`, hyphen, and underscore. The feed label must
+          #     not include any spaces. For more information, see [Using feed
+          #     labels](//support.google.com/merchants/answer/14994087).
+          # @!attribute [rw] version_number
+          #   @return [::Integer]
+          #     Optional. Immutable. Represents the existing version (freshness) of the
+          #     product, which can be used to preserve the right order when multiple
+          #     updates are done at the same time.
+          #
+          #     If set, the insertion is prevented when version number is lower than
+          #     the current version number of the existing product. Re-insertion (for
+          #     example, product refresh after 30 days) can be performed with the current
+          #     `version_number`.
+          #
+          #     Only supported for insertions into primary data sources.
+          #     Do not set this field for updates.
+          #     Do not set this field for insertions into supplemental data sources.
+          #
+          #     If the operation is prevented, the aborted exception will be
+          #     thrown.
+          # @!attribute [rw] product_attributes
+          #   @return [::Google::Shopping::Merchant::Products::V1::ProductAttributes]
+          #     Optional. A list of strongly-typed product attributes.
+          # @!attribute [rw] custom_attributes
+          #   @return [::Array<::Google::Shopping::Type::CustomAttribute>]
+          #     Optional. A list of custom (merchant-provided) attributes. It can also be
+          #     used for submitting any attribute of the data specification in its generic
+          #     form (for example,
+          #     `{ "name": "size type", "value": "regular" }`).
+          #     This is useful for submitting attributes not explicitly exposed by the
+          #     API.
+          #     Maximum allowed number of characters for each
+          #     custom attribute is 10240 (represents sum of characters for name and
+          #     value). Maximum 2500 custom attributes can be set per product, with total
+          #     size of 102.4kB. Underscores in custom attribute names are replaced by
+          #     spaces upon insertion.
+          class ProductInput
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request message for the InsertProductInput method.
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. The account where this product will be inserted.
+          #     Format: `accounts/{account}`
+          # @!attribute [rw] product_input
+          #   @return [::Google::Shopping::Merchant::Products::V1::ProductInput]
+          #     Required. The product input to insert.
+          # @!attribute [rw] data_source
+          #   @return [::String]
+          #     Required. The primary or supplemental product data source name. If the
+          #     product already exists and data source provided is different, then the
+          #     product will be moved to a new data source. For more information, see
+          #     [Overview of Data sources
+          #     sub-API](/merchant/api/guides/data-sources/overview).
+          #
+          #     Only API data sources are supported.
+          #
+          #     Format: `accounts/{account}/dataSources/{datasource}`. For example,
+          #     `accounts/123456/dataSources/104628`.
+          class InsertProductInputRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request message for the UpdateProductInput method.
+          # The product (primary input) must exist for the update to succeed.
+          # If the update is for a primary product input, the existing primary product
+          # input must be from the same data source.
+          # @!attribute [rw] product_input
+          #   @return [::Google::Shopping::Merchant::Products::V1::ProductInput]
+          #     Required. The product input resource to update. Information you submit will
+          #     be applied to the processed product as well.
+          # @!attribute [rw] update_mask
+          #   @return [::Google::Protobuf::FieldMask]
+          #     Optional. The list of product attributes to be updated.
+          #
+          #     If the update mask is omitted, then it is treated as implied field mask
+          #     equivalent to all fields that are populated (have a non-empty value).
+          #
+          #     Attributes specified in the update mask without a value specified in the
+          #     body will be deleted from the product.
+          #
+          #     Update mask can only be specified for top level fields in
+          #     attributes and custom attributes.
+          #
+          #     To specify the update mask for custom attributes you need to add the
+          #     `custom_attribute.` prefix.
+          #
+          #     Providing special "*" value for full product replacement is not supported.
+          # @!attribute [rw] data_source
+          #   @return [::String]
+          #     Required. The primary or supplemental product data source where
+          #     `data_source` name identifies the product input to be updated.
+          #
+          #     Only API data sources are supported.
+          #
+          #     Format: `accounts/{account}/dataSources/{datasource}`. For example,
+          #     `accounts/123456/dataSources/104628`.
+          class UpdateProductInputRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request message for the DeleteProductInput method.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. The name of the product input resource to delete.
+          #     Format: `accounts/{account}/productInputs/{product}`
+          #     where the last section `product` consists of:
+          #     `content_language~feed_label~offer_id`
+          #     example for product name is
+          #     `accounts/123/productInputs/en~US~sku123`.
+          # @!attribute [rw] data_source
+          #   @return [::String]
+          #     Required. The primary or supplemental data source from which the product
+          #     input should be deleted. Format:
+          #     `accounts/{account}/dataSources/{datasource}`. For example,
+          #     `accounts/123456/dataSources/104628`.
+          class DeleteProductInputRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/shopping/merchant/products/v1/products.rb

@@ -0,0 +1,175 @@
+# 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 Products
+        module V1
+          # The processed product, built from multiple [product
+          # inputs][google.shopping.merchant.products.v1main.ProductInput]
+          # after applying rules and supplemental data sources. This processed product
+          # matches what is shown in your Merchant Center account. Each product is built
+          # from exactly one primary data source product input, and multiple supplemental
+          # data source inputs. After inserting, updating, or deleting a product input,
+          # it may take several minutes before the updated processed product can be
+          # retrieved.
+          #
+          # All fields in the processed product and its sub-messages match the name of
+          # their corresponding attribute in the [Product data
+          # specification](https://support.google.com/merchants/answer/7052112) with some
+          # exceptions.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     The name of the product.
+          #     Format:
+          #     `accounts/{account}/products/{product}` where the last
+          #     section `product` consists of:
+          #     `content_language~feed_label~offer_id`
+          #     example for product name is `accounts/123/products/en~US~sku123`. A legacy
+          #     local product name would be `accounts/123/products/local~en~US~sku123`.
+          #     Note: For calls to the v1beta version, the `product` section consists
+          #     of: `channel~content_language~feed_label~offer_id`, for example:
+          #     `accounts/123/products/online~en~US~sku123`.
+          # @!attribute [r] legacy_local
+          #   @return [::Boolean]
+          #     Output only. Determines whether the product is **only** targeting
+          #     local destinations and whether the product name should be distinguished
+          #     with a `local~` prefix. For example,
+          #     `accounts/123/products/local~en~US~sku123`.
+          # @!attribute [r] offer_id
+          #   @return [::String]
+          #     Output only. Your unique identifier for the product. This is the same for
+          #     the product input and processed product. Leading and trailing whitespaces
+          #     are stripped and multiple whitespaces are replaced by a single whitespace
+          #     upon submission. See the [product data
+          #     specification](https://support.google.com/merchants/answer/188494#id) for
+          #     details.
+          # @!attribute [r] content_language
+          #   @return [::String]
+          #     Output only. The two-letter [ISO
+          #     639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the
+          #     product.
+          # @!attribute [r] feed_label
+          #   @return [::String]
+          #     Output only. The feed label lets you categorize and identify your products.
+          #     The maximum allowed characters is 20 and the supported characters are`A-Z`,
+          #     `0-9`, hyphen and underscore. The feed label must not include any spaces.
+          #     For more information, see [Using feed
+          #     labels](//support.google.com/merchants/answer/14994087)
+          # @!attribute [r] data_source
+          #   @return [::String]
+          #     Output only. The primary data source of the product.
+          # @!attribute [r] version_number
+          #   @return [::Integer]
+          #     Output only. Represents the existing version (freshness) of the product,
+          #     which can be used to preserve the right order when multiple updates are
+          #     done at the same time.
+          #
+          #     If set, the insertion is prevented when version number is lower than
+          #     the current version number of the existing product. Re-insertion (for
+          #     example, product refresh after 30 days) can be performed with the current
+          #     `version_number`.
+          #
+          #     Only supported for insertions into primary data sources.
+          #
+          #     If the operation is prevented, the aborted exception will be
+          #     thrown.
+          # @!attribute [r] product_attributes
+          #   @return [::Google::Shopping::Merchant::Products::V1::ProductAttributes]
+          #     Output only. A list of strongly-typed product attributes.
+          # @!attribute [r] custom_attributes
+          #   @return [::Array<::Google::Shopping::Type::CustomAttribute>]
+          #     Output only. A list of custom (merchant-provided) attributes. It can also
+          #     be used to submit any attribute of the data specification in its generic
+          #     form (for example,
+          #     `{ "name": "size type", "value": "regular" }`).
+          #     This is useful for submitting attributes not explicitly exposed by the
+          #     API, such as additional attributes used for Buy on Google.
+          # @!attribute [r] product_status
+          #   @return [::Google::Shopping::Merchant::Products::V1::ProductStatus]
+          #     Output only. The status of a product, data validation issues, that is,
+          #     information about a product computed asynchronously.
+          # @!attribute [r] automated_discounts
+          #   @return [::Google::Shopping::Merchant::Products::V1::AutomatedDiscounts]
+          #     Output only. The automated discounts information for the product.
+          class Product
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request message for the GetProduct method.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. The name of the product to retrieve.
+          #     Format:
+          #     `accounts/{account}/products/{product}` where the last
+          #     section `product` consists of:
+          #     `content_language~feed_label~offer_id`
+          #     example for product name is `accounts/123/products/en~US~sku123`. A legacy
+          #     local product name would be `accounts/123/products/local~en~US~sku123`.
+          #     Note: For calls to the v1beta version, the `product` section consists
+          #     of: `channel~content_language~feed_label~offer_id`, for example:
+          #     `accounts/123/products/online~en~US~sku123`.
+          class GetProductRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request message for the ListProducts method.
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. The account to list processed products for.
+          #     Format: `accounts/{account}`
+          # @!attribute [rw] page_size
+          #   @return [::Integer]
+          #     The maximum number of products to return. The service may return fewer than
+          #     this value.
+          #     The maximum value is 1000; values above 1000 will be coerced to 1000.
+          #     If unspecified, the default page size of 25 products will be returned.
+          # @!attribute [rw] page_token
+          #   @return [::String]
+          #     A page token, received from a previous `ListProducts` call.
+          #     Provide this to retrieve the subsequent page.
+          #
+          #     When paginating, all other parameters provided to `ListProducts` must
+          #     match the call that provided the page token.
+          class ListProductsRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Response message for the ListProducts method.
+          # @!attribute [rw] products
+          #   @return [::Array<::Google::Shopping::Merchant::Products::V1::Product>]
+          #     The processed products from the specified account. These are your processed
+          #     products after applying rules and supplemental data sources.
+          # @!attribute [rw] next_page_token
+          #   @return [::String]
+          #     A token, which can be sent as `page_token` to retrieve the next page.
+          #     If this field is omitted, there are no subsequent pages.
+          class ListProductsResponse
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end