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

data/proto_docs/google/protobuf/timestamp.rb

@@ -0,0 +1,127 @@
+# 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 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/lfp/v1beta/lfpinventory.rb

@@ -0,0 +1,113 @@
+# 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 Lfp
+        module V1beta
+          # Local Inventory for the merchant.
+          # @!attribute [r] name
+          #   @return [::String]
+          #     Output only. Identifier. The name for the `LfpInventory` resource.
+          #     Format:
+          #     `accounts/{account}/lfpInventories/{target_merchant}~{store_code}~{offer}`
+          # @!attribute [rw] target_account
+          #   @return [::Integer]
+          #     Required. The Merchant Center ID of the merchant to submit the inventory
+          #     for.
+          # @!attribute [rw] store_code
+          #   @return [::String]
+          #     Required. The identifier of the merchant's store. Either the store code
+          #     inserted through `InsertLfpStore` or the store code in the Business
+          #     Profile.
+          # @!attribute [rw] offer_id
+          #   @return [::String]
+          #     Required. Immutable. A unique identifier for the product. If both
+          #     inventories and sales are submitted for a merchant, this id should match
+          #     for the same product.
+          #
+          #     **Note**: if the merchant sells the same product new and used, they should
+          #     have different IDs.
+          # @!attribute [rw] region_code
+          #   @return [::String]
+          #     Required. The [CLDR territory
+          #     code](https://github.com/unicode-org/cldr/blob/latest/common/main/en.xml)
+          #     for the country where the product is sold.
+          # @!attribute [rw] content_language
+          #   @return [::String]
+          #     Required. The two-letter ISO 639-1 language code for the item.
+          # @!attribute [rw] gtin
+          #   @return [::String]
+          #     Optional. The Global Trade Item Number of the product.
+          # @!attribute [rw] price
+          #   @return [::Google::Shopping::Type::Price]
+          #     Optional. The current price of the product.
+          # @!attribute [rw] availability
+          #   @return [::String]
+          #     Required. Availability of the product at this store.
+          #     For accepted attribute values, see the [local product inventory feed
+          #     specification](https://support.google.com/merchants/answer/3061342)
+          # @!attribute [rw] quantity
+          #   @return [::Integer]
+          #     Optional. Quantity of the product available at this store. Must be greater
+          #     than or equal to zero.
+          # @!attribute [rw] collection_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Optional. The time when the inventory is collected. If not set, it will be
+          #     set to the time when the inventory is submitted.
+          # @!attribute [rw] pickup_method
+          #   @return [::String]
+          #     Optional. Supported pickup method for this offer. Unless the value is "not
+          #     supported", this field must be submitted together with `pickupSla`. For
+          #     accepted attribute values, see the [local product inventory feed
+          #     specification](https://support.google.com/merchants/answer/3061342).
+          # @!attribute [rw] pickup_sla
+          #   @return [::String]
+          #     Optional. Expected date that an order will be ready for pickup relative to
+          #     the order date. Must be submitted together with `pickupMethod`. For
+          #     accepted attribute values, see the [local product inventory feed
+          #     specification](https://support.google.com/merchants/answer/3061342).
+          # @!attribute [rw] feed_label
+          #   @return [::String]
+          #     Optional. The [feed
+          #     label](https://developers.google.com/shopping-content/guides/products/feed-labels)
+          #     for the product. If this is not set, it will default to `regionCode`.
+          class LfpInventory
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request message for the `InsertLfpInventory` method.
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. The LFP provider account.
+          #     Format: `accounts/{account}`
+          # @!attribute [rw] lfp_inventory
+          #   @return [::Google::Shopping::Merchant::Lfp::V1beta::LfpInventory]
+          #     Required. The inventory to insert.
+          class InsertLfpInventoryRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/shopping/merchant/lfp/v1beta/lfpsale.rb

@@ -0,0 +1,96 @@
+# 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 Lfp
+        module V1beta
+          # A sale for the merchant.
+          # @!attribute [r] name
+          #   @return [::String]
+          #     Output only. Identifier. The name of the `LfpSale` resource.
+          #     Format:
+          #     `accounts/{account}/lfpSales/{sale}`
+          # @!attribute [rw] target_account
+          #   @return [::Integer]
+          #     Required. The Merchant Center ID of the merchant to submit the sale for.
+          # @!attribute [rw] store_code
+          #   @return [::String]
+          #     Required. The identifier of the merchant's store. Either a `storeCode`
+          #     inserted through the API or the code of the store in the Business Profile.
+          # @!attribute [rw] offer_id
+          #   @return [::String]
+          #     Required. A unique identifier for the product. If both inventories and
+          #     sales are submitted for a merchant, this id should match for the same
+          #     product.
+          #
+          #     **Note**: if the merchant sells the same product new and used, they should
+          #     have different IDs.
+          # @!attribute [rw] region_code
+          #   @return [::String]
+          #     Required. The [CLDR territory
+          #     code](https://github.com/unicode-org/cldr/blob/latest/common/main/en.xml)
+          #     for the country where the product is sold.
+          # @!attribute [rw] content_language
+          #   @return [::String]
+          #     Required. The two-letter ISO 639-1 language code for the item.
+          # @!attribute [rw] gtin
+          #   @return [::String]
+          #     Required. The Global Trade Item Number of the sold product.
+          # @!attribute [rw] price
+          #   @return [::Google::Shopping::Type::Price]
+          #     Required. The unit price of the product.
+          # @!attribute [rw] quantity
+          #   @return [::Integer]
+          #     Required. The relative change of the available quantity. Negative for items
+          #     returned.
+          # @!attribute [rw] sale_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Required. The timestamp for the sale.
+          # @!attribute [r] uid
+          #   @return [::String]
+          #     Output only. System generated globally unique ID for the `LfpSale`.
+          # @!attribute [rw] feed_label
+          #   @return [::String]
+          #     Optional. The [feed
+          #     label](https://developers.google.com/shopping-content/guides/products/feed-labels)
+          #     for the product. If this is not set, it will default to `regionCode`.
+          class LfpSale
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request message for the InsertLfpSale method.
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. The LFP provider account.
+          #     Format: `accounts/{lfp_partner}`
+          # @!attribute [rw] lfp_sale
+          #   @return [::Google::Shopping::Merchant::Lfp::V1beta::LfpSale]
+          #     Required. The sale to insert.
+          class InsertLfpSaleRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/shopping/merchant/lfp/v1beta/lfpstore.rb

@@ -0,0 +1,185 @@
+# 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 Lfp
+        module V1beta
+          # A store for the merchant. This will be used to match to a Google Business
+          # Profile listing for the target merchant. If a matching listing can't be
+          # found, the inventories or sales submitted with the store code will not be
+          # used.
+          # @!attribute [r] name
+          #   @return [::String]
+          #     Output only. Identifier. The name of the `LfpStore` resource.
+          #     Format: `accounts/{account}/lfpStores/{target_merchant}~{store_code}`
+          # @!attribute [rw] target_account
+          #   @return [::Integer]
+          #     Required. The Merchant Center id of the merchant to submit the store for.
+          # @!attribute [rw] store_code
+          #   @return [::String]
+          #     Required. Immutable. A store identifier that is unique for the target
+          #     merchant.
+          # @!attribute [rw] store_address
+          #   @return [::String]
+          #     Required. The street address of the store.
+          #     Example: 1600 Amphitheatre Pkwy, Mountain View, CA 94043, USA.
+          # @!attribute [rw] store_name
+          #   @return [::String]
+          #     Optional. The merchant or store name.
+          # @!attribute [rw] phone_number
+          #   @return [::String]
+          #     Optional. The store phone number in
+          #     [E.164](https://en.wikipedia.org/wiki/E.164) format. Example:
+          #     `+15556767888`
+          # @!attribute [rw] website_uri
+          #   @return [::String]
+          #     Optional. The website URL for the store or merchant.
+          # @!attribute [rw] gcid_category
+          #   @return [::Array<::String>]
+          #     Optional. [Google My Business category
+          #     id](https://gcid-explorer.corp.google.com/static/gcid.html).
+          # @!attribute [rw] place_id
+          #   @return [::String]
+          #     Optional. The [Google Place
+          #     Id](https://developers.google.com/maps/documentation/places/web-service/place-id#id-overview)
+          #     of the store location.
+          # @!attribute [r] matching_state
+          #   @return [::Google::Shopping::Merchant::Lfp::V1beta::LfpStore::StoreMatchingState]
+          #     Optional. Output only. The state of matching to a Google Business Profile
+          #     listing. See
+          #     {::Google::Shopping::Merchant::Lfp::V1beta::LfpStore#matching_state_hint matchingStateHint}
+          #     for further details if no match is found.
+          # @!attribute [r] matching_state_hint
+          #   @return [::String]
+          #     Optional. Output only. The hint of why the matching has failed. This is
+          #     only set when
+          #     {::Google::Shopping::Merchant::Lfp::V1beta::LfpStore#matching_state matchingState}=`STORE_MATCHING_STATE_FAILED`.
+          #
+          #     Possible values are:
+          #
+          #     - "`linked-store-not-found`": There aren't any Google Business
+          #     Profile stores available for matching.
+          #     - "`store-match-not-found`": The provided `LfpStore` couldn't be matched to
+          #     any of the connected Google Business Profile stores. Merchant Center
+          #     account is connected correctly and stores are available on Google Business
+          #     Profile, but the `LfpStore` location address does not match with Google
+          #     Business Profile stores' addresses. Update the `LfpStore` address or Google
+          #     Business Profile store address to match correctly.
+          #     - "`store-match-unverified`": The provided `LfpStore` couldn't be matched
+          #     to any of the connected Google Business Profile stores, as the matched
+          #     Google Business Profile store is unverified. Go through the Google Business
+          #     Profile verification process to match correctly.
+          class LfpStore
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # The state of matching `LfpStore` to a Google Business Profile listing.
+            module StoreMatchingState
+              # Store matching state unspecified.
+              STORE_MATCHING_STATE_UNSPECIFIED = 0
+
+              # The `LfpStore` is successfully matched with a Google Business Profile
+              # store.
+              STORE_MATCHING_STATE_MATCHED = 1
+
+              # The `LfpStore` is not matched with a Google Business Profile store.
+              STORE_MATCHING_STATE_FAILED = 2
+            end
+          end
+
+          # Request message for the `GetLfpStore` method.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. The name of the store to retrieve.
+          #     Format: `accounts/{account}/lfpStores/{target_merchant}~{store_code}`
+          class GetLfpStoreRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request message for the InsertLfpStore method.
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. The LFP provider account
+          #     Format: `accounts/{account}`
+          # @!attribute [rw] lfp_store
+          #   @return [::Google::Shopping::Merchant::Lfp::V1beta::LfpStore]
+          #     Required. The store to insert.
+          class InsertLfpStoreRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request message for the DeleteLfpStore method.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. The name of the store to delete for the target merchant account.
+          #     Format: `accounts/{account}/lfpStores/{target_merchant}~{store_code}`
+          class DeleteLfpStoreRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request message for the ListLfpStores method.
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. The LFP partner.
+          #     Format: `accounts/{account}`
+          # @!attribute [rw] target_account
+          #   @return [::Integer]
+          #     Required. The Merchant Center id of the merchant to list stores for.
+          # @!attribute [rw] page_size
+          #   @return [::Integer]
+          #     Optional. The maximum number of `LfpStore` resources for the given account
+          #     to return. The service returns fewer than this value if the number of
+          #     stores for the given account is less than the `pageSize`. The default value
+          #     is 250. The maximum value is 1000; If a value higher than the maximum is
+          #     specified, then the `pageSize` will default to the maximum.
+          # @!attribute [rw] page_token
+          #   @return [::String]
+          #     Optional. A page token, received from a previous `ListLfpStoresRequest`
+          #     call. Provide the page token to retrieve the subsequent page. When
+          #     paginating, all other parameters provided to `ListLfpStoresRequest` must
+          #     match the call that provided the page token. The token returned as
+          #     {::Google::Shopping::Merchant::Lfp::V1beta::ListLfpStoresResponse#next_page_token nextPageToken}
+          #     in the response to the previous request.
+          class ListLfpStoresRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Response message for the ListLfpStores method.
+          # @!attribute [rw] lfp_stores
+          #   @return [::Array<::Google::Shopping::Merchant::Lfp::V1beta::LfpStore>]
+          #     The stores from the specified merchant.
+          # @!attribute [rw] next_page_token
+          #   @return [::String]
+          #     A token, which can be sent as `pageToken` to retrieve the next page.
+          #     If this field is omitted, there are no subsequent pages.
+          class ListLfpStoresResponse
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end