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

data/proto_docs/google/shopping/merchant/notifications/v1beta/notificationsapi.rb

@@ -0,0 +1,215 @@
+# 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 Notifications
+        module V1beta
+          # Request message for the GetNotificationSubscription method.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. The `name` of the notification subscription.
+          class GetNotificationSubscriptionRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request message for the CreateNotificationSubscription method.
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. The merchant account that owns the new notification subscription.
+          #     Format: `accounts/{account}`
+          # @!attribute [rw] notification_subscription
+          #   @return [::Google::Shopping::Merchant::Notifications::V1beta::NotificationSubscription]
+          #     Required. The notification subscription to create.
+          class CreateNotificationSubscriptionRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request message for the UpdateNotificationSubscription method.
+          # @!attribute [rw] notification_subscription
+          #   @return [::Google::Shopping::Merchant::Notifications::V1beta::NotificationSubscription]
+          #     Required. The new version of the notification subscription that should be
+          #     updated.
+          # @!attribute [rw] update_mask
+          #   @return [::Google::Protobuf::FieldMask]
+          #     List of fields being updated.
+          class UpdateNotificationSubscriptionRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request message for the DeleteNotificationSubscription method.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. The name of the notification subscription to be deleted.
+          class DeleteNotificationSubscriptionRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request message for the ListNotificationSubscription method.
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. The merchant account who owns the notification subscriptions.
+          #     Format: `accounts/{account}`
+          # @!attribute [rw] page_size
+          #   @return [::Integer]
+          #     The maximum number of notification subscriptions to return in a page.
+          #     The default value for `page_size` is 100. The
+          #     maximum value is `200`. Values above `200` will be coerced to `200`.
+          # @!attribute [rw] page_token
+          #   @return [::String]
+          #     Token (if provided) to retrieve the subsequent page. All other parameters
+          #     must match the original call that provided the page token.
+          class ListNotificationSubscriptionsRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Response message for the ListNotificationSubscription method.
+          # @!attribute [rw] notification_subscriptions
+          #   @return [::Array<::Google::Shopping::Merchant::Notifications::V1beta::NotificationSubscription>]
+          #     The list of notification subscriptions requested by the merchant.
+          # @!attribute [rw] next_page_token
+          #   @return [::String]
+          #     A token, which can be sent as `page_token` to retrieve the next page.
+          #     If this field is omitted, there are no subsequent pages.
+          class ListNotificationSubscriptionsResponse
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Represents a notification subscription owned by a Merchant account.
+          # @!attribute [rw] all_managed_accounts
+          #   @return [::Boolean]
+          #     If this value is true, the requesting account is notified of the
+          #     specified event for all managed accounts (can be subaccounts or other
+          #     linked accounts) including newly added accounts on a daily basis.
+          # @!attribute [rw] target_account
+          #   @return [::String]
+          #     The `name` of the account you want to receive notifications for.
+          #     Format: `accounts/{account}`
+          # @!attribute [r] name
+          #   @return [::String]
+          #     Output only. The `name` of the notification configuration. Generated by the
+          #     Content API upon creation of a new `NotificationSubscription`. The
+          #     `account` represents the merchant ID of the merchant that owns the
+          #     configuration. Format:
+          #     `accounts/{account}/notificationsubscriptions/{notification_subscription}`
+          # @!attribute [rw] registered_event
+          #   @return [::Google::Shopping::Merchant::Notifications::V1beta::NotificationSubscription::NotificationEventType]
+          #     The event that the merchant wants to be notified about.
+          # @!attribute [rw] call_back_uri
+          #   @return [::String]
+          #     URL to be used to push the notification to the merchant.
+          class NotificationSubscription
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Represents the event type that the merchant is interested in receiving
+            # notifications for.
+            module NotificationEventType
+              # Notifications event type is unspecified.
+              NOTIFICATION_EVENT_TYPE_UNSPECIFIED = 0
+
+              # Notification of product status changes, for example when product becomes
+              # disapproved.
+              PRODUCT_STATUS_CHANGE = 1
+            end
+          end
+
+          # The change that happened to the product including old value, new value,
+          # country code as the region code and reporting context.
+          # @!attribute [rw] old_value
+          #   @return [::String]
+          #     The old value of the changed resource or attribute.
+          # @!attribute [rw] new_value
+          #   @return [::String]
+          #     The new value of the changed resource or attribute.
+          # @!attribute [rw] region_code
+          #   @return [::String]
+          #     Countries that have the change (if applicable)
+          # @!attribute [rw] reporting_context
+          #   @return [::Google::Shopping::Type::ReportingContext::ReportingContextEnum]
+          #     Reporting contexts that have the change (if applicable)
+          class ProductChange
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The message that the merchant will receive to notify about product status
+          # change event
+          # @!attribute [rw] account
+          #   @return [::String]
+          #     The target account that owns the entity that changed.
+          #     Format : `accounts/{merchant_id}`
+          # @!attribute [rw] managing_account
+          #   @return [::String]
+          #     The account that manages the merchant's account. can be the same as
+          #     merchant id if it is standalone account. Format :
+          #     `accounts/{service_provider_id}`
+          # @!attribute [rw] resource_type
+          #   @return [::Google::Shopping::Merchant::Notifications::V1beta::Resource]
+          #     The resource that changed, in this case it will always be `Product`.
+          # @!attribute [rw] attribute
+          #   @return [::Google::Shopping::Merchant::Notifications::V1beta::Attribute]
+          #     The attribute in the resource that changed, in this case it will be always
+          #     `Status`.
+          # @!attribute [rw] changes
+          #   @return [::Array<::Google::Shopping::Merchant::Notifications::V1beta::ProductChange>]
+          #     A message to describe the change that happened to the product
+          # @!attribute [rw] resource_id
+          #   @return [::String]
+          #     The product id.
+          # @!attribute [rw] resource
+          #   @return [::String]
+          #     The product name.
+          #     Format: `{product.name=accounts/{account}/products/{product}}`
+          class ProductStatusChangeMessage
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Enum to specify the resource that is being changed to notify the merchant
+          # about.
+          module Resource
+            # Unspecified resource
+            RESOURCE_UNSPECIFIED = 0
+
+            # Resource type : product
+            PRODUCT = 1
+          end
+
+          # Enum to specify the attribute in the resource that is being changed to
+          # notify the merchant about.
+          module Attribute
+            # Unspecified attribute
+            ATTRIBUTE_UNSPECIFIED = 0
+
+            # Status of the changed entity
+            STATUS = 1
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/shopping/type/types.rb

@@ -0,0 +1,183 @@
+# 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 Type
+      # The price represented as a number and currency.
+      # @!attribute [rw] amount_micros
+      #   @return [::Integer]
+      #     The price represented as a number in micros (1 million micros is an
+      #     equivalent to one's currency standard unit, for example, 1 USD = 1000000
+      #     micros).
+      #     This field can also be set as infinity by setting to -1.
+      #     This field only support -1 and positive value.
+      # @!attribute [rw] currency_code
+      #   @return [::String]
+      #     The currency of the price using three-letter acronyms according to [ISO
+      #     4217](http://en.wikipedia.org/wiki/ISO_4217).
+      class Price
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+      end
+
+      # A message that represents custom attributes. Exactly one of `value` or
+      # `group_values` must not be empty.
+      # @!attribute [rw] name
+      #   @return [::String]
+      #     The name of the attribute.
+      # @!attribute [rw] value
+      #   @return [::String]
+      #     The value of the attribute. If `value` is not empty, `group_values` must be
+      #     empty.
+      # @!attribute [rw] group_values
+      #   @return [::Array<::Google::Shopping::Type::CustomAttribute>]
+      #     Subattributes within this attribute group.  If
+      #     `group_values` is not empty, `value` must be empty.
+      class CustomAttribute
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+      end
+
+      # Destinations available for a product.
+      #
+      # Destinations are used in Merchant Center to allow you to control where the
+      # products from your data feed should be displayed.
+      class Destination
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+
+        # Destination values.
+        module DestinationEnum
+          # Not specified.
+          DESTINATION_ENUM_UNSPECIFIED = 0
+
+          # [Shopping ads](https://support.google.com/google-ads/answer/2454022).
+          SHOPPING_ADS = 1
+
+          # [Display ads](https://support.google.com/merchants/answer/6069387).
+          DISPLAY_ADS = 2
+
+          # [Local inventory
+          # ads](https://support.google.com/merchants/answer/3057972).
+          LOCAL_INVENTORY_ADS = 3
+
+          # [Free listings](https://support.google.com/merchants/answer/9199328).
+          FREE_LISTINGS = 4
+
+          # [Free local product
+          # listings](https://support.google.com/merchants/answer/9825611).
+          FREE_LOCAL_LISTINGS = 5
+
+          # [YouTube Shopping](https://support.google.com/merchants/answer/12362804).
+          YOUTUBE_SHOPPING = 6
+        end
+      end
+
+      # Reporting contexts that your account and product issues apply to.
+      #
+      # Reporting contexts are groups of surfaces and formats for product results on
+      # Google. They can represent the entire destination (for example, [Shopping
+      # ads](https://support.google.com/merchants/answer/6149970)) or a subset of
+      # formats within a destination (for example, [Demand Gen
+      # ads](https://support.google.com/merchants/answer/13389785)).
+      class ReportingContext
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+
+        # Reporting context values.
+        module ReportingContextEnum
+          # Not specified.
+          REPORTING_CONTEXT_ENUM_UNSPECIFIED = 0
+
+          # [Shopping ads](https://support.google.com/merchants/answer/6149970).
+          SHOPPING_ADS = 1
+
+          # Deprecated:  Use `DEMAND_GEN_ADS` instead.
+          # [Discovery and Demand Gen
+          # ads](https://support.google.com/merchants/answer/13389785).
+          DISCOVERY_ADS = 2
+
+          # [Demand Gen ads](https://support.google.com/merchants/answer/13389785).
+          DEMAND_GEN_ADS = 13
+
+          # [Demand Gen ads on Discover
+          # surface](https://support.google.com/merchants/answer/13389785).
+          DEMAND_GEN_ADS_DISCOVER_SURFACE = 14
+
+          # [Video ads](https://support.google.com/google-ads/answer/6340491).
+          VIDEO_ADS = 3
+
+          # [Display ads](https://support.google.com/merchants/answer/6069387).
+          DISPLAY_ADS = 4
+
+          # [Local inventory
+          # ads](https://support.google.com/merchants/answer/3271956).
+          LOCAL_INVENTORY_ADS = 5
+
+          # [Vehicle inventory
+          # ads](https://support.google.com/merchants/answer/11544533).
+          VEHICLE_INVENTORY_ADS = 6
+
+          # [Free product
+          # listings](https://support.google.com/merchants/answer/9199328).
+          FREE_LISTINGS = 7
+
+          # [Free local product
+          # listings](https://support.google.com/merchants/answer/9825611).
+          FREE_LOCAL_LISTINGS = 8
+
+          # [Free local vehicle
+          # listings](https://support.google.com/merchants/answer/11544533).
+          FREE_LOCAL_VEHICLE_LISTINGS = 9
+
+          # [YouTube
+          # Shopping](https://support.google.com/merchants/answer/13478370).
+          YOUTUBE_SHOPPING = 10
+
+          # [Cloud retail](https://cloud.google.com/solutions/retail).
+          CLOUD_RETAIL = 11
+
+          # [Local cloud retail](https://cloud.google.com/solutions/retail).
+          LOCAL_CLOUD_RETAIL = 12
+        end
+      end
+
+      # [Channel](https://support.google.com/merchants/answer/7361332) of a product.
+      #
+      # Channel is used to distinguish between online and local products.
+      class Channel
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+
+        # Channel values.
+        module ChannelEnum
+          # Not specified.
+          CHANNEL_ENUM_UNSPECIFIED = 0
+
+          # Online product.
+          ONLINE = 1
+
+          # Local product.
+          LOCAL = 2
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,28 +1,105 @@
 --- !ruby/object:Gem::Specification
 name: google-shopping-merchant-notifications-v1beta
 version: !ruby/object:Gem::Version
-  version: 0.a
+  version: 0.1.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-23 00:00:00.000000000 Z
-dependencies: []
-description: Placeholder for the future Google-authored gem google-shopping-merchant-notifications-v1beta.
-  This placeholder is being released on 2024-04-23 in order to reserve the name. The
-  final gem should be available shortly after that date. If it has not been released
-  in a timely manner, or if this placeholder interferes with your work, you can contact
-  the Google Ruby team by opening an issue in the GitHub repository https://github.com/googleapis/google-cloud-ruby.
+date: 2024-04-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gapic-common
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.21.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.a
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.21.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.a
+- !ruby/object:Gem::Dependency
+  name: google-cloud-errors
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: google-shopping-type
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.a
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.a
+description: Programmatically manage your Merchant Center accounts. Note that google-shopping-merchant-notifications-v1beta
+  is a version-specific client library. For most uses, we recommend installing the
+  main client library google-shopping-merchant-notifications instead. See the readme
+  for more details.
 email: googleapis-packages@google.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".yardopts"
+- AUTHENTICATION.md
 - LICENSE.md
 - README.md
+- lib/google-shopping-merchant-notifications-v1beta.rb
+- lib/google/shopping/merchant/notifications/v1beta.rb
+- lib/google/shopping/merchant/notifications/v1beta/notifications_api_service.rb
+- lib/google/shopping/merchant/notifications/v1beta/notifications_api_service/client.rb
+- lib/google/shopping/merchant/notifications/v1beta/notifications_api_service/credentials.rb
+- lib/google/shopping/merchant/notifications/v1beta/notifications_api_service/paths.rb
+- lib/google/shopping/merchant/notifications/v1beta/notifications_api_service/rest.rb
+- lib/google/shopping/merchant/notifications/v1beta/notifications_api_service/rest/client.rb
+- lib/google/shopping/merchant/notifications/v1beta/notifications_api_service/rest/service_stub.rb
+- lib/google/shopping/merchant/notifications/v1beta/notificationsapi_pb.rb
+- lib/google/shopping/merchant/notifications/v1beta/notificationsapi_services_pb.rb
+- lib/google/shopping/merchant/notifications/v1beta/rest.rb
 - lib/google/shopping/merchant/notifications/v1beta/version.rb
+- proto_docs/README.md
+- proto_docs/google/api/client.rb
+- proto_docs/google/api/field_behavior.rb
+- proto_docs/google/api/launch_stage.rb
+- proto_docs/google/api/resource.rb
+- proto_docs/google/protobuf/duration.rb
+- proto_docs/google/protobuf/empty.rb
+- proto_docs/google/protobuf/field_mask.rb
+- proto_docs/google/shopping/merchant/notifications/v1beta/notificationsapi.rb
+- proto_docs/google/shopping/type/types.rb
 homepage: https://github.com/googleapis/google-cloud-ruby
 licenses:
 - Apache-2.0
@@ -35,7 +112,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -45,5 +122,5 @@ requirements: []
 rubygems_version: 3.5.6
 signing_key: 
 specification_version: 4
-summary: Placeholder for the future Google-authored gem google-shopping-merchant-notifications-v1beta
+summary: Programmatically manage your Merchant Center accounts.
 test_files: []