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

data/proto_docs/google/shopping/merchant/datasources/v1beta/datasources.rb

@@ -0,0 +1,205 @@
+# frozen_string_literal: true
+
+# Copyright 2024 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 V1beta
+          # The [data source](https://support.google.com/merchants/answer/7439058) for
+          # the Merchant Center account.
+          # @!attribute [rw] primary_product_data_source
+          #   @return [::Google::Shopping::Merchant::DataSources::V1beta::PrimaryProductDataSource]
+          #     Required. The [primary data
+          #     source](https://support.google.com/merchants/answer/7439058) for local
+          #     and online products.
+          # @!attribute [rw] supplemental_product_data_source
+          #   @return [::Google::Shopping::Merchant::DataSources::V1beta::SupplementalProductDataSource]
+          #     Required. The [supplemental data
+          #     source](https://support.google.com/merchants/answer/7439058) for local
+          #     and online products.
+          # @!attribute [rw] local_inventory_data_source
+          #   @return [::Google::Shopping::Merchant::DataSources::V1beta::LocalInventoryDataSource]
+          #     Required. The [local
+          #     inventory](https://support.google.com/merchants/answer/7023001) data
+          #     source.
+          # @!attribute [rw] regional_inventory_data_source
+          #   @return [::Google::Shopping::Merchant::DataSources::V1beta::RegionalInventoryDataSource]
+          #     Required. The [regional
+          #     inventory](https://support.google.com/merchants/answer/7439058) data
+          #     source.
+          # @!attribute [rw] promotion_data_source
+          #   @return [::Google::Shopping::Merchant::DataSources::V1beta::PromotionDataSource]
+          #     Required. The
+          #     [promotion](https://support.google.com/merchants/answer/2906014) data
+          #     source.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Identifier. The name of the data source.
+          #     Format:
+          #     `{datasource.name=accounts/{account}/dataSources/{datasource}}`
+          # @!attribute [r] data_source_id
+          #   @return [::Integer]
+          #     Output only. The data source id.
+          # @!attribute [rw] display_name
+          #   @return [::String]
+          #     Required. The displayed data source name in the Merchant Center UI.
+          # @!attribute [r] input
+          #   @return [::Google::Shopping::Merchant::DataSources::V1beta::DataSource::Input]
+          #     Output only. Determines the type of input to the data source. Based on the
+          #     input some settings might not work. Only generic data sources can be
+          #     created through the API.
+          # @!attribute [rw] file_input
+          #   @return [::Google::Shopping::Merchant::DataSources::V1beta::FileInput]
+          #     Optional. The field is used only when data is managed through a file.
+          class DataSource
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Determines the type of input to the data source. Based on the input some
+            # settings might not be supported.
+            module Input
+              # Input unspecified.
+              INPUT_UNSPECIFIED = 0
+
+              # Represents data sources for which the data is primarily provided through
+              # the API.
+              API = 1
+
+              # Represents data sources for which the data is primarily provided through
+              # file input. Data can still be provided through the API.
+              FILE = 2
+
+              # The data source for products added directly in Merchant Center.
+              #
+              # This type of data source can not be created or updated through this API,
+              # only by Merchant Center UI.
+              #
+              # This type of data source is read only.
+              UI = 3
+
+              # This is also known as
+              # [Automated feeds](https://support.google.com/merchants/answer/12158480)
+              # used to automatically build your product data. This type of data source
+              # can be enabled or disabled through the Accounts bundle.
+              AUTOFEED = 4
+            end
+          end
+
+          # Request message for the GetDataSource method.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. The name of the data source to retrieve.
+          #     Format: `accounts/{account}/dataSources/{datasource}`
+          class GetDataSourceRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request message for the ListDataSources method.
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. The account to list data sources for.
+          #     Format: `accounts/{account}`
+          # @!attribute [rw] page_size
+          #   @return [::Integer]
+          #     Optional. The maximum number of data sources 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 maximum number of data sources
+          #     will be returned.
+          # @!attribute [rw] page_token
+          #   @return [::String]
+          #     Optional. A page token, received from a previous `ListDataSources` call.
+          #     Provide this to retrieve the subsequent page.
+          #
+          #     When paginating, all other parameters provided to `ListDataSources`
+          #     must match the call that provided the page token.
+          class ListDataSourcesRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Response message for the ListDataSources method.
+          # @!attribute [rw] data_sources
+          #   @return [::Array<::Google::Shopping::Merchant::DataSources::V1beta::DataSource>]
+          #     The data sources from the specified account.
+          # @!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 ListDataSourcesResponse
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request message for the CreateDataSource method.
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. The account where this data source will be created.
+          #     Format: `accounts/{account}`
+          # @!attribute [rw] data_source
+          #   @return [::Google::Shopping::Merchant::DataSources::V1beta::DataSource]
+          #     Required. The data source to create.
+          class CreateDataSourceRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request message for the UpdateDataSource method.
+          # @!attribute [rw] data_source
+          #   @return [::Google::Shopping::Merchant::DataSources::V1beta::DataSource]
+          #     Required. The data source resource to update.
+          # @!attribute [rw] update_mask
+          #   @return [::Google::Protobuf::FieldMask]
+          #     Required. The list of data source fields to be updated.
+          #
+          #     Fields specified in the update mask without a value specified in the
+          #     body will be deleted from the data source.
+          #
+          #     Providing special "*" value for full data source replacement is not
+          #     supported.
+          class UpdateDataSourceRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request message for the FetchDataSource method.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. The name of the data source resource to fetch.
+          #     Format: `accounts/{account}/dataSources/{datasource}`
+          class FetchDataSourceRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request message for the DeleteDataSource method.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. The name of the data source to delete.
+          #     Format: `accounts/{account}/dataSources/{datasource}`
+          class DeleteDataSourceRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/shopping/merchant/datasources/v1beta/datasourcetypes.rb

@@ -0,0 +1,182 @@
+# frozen_string_literal: true
+
+# Copyright 2024 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 V1beta
+          # The primary data source for local and online products.
+          # @!attribute [rw] channel
+          #   @return [::Google::Shopping::Merchant::DataSources::V1beta::PrimaryProductDataSource::Channel]
+          #     Required. Immutable. Specifies the type of data source channel.
+          # @!attribute [rw] feed_label
+          #   @return [::String]
+          #     Optional. Immutable. The feed label that is specified on the data source
+          #     level.
+          #
+          #     Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9),
+          #     and dashes (-).
+          #
+          #     See also [migration to feed
+          #     labels](https://developers.google.com/shopping-content/guides/products/feed-labels).
+          #
+          #     `feedLabel` and `contentLanguage` must be either both set or unset for data
+          #     sources with product content type.
+          #     They must be set for data sources with a file input.
+          #
+          #     If set, the data source will only accept products matching this
+          #     combination. If unset, the data source will accept products without that
+          #     restriction.
+          # @!attribute [rw] content_language
+          #   @return [::String]
+          #     Optional. Immutable. The two-letter ISO 639-1 language of the items in the
+          #     data source.
+          #
+          #     `feedLabel` and `contentLanguage` must be either both set or unset.
+          #     The fields can only be unset for data sources without file input.
+          #
+          #     If set, the data source will only accept products matching this
+          #     combination. If unset, the data source will accept products without that
+          #     restriction.
+          # @!attribute [rw] countries
+          #   @return [::Array<::String>]
+          #     Optional. The countries where the items may be displayed. Represented as a
+          #     [CLDR territory
+          #     code](https://github.com/unicode-org/cldr/blob/latest/common/main/en.xml).
+          class PrimaryProductDataSource
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Data Source Channel.
+            #
+            # Channel is used to distinguish between data sources for different product
+            # verticals.
+            module Channel
+              # Not specified.
+              CHANNEL_UNSPECIFIED = 0
+
+              # Online product.
+              ONLINE_PRODUCTS = 1
+
+              # Local product.
+              LOCAL_PRODUCTS = 2
+
+              # Unified data source for both local and online products.
+              PRODUCTS = 3
+            end
+          end
+
+          # The supplemental data source for local and online products.
+          # @!attribute [rw] feed_label
+          #   @return [::String]
+          #     Optional. Immutable. The feed label that is specified on the data source
+          #     level.
+          #
+          #     Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9),
+          #     and dashes (-).
+          #
+          #     See also [migration to feed
+          #     labels](https://developers.google.com/shopping-content/guides/products/feed-labels).
+          #
+          #     `feedLabel` and `contentLanguage` must be either both set or unset for data
+          #     sources with product content type.
+          #     They must be set for data sources with a file input.
+          #
+          #     If set, the data source will only accept products matching this
+          #     combination. If unset, the data source will accept produts without that
+          #     restriction.
+          # @!attribute [rw] content_language
+          #   @return [::String]
+          #     Optional. Immutable. The two-letter ISO 639-1 language of the items in the
+          #     data source.
+          #
+          #     `feedLabel` and `contentLanguage` must be either both set or unset.
+          #     The fields can only be unset for data sources without file input.
+          #
+          #     If set, the data source will only accept products matching this
+          #     combination. If unset, the data source will accept produts without that
+          #     restriction.
+          class SupplementalProductDataSource
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The local inventory data source.
+          # @!attribute [rw] feed_label
+          #   @return [::String]
+          #     Required. Immutable. The feed label of the offers to which the local
+          #     inventory is provided.
+          #
+          #     Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9),
+          #     and dashes (-).
+          #
+          #     See also [migration to feed
+          #     labels](https://developers.google.com/shopping-content/guides/products/feed-labels).
+          # @!attribute [rw] content_language
+          #   @return [::String]
+          #     Required. Immutable. The two-letter ISO 639-1 language of the items to
+          #     which the local inventory is provided.
+          class LocalInventoryDataSource
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The regional inventory data source.
+          # @!attribute [rw] feed_label
+          #   @return [::String]
+          #     Required. Immutable. The feed label of the offers to which the regional
+          #     inventory is provided.
+          #
+          #     Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9),
+          #     and dashes (-).
+          #
+          #     See also [migration to feed
+          #     labels](https://developers.google.com/shopping-content/guides/products/feed-labels).
+          # @!attribute [rw] content_language
+          #   @return [::String]
+          #     Required. Immutable. The two-letter ISO 639-1 language of the items to
+          #     which the regional inventory is provided.
+          class RegionalInventoryDataSource
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The promotion data source.
+          # @!attribute [rw] target_country
+          #   @return [::String]
+          #     Required. Immutable. The target country used as part of the unique
+          #     identifier. Represented as a [CLDR territory
+          #     code](https://github.com/unicode-org/cldr/blob/latest/common/main/en.xml).
+          #
+          #     Promotions are only available in selected
+          #     [countries](https://support.google.com/merchants/answer/4588460).
+          # @!attribute [rw] content_language
+          #   @return [::String]
+          #     Required. Immutable. The two-letter ISO 639-1 language of the items in the
+          #     data source.
+          class PromotionDataSource
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+# Copyright 2024 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 V1beta
+          # 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::V1beta::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::V1beta::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::V1beta::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 [fetch
+            #     url][google.shopping.content.bundles.DataSources.FileInput.fetch_url].
+            #     Used for [submitting data sources through
+            #     SFTP](https://support.google.com/merchants/answer/13813117).
+            # @!attribute [rw] password
+            #   @return [::String]
+            #     Optional. An optional password for [fetch
+            #     url][google.shopping.content.bundles.DataSources.FileInput.fetch_url].
+            #     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][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.day_of_month]
+              # and
+              # [hour of
+              # day][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day]
+              # are required. For a weekly fetch schedule,
+              # [day of
+              # week][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.day_of_week]
+              # and [hour of
+              # day][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day]
+              # are required. For a daily fetch schedule, only an [hour of
+              # day][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day]
+              # 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
+              # [fetch_uri][google.shopping.content.bundles.DataSources.FileInput.FetchSettings.fetch_uri].
+              FETCH = 2
+
+              # The file is fetched from Google Sheets specified in the
+              # [fetch_uri][google.shopping.content.bundles.DataSources.FileInput.FetchSettings.fetch_uri].
+              GOOGLE_SHEETS = 3
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/type/dayofweek.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# Copyright 2024 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 2024 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