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

data/proto_docs/google/shopping/merchant/datasources/v1/fileinputs.rb

@@ -0,0 +1,145 @@
+# 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 DataSources
+        module V1
+          # The data specific for file data sources. This field is empty for other
+          # data source inputs.
+          # @!attribute [rw] fetch_settings
+          #   @return [::Google::Shopping::Merchant::DataSources::V1::FileInput::FetchSettings]
+          #     Optional. Fetch details to deliver the data source. It contains settings
+          #     for `FETCH` and `GOOGLE_SHEETS` file input types. The required fields vary
+          #     based on the frequency of fetching.
+          # @!attribute [rw] file_name
+          #   @return [::String]
+          #     Optional. The file name of the data source. Required for `UPLOAD` file
+          #     input type.
+          # @!attribute [r] file_input_type
+          #   @return [::Google::Shopping::Merchant::DataSources::V1::FileInput::FileInputType]
+          #     Output only. The type of file input.
+          class FileInput
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Fetch details to deliver the data source.
+            # @!attribute [rw] enabled
+            #   @return [::Boolean]
+            #     Optional. Enables or pauses the fetch schedule.
+            # @!attribute [rw] day_of_month
+            #   @return [::Integer]
+            #     Optional. The day of the month when the data source file should be
+            #     fetched (1-31). This field can only be set for monthly frequency.
+            # @!attribute [rw] time_of_day
+            #   @return [::Google::Type::TimeOfDay]
+            #     Optional. The hour of the day when the data source file should be
+            #     fetched. Minutes and seconds are not supported and will be ignored.
+            # @!attribute [rw] day_of_week
+            #   @return [::Google::Type::DayOfWeek]
+            #     Optional. The day of the week when the data source file should be
+            #     fetched. This field can only be set for weekly frequency.
+            # @!attribute [rw] time_zone
+            #   @return [::String]
+            #     Optional. [Time zone](https://cldr.unicode.org) used for schedule. UTC by
+            #     default. For example, "America/Los_Angeles".
+            # @!attribute [rw] frequency
+            #   @return [::Google::Shopping::Merchant::DataSources::V1::FileInput::FetchSettings::Frequency]
+            #     Required. The frequency describing fetch schedule.
+            # @!attribute [rw] fetch_uri
+            #   @return [::String]
+            #     Optional. The URL where the data source file can be fetched. Google
+            #     Merchant Center supports automatic scheduled uploads using the HTTP,
+            #     HTTPS or SFTP protocols, so the value will need to be a valid link using
+            #     one of those three protocols. Immutable for Google Sheets files.
+            # @!attribute [rw] username
+            #   @return [::String]
+            #     Optional. An optional user name for
+            #     {::Google::Shopping::Merchant::DataSources::V1::FileInput::FetchSettings#fetch_uri fetch_uri}.
+            #     Used for [submitting data sources through
+            #     SFTP](https://support.google.com/merchants/answer/13813117).
+            # @!attribute [rw] password
+            #   @return [::String]
+            #     Optional. An optional password for
+            #     {::Google::Shopping::Merchant::DataSources::V1::FileInput::FetchSettings#fetch_uri fetch_uri}.
+            #     Used for [submitting data sources through
+            #     SFTP](https://support.google.com/merchants/answer/13813117).
+            class FetchSettings
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+
+              # The required fields vary based on the frequency of fetching. For a
+              # monthly
+              # fetch schedule,
+              # `day of
+              # month`
+              # and
+              # [hour of
+              # day][https://developers.google.com/merchant/api/reference/rest/datasources_v1beta/accounts.dataSources#timeofday]
+              # are required. For a weekly fetch schedule,
+              # [day of
+              # week][https://developers.google.com/merchant/api/reference/rest/datasources_v1beta/accounts.dataSources#dayofweek]
+              # and [hour of
+              # day][https://developers.google.com/merchant/api/reference/rest/datasources_v1beta/accounts.dataSources#timeofday]
+              # are required. For a daily fetch schedule, only an [hour of
+              # day][https://developers.google.com/merchant/api/reference/rest/datasources_v1beta/accounts.dataSources#timeofday]
+              # is required.
+              module Frequency
+                # Frequency unspecified.
+                FREQUENCY_UNSPECIFIED = 0
+
+                # The fetch happens every day.
+                FREQUENCY_DAILY = 1
+
+                # The fetch happens every week.
+                FREQUENCY_WEEKLY = 2
+
+                # The fetch happens every month.
+                FREQUENCY_MONTHLY = 3
+              end
+            end
+
+            # The method of file delivery.
+            module FileInputType
+              # File input type unspecified.
+              FILE_INPUT_TYPE_UNSPECIFIED = 0
+
+              # The file is uploaded through SFTP, Google Cloud Storage or manually in
+              # the Merchant Center.
+              UPLOAD = 1
+
+              # The file is fetched from the configured
+              # {::Google::Shopping::Merchant::DataSources::V1::FileInput::FetchSettings#fetch_uri fetch_uri}.
+              FETCH = 2
+
+              # The file is fetched from Google Sheets specified in the
+              # {::Google::Shopping::Merchant::DataSources::V1::FileInput::FetchSettings#fetch_uri fetch_uri}.
+              # However, you can't set up `GOOGLE_SHEETS` as a data source through the
+              # API. To add `GOOGLE_SHEETS` as a data source through the Merchant Center,
+              # see [Add products to Merchant
+              # Center](https://support.google.com/merchants/answer/12158053).
+              GOOGLE_SHEETS = 3
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/shopping/merchant/datasources/v1/fileuploads.rb

@@ -0,0 +1,131 @@
+# 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 DataSources
+        module V1
+          # The file upload of a specific data source, that is, the result of the
+          # retrieval of the data source at a certain timestamp computed asynchronously
+          # when the data source processing is finished. Only applicable to file data
+          # sources.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Identifier. The name of the data source file upload.
+          #     Format:
+          #     `{datasource.name=accounts/{account}/dataSources/{datasource}/fileUploads/{fileupload}}`
+          # @!attribute [r] data_source_id
+          #   @return [::Integer]
+          #     Output only. The data source id.
+          # @!attribute [r] processing_state
+          #   @return [::Google::Shopping::Merchant::DataSources::V1::FileUpload::ProcessingState]
+          #     Output only. The processing state of the data source.
+          # @!attribute [r] issues
+          #   @return [::Array<::Google::Shopping::Merchant::DataSources::V1::FileUpload::Issue>]
+          #     Output only. The list of issues occurring in the data source.
+          # @!attribute [r] items_total
+          #   @return [::Integer]
+          #     Output only. The number of items in the data source that were processed.
+          # @!attribute [r] items_created
+          #   @return [::Integer]
+          #     Output only. The number of items in the data source that were created.
+          # @!attribute [r] items_updated
+          #   @return [::Integer]
+          #     Output only. The number of items in the data source that were updated.
+          # @!attribute [r] upload_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Output only. The date at which the file of the data source was uploaded.
+          class FileUpload
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # An error occurring in the data source, like "invalid price".
+            # @!attribute [r] title
+            #   @return [::String]
+            #     Output only. The title of the issue, for example, "Item too big".
+            # @!attribute [r] description
+            #   @return [::String]
+            #     Output only. The error description, for example, "Your data source
+            #     contains items which have too many attributes, or are too big. These
+            #     items will be dropped".
+            # @!attribute [r] code
+            #   @return [::String]
+            #     Output only. The code of the error, for example,
+            #     "validation/invalid_value". Returns
+            #     "?" if the code is unknown.
+            # @!attribute [r] count
+            #   @return [::Integer]
+            #     Output only. The number of occurrences of the error in the file upload.
+            # @!attribute [r] severity
+            #   @return [::Google::Shopping::Merchant::DataSources::V1::FileUpload::Issue::Severity]
+            #     Output only. The severity of the issue.
+            # @!attribute [r] documentation_uri
+            #   @return [::String]
+            #     Output only. Link to the documentation explaining the issue in more
+            #     details, if available.
+            class Issue
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+
+              # The severity of the issue.
+              module Severity
+                # Severity unspecified.
+                SEVERITY_UNSPECIFIED = 0
+
+                # The issue is the warning.
+                WARNING = 1
+
+                # The issue is an error.
+                ERROR = 2
+              end
+            end
+
+            # The processing state of the data source.
+            module ProcessingState
+              # Processing state unspecified.
+              PROCESSING_STATE_UNSPECIFIED = 0
+
+              # The data source could not be processed or all the items had errors.
+              FAILED = 1
+
+              # The data source is being processed.
+              IN_PROGRESS = 2
+
+              # The data source was processed successfully, though some items might have
+              # had errors.
+              SUCCEEDED = 3
+            end
+          end
+
+          # Request message for the GetFileUploadRequest method.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. The name of the data source file upload to retrieve.
+          #     Format:
+          #     `accounts/{account}/dataSources/{datasource}/fileUploads/latest`
+          class GetFileUploadRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/shopping/type/types.rb

@@ -0,0 +1,210 @@
+# 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 Type
+      # The weight represented as the value in string and the unit.
+      # @!attribute [rw] amount_micros
+      #   @return [::Integer]
+      #     Required. The weight represented as a number in micros (1 million micros is
+      #     an equivalent to one's currency standard unit, for example, 1 kg = 1000000
+      #     micros).
+      #     This field can also be set as infinity by setting to -1.
+      #     This field only support -1 and positive value.
+      # @!attribute [rw] unit
+      #   @return [::Google::Shopping::Type::Weight::WeightUnit]
+      #     Required. The weight unit.
+      #     Acceptable values are: kg and lb
+      class Weight
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+
+        # The weight unit.
+        module WeightUnit
+          # unit unspecified
+          WEIGHT_UNIT_UNSPECIFIED = 0
+
+          # lb unit.
+          POUND = 1
+
+          # kg unit.
+          KILOGRAM = 2
+        end
+      end
+
+      # The price represented as a number and currency.
+      # @!attribute [rw] amount_micros
+      #   @return [::Integer]
+      #     The price represented as a number in micros (1 million micros is an
+      #     equivalent to one's currency standard unit, for example, 1 USD = 1000000
+      #     micros).
+      # @!attribute [rw] currency_code
+      #   @return [::String]
+      #     The currency of the price using three-letter acronyms according to [ISO
+      #     4217](http://en.wikipedia.org/wiki/ISO_4217).
+      class Price
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+      end
+
+      # A message that represents custom attributes. Exactly one of `value` or
+      # `group_values` must not be empty.
+      # @!attribute [rw] name
+      #   @return [::String]
+      #     The name of the attribute.
+      # @!attribute [rw] value
+      #   @return [::String]
+      #     The value of the attribute. If `value` is not empty, `group_values` must be
+      #     empty.
+      # @!attribute [rw] group_values
+      #   @return [::Array<::Google::Shopping::Type::CustomAttribute>]
+      #     Subattributes within this attribute group.  If
+      #     `group_values` is not empty, `value` must be empty.
+      class CustomAttribute
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+      end
+
+      # Destinations available for a product.
+      #
+      # Destinations are used in Merchant Center to allow you to control where the
+      # products from your data feed should be displayed.
+      class Destination
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+
+        # Destination values.
+        module DestinationEnum
+          # Not specified.
+          DESTINATION_ENUM_UNSPECIFIED = 0
+
+          # [Shopping ads](https://support.google.com/google-ads/answer/2454022).
+          SHOPPING_ADS = 1
+
+          # [Display ads](https://support.google.com/merchants/answer/6069387).
+          DISPLAY_ADS = 2
+
+          # [Local inventory
+          # ads](https://support.google.com/merchants/answer/3057972).
+          LOCAL_INVENTORY_ADS = 3
+
+          # [Free listings](https://support.google.com/merchants/answer/9199328).
+          FREE_LISTINGS = 4
+
+          # [Free local product
+          # listings](https://support.google.com/merchants/answer/9825611).
+          FREE_LOCAL_LISTINGS = 5
+
+          # [YouTube Shopping](https://support.google.com/merchants/answer/12362804).
+          YOUTUBE_SHOPPING = 6
+        end
+      end
+
+      # Reporting contexts that your account and product issues apply to.
+      #
+      # Reporting contexts are groups of surfaces and formats for product results on
+      # Google. They can represent the entire destination (for example, [Shopping
+      # ads](https://support.google.com/merchants/answer/6149970)) or a subset of
+      # formats within a destination (for example, [Demand Gen
+      # ads](https://support.google.com/merchants/answer/13389785)).
+      class ReportingContext
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+
+        # Reporting context values.
+        module ReportingContextEnum
+          # Not specified.
+          REPORTING_CONTEXT_ENUM_UNSPECIFIED = 0
+
+          # [Shopping ads](https://support.google.com/merchants/answer/6149970).
+          SHOPPING_ADS = 1
+
+          # Deprecated:  Use `DEMAND_GEN_ADS` instead.
+          # [Discovery and Demand Gen
+          # ads](https://support.google.com/merchants/answer/13389785).
+          DISCOVERY_ADS = 2
+
+          # [Demand Gen ads](https://support.google.com/merchants/answer/13389785).
+          DEMAND_GEN_ADS = 13
+
+          # [Demand Gen ads on Discover
+          # surface](https://support.google.com/merchants/answer/13389785).
+          DEMAND_GEN_ADS_DISCOVER_SURFACE = 14
+
+          # [Video ads](https://support.google.com/google-ads/answer/6340491).
+          VIDEO_ADS = 3
+
+          # [Display ads](https://support.google.com/merchants/answer/6069387).
+          DISPLAY_ADS = 4
+
+          # [Local inventory
+          # ads](https://support.google.com/merchants/answer/3271956).
+          LOCAL_INVENTORY_ADS = 5
+
+          # [Vehicle inventory
+          # ads](https://support.google.com/merchants/answer/11544533).
+          VEHICLE_INVENTORY_ADS = 6
+
+          # [Free product
+          # listings](https://support.google.com/merchants/answer/9199328).
+          FREE_LISTINGS = 7
+
+          # [Free local product
+          # listings](https://support.google.com/merchants/answer/9825611).
+          FREE_LOCAL_LISTINGS = 8
+
+          # [Free local vehicle
+          # listings](https://support.google.com/merchants/answer/11544533).
+          FREE_LOCAL_VEHICLE_LISTINGS = 9
+
+          # [YouTube
+          # Shopping](https://support.google.com/merchants/answer/13478370).
+          YOUTUBE_SHOPPING = 10
+
+          # [Cloud retail](https://cloud.google.com/solutions/retail).
+          CLOUD_RETAIL = 11
+
+          # [Local cloud retail](https://cloud.google.com/solutions/retail).
+          LOCAL_CLOUD_RETAIL = 12
+        end
+      end
+
+      # [Channel](https://support.google.com/merchants/answer/7361332) of a product.
+      #
+      # Channel is used to distinguish between online and local products.
+      class Channel
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+
+        # Channel values.
+        module ChannelEnum
+          # Not specified.
+          CHANNEL_ENUM_UNSPECIFIED = 0
+
+          # Online product.
+          ONLINE = 1
+
+          # Local product.
+          LOCAL = 2
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/type/dayofweek.rb

@@ -0,0 +1,49 @@
+# 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 Type
+    # Represents a day of the week.
+    module DayOfWeek
+      # The day of the week is unspecified.
+      DAY_OF_WEEK_UNSPECIFIED = 0
+
+      # Monday
+      MONDAY = 1
+
+      # Tuesday
+      TUESDAY = 2
+
+      # Wednesday
+      WEDNESDAY = 3
+
+      # Thursday
+      THURSDAY = 4
+
+      # Friday
+      FRIDAY = 5
+
+      # Saturday
+      SATURDAY = 6
+
+      # Sunday
+      SUNDAY = 7
+    end
+  end
+end

data/proto_docs/google/type/timeofday.rb

@@ -0,0 +1,45 @@
+# 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 Type
+    # Represents a time of day. The date and time zone are either not significant
+    # or are specified elsewhere. An API may choose to allow leap seconds. Related
+    # types are [google.type.Date][google.type.Date] and
+    # `google.protobuf.Timestamp`.
+    # @!attribute [rw] hours
+    #   @return [::Integer]
+    #     Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
+    #     to allow the value "24:00:00" for scenarios like business closing time.
+    # @!attribute [rw] minutes
+    #   @return [::Integer]
+    #     Minutes of hour of day. Must be from 0 to 59.
+    # @!attribute [rw] seconds
+    #   @return [::Integer]
+    #     Seconds of minutes of the time. Must normally be from 0 to 59. An API may
+    #     allow the value 60 if it allows leap-seconds.
+    # @!attribute [rw] nanos
+    #   @return [::Integer]
+    #     Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+    class TimeOfDay
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end