google-shopping-merchant-notifications-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/notifications/v1/notifications_api_service/client.rb +971 -0
- data/lib/google/shopping/merchant/notifications/v1/notifications_api_service/credentials.rb +49 -0
- data/lib/google/shopping/merchant/notifications/v1/notifications_api_service/paths.rb +83 -0
- data/lib/google/shopping/merchant/notifications/v1/notifications_api_service/rest/client.rb +903 -0
- data/lib/google/shopping/merchant/notifications/v1/notifications_api_service/rest/service_stub.rb +451 -0
- data/lib/google/shopping/merchant/notifications/v1/notifications_api_service/rest.rb +54 -0
- data/lib/google/shopping/merchant/notifications/v1/notifications_api_service.rb +57 -0
- data/lib/google/shopping/merchant/notifications/v1/notificationsapi_pb.rb +61 -0
- data/lib/google/shopping/merchant/notifications/v1/notificationsapi_services_pb.rb +81 -0
- data/lib/google/shopping/merchant/notifications/v1/rest.rb +39 -0
- data/lib/google/shopping/merchant/notifications/v1/version.rb +7 -2
- data/lib/google/shopping/merchant/notifications/v1.rb +47 -0
- data/lib/google-shopping-merchant-notifications-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/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/field_mask.rb +229 -0
- data/proto_docs/google/shopping/merchant/notifications/v1/notificationsapi.rb +184 -0
- metadata +71 -9
|
@@ -0,0 +1,184 @@
|
|
|
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 Notifications
|
|
24
|
+
module V1
|
|
25
|
+
# Request message for the GetNotificationSubscription method.
|
|
26
|
+
# @!attribute [rw] name
|
|
27
|
+
# @return [::String]
|
|
28
|
+
# Required. The `name` of the notification subscription.
|
|
29
|
+
class GetNotificationSubscriptionRequest
|
|
30
|
+
include ::Google::Protobuf::MessageExts
|
|
31
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
32
|
+
end
|
|
33
|
+
|
|
34
|
+
# Request message for the CreateNotificationSubscription method.
|
|
35
|
+
# @!attribute [rw] parent
|
|
36
|
+
# @return [::String]
|
|
37
|
+
# Required. The merchant account that owns the new notification subscription.
|
|
38
|
+
# Format: `accounts/{account}`
|
|
39
|
+
# @!attribute [rw] notification_subscription
|
|
40
|
+
# @return [::Google::Shopping::Merchant::Notifications::V1::NotificationSubscription]
|
|
41
|
+
# Required. The notification subscription to create.
|
|
42
|
+
class CreateNotificationSubscriptionRequest
|
|
43
|
+
include ::Google::Protobuf::MessageExts
|
|
44
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
45
|
+
end
|
|
46
|
+
|
|
47
|
+
# Request message for the UpdateNotificationSubscription method.
|
|
48
|
+
# @!attribute [rw] notification_subscription
|
|
49
|
+
# @return [::Google::Shopping::Merchant::Notifications::V1::NotificationSubscription]
|
|
50
|
+
# Required. The new version of the notification subscription that should be
|
|
51
|
+
# updated.
|
|
52
|
+
# @!attribute [rw] update_mask
|
|
53
|
+
# @return [::Google::Protobuf::FieldMask]
|
|
54
|
+
# List of fields being updated.
|
|
55
|
+
class UpdateNotificationSubscriptionRequest
|
|
56
|
+
include ::Google::Protobuf::MessageExts
|
|
57
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
58
|
+
end
|
|
59
|
+
|
|
60
|
+
# Request message for the DeleteNotificationSubscription method.
|
|
61
|
+
# @!attribute [rw] name
|
|
62
|
+
# @return [::String]
|
|
63
|
+
# Required. The name of the notification subscription to be deleted.
|
|
64
|
+
class DeleteNotificationSubscriptionRequest
|
|
65
|
+
include ::Google::Protobuf::MessageExts
|
|
66
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
67
|
+
end
|
|
68
|
+
|
|
69
|
+
# Request message for the ListNotificationSubscription method.
|
|
70
|
+
# @!attribute [rw] parent
|
|
71
|
+
# @return [::String]
|
|
72
|
+
# Required. The merchant account who owns the notification subscriptions.
|
|
73
|
+
# Format: `accounts/{account}`
|
|
74
|
+
# @!attribute [rw] page_size
|
|
75
|
+
# @return [::Integer]
|
|
76
|
+
# The maximum number of notification subscriptions to return in a page.
|
|
77
|
+
# The default value for `page_size` is 100. The
|
|
78
|
+
# maximum value is `200`. Values above `200` will be coerced to `200`.
|
|
79
|
+
# @!attribute [rw] page_token
|
|
80
|
+
# @return [::String]
|
|
81
|
+
# Token (if provided) to retrieve the subsequent page. All other parameters
|
|
82
|
+
# must match the original call that provided the page token.
|
|
83
|
+
class ListNotificationSubscriptionsRequest
|
|
84
|
+
include ::Google::Protobuf::MessageExts
|
|
85
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
86
|
+
end
|
|
87
|
+
|
|
88
|
+
# Response message for the ListNotificationSubscription method.
|
|
89
|
+
# @!attribute [rw] notification_subscriptions
|
|
90
|
+
# @return [::Array<::Google::Shopping::Merchant::Notifications::V1::NotificationSubscription>]
|
|
91
|
+
# The list of notification subscriptions requested by the merchant.
|
|
92
|
+
# @!attribute [rw] next_page_token
|
|
93
|
+
# @return [::String]
|
|
94
|
+
# A token, which can be sent as `page_token` to retrieve the next page.
|
|
95
|
+
# If this field is omitted, there are no subsequent pages.
|
|
96
|
+
class ListNotificationSubscriptionsResponse
|
|
97
|
+
include ::Google::Protobuf::MessageExts
|
|
98
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
99
|
+
end
|
|
100
|
+
|
|
101
|
+
# Represents a notification subscription owned by a Merchant account.
|
|
102
|
+
# @!attribute [rw] all_managed_accounts
|
|
103
|
+
# @return [::Boolean]
|
|
104
|
+
# If this value is true, the requesting account is notified of the
|
|
105
|
+
# specified event for all managed accounts (can be subaccounts or other
|
|
106
|
+
# linked accounts) including newly added accounts on a daily basis.
|
|
107
|
+
#
|
|
108
|
+
# Note: The following fields are mutually exclusive: `all_managed_accounts`, `target_account`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
109
|
+
# @!attribute [rw] target_account
|
|
110
|
+
# @return [::String]
|
|
111
|
+
# The `name` of the account you want to receive notifications for.
|
|
112
|
+
# Format: `accounts/{account}`
|
|
113
|
+
#
|
|
114
|
+
# Note: The following fields are mutually exclusive: `target_account`, `all_managed_accounts`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
115
|
+
# @!attribute [r] name
|
|
116
|
+
# @return [::String]
|
|
117
|
+
# Output only. The `name` of the notification configuration. Generated by the
|
|
118
|
+
# Content API upon creation of a new `NotificationSubscription`. The
|
|
119
|
+
# `account` represents the merchant ID of the merchant that owns the
|
|
120
|
+
# configuration. Format:
|
|
121
|
+
# `accounts/{account}/notificationsubscriptions/{notification_subscription}`
|
|
122
|
+
# @!attribute [rw] registered_event
|
|
123
|
+
# @return [::Google::Shopping::Merchant::Notifications::V1::NotificationSubscription::NotificationEventType]
|
|
124
|
+
# The event that the merchant wants to be notified about.
|
|
125
|
+
# @!attribute [rw] call_back_uri
|
|
126
|
+
# @return [::String]
|
|
127
|
+
# URL to be used to push the notification to the merchant.
|
|
128
|
+
class NotificationSubscription
|
|
129
|
+
include ::Google::Protobuf::MessageExts
|
|
130
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
131
|
+
|
|
132
|
+
# Represents the event type that the merchant is interested in receiving
|
|
133
|
+
# notifications for.
|
|
134
|
+
module NotificationEventType
|
|
135
|
+
# Notifications event type is unspecified.
|
|
136
|
+
NOTIFICATION_EVENT_TYPE_UNSPECIFIED = 0
|
|
137
|
+
|
|
138
|
+
# Notification of product status changes, for example when product becomes
|
|
139
|
+
# disapproved.
|
|
140
|
+
PRODUCT_STATUS_CHANGE = 1
|
|
141
|
+
end
|
|
142
|
+
end
|
|
143
|
+
|
|
144
|
+
# Request for notification subscription health metrics.
|
|
145
|
+
# @!attribute [rw] name
|
|
146
|
+
# @return [::String]
|
|
147
|
+
# Required. The `name` of the notification subscription for which metrics are
|
|
148
|
+
# retrieved.
|
|
149
|
+
# Format:
|
|
150
|
+
# `accounts/{account}/notificationsubscriptions/{notification_subscription}`
|
|
151
|
+
class GetNotificationSubscriptionHealthMetricsRequest
|
|
152
|
+
include ::Google::Protobuf::MessageExts
|
|
153
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
154
|
+
end
|
|
155
|
+
|
|
156
|
+
# Represents a notification subscription health metrics.
|
|
157
|
+
# @!attribute [r] name
|
|
158
|
+
# @return [::String]
|
|
159
|
+
# Output only. Identifier. The name of the notification configuration.
|
|
160
|
+
# Generated by the Content API upon creation of a new
|
|
161
|
+
# NotificationSubscription. The account represents the merchant ID of the
|
|
162
|
+
# merchant that owns the configuration.
|
|
163
|
+
# @!attribute [rw] acknowledged_messages_count
|
|
164
|
+
# @return [::Integer]
|
|
165
|
+
# The number of retained acknowledged messages for the last 24 hours
|
|
166
|
+
# @!attribute [rw] undelivered_messages_count
|
|
167
|
+
# @return [::Integer]
|
|
168
|
+
# The number of unacknowledged messages for the last 7 days, we will attempt
|
|
169
|
+
# to re-deliver the unacknowledged message later and once successfully
|
|
170
|
+
# delivered it will not be counted within unacknowledged messages (the number
|
|
171
|
+
# of unacknowledged messages should gradually decrease to zero once the issue
|
|
172
|
+
# is fixed).
|
|
173
|
+
# @!attribute [rw] oldest_unacknowledged_message_waiting_time
|
|
174
|
+
# @return [::Integer]
|
|
175
|
+
# The time since the oldest unacknowledged message was sent in seconds
|
|
176
|
+
class NotificationSubscriptionHealthMetrics
|
|
177
|
+
include ::Google::Protobuf::MessageExts
|
|
178
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
179
|
+
end
|
|
180
|
+
end
|
|
181
|
+
end
|
|
182
|
+
end
|
|
183
|
+
end
|
|
184
|
+
end
|
metadata
CHANGED
|
@@ -1,27 +1,89 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: google-shopping-merchant-notifications-v1
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.1.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Google LLC
|
|
8
8
|
bindir: bin
|
|
9
9
|
cert_chain: []
|
|
10
10
|
date: 1980-01-02 00:00:00.000000000 Z
|
|
11
|
-
dependencies:
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
11
|
+
dependencies:
|
|
12
|
+
- !ruby/object:Gem::Dependency
|
|
13
|
+
name: gapic-common
|
|
14
|
+
requirement: !ruby/object:Gem::Requirement
|
|
15
|
+
requirements:
|
|
16
|
+
- - "~>"
|
|
17
|
+
- !ruby/object:Gem::Version
|
|
18
|
+
version: '1.0'
|
|
19
|
+
type: :runtime
|
|
20
|
+
prerelease: false
|
|
21
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
22
|
+
requirements:
|
|
23
|
+
- - "~>"
|
|
24
|
+
- !ruby/object:Gem::Version
|
|
25
|
+
version: '1.0'
|
|
26
|
+
- !ruby/object:Gem::Dependency
|
|
27
|
+
name: google-cloud-errors
|
|
28
|
+
requirement: !ruby/object:Gem::Requirement
|
|
29
|
+
requirements:
|
|
30
|
+
- - "~>"
|
|
31
|
+
- !ruby/object:Gem::Version
|
|
32
|
+
version: '1.0'
|
|
33
|
+
type: :runtime
|
|
34
|
+
prerelease: false
|
|
35
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
36
|
+
requirements:
|
|
37
|
+
- - "~>"
|
|
38
|
+
- !ruby/object:Gem::Version
|
|
39
|
+
version: '1.0'
|
|
40
|
+
description: 'Merchant API consists of multiple Sub-APIs. Accounts Sub-API: Enables
|
|
41
|
+
you to programmatically manage your accounts. Conversions Sub-API: Enables you to
|
|
42
|
+
programmatically manage your conversion sources for a merchant account. Datasources
|
|
43
|
+
Sub-API: Enables you to programmatically manage your datasources. Inventories Sub-API:
|
|
44
|
+
This bundle enables you to programmatically manage your local and regional inventories.
|
|
45
|
+
Local Feeds Partnerships Sub-API: This bundle enables LFP partners to submit local
|
|
46
|
+
inventories for a merchant. Notifications Sub-API: This bundle enables you to programmatically
|
|
47
|
+
manage your notification subscriptions. Products Sub-API: This bundle enables you
|
|
48
|
+
to programmatically manage your products. Promotions Sub-API: This bundle enables
|
|
49
|
+
you to programmatically manage your promotions for products. Quota Sub-API: This
|
|
50
|
+
bundle enables you to list your quotas for all APIs you are using. Reports Sub-API:
|
|
51
|
+
This bundle enables you to programmatically retrieve reports and insights about
|
|
52
|
+
products, their performance and their competitive environment. Note that google-shopping-merchant-notifications-v1
|
|
53
|
+
is a version-specific client library. For most uses, we recommend installing the
|
|
54
|
+
main client library google-shopping-merchant-notifications instead. See the readme
|
|
55
|
+
for more details.'
|
|
17
56
|
email: googleapis-packages@google.com
|
|
18
57
|
executables: []
|
|
19
58
|
extensions: []
|
|
20
59
|
extra_rdoc_files: []
|
|
21
60
|
files:
|
|
61
|
+
- ".yardopts"
|
|
62
|
+
- AUTHENTICATION.md
|
|
22
63
|
- LICENSE.md
|
|
23
64
|
- README.md
|
|
65
|
+
- lib/google-shopping-merchant-notifications-v1.rb
|
|
66
|
+
- lib/google/shopping/merchant/notifications/v1.rb
|
|
67
|
+
- lib/google/shopping/merchant/notifications/v1/notifications_api_service.rb
|
|
68
|
+
- lib/google/shopping/merchant/notifications/v1/notifications_api_service/client.rb
|
|
69
|
+
- lib/google/shopping/merchant/notifications/v1/notifications_api_service/credentials.rb
|
|
70
|
+
- lib/google/shopping/merchant/notifications/v1/notifications_api_service/paths.rb
|
|
71
|
+
- lib/google/shopping/merchant/notifications/v1/notifications_api_service/rest.rb
|
|
72
|
+
- lib/google/shopping/merchant/notifications/v1/notifications_api_service/rest/client.rb
|
|
73
|
+
- lib/google/shopping/merchant/notifications/v1/notifications_api_service/rest/service_stub.rb
|
|
74
|
+
- lib/google/shopping/merchant/notifications/v1/notificationsapi_pb.rb
|
|
75
|
+
- lib/google/shopping/merchant/notifications/v1/notificationsapi_services_pb.rb
|
|
76
|
+
- lib/google/shopping/merchant/notifications/v1/rest.rb
|
|
24
77
|
- lib/google/shopping/merchant/notifications/v1/version.rb
|
|
78
|
+
- proto_docs/README.md
|
|
79
|
+
- proto_docs/google/api/client.rb
|
|
80
|
+
- proto_docs/google/api/field_behavior.rb
|
|
81
|
+
- proto_docs/google/api/launch_stage.rb
|
|
82
|
+
- proto_docs/google/api/resource.rb
|
|
83
|
+
- proto_docs/google/protobuf/duration.rb
|
|
84
|
+
- proto_docs/google/protobuf/empty.rb
|
|
85
|
+
- proto_docs/google/protobuf/field_mask.rb
|
|
86
|
+
- proto_docs/google/shopping/merchant/notifications/v1/notificationsapi.rb
|
|
25
87
|
homepage: https://github.com/googleapis/google-cloud-ruby
|
|
26
88
|
licenses:
|
|
27
89
|
- Apache-2.0
|
|
@@ -33,7 +95,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
|
33
95
|
requirements:
|
|
34
96
|
- - ">="
|
|
35
97
|
- !ruby/object:Gem::Version
|
|
36
|
-
version: '3.
|
|
98
|
+
version: '3.1'
|
|
37
99
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
38
100
|
requirements:
|
|
39
101
|
- - ">="
|
|
@@ -42,5 +104,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
42
104
|
requirements: []
|
|
43
105
|
rubygems_version: 3.6.9
|
|
44
106
|
specification_version: 4
|
|
45
|
-
summary:
|
|
107
|
+
summary: Programmatically manage your Merchant Center Accounts.
|
|
46
108
|
test_files: []
|