google-shopping-merchant-data_sources-v1beta 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 +144 -8
- data/lib/google/shopping/merchant/data_sources/v1beta/data_sources_service/client.rb +935 -0
- data/lib/google/shopping/merchant/data_sources/v1beta/data_sources_service/credentials.rb +49 -0
- data/lib/google/shopping/merchant/data_sources/v1beta/data_sources_service/paths.rb +66 -0
- data/lib/google/shopping/merchant/data_sources/v1beta/data_sources_service/rest/client.rb +867 -0
- data/lib/google/shopping/merchant/data_sources/v1beta/data_sources_service/rest/service_stub.rb +428 -0
- data/lib/google/shopping/merchant/data_sources/v1beta/data_sources_service/rest.rb +56 -0
- data/lib/google/shopping/merchant/data_sources/v1beta/data_sources_service.rb +59 -0
- data/lib/google/shopping/merchant/data_sources/v1beta/rest.rb +39 -0
- data/lib/google/shopping/merchant/data_sources/v1beta/version.rb +7 -2
- data/lib/google/shopping/merchant/data_sources/v1beta.rb +47 -0
- data/lib/google/shopping/merchant/datasources/v1beta/datasources_pb.rb +64 -0
- data/lib/google/shopping/merchant/datasources/v1beta/datasources_services_pb.rb +64 -0
- data/lib/google/shopping/merchant/datasources/v1beta/datasourcetypes_pb.rb +51 -0
- data/lib/google/shopping/merchant/datasources/v1beta/fileinputs_pb.rb +52 -0
- data/lib/google-shopping-merchant-data_sources-v1beta.rb +21 -0
- data/proto_docs/README.md +4 -0
- data/proto_docs/google/api/client.rb +399 -0
- data/proto_docs/google/api/field_behavior.rb +85 -0
- data/proto_docs/google/api/launch_stage.rb +71 -0
- data/proto_docs/google/api/resource.rb +222 -0
- data/proto_docs/google/protobuf/duration.rb +98 -0
- data/proto_docs/google/protobuf/empty.rb +34 -0
- data/proto_docs/google/protobuf/field_mask.rb +229 -0
- data/proto_docs/google/shopping/merchant/datasources/v1beta/datasources.rb +205 -0
- data/proto_docs/google/shopping/merchant/datasources/v1beta/datasourcetypes.rb +182 -0
- data/proto_docs/google/shopping/merchant/datasources/v1beta/fileinputs.rb +141 -0
- data/proto_docs/google/type/dayofweek.rb +49 -0
- data/proto_docs/google/type/timeofday.rb +45 -0
- metadata +72 -10
@@ -0,0 +1,205 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2024 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 DataSources
|
24
|
+
module V1beta
|
25
|
+
# The [data source](https://support.google.com/merchants/answer/7439058) for
|
26
|
+
# the Merchant Center account.
|
27
|
+
# @!attribute [rw] primary_product_data_source
|
28
|
+
# @return [::Google::Shopping::Merchant::DataSources::V1beta::PrimaryProductDataSource]
|
29
|
+
# Required. The [primary data
|
30
|
+
# source](https://support.google.com/merchants/answer/7439058) for local
|
31
|
+
# and online products.
|
32
|
+
# @!attribute [rw] supplemental_product_data_source
|
33
|
+
# @return [::Google::Shopping::Merchant::DataSources::V1beta::SupplementalProductDataSource]
|
34
|
+
# Required. The [supplemental data
|
35
|
+
# source](https://support.google.com/merchants/answer/7439058) for local
|
36
|
+
# and online products.
|
37
|
+
# @!attribute [rw] local_inventory_data_source
|
38
|
+
# @return [::Google::Shopping::Merchant::DataSources::V1beta::LocalInventoryDataSource]
|
39
|
+
# Required. The [local
|
40
|
+
# inventory](https://support.google.com/merchants/answer/7023001) data
|
41
|
+
# source.
|
42
|
+
# @!attribute [rw] regional_inventory_data_source
|
43
|
+
# @return [::Google::Shopping::Merchant::DataSources::V1beta::RegionalInventoryDataSource]
|
44
|
+
# Required. The [regional
|
45
|
+
# inventory](https://support.google.com/merchants/answer/7439058) data
|
46
|
+
# source.
|
47
|
+
# @!attribute [rw] promotion_data_source
|
48
|
+
# @return [::Google::Shopping::Merchant::DataSources::V1beta::PromotionDataSource]
|
49
|
+
# Required. The
|
50
|
+
# [promotion](https://support.google.com/merchants/answer/2906014) data
|
51
|
+
# source.
|
52
|
+
# @!attribute [rw] name
|
53
|
+
# @return [::String]
|
54
|
+
# Identifier. The name of the data source.
|
55
|
+
# Format:
|
56
|
+
# `{datasource.name=accounts/{account}/dataSources/{datasource}}`
|
57
|
+
# @!attribute [r] data_source_id
|
58
|
+
# @return [::Integer]
|
59
|
+
# Output only. The data source id.
|
60
|
+
# @!attribute [rw] display_name
|
61
|
+
# @return [::String]
|
62
|
+
# Required. The displayed data source name in the Merchant Center UI.
|
63
|
+
# @!attribute [r] input
|
64
|
+
# @return [::Google::Shopping::Merchant::DataSources::V1beta::DataSource::Input]
|
65
|
+
# Output only. Determines the type of input to the data source. Based on the
|
66
|
+
# input some settings might not work. Only generic data sources can be
|
67
|
+
# created through the API.
|
68
|
+
# @!attribute [rw] file_input
|
69
|
+
# @return [::Google::Shopping::Merchant::DataSources::V1beta::FileInput]
|
70
|
+
# Optional. The field is used only when data is managed through a file.
|
71
|
+
class DataSource
|
72
|
+
include ::Google::Protobuf::MessageExts
|
73
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
74
|
+
|
75
|
+
# Determines the type of input to the data source. Based on the input some
|
76
|
+
# settings might not be supported.
|
77
|
+
module Input
|
78
|
+
# Input unspecified.
|
79
|
+
INPUT_UNSPECIFIED = 0
|
80
|
+
|
81
|
+
# Represents data sources for which the data is primarily provided through
|
82
|
+
# the API.
|
83
|
+
API = 1
|
84
|
+
|
85
|
+
# Represents data sources for which the data is primarily provided through
|
86
|
+
# file input. Data can still be provided through the API.
|
87
|
+
FILE = 2
|
88
|
+
|
89
|
+
# The data source for products added directly in Merchant Center.
|
90
|
+
#
|
91
|
+
# This type of data source can not be created or updated through this API,
|
92
|
+
# only by Merchant Center UI.
|
93
|
+
#
|
94
|
+
# This type of data source is read only.
|
95
|
+
UI = 3
|
96
|
+
|
97
|
+
# This is also known as
|
98
|
+
# [Automated feeds](https://support.google.com/merchants/answer/12158480)
|
99
|
+
# used to automatically build your product data. This type of data source
|
100
|
+
# can be enabled or disabled through the Accounts bundle.
|
101
|
+
AUTOFEED = 4
|
102
|
+
end
|
103
|
+
end
|
104
|
+
|
105
|
+
# Request message for the GetDataSource method.
|
106
|
+
# @!attribute [rw] name
|
107
|
+
# @return [::String]
|
108
|
+
# Required. The name of the data source to retrieve.
|
109
|
+
# Format: `accounts/{account}/dataSources/{datasource}`
|
110
|
+
class GetDataSourceRequest
|
111
|
+
include ::Google::Protobuf::MessageExts
|
112
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
113
|
+
end
|
114
|
+
|
115
|
+
# Request message for the ListDataSources method.
|
116
|
+
# @!attribute [rw] parent
|
117
|
+
# @return [::String]
|
118
|
+
# Required. The account to list data sources for.
|
119
|
+
# Format: `accounts/{account}`
|
120
|
+
# @!attribute [rw] page_size
|
121
|
+
# @return [::Integer]
|
122
|
+
# Optional. The maximum number of data sources to return. The service may
|
123
|
+
# return fewer than this value. The maximum value is 1000; values above 1000
|
124
|
+
# will be coerced to 1000. If unspecified, the maximum number of data sources
|
125
|
+
# will be returned.
|
126
|
+
# @!attribute [rw] page_token
|
127
|
+
# @return [::String]
|
128
|
+
# Optional. A page token, received from a previous `ListDataSources` call.
|
129
|
+
# Provide this to retrieve the subsequent page.
|
130
|
+
#
|
131
|
+
# When paginating, all other parameters provided to `ListDataSources`
|
132
|
+
# must match the call that provided the page token.
|
133
|
+
class ListDataSourcesRequest
|
134
|
+
include ::Google::Protobuf::MessageExts
|
135
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
136
|
+
end
|
137
|
+
|
138
|
+
# Response message for the ListDataSources method.
|
139
|
+
# @!attribute [rw] data_sources
|
140
|
+
# @return [::Array<::Google::Shopping::Merchant::DataSources::V1beta::DataSource>]
|
141
|
+
# The data sources from the specified account.
|
142
|
+
# @!attribute [rw] next_page_token
|
143
|
+
# @return [::String]
|
144
|
+
# A token, which can be sent as `page_token` to retrieve the next page.
|
145
|
+
# If this field is omitted, there are no subsequent pages.
|
146
|
+
class ListDataSourcesResponse
|
147
|
+
include ::Google::Protobuf::MessageExts
|
148
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
149
|
+
end
|
150
|
+
|
151
|
+
# Request message for the CreateDataSource method.
|
152
|
+
# @!attribute [rw] parent
|
153
|
+
# @return [::String]
|
154
|
+
# Required. The account where this data source will be created.
|
155
|
+
# Format: `accounts/{account}`
|
156
|
+
# @!attribute [rw] data_source
|
157
|
+
# @return [::Google::Shopping::Merchant::DataSources::V1beta::DataSource]
|
158
|
+
# Required. The data source to create.
|
159
|
+
class CreateDataSourceRequest
|
160
|
+
include ::Google::Protobuf::MessageExts
|
161
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
162
|
+
end
|
163
|
+
|
164
|
+
# Request message for the UpdateDataSource method.
|
165
|
+
# @!attribute [rw] data_source
|
166
|
+
# @return [::Google::Shopping::Merchant::DataSources::V1beta::DataSource]
|
167
|
+
# Required. The data source resource to update.
|
168
|
+
# @!attribute [rw] update_mask
|
169
|
+
# @return [::Google::Protobuf::FieldMask]
|
170
|
+
# Required. The list of data source fields to be updated.
|
171
|
+
#
|
172
|
+
# Fields specified in the update mask without a value specified in the
|
173
|
+
# body will be deleted from the data source.
|
174
|
+
#
|
175
|
+
# Providing special "*" value for full data source replacement is not
|
176
|
+
# supported.
|
177
|
+
class UpdateDataSourceRequest
|
178
|
+
include ::Google::Protobuf::MessageExts
|
179
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
180
|
+
end
|
181
|
+
|
182
|
+
# Request message for the FetchDataSource method.
|
183
|
+
# @!attribute [rw] name
|
184
|
+
# @return [::String]
|
185
|
+
# Required. The name of the data source resource to fetch.
|
186
|
+
# Format: `accounts/{account}/dataSources/{datasource}`
|
187
|
+
class FetchDataSourceRequest
|
188
|
+
include ::Google::Protobuf::MessageExts
|
189
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
190
|
+
end
|
191
|
+
|
192
|
+
# Request message for the DeleteDataSource method.
|
193
|
+
# @!attribute [rw] name
|
194
|
+
# @return [::String]
|
195
|
+
# Required. The name of the data source to delete.
|
196
|
+
# Format: `accounts/{account}/dataSources/{datasource}`
|
197
|
+
class DeleteDataSourceRequest
|
198
|
+
include ::Google::Protobuf::MessageExts
|
199
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
200
|
+
end
|
201
|
+
end
|
202
|
+
end
|
203
|
+
end
|
204
|
+
end
|
205
|
+
end
|
@@ -0,0 +1,182 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2024 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 DataSources
|
24
|
+
module V1beta
|
25
|
+
# The primary data source for local and online products.
|
26
|
+
# @!attribute [rw] channel
|
27
|
+
# @return [::Google::Shopping::Merchant::DataSources::V1beta::PrimaryProductDataSource::Channel]
|
28
|
+
# Required. Immutable. Specifies the type of data source channel.
|
29
|
+
# @!attribute [rw] feed_label
|
30
|
+
# @return [::String]
|
31
|
+
# Optional. Immutable. The feed label that is specified on the data source
|
32
|
+
# level.
|
33
|
+
#
|
34
|
+
# Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9),
|
35
|
+
# and dashes (-).
|
36
|
+
#
|
37
|
+
# See also [migration to feed
|
38
|
+
# labels](https://developers.google.com/shopping-content/guides/products/feed-labels).
|
39
|
+
#
|
40
|
+
# `feedLabel` and `contentLanguage` must be either both set or unset for data
|
41
|
+
# sources with product content type.
|
42
|
+
# They must be set for data sources with a file input.
|
43
|
+
#
|
44
|
+
# If set, the data source will only accept products matching this
|
45
|
+
# combination. If unset, the data source will accept products without that
|
46
|
+
# restriction.
|
47
|
+
# @!attribute [rw] content_language
|
48
|
+
# @return [::String]
|
49
|
+
# Optional. Immutable. The two-letter ISO 639-1 language of the items in the
|
50
|
+
# data source.
|
51
|
+
#
|
52
|
+
# `feedLabel` and `contentLanguage` must be either both set or unset.
|
53
|
+
# The fields can only be unset for data sources without file input.
|
54
|
+
#
|
55
|
+
# If set, the data source will only accept products matching this
|
56
|
+
# combination. If unset, the data source will accept products without that
|
57
|
+
# restriction.
|
58
|
+
# @!attribute [rw] countries
|
59
|
+
# @return [::Array<::String>]
|
60
|
+
# Optional. The countries where the items may be displayed. Represented as a
|
61
|
+
# [CLDR territory
|
62
|
+
# code](https://github.com/unicode-org/cldr/blob/latest/common/main/en.xml).
|
63
|
+
class PrimaryProductDataSource
|
64
|
+
include ::Google::Protobuf::MessageExts
|
65
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
66
|
+
|
67
|
+
# Data Source Channel.
|
68
|
+
#
|
69
|
+
# Channel is used to distinguish between data sources for different product
|
70
|
+
# verticals.
|
71
|
+
module Channel
|
72
|
+
# Not specified.
|
73
|
+
CHANNEL_UNSPECIFIED = 0
|
74
|
+
|
75
|
+
# Online product.
|
76
|
+
ONLINE_PRODUCTS = 1
|
77
|
+
|
78
|
+
# Local product.
|
79
|
+
LOCAL_PRODUCTS = 2
|
80
|
+
|
81
|
+
# Unified data source for both local and online products.
|
82
|
+
PRODUCTS = 3
|
83
|
+
end
|
84
|
+
end
|
85
|
+
|
86
|
+
# The supplemental data source for local and online products.
|
87
|
+
# @!attribute [rw] feed_label
|
88
|
+
# @return [::String]
|
89
|
+
# Optional. Immutable. The feed label that is specified on the data source
|
90
|
+
# level.
|
91
|
+
#
|
92
|
+
# Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9),
|
93
|
+
# and dashes (-).
|
94
|
+
#
|
95
|
+
# See also [migration to feed
|
96
|
+
# labels](https://developers.google.com/shopping-content/guides/products/feed-labels).
|
97
|
+
#
|
98
|
+
# `feedLabel` and `contentLanguage` must be either both set or unset for data
|
99
|
+
# sources with product content type.
|
100
|
+
# They must be set for data sources with a file input.
|
101
|
+
#
|
102
|
+
# If set, the data source will only accept products matching this
|
103
|
+
# combination. If unset, the data source will accept produts without that
|
104
|
+
# restriction.
|
105
|
+
# @!attribute [rw] content_language
|
106
|
+
# @return [::String]
|
107
|
+
# Optional. Immutable. The two-letter ISO 639-1 language of the items in the
|
108
|
+
# data source.
|
109
|
+
#
|
110
|
+
# `feedLabel` and `contentLanguage` must be either both set or unset.
|
111
|
+
# The fields can only be unset for data sources without file input.
|
112
|
+
#
|
113
|
+
# If set, the data source will only accept products matching this
|
114
|
+
# combination. If unset, the data source will accept produts without that
|
115
|
+
# restriction.
|
116
|
+
class SupplementalProductDataSource
|
117
|
+
include ::Google::Protobuf::MessageExts
|
118
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
119
|
+
end
|
120
|
+
|
121
|
+
# The local inventory data source.
|
122
|
+
# @!attribute [rw] feed_label
|
123
|
+
# @return [::String]
|
124
|
+
# Required. Immutable. The feed label of the offers to which the local
|
125
|
+
# inventory is provided.
|
126
|
+
#
|
127
|
+
# Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9),
|
128
|
+
# and dashes (-).
|
129
|
+
#
|
130
|
+
# See also [migration to feed
|
131
|
+
# labels](https://developers.google.com/shopping-content/guides/products/feed-labels).
|
132
|
+
# @!attribute [rw] content_language
|
133
|
+
# @return [::String]
|
134
|
+
# Required. Immutable. The two-letter ISO 639-1 language of the items to
|
135
|
+
# which the local inventory is provided.
|
136
|
+
class LocalInventoryDataSource
|
137
|
+
include ::Google::Protobuf::MessageExts
|
138
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
139
|
+
end
|
140
|
+
|
141
|
+
# The regional inventory data source.
|
142
|
+
# @!attribute [rw] feed_label
|
143
|
+
# @return [::String]
|
144
|
+
# Required. Immutable. The feed label of the offers to which the regional
|
145
|
+
# inventory is provided.
|
146
|
+
#
|
147
|
+
# Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9),
|
148
|
+
# and dashes (-).
|
149
|
+
#
|
150
|
+
# See also [migration to feed
|
151
|
+
# labels](https://developers.google.com/shopping-content/guides/products/feed-labels).
|
152
|
+
# @!attribute [rw] content_language
|
153
|
+
# @return [::String]
|
154
|
+
# Required. Immutable. The two-letter ISO 639-1 language of the items to
|
155
|
+
# which the regional inventory is provided.
|
156
|
+
class RegionalInventoryDataSource
|
157
|
+
include ::Google::Protobuf::MessageExts
|
158
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
159
|
+
end
|
160
|
+
|
161
|
+
# The promotion data source.
|
162
|
+
# @!attribute [rw] target_country
|
163
|
+
# @return [::String]
|
164
|
+
# Required. Immutable. The target country used as part of the unique
|
165
|
+
# identifier. Represented as a [CLDR territory
|
166
|
+
# code](https://github.com/unicode-org/cldr/blob/latest/common/main/en.xml).
|
167
|
+
#
|
168
|
+
# Promotions are only available in selected
|
169
|
+
# [countries](https://support.google.com/merchants/answer/4588460).
|
170
|
+
# @!attribute [rw] content_language
|
171
|
+
# @return [::String]
|
172
|
+
# Required. Immutable. The two-letter ISO 639-1 language of the items in the
|
173
|
+
# data source.
|
174
|
+
class PromotionDataSource
|
175
|
+
include ::Google::Protobuf::MessageExts
|
176
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
177
|
+
end
|
178
|
+
end
|
179
|
+
end
|
180
|
+
end
|
181
|
+
end
|
182
|
+
end
|
@@ -0,0 +1,141 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2024 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 DataSources
|
24
|
+
module V1beta
|
25
|
+
# The data specific for file data sources. This field is empty for other
|
26
|
+
# data source inputs.
|
27
|
+
# @!attribute [rw] fetch_settings
|
28
|
+
# @return [::Google::Shopping::Merchant::DataSources::V1beta::FileInput::FetchSettings]
|
29
|
+
# Optional. Fetch details to deliver the data source. It contains settings
|
30
|
+
# for `FETCH` and `GOOGLE_SHEETS` file input types. The required fields vary
|
31
|
+
# based on the frequency of fetching.
|
32
|
+
# @!attribute [rw] file_name
|
33
|
+
# @return [::String]
|
34
|
+
# Optional. The file name of the data source. Required for `UPLOAD` file
|
35
|
+
# input type.
|
36
|
+
# @!attribute [r] file_input_type
|
37
|
+
# @return [::Google::Shopping::Merchant::DataSources::V1beta::FileInput::FileInputType]
|
38
|
+
# Output only. The type of file input.
|
39
|
+
class FileInput
|
40
|
+
include ::Google::Protobuf::MessageExts
|
41
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
42
|
+
|
43
|
+
# Fetch details to deliver the data source.
|
44
|
+
# @!attribute [rw] enabled
|
45
|
+
# @return [::Boolean]
|
46
|
+
# Optional. Enables or pauses the fetch schedule.
|
47
|
+
# @!attribute [rw] day_of_month
|
48
|
+
# @return [::Integer]
|
49
|
+
# Optional. The day of the month when the data source file should be
|
50
|
+
# fetched (1-31). This field can only be set for monthly frequency.
|
51
|
+
# @!attribute [rw] time_of_day
|
52
|
+
# @return [::Google::Type::TimeOfDay]
|
53
|
+
# Optional. The hour of the day when the data source file should be
|
54
|
+
# fetched. Minutes and seconds are not supported and will be ignored.
|
55
|
+
# @!attribute [rw] day_of_week
|
56
|
+
# @return [::Google::Type::DayOfWeek]
|
57
|
+
# Optional. The day of the week when the data source file should be
|
58
|
+
# fetched. This field can only be set for weekly frequency.
|
59
|
+
# @!attribute [rw] time_zone
|
60
|
+
# @return [::String]
|
61
|
+
# Optional. [Time zone](https://cldr.unicode.org) used for schedule. UTC by
|
62
|
+
# default. For example, "America/Los_Angeles".
|
63
|
+
# @!attribute [rw] frequency
|
64
|
+
# @return [::Google::Shopping::Merchant::DataSources::V1beta::FileInput::FetchSettings::Frequency]
|
65
|
+
# Required. The frequency describing fetch schedule.
|
66
|
+
# @!attribute [rw] fetch_uri
|
67
|
+
# @return [::String]
|
68
|
+
# Optional. The URL where the data source file can be fetched. Google
|
69
|
+
# Merchant Center supports automatic scheduled uploads using the HTTP,
|
70
|
+
# HTTPS or SFTP protocols, so the value will need to be a valid link using
|
71
|
+
# one of those three protocols. Immutable for Google Sheets files.
|
72
|
+
# @!attribute [rw] username
|
73
|
+
# @return [::String]
|
74
|
+
# Optional. An optional user name for [fetch
|
75
|
+
# url][google.shopping.content.bundles.DataSources.FileInput.fetch_url].
|
76
|
+
# Used for [submitting data sources through
|
77
|
+
# SFTP](https://support.google.com/merchants/answer/13813117).
|
78
|
+
# @!attribute [rw] password
|
79
|
+
# @return [::String]
|
80
|
+
# Optional. An optional password for [fetch
|
81
|
+
# url][google.shopping.content.bundles.DataSources.FileInput.fetch_url].
|
82
|
+
# Used for [submitting data sources through
|
83
|
+
# SFTP](https://support.google.com/merchants/answer/13813117).
|
84
|
+
class FetchSettings
|
85
|
+
include ::Google::Protobuf::MessageExts
|
86
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
87
|
+
|
88
|
+
# The required fields vary based on the frequency of fetching. For a
|
89
|
+
# monthly
|
90
|
+
# fetch schedule,
|
91
|
+
# [day of
|
92
|
+
# month][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.day_of_month]
|
93
|
+
# and
|
94
|
+
# [hour of
|
95
|
+
# day][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day]
|
96
|
+
# are required. For a weekly fetch schedule,
|
97
|
+
# [day of
|
98
|
+
# week][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.day_of_week]
|
99
|
+
# and [hour of
|
100
|
+
# day][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day]
|
101
|
+
# are required. For a daily fetch schedule, only an [hour of
|
102
|
+
# day][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day]
|
103
|
+
# is required.
|
104
|
+
module Frequency
|
105
|
+
# Frequency unspecified.
|
106
|
+
FREQUENCY_UNSPECIFIED = 0
|
107
|
+
|
108
|
+
# The fetch happens every day.
|
109
|
+
FREQUENCY_DAILY = 1
|
110
|
+
|
111
|
+
# The fetch happens every week.
|
112
|
+
FREQUENCY_WEEKLY = 2
|
113
|
+
|
114
|
+
# The fetch happens every month.
|
115
|
+
FREQUENCY_MONTHLY = 3
|
116
|
+
end
|
117
|
+
end
|
118
|
+
|
119
|
+
# The method of file delivery.
|
120
|
+
module FileInputType
|
121
|
+
# File input type unspecified.
|
122
|
+
FILE_INPUT_TYPE_UNSPECIFIED = 0
|
123
|
+
|
124
|
+
# The file is uploaded through SFTP, Google Cloud Storage or manually in
|
125
|
+
# the Merchant Center.
|
126
|
+
UPLOAD = 1
|
127
|
+
|
128
|
+
# The file is fetched from the configured
|
129
|
+
# [fetch_uri][google.shopping.content.bundles.DataSources.FileInput.FetchSettings.fetch_uri].
|
130
|
+
FETCH = 2
|
131
|
+
|
132
|
+
# The file is fetched from Google Sheets specified in the
|
133
|
+
# [fetch_uri][google.shopping.content.bundles.DataSources.FileInput.FetchSettings.fetch_uri].
|
134
|
+
GOOGLE_SHEETS = 3
|
135
|
+
end
|
136
|
+
end
|
137
|
+
end
|
138
|
+
end
|
139
|
+
end
|
140
|
+
end
|
141
|
+
end
|
@@ -0,0 +1,49 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2024 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 Type
|
22
|
+
# Represents a day of the week.
|
23
|
+
module DayOfWeek
|
24
|
+
# The day of the week is unspecified.
|
25
|
+
DAY_OF_WEEK_UNSPECIFIED = 0
|
26
|
+
|
27
|
+
# Monday
|
28
|
+
MONDAY = 1
|
29
|
+
|
30
|
+
# Tuesday
|
31
|
+
TUESDAY = 2
|
32
|
+
|
33
|
+
# Wednesday
|
34
|
+
WEDNESDAY = 3
|
35
|
+
|
36
|
+
# Thursday
|
37
|
+
THURSDAY = 4
|
38
|
+
|
39
|
+
# Friday
|
40
|
+
FRIDAY = 5
|
41
|
+
|
42
|
+
# Saturday
|
43
|
+
SATURDAY = 6
|
44
|
+
|
45
|
+
# Sunday
|
46
|
+
SUNDAY = 7
|
47
|
+
end
|
48
|
+
end
|
49
|
+
end
|
@@ -0,0 +1,45 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2024 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 Type
|
22
|
+
# Represents a time of day. The date and time zone are either not significant
|
23
|
+
# or are specified elsewhere. An API may choose to allow leap seconds. Related
|
24
|
+
# types are [google.type.Date][google.type.Date] and
|
25
|
+
# `google.protobuf.Timestamp`.
|
26
|
+
# @!attribute [rw] hours
|
27
|
+
# @return [::Integer]
|
28
|
+
# Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
|
29
|
+
# to allow the value "24:00:00" for scenarios like business closing time.
|
30
|
+
# @!attribute [rw] minutes
|
31
|
+
# @return [::Integer]
|
32
|
+
# Minutes of hour of day. Must be from 0 to 59.
|
33
|
+
# @!attribute [rw] seconds
|
34
|
+
# @return [::Integer]
|
35
|
+
# Seconds of minutes of the time. Must normally be from 0 to 59. An API may
|
36
|
+
# allow the value 60 if it allows leap-seconds.
|
37
|
+
# @!attribute [rw] nanos
|
38
|
+
# @return [::Integer]
|
39
|
+
# Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
|
40
|
+
class TimeOfDay
|
41
|
+
include ::Google::Protobuf::MessageExts
|
42
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
43
|
+
end
|
44
|
+
end
|
45
|
+
end
|