google-shopping-merchant-lfp-v1 0.a → 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.yardopts +12 -0
- data/AUTHENTICATION.md +122 -0
- data/README.md +154 -8
- data/lib/google/shopping/merchant/lfp/v1/lfp_inventory_service/client.rb +471 -0
- data/lib/google/shopping/merchant/lfp/v1/lfp_inventory_service/credentials.rb +49 -0
- data/lib/google/shopping/merchant/lfp/v1/lfp_inventory_service/paths.rb +70 -0
- data/lib/google/shopping/merchant/lfp/v1/lfp_inventory_service/rest/client.rb +438 -0
- data/lib/google/shopping/merchant/lfp/v1/lfp_inventory_service/rest/service_stub.rb +145 -0
- data/lib/google/shopping/merchant/lfp/v1/lfp_inventory_service/rest.rb +56 -0
- data/lib/google/shopping/merchant/lfp/v1/lfp_inventory_service.rb +59 -0
- data/lib/google/shopping/merchant/lfp/v1/lfp_merchant_state_service/client.rb +471 -0
- data/lib/google/shopping/merchant/lfp/v1/lfp_merchant_state_service/credentials.rb +49 -0
- data/lib/google/shopping/merchant/lfp/v1/lfp_merchant_state_service/paths.rb +52 -0
- data/lib/google/shopping/merchant/lfp/v1/lfp_merchant_state_service/rest/client.rb +438 -0
- data/lib/google/shopping/merchant/lfp/v1/lfp_merchant_state_service/rest/service_stub.rb +144 -0
- data/lib/google/shopping/merchant/lfp/v1/lfp_merchant_state_service/rest.rb +59 -0
- data/lib/google/shopping/merchant/lfp/v1/lfp_merchant_state_service.rb +62 -0
- data/lib/google/shopping/merchant/lfp/v1/lfp_sale_service/client.rb +469 -0
- data/lib/google/shopping/merchant/lfp/v1/lfp_sale_service/credentials.rb +49 -0
- data/lib/google/shopping/merchant/lfp/v1/lfp_sale_service/paths.rb +52 -0
- data/lib/google/shopping/merchant/lfp/v1/lfp_sale_service/rest/client.rb +436 -0
- data/lib/google/shopping/merchant/lfp/v1/lfp_sale_service/rest/service_stub.rb +145 -0
- data/lib/google/shopping/merchant/lfp/v1/lfp_sale_service/rest.rb +56 -0
- data/lib/google/shopping/merchant/lfp/v1/lfp_sale_service.rb +59 -0
- data/lib/google/shopping/merchant/lfp/v1/lfp_store_service/client.rb +771 -0
- data/lib/google/shopping/merchant/lfp/v1/lfp_store_service/credentials.rb +49 -0
- data/lib/google/shopping/merchant/lfp/v1/lfp_store_service/paths.rb +68 -0
- data/lib/google/shopping/merchant/lfp/v1/lfp_store_service/rest/client.rb +717 -0
- data/lib/google/shopping/merchant/lfp/v1/lfp_store_service/rest/service_stub.rb +328 -0
- data/lib/google/shopping/merchant/lfp/v1/lfp_store_service/rest.rb +56 -0
- data/lib/google/shopping/merchant/lfp/v1/lfp_store_service.rb +59 -0
- data/lib/google/shopping/merchant/lfp/v1/lfpinventory_pb.rb +54 -0
- data/lib/google/shopping/merchant/lfp/v1/lfpinventory_services_pb.rb +51 -0
- data/lib/google/shopping/merchant/lfp/v1/lfpmerchantstate_pb.rb +56 -0
- data/lib/google/shopping/merchant/lfp/v1/lfpmerchantstate_services_pb.rb +52 -0
- data/lib/google/shopping/merchant/lfp/v1/lfpsale_pb.rb +55 -0
- data/lib/google/shopping/merchant/lfp/v1/lfpsale_services_pb.rb +49 -0
- data/lib/google/shopping/merchant/lfp/v1/lfpstore_pb.rb +56 -0
- data/lib/google/shopping/merchant/lfp/v1/lfpstore_services_pb.rb +57 -0
- data/lib/google/shopping/merchant/lfp/v1/rest.rb +42 -0
- data/lib/google/shopping/merchant/lfp/v1/version.rb +7 -2
- data/lib/google/shopping/merchant/lfp/v1.rb +50 -0
- data/lib/google-shopping-merchant-lfp-v1.rb +21 -0
- data/proto_docs/README.md +4 -0
- data/proto_docs/google/api/client.rb +473 -0
- data/proto_docs/google/api/field_behavior.rb +85 -0
- data/proto_docs/google/api/field_info.rb +88 -0
- data/proto_docs/google/api/launch_stage.rb +71 -0
- data/proto_docs/google/api/resource.rb +227 -0
- data/proto_docs/google/protobuf/duration.rb +98 -0
- data/proto_docs/google/protobuf/empty.rb +34 -0
- data/proto_docs/google/protobuf/timestamp.rb +127 -0
- data/proto_docs/google/shopping/merchant/lfp/v1/lfpinventory.rb +113 -0
- data/proto_docs/google/shopping/merchant/lfp/v1/lfpmerchantstate.rb +181 -0
- data/proto_docs/google/shopping/merchant/lfp/v1/lfpsale.rb +96 -0
- data/proto_docs/google/shopping/merchant/lfp/v1/lfpstore.rb +185 -0
- data/proto_docs/google/shopping/type/types.rb +210 -0
- metadata +117 -9
@@ -0,0 +1,181 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2025 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Shopping
|
22
|
+
module Merchant
|
23
|
+
module Lfp
|
24
|
+
module V1
|
25
|
+
# The LFP state of a merchant.
|
26
|
+
# @!attribute [rw] name
|
27
|
+
# @return [::String]
|
28
|
+
# Identifier. The name of the `LfpMerchantState` resource. Format:
|
29
|
+
# `accounts/{account}/lfpMerchantStates/{target_merchant}`. For example,
|
30
|
+
# `accounts/123456/lfpMerchantStates/567890`.
|
31
|
+
# @!attribute [rw] linked_gbps
|
32
|
+
# @return [::Integer]
|
33
|
+
# Number of [GBPs](https://www.google.com/business/) this merchant has access
|
34
|
+
# to.
|
35
|
+
# @!attribute [r] store_states
|
36
|
+
# @return [::Array<::Google::Shopping::Merchant::Lfp::V1::LfpMerchantState::LfpStoreState>]
|
37
|
+
# Output only. The state per store from the specified merchant. The field
|
38
|
+
# will be absent if the merchant has no stores submitted through LFP.
|
39
|
+
# @!attribute [rw] inventory_stats
|
40
|
+
# @return [::Google::Shopping::Merchant::Lfp::V1::LfpMerchantState::InventoryStats]
|
41
|
+
# The inventory statistics for the merchant. The field will be absent if the
|
42
|
+
# merchant has no inventory submitted through LFP.
|
43
|
+
# @!attribute [rw] country_settings
|
44
|
+
# @return [::Array<::Google::Shopping::Merchant::Lfp::V1::LfpMerchantState::CountrySettings>]
|
45
|
+
# Country-specific settings for the merchant.
|
46
|
+
class LfpMerchantState
|
47
|
+
include ::Google::Protobuf::MessageExts
|
48
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
49
|
+
|
50
|
+
# The state of a specific merchant's store.
|
51
|
+
# @!attribute [rw] store_code
|
52
|
+
# @return [::String]
|
53
|
+
# Required. Immutable. The identifier of this store.
|
54
|
+
# @!attribute [r] matching_state
|
55
|
+
# @return [::Google::Shopping::Merchant::Lfp::V1::LfpMerchantState::LfpStoreState::StoreMatchingState]
|
56
|
+
# Output only. The store matching state.
|
57
|
+
# @!attribute [rw] matching_state_hint
|
58
|
+
# @return [::String]
|
59
|
+
# The hint of why the matching has failed (only set if matching_state is
|
60
|
+
# FAILED).
|
61
|
+
class LfpStoreState
|
62
|
+
include ::Google::Protobuf::MessageExts
|
63
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
64
|
+
|
65
|
+
# The state of matching `LfpStore` to a Google Business Profile listing.
|
66
|
+
module StoreMatchingState
|
67
|
+
# Store matching state unspecified.
|
68
|
+
STORE_MATCHING_STATE_UNSPECIFIED = 0
|
69
|
+
|
70
|
+
# The `LfpStore` is successfully matched with a Google Business Profile
|
71
|
+
# store.
|
72
|
+
STORE_MATCHING_STATE_MATCHED = 1
|
73
|
+
|
74
|
+
# The `LfpStore` is not matched with a Google Business Profile store.
|
75
|
+
STORE_MATCHING_STATE_FAILED = 2
|
76
|
+
end
|
77
|
+
end
|
78
|
+
|
79
|
+
# The inventory statistics for a merchant.
|
80
|
+
# @!attribute [rw] submitted_entries
|
81
|
+
# @return [::Integer]
|
82
|
+
# Number of entries (understanding entry as a pair of product and store)
|
83
|
+
# that were built based on provided inventories/sales and submitted to
|
84
|
+
# Google.
|
85
|
+
# @!attribute [rw] submitted_in_stock_entries
|
86
|
+
# @return [::Integer]
|
87
|
+
# Number of submitted in stock entries.
|
88
|
+
# @!attribute [rw] unsubmitted_entries
|
89
|
+
# @return [::Integer]
|
90
|
+
# Number of entries that were built based on provided
|
91
|
+
# inventories/sales and couldn't be submitted to Google due to errors like
|
92
|
+
# missing product.
|
93
|
+
# @!attribute [rw] submitted_products
|
94
|
+
# @return [::Integer]
|
95
|
+
# Number of products from provided inventories/sales that were created from
|
96
|
+
# matches to existing online products provided by the merchant or to the
|
97
|
+
# Google catalog.
|
98
|
+
class InventoryStats
|
99
|
+
include ::Google::Protobuf::MessageExts
|
100
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
101
|
+
end
|
102
|
+
|
103
|
+
# Country-specific settings for the merchant.
|
104
|
+
# @!attribute [rw] region_code
|
105
|
+
# @return [::String]
|
106
|
+
# Required. The [CLDR territory
|
107
|
+
# code](https://github.com/unicode-org/cldr/blob/latest/common/main/en.xml)
|
108
|
+
# for the country for which these settings are defined.
|
109
|
+
# @!attribute [rw] free_local_listings_enabled
|
110
|
+
# @return [::Boolean]
|
111
|
+
# True if this merchant has enabled free local listings in MC.
|
112
|
+
# @!attribute [rw] local_inventory_ads_enabled
|
113
|
+
# @return [::Boolean]
|
114
|
+
# True if this merchant has enabled local inventory ads in MC.
|
115
|
+
# @!attribute [r] inventory_verification_state
|
116
|
+
# @return [::Google::Shopping::Merchant::Lfp::V1::LfpMerchantState::CountrySettings::VerificationState]
|
117
|
+
# Output only. The verification state of this merchant's inventory check.
|
118
|
+
# @!attribute [r] product_page_type
|
119
|
+
# @return [::Google::Shopping::Merchant::Lfp::V1::LfpMerchantState::CountrySettings::ProductPageType]
|
120
|
+
# Output only. The product page type selected by this merchant.
|
121
|
+
# @!attribute [r] instock_serving_verification_state
|
122
|
+
# @return [::Google::Shopping::Merchant::Lfp::V1::LfpMerchantState::CountrySettings::VerificationState]
|
123
|
+
# Output only. The verification state of this merchant's instock serving
|
124
|
+
# feature.
|
125
|
+
# @!attribute [r] pickup_serving_verification_state
|
126
|
+
# @return [::Google::Shopping::Merchant::Lfp::V1::LfpMerchantState::CountrySettings::VerificationState]
|
127
|
+
# Output only. The verification state of this merchant's pickup serving
|
128
|
+
# feature.
|
129
|
+
class CountrySettings
|
130
|
+
include ::Google::Protobuf::MessageExts
|
131
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
132
|
+
|
133
|
+
# The possible verification states for different merchant programs.
|
134
|
+
module VerificationState
|
135
|
+
# Verification state unspecified.
|
136
|
+
VERIFICATION_STATE_UNSPECIFIED = 0
|
137
|
+
|
138
|
+
# Verification state not approved.
|
139
|
+
VERIFICATION_STATE_NOT_APPROVED = 1
|
140
|
+
|
141
|
+
# Verification state in progress.
|
142
|
+
VERIFICATION_STATE_IN_PROGRESS = 2
|
143
|
+
|
144
|
+
# Verification state approved.
|
145
|
+
VERIFICATION_STATE_APPROVED = 3
|
146
|
+
end
|
147
|
+
|
148
|
+
# The possible [product page
|
149
|
+
# types](https://support.google.com/merchants/topic/15148370) for a
|
150
|
+
# merchant.
|
151
|
+
module ProductPageType
|
152
|
+
# Product page type unspecified.
|
153
|
+
PRODUCT_PAGE_TYPE_UNSPECIFIED = 0
|
154
|
+
|
155
|
+
# Google hosted product page.
|
156
|
+
GOOGLE_HOSTED = 1
|
157
|
+
|
158
|
+
# Merchant hosted product page.
|
159
|
+
MERCHANT_HOSTED = 2
|
160
|
+
|
161
|
+
# Merchant hosted store specific product page.
|
162
|
+
MERCHANT_HOSTED_STORE_SPECIFIC = 3
|
163
|
+
end
|
164
|
+
end
|
165
|
+
end
|
166
|
+
|
167
|
+
# Request message for the GetLfpMerchantState method.
|
168
|
+
# @!attribute [rw] name
|
169
|
+
# @return [::String]
|
170
|
+
# Required. The name of the state to retrieve.
|
171
|
+
# Format: `accounts/{account}/lfpMerchantStates/{target_merchant}`. For
|
172
|
+
# example, `accounts/123456/lfpMerchantStates/567890`.
|
173
|
+
class GetLfpMerchantStateRequest
|
174
|
+
include ::Google::Protobuf::MessageExts
|
175
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
176
|
+
end
|
177
|
+
end
|
178
|
+
end
|
179
|
+
end
|
180
|
+
end
|
181
|
+
end
|
@@ -0,0 +1,96 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2025 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Shopping
|
22
|
+
module Merchant
|
23
|
+
module Lfp
|
24
|
+
module V1
|
25
|
+
# A sale for the merchant.
|
26
|
+
# @!attribute [r] name
|
27
|
+
# @return [::String]
|
28
|
+
# Output only. Identifier. The name of the `LfpSale` resource.
|
29
|
+
# Format:
|
30
|
+
# `accounts/{account}/lfpSales/{sale}`
|
31
|
+
# @!attribute [rw] target_account
|
32
|
+
# @return [::Integer]
|
33
|
+
# Required. The Merchant Center ID of the merchant to submit the sale for.
|
34
|
+
# @!attribute [rw] store_code
|
35
|
+
# @return [::String]
|
36
|
+
# Required. The identifier of the merchant's store. Either a `storeCode`
|
37
|
+
# inserted through the API or the code of the store in the Business Profile.
|
38
|
+
# @!attribute [rw] offer_id
|
39
|
+
# @return [::String]
|
40
|
+
# Required. A unique identifier for the product. If both inventories and
|
41
|
+
# sales are submitted for a merchant, this id should match for the same
|
42
|
+
# product.
|
43
|
+
#
|
44
|
+
# **Note**: if the merchant sells the same product new and used, they should
|
45
|
+
# have different IDs.
|
46
|
+
# @!attribute [rw] region_code
|
47
|
+
# @return [::String]
|
48
|
+
# Required. The [CLDR territory
|
49
|
+
# code](https://github.com/unicode-org/cldr/blob/latest/common/main/en.xml)
|
50
|
+
# for the country where the product is sold.
|
51
|
+
# @!attribute [rw] content_language
|
52
|
+
# @return [::String]
|
53
|
+
# Required. The two-letter ISO 639-1 language code for the item.
|
54
|
+
# @!attribute [rw] gtin
|
55
|
+
# @return [::String]
|
56
|
+
# Required. The Global Trade Item Number of the sold product.
|
57
|
+
# @!attribute [rw] price
|
58
|
+
# @return [::Google::Shopping::Type::Price]
|
59
|
+
# Required. The unit price of the product.
|
60
|
+
# @!attribute [rw] quantity
|
61
|
+
# @return [::Integer]
|
62
|
+
# Required. The relative change of the available quantity. Negative for items
|
63
|
+
# returned.
|
64
|
+
# @!attribute [rw] sale_time
|
65
|
+
# @return [::Google::Protobuf::Timestamp]
|
66
|
+
# Required. The timestamp for the sale.
|
67
|
+
# @!attribute [r] uid
|
68
|
+
# @return [::String]
|
69
|
+
# Output only. System generated globally unique ID for the `LfpSale`.
|
70
|
+
# @!attribute [rw] feed_label
|
71
|
+
# @return [::String]
|
72
|
+
# Optional. The [feed
|
73
|
+
# label](https://developers.google.com/shopping-content/guides/products/feed-labels)
|
74
|
+
# for the product. If this is not set, it will default to `regionCode`.
|
75
|
+
class LfpSale
|
76
|
+
include ::Google::Protobuf::MessageExts
|
77
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
78
|
+
end
|
79
|
+
|
80
|
+
# Request message for the InsertLfpSale method.
|
81
|
+
# @!attribute [rw] parent
|
82
|
+
# @return [::String]
|
83
|
+
# Required. The LFP provider account.
|
84
|
+
# Format: `accounts/{lfp_partner}`
|
85
|
+
# @!attribute [rw] lfp_sale
|
86
|
+
# @return [::Google::Shopping::Merchant::Lfp::V1::LfpSale]
|
87
|
+
# Required. The sale to insert.
|
88
|
+
class InsertLfpSaleRequest
|
89
|
+
include ::Google::Protobuf::MessageExts
|
90
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
91
|
+
end
|
92
|
+
end
|
93
|
+
end
|
94
|
+
end
|
95
|
+
end
|
96
|
+
end
|
@@ -0,0 +1,185 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2025 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Shopping
|
22
|
+
module Merchant
|
23
|
+
module Lfp
|
24
|
+
module V1
|
25
|
+
# A store for the merchant. This will be used to match to a store under the
|
26
|
+
# Google Business Profile of the target merchant. If a matching store can't be
|
27
|
+
# found, the inventories or sales submitted with the store code will not be
|
28
|
+
# used.
|
29
|
+
# @!attribute [r] name
|
30
|
+
# @return [::String]
|
31
|
+
# Output only. Identifier. The name of the `LfpStore` resource.
|
32
|
+
# Format: `accounts/{account}/lfpStores/{target_merchant}~{store_code}`
|
33
|
+
# @!attribute [rw] target_account
|
34
|
+
# @return [::Integer]
|
35
|
+
# Required. The Merchant Center id of the merchant to submit the store for.
|
36
|
+
# @!attribute [rw] store_code
|
37
|
+
# @return [::String]
|
38
|
+
# Required. Immutable. A store identifier that is unique for the target
|
39
|
+
# merchant.
|
40
|
+
# @!attribute [rw] store_address
|
41
|
+
# @return [::String]
|
42
|
+
# Required. The street address of the store.
|
43
|
+
# Example: 1600 Amphitheatre Pkwy, Mountain View, CA 94043, USA.
|
44
|
+
# @!attribute [rw] store_name
|
45
|
+
# @return [::String]
|
46
|
+
# Optional. The merchant or store name.
|
47
|
+
# @!attribute [rw] phone_number
|
48
|
+
# @return [::String]
|
49
|
+
# Optional. The store phone number in
|
50
|
+
# [E.164](https://en.wikipedia.org/wiki/E.164) format. Example:
|
51
|
+
# `+15556767888`
|
52
|
+
# @!attribute [rw] website_uri
|
53
|
+
# @return [::String]
|
54
|
+
# Optional. The website URL for the store or merchant.
|
55
|
+
# @!attribute [rw] gcid_category
|
56
|
+
# @return [::Array<::String>]
|
57
|
+
# Optional. [Google My Business category
|
58
|
+
# id](https://gcid-explorer.corp.google.com/static/gcid.html).
|
59
|
+
# @!attribute [rw] place_id
|
60
|
+
# @return [::String]
|
61
|
+
# Optional. The [Google Place
|
62
|
+
# Id](https://developers.google.com/maps/documentation/places/web-service/place-id#id-overview)
|
63
|
+
# of the store location.
|
64
|
+
# @!attribute [r] matching_state
|
65
|
+
# @return [::Google::Shopping::Merchant::Lfp::V1::LfpStore::StoreMatchingState]
|
66
|
+
# Optional. Output only. The state of matching to a Google Business Profile.
|
67
|
+
# See
|
68
|
+
# {::Google::Shopping::Merchant::Lfp::V1::LfpStore#matching_state_hint matchingStateHint}
|
69
|
+
# for further details if no match is found.
|
70
|
+
# @!attribute [r] matching_state_hint
|
71
|
+
# @return [::String]
|
72
|
+
# Optional. Output only. The hint of why the matching has failed. This is
|
73
|
+
# only set when
|
74
|
+
# {::Google::Shopping::Merchant::Lfp::V1::LfpStore#matching_state matchingState}=`STORE_MATCHING_STATE_FAILED`.
|
75
|
+
#
|
76
|
+
# Possible values are:
|
77
|
+
#
|
78
|
+
# - "`linked-store-not-found`": There aren't any Google Business
|
79
|
+
# Profile stores available for matching.
|
80
|
+
# - "`store-match-not-found`": The provided `LfpStore` couldn't be matched to
|
81
|
+
# any of the connected Google Business Profile stores. Merchant Center
|
82
|
+
# account is connected correctly and stores are available on Google Business
|
83
|
+
# Profile, but the `LfpStore` location address does not match with Google
|
84
|
+
# Business Profile stores' addresses. Update the `LfpStore` address or Google
|
85
|
+
# Business Profile store address to match correctly.
|
86
|
+
# - "`store-match-unverified`": The provided `LfpStore` couldn't be matched
|
87
|
+
# to any of the connected Google Business Profile stores, as the matched
|
88
|
+
# Google Business Profile store is unverified. Go through the Google Business
|
89
|
+
# Profile verification process to match correctly.
|
90
|
+
class LfpStore
|
91
|
+
include ::Google::Protobuf::MessageExts
|
92
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
93
|
+
|
94
|
+
# The state of matching `LfpStore` to a Google Business Profile.
|
95
|
+
module StoreMatchingState
|
96
|
+
# Store matching state unspecified.
|
97
|
+
STORE_MATCHING_STATE_UNSPECIFIED = 0
|
98
|
+
|
99
|
+
# The `LfpStore` is successfully matched with a Google Business Profile
|
100
|
+
# store.
|
101
|
+
STORE_MATCHING_STATE_MATCHED = 1
|
102
|
+
|
103
|
+
# The `LfpStore` is not matched with a Google Business Profile store.
|
104
|
+
STORE_MATCHING_STATE_FAILED = 2
|
105
|
+
end
|
106
|
+
end
|
107
|
+
|
108
|
+
# Request message for the `GetLfpStore` method.
|
109
|
+
# @!attribute [rw] name
|
110
|
+
# @return [::String]
|
111
|
+
# Required. The name of the store to retrieve.
|
112
|
+
# Format: `accounts/{account}/lfpStores/{target_merchant}~{store_code}`
|
113
|
+
class GetLfpStoreRequest
|
114
|
+
include ::Google::Protobuf::MessageExts
|
115
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
116
|
+
end
|
117
|
+
|
118
|
+
# Request message for the InsertLfpStore method.
|
119
|
+
# @!attribute [rw] parent
|
120
|
+
# @return [::String]
|
121
|
+
# Required. The LFP provider account
|
122
|
+
# Format: `accounts/{account}`
|
123
|
+
# @!attribute [rw] lfp_store
|
124
|
+
# @return [::Google::Shopping::Merchant::Lfp::V1::LfpStore]
|
125
|
+
# Required. The store to insert.
|
126
|
+
class InsertLfpStoreRequest
|
127
|
+
include ::Google::Protobuf::MessageExts
|
128
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
129
|
+
end
|
130
|
+
|
131
|
+
# Request message for the DeleteLfpStore method.
|
132
|
+
# @!attribute [rw] name
|
133
|
+
# @return [::String]
|
134
|
+
# Required. The name of the store to delete for the target merchant account.
|
135
|
+
# Format: `accounts/{account}/lfpStores/{target_merchant}~{store_code}`
|
136
|
+
class DeleteLfpStoreRequest
|
137
|
+
include ::Google::Protobuf::MessageExts
|
138
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
139
|
+
end
|
140
|
+
|
141
|
+
# Request message for the ListLfpStores method.
|
142
|
+
# @!attribute [rw] parent
|
143
|
+
# @return [::String]
|
144
|
+
# Required. The LFP partner.
|
145
|
+
# Format: `accounts/{account}`
|
146
|
+
# @!attribute [rw] target_account
|
147
|
+
# @return [::Integer]
|
148
|
+
# Required. The Merchant Center id of the merchant to list stores for.
|
149
|
+
# @!attribute [rw] page_size
|
150
|
+
# @return [::Integer]
|
151
|
+
# Optional. The maximum number of `LfpStore` resources for the given account
|
152
|
+
# to return. The service returns fewer than this value if the number of
|
153
|
+
# stores for the given account is less than the `pageSize`. The default value
|
154
|
+
# is 250. The maximum value is 1000; If a value higher than the maximum is
|
155
|
+
# specified, then the `pageSize` will default to the maximum.
|
156
|
+
# @!attribute [rw] page_token
|
157
|
+
# @return [::String]
|
158
|
+
# Optional. A page token, received from a previous `ListLfpStoresRequest`
|
159
|
+
# call. Provide the page token to retrieve the subsequent page. When
|
160
|
+
# paginating, all other parameters provided to `ListLfpStoresRequest` must
|
161
|
+
# match the call that provided the page token. The token returned as
|
162
|
+
# {::Google::Shopping::Merchant::Lfp::V1::ListLfpStoresResponse#next_page_token nextPageToken}
|
163
|
+
# in the response to the previous request.
|
164
|
+
class ListLfpStoresRequest
|
165
|
+
include ::Google::Protobuf::MessageExts
|
166
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
167
|
+
end
|
168
|
+
|
169
|
+
# Response message for the ListLfpStores method.
|
170
|
+
# @!attribute [rw] lfp_stores
|
171
|
+
# @return [::Array<::Google::Shopping::Merchant::Lfp::V1::LfpStore>]
|
172
|
+
# The stores from the specified merchant.
|
173
|
+
# @!attribute [rw] next_page_token
|
174
|
+
# @return [::String]
|
175
|
+
# A token, which can be sent as `pageToken` to retrieve the next page.
|
176
|
+
# If this field is omitted, there are no subsequent pages.
|
177
|
+
class ListLfpStoresResponse
|
178
|
+
include ::Google::Protobuf::MessageExts
|
179
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
180
|
+
end
|
181
|
+
end
|
182
|
+
end
|
183
|
+
end
|
184
|
+
end
|
185
|
+
end
|
@@ -0,0 +1,210 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2025 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Shopping
|
22
|
+
module Type
|
23
|
+
# The weight represented as the value in string and the unit.
|
24
|
+
# @!attribute [rw] amount_micros
|
25
|
+
# @return [::Integer]
|
26
|
+
# Required. The weight represented as a number in micros (1 million micros is
|
27
|
+
# an equivalent to one's currency standard unit, for example, 1 kg = 1000000
|
28
|
+
# micros).
|
29
|
+
# This field can also be set as infinity by setting to -1.
|
30
|
+
# This field only support -1 and positive value.
|
31
|
+
# @!attribute [rw] unit
|
32
|
+
# @return [::Google::Shopping::Type::Weight::WeightUnit]
|
33
|
+
# Required. The weight unit.
|
34
|
+
# Acceptable values are: kg and lb
|
35
|
+
class Weight
|
36
|
+
include ::Google::Protobuf::MessageExts
|
37
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
38
|
+
|
39
|
+
# The weight unit.
|
40
|
+
module WeightUnit
|
41
|
+
# unit unspecified
|
42
|
+
WEIGHT_UNIT_UNSPECIFIED = 0
|
43
|
+
|
44
|
+
# lb unit.
|
45
|
+
POUND = 1
|
46
|
+
|
47
|
+
# kg unit.
|
48
|
+
KILOGRAM = 2
|
49
|
+
end
|
50
|
+
end
|
51
|
+
|
52
|
+
# The price represented as a number and currency.
|
53
|
+
# @!attribute [rw] amount_micros
|
54
|
+
# @return [::Integer]
|
55
|
+
# The price represented as a number in micros (1 million micros is an
|
56
|
+
# equivalent to one's currency standard unit, for example, 1 USD = 1000000
|
57
|
+
# micros).
|
58
|
+
# @!attribute [rw] currency_code
|
59
|
+
# @return [::String]
|
60
|
+
# The currency of the price using three-letter acronyms according to [ISO
|
61
|
+
# 4217](http://en.wikipedia.org/wiki/ISO_4217).
|
62
|
+
class Price
|
63
|
+
include ::Google::Protobuf::MessageExts
|
64
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
65
|
+
end
|
66
|
+
|
67
|
+
# A message that represents custom attributes. Exactly one of `value` or
|
68
|
+
# `group_values` must not be empty.
|
69
|
+
# @!attribute [rw] name
|
70
|
+
# @return [::String]
|
71
|
+
# The name of the attribute.
|
72
|
+
# @!attribute [rw] value
|
73
|
+
# @return [::String]
|
74
|
+
# The value of the attribute. If `value` is not empty, `group_values` must be
|
75
|
+
# empty.
|
76
|
+
# @!attribute [rw] group_values
|
77
|
+
# @return [::Array<::Google::Shopping::Type::CustomAttribute>]
|
78
|
+
# Subattributes within this attribute group. If
|
79
|
+
# `group_values` is not empty, `value` must be empty.
|
80
|
+
class CustomAttribute
|
81
|
+
include ::Google::Protobuf::MessageExts
|
82
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
83
|
+
end
|
84
|
+
|
85
|
+
# Destinations available for a product.
|
86
|
+
#
|
87
|
+
# Destinations are used in Merchant Center to allow you to control where the
|
88
|
+
# products from your data feed should be displayed.
|
89
|
+
class Destination
|
90
|
+
include ::Google::Protobuf::MessageExts
|
91
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
92
|
+
|
93
|
+
# Destination values.
|
94
|
+
module DestinationEnum
|
95
|
+
# Not specified.
|
96
|
+
DESTINATION_ENUM_UNSPECIFIED = 0
|
97
|
+
|
98
|
+
# [Shopping ads](https://support.google.com/google-ads/answer/2454022).
|
99
|
+
SHOPPING_ADS = 1
|
100
|
+
|
101
|
+
# [Display ads](https://support.google.com/merchants/answer/6069387).
|
102
|
+
DISPLAY_ADS = 2
|
103
|
+
|
104
|
+
# [Local inventory
|
105
|
+
# ads](https://support.google.com/merchants/answer/3057972).
|
106
|
+
LOCAL_INVENTORY_ADS = 3
|
107
|
+
|
108
|
+
# [Free listings](https://support.google.com/merchants/answer/9199328).
|
109
|
+
FREE_LISTINGS = 4
|
110
|
+
|
111
|
+
# [Free local product
|
112
|
+
# listings](https://support.google.com/merchants/answer/9825611).
|
113
|
+
FREE_LOCAL_LISTINGS = 5
|
114
|
+
|
115
|
+
# [YouTube Shopping](https://support.google.com/merchants/answer/12362804).
|
116
|
+
YOUTUBE_SHOPPING = 6
|
117
|
+
end
|
118
|
+
end
|
119
|
+
|
120
|
+
# Reporting contexts that your account and product issues apply to.
|
121
|
+
#
|
122
|
+
# Reporting contexts are groups of surfaces and formats for product results on
|
123
|
+
# Google. They can represent the entire destination (for example, [Shopping
|
124
|
+
# ads](https://support.google.com/merchants/answer/6149970)) or a subset of
|
125
|
+
# formats within a destination (for example, [Demand Gen
|
126
|
+
# ads](https://support.google.com/merchants/answer/13389785)).
|
127
|
+
class ReportingContext
|
128
|
+
include ::Google::Protobuf::MessageExts
|
129
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
130
|
+
|
131
|
+
# Reporting context values.
|
132
|
+
module ReportingContextEnum
|
133
|
+
# Not specified.
|
134
|
+
REPORTING_CONTEXT_ENUM_UNSPECIFIED = 0
|
135
|
+
|
136
|
+
# [Shopping ads](https://support.google.com/merchants/answer/6149970).
|
137
|
+
SHOPPING_ADS = 1
|
138
|
+
|
139
|
+
# Deprecated: Use `DEMAND_GEN_ADS` instead.
|
140
|
+
# [Discovery and Demand Gen
|
141
|
+
# ads](https://support.google.com/merchants/answer/13389785).
|
142
|
+
DISCOVERY_ADS = 2
|
143
|
+
|
144
|
+
# [Demand Gen ads](https://support.google.com/merchants/answer/13389785).
|
145
|
+
DEMAND_GEN_ADS = 13
|
146
|
+
|
147
|
+
# [Demand Gen ads on Discover
|
148
|
+
# surface](https://support.google.com/merchants/answer/13389785).
|
149
|
+
DEMAND_GEN_ADS_DISCOVER_SURFACE = 14
|
150
|
+
|
151
|
+
# [Video ads](https://support.google.com/google-ads/answer/6340491).
|
152
|
+
VIDEO_ADS = 3
|
153
|
+
|
154
|
+
# [Display ads](https://support.google.com/merchants/answer/6069387).
|
155
|
+
DISPLAY_ADS = 4
|
156
|
+
|
157
|
+
# [Local inventory
|
158
|
+
# ads](https://support.google.com/merchants/answer/3271956).
|
159
|
+
LOCAL_INVENTORY_ADS = 5
|
160
|
+
|
161
|
+
# [Vehicle inventory
|
162
|
+
# ads](https://support.google.com/merchants/answer/11544533).
|
163
|
+
VEHICLE_INVENTORY_ADS = 6
|
164
|
+
|
165
|
+
# [Free product
|
166
|
+
# listings](https://support.google.com/merchants/answer/9199328).
|
167
|
+
FREE_LISTINGS = 7
|
168
|
+
|
169
|
+
# [Free local product
|
170
|
+
# listings](https://support.google.com/merchants/answer/9825611).
|
171
|
+
FREE_LOCAL_LISTINGS = 8
|
172
|
+
|
173
|
+
# [Free local vehicle
|
174
|
+
# listings](https://support.google.com/merchants/answer/11544533).
|
175
|
+
FREE_LOCAL_VEHICLE_LISTINGS = 9
|
176
|
+
|
177
|
+
# [YouTube
|
178
|
+
# Shopping](https://support.google.com/merchants/answer/13478370).
|
179
|
+
YOUTUBE_SHOPPING = 10
|
180
|
+
|
181
|
+
# [Cloud retail](https://cloud.google.com/solutions/retail).
|
182
|
+
CLOUD_RETAIL = 11
|
183
|
+
|
184
|
+
# [Local cloud retail](https://cloud.google.com/solutions/retail).
|
185
|
+
LOCAL_CLOUD_RETAIL = 12
|
186
|
+
end
|
187
|
+
end
|
188
|
+
|
189
|
+
# [Channel](https://support.google.com/merchants/answer/7361332) of a product.
|
190
|
+
#
|
191
|
+
# Channel is used to distinguish between online and local products.
|
192
|
+
class Channel
|
193
|
+
include ::Google::Protobuf::MessageExts
|
194
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
195
|
+
|
196
|
+
# Channel values.
|
197
|
+
module ChannelEnum
|
198
|
+
# Not specified.
|
199
|
+
CHANNEL_ENUM_UNSPECIFIED = 0
|
200
|
+
|
201
|
+
# Online product.
|
202
|
+
ONLINE = 1
|
203
|
+
|
204
|
+
# Local product.
|
205
|
+
LOCAL = 2
|
206
|
+
end
|
207
|
+
end
|
208
|
+
end
|
209
|
+
end
|
210
|
+
end
|