google-cloud-retail-v2 0.1.0

data/proto_docs/google/cloud/retail/v2/catalog.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+# Copyright 2021 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 Cloud
+    module Retail
+      module V2
+        # Configures what level the product should be uploaded with regards to
+        # how users will be send events and how predictions will be made.
+        # @!attribute [rw] ingestion_product_type
+        #   @return [::String]
+        #     The type of {::Google::Cloud::Retail::V2::Product Product}s allowed to be
+        #     ingested into the catalog. Acceptable values are:
+        #
+        #     * `primary` (default): You can only ingest
+        #     {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Product.Type.PRIMARY}
+        #       {::Google::Cloud::Retail::V2::Product Product}s. This means
+        #       {::Google::Cloud::Retail::V2::Product#primary_product_id Product.primary_product_id}
+        #       can only be empty or set to the same value as
+        #       {::Google::Cloud::Retail::V2::Product#id Product.id}.
+        #     * `variant`: You can only ingest
+        #     {::Google::Cloud::Retail::V2::Product::Type::VARIANT Product.Type.VARIANT}
+        #     {::Google::Cloud::Retail::V2::Product Product}s.
+        #       This means
+        #       {::Google::Cloud::Retail::V2::Product#primary_product_id Product.primary_product_id}
+        #       cannot be empty.
+        #
+        #     If this field is set to an invalid value other than these, an
+        #     INVALID_ARGUMENT error is returned.
+        #
+        #     If this field is `variant` and
+        #     {::Google::Cloud::Retail::V2::ProductLevelConfig#merchant_center_product_id_field merchant_center_product_id_field}
+        #     is `itemGroupId`, an INVALID_ARGUMENT error is returned.
+        #
+        #     See [Using catalog
+        #     levels](/retail/recommendations-ai/docs/catalog#catalog-levels) for more
+        #     details.
+        # @!attribute [rw] merchant_center_product_id_field
+        #   @return [::String]
+        #     Which field of [Merchant Center
+        #     Product](/bigquery-transfer/docs/merchant-center-products-schema) should be
+        #     imported as {::Google::Cloud::Retail::V2::Product#id Product.id}. Acceptable
+        #     values are:
+        #
+        #     * `offerId` (default): Import `offerId` as the product ID.
+        #     * `itemGroupId`: Import `itemGroupId` as the product ID. Notice that Retail
+        #       API will choose one item from the ones with the same `itemGroupId`, and
+        #       use it to represent the item group.
+        #
+        #     If this field is set to an invalid value other than these, an
+        #     INVALID_ARGUMENT error is returned.
+        #
+        #     If this field is `itemGroupId` and
+        #     {::Google::Cloud::Retail::V2::ProductLevelConfig#ingestion_product_type ingestion_product_type}
+        #     is `variant`, an INVALID_ARGUMENT error is returned.
+        #
+        #     See [Using catalog
+        #     levels](/retail/recommendations-ai/docs/catalog#catalog-levels) for more
+        #     details.
+        class ProductLevelConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The catalog configuration.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Immutable. The fully qualified resource name of the catalog.
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     Required. Immutable. The catalog display name.
+        #
+        #     This field must be a UTF-8 encoded string with a length limit of 128
+        #     characters. Otherwise, an INVALID_ARGUMENT error is returned.
+        # @!attribute [rw] product_level_config
+        #   @return [::Google::Cloud::Retail::V2::ProductLevelConfig]
+        #     Required. The product level configuration.
+        class Catalog
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/retail/v2/catalog_service.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+# Copyright 2021 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 Cloud
+    module Retail
+      module V2
+        # Request for
+        # {::Google::Cloud::Retail::V2::CatalogService::Client#list_catalogs CatalogService.ListCatalogs}
+        # method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The account resource name with an associated location.
+        #
+        #     If the caller does not have permission to list
+        #     {::Google::Cloud::Retail::V2::Catalog Catalog}s under this location, regardless
+        #     of whether or not this location exists, a PERMISSION_DENIED error is
+        #     returned.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Maximum number of {::Google::Cloud::Retail::V2::Catalog Catalog}s to return. If
+        #     unspecified, defaults to 50. The maximum allowed value is 1000. Values
+        #     above 1000 will be coerced to 1000.
+        #
+        #     If this field is negative, an INVALID_ARGUMENT is returned.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     A page token
+        #     {::Google::Cloud::Retail::V2::ListCatalogsResponse#next_page_token ListCatalogsResponse.next_page_token},
+        #     received from a previous
+        #     {::Google::Cloud::Retail::V2::CatalogService::Client#list_catalogs CatalogService.ListCatalogs}
+        #     call. Provide this to retrieve the subsequent page.
+        #
+        #     When paginating, all other parameters provided to
+        #     {::Google::Cloud::Retail::V2::CatalogService::Client#list_catalogs CatalogService.ListCatalogs}
+        #     must match the call that provided the page token. Otherwise, an
+        #     INVALID_ARGUMENT error is returned.
+        class ListCatalogsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response for
+        # {::Google::Cloud::Retail::V2::CatalogService::Client#list_catalogs CatalogService.ListCatalogs}
+        # method.
+        # @!attribute [rw] catalogs
+        #   @return [::Array<::Google::Cloud::Retail::V2::Catalog>]
+        #     All the customer's {::Google::Cloud::Retail::V2::Catalog Catalog}s.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token that can be sent as
+        #     {::Google::Cloud::Retail::V2::ListCatalogsRequest#page_token ListCatalogsRequest.page_token}
+        #     to retrieve the next page. If this field is omitted, there are no
+        #     subsequent pages.
+        class ListCatalogsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for
+        # {::Google::Cloud::Retail::V2::CatalogService::Client#update_catalog CatalogService.UpdateCatalog}
+        # method.
+        # @!attribute [rw] catalog
+        #   @return [::Google::Cloud::Retail::V2::Catalog]
+        #     Required. The {::Google::Cloud::Retail::V2::Catalog Catalog} to update.
+        #
+        #     If the caller does not have permission to update the
+        #     {::Google::Cloud::Retail::V2::Catalog Catalog}, regardless of whether or not it
+        #     exists, a PERMISSION_DENIED error is returned.
+        #
+        #     If the {::Google::Cloud::Retail::V2::Catalog Catalog} to update does not exist,
+        #     a NOT_FOUND error is returned.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Indicates which fields in the provided
+        #     {::Google::Cloud::Retail::V2::Catalog Catalog} to update. If not set, will only
+        #     update the
+        #     {::Google::Cloud::Retail::V2::Catalog#product_level_config Catalog.product_level_config}
+        #     field, which is also the only currently supported field to update.
+        #
+        #     If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
+        #     is returned.
+        class UpdateCatalogRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/retail/v2/common.rb

@@ -0,0 +1,169 @@
+# frozen_string_literal: true
+
+# Copyright 2021 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 Cloud
+    module Retail
+      module V2
+        # A custom attribute that is not explicitly modeled in
+        # {::Google::Cloud::Retail::V2::Product Product}].
+        # @!attribute [rw] text
+        #   @return [::Array<::String>]
+        #     The textual values of this custom attribute. For example, `["yellow",
+        #     "green"]` when the key is "color".
+        #
+        #     At most 400 values are allowed. Empty values are not allowed. Each value
+        #     must be a UTF-8 encoded string with a length limit of 256 characters.
+        #     Otherwise, an INVALID_ARGUMENT error is returned.
+        #
+        #     Exactly one of {::Google::Cloud::Retail::V2::CustomAttribute#text text} or
+        #     {::Google::Cloud::Retail::V2::CustomAttribute#numbers numbers} should be set.
+        #     Otherwise, an INVALID_ARGUMENT error is returned.
+        # @!attribute [rw] numbers
+        #   @return [::Array<::Float>]
+        #     The numerical values of this custom attribute. For example, `[2.3, 15.4]`
+        #     when the key is "lengths_cm".
+        #
+        #     At most 400 values are allowed.Otherwise, an INVALID_ARGUMENT error is
+        #     returned.
+        #
+        #     Exactly one of {::Google::Cloud::Retail::V2::CustomAttribute#text text} or
+        #     {::Google::Cloud::Retail::V2::CustomAttribute#numbers numbers} should be set.
+        #     Otherwise, an INVALID_ARGUMENT error is returned.
+        class CustomAttribute
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # {::Google::Cloud::Retail::V2::Product Product} thumbnail/detail image.
+        # @!attribute [rw] uri
+        #   @return [::String]
+        #     Required. URI of the image.
+        #
+        #     This field must be a valid UTF-8 encoded URI with a length limit of 5,000
+        #     characters. Otherwise, an INVALID_ARGUMENT error is returned.
+        #
+        #     Google Merchant Center property
+        #     [image_link](https://support.google.com/merchants/answer/6324350).
+        #     Schema.org property [Product.image](https://schema.org/image).
+        # @!attribute [rw] height
+        #   @return [::Integer]
+        #     Height of the image in number of pixels.
+        #
+        #     This field must be nonnegative. Otherwise, an INVALID_ARGUMENT error is
+        #     returned.
+        # @!attribute [rw] width
+        #   @return [::Integer]
+        #     Width of the image in number of pixels.
+        #
+        #     This field must be nonnegative. Otherwise, an INVALID_ARGUMENT error is
+        #     returned.
+        class Image
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The price information of a {::Google::Cloud::Retail::V2::Product Product}.
+        # @!attribute [rw] currency_code
+        #   @return [::String]
+        #     The 3-letter currency code defined in [ISO
+        #     4217](https://www.iso.org/iso-4217-currency-codes.html).
+        #
+        #     If this field is an unrecognizable currency code, an INVALID_ARGUMENT
+        #     error is returned.
+        # @!attribute [rw] price
+        #   @return [::Float]
+        #     Price of the product.
+        #
+        #     Google Merchant Center property
+        #     [price](https://support.google.com/merchants/answer/6324371). Schema.org
+        #     property [Offer.priceSpecification](https://schema.org/priceSpecification).
+        # @!attribute [rw] original_price
+        #   @return [::Float]
+        #     Price of the product without any discount. If zero, by default set to be
+        #     the {::Google::Cloud::Retail::V2::PriceInfo#price price}.
+        # @!attribute [rw] cost
+        #   @return [::Float]
+        #     The costs associated with the sale of a particular product. Used for gross
+        #     profit reporting.
+        #
+        #     * Profit = {::Google::Cloud::Retail::V2::PriceInfo#price price} -
+        #     {::Google::Cloud::Retail::V2::PriceInfo#cost cost}
+        #
+        #     Google Merchant Center property
+        #     [cost_of_goods_sold](https://support.google.com/merchants/answer/9017895).
+        class PriceInfo
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Information of an end user.
+        # @!attribute [rw] user_id
+        #   @return [::String]
+        #     Highly recommended for logged-in users. Unique identifier for logged-in
+        #     user, such as a user name.
+        #
+        #     The field must be a UTF-8 encoded string with a length limit of 128
+        #     characters. Otherwise, an INVALID_ARGUMENT error is returned.
+        # @!attribute [rw] ip_address
+        #   @return [::String]
+        #     The end user's IP address. This field is used to extract location
+        #     information for personalization.
+        #
+        #     This field must be either an IPv4 address (e.g. "104.133.9.80") or an IPv6
+        #     address (e.g. "2001:0db8:85a3:0000:0000:8a2e:0370:7334"). Otherwise, an
+        #     INVALID_ARGUMENT error is returned.
+        #
+        #     This should not be set when using the JavaScript tag in
+        #     {::Google::Cloud::Retail::V2::UserEventService::Client#collect_user_event UserEventService.CollectUserEvent}
+        #     or if
+        #     {::Google::Cloud::Retail::V2::UserInfo#direct_user_request direct_user_request}
+        #     is set.
+        # @!attribute [rw] user_agent
+        #   @return [::String]
+        #     User agent as included in the HTTP header.
+        #
+        #     The field must be a UTF-8 encoded string with a length limit of 1,000
+        #     characters. Otherwise, an INVALID_ARGUMENT error is returned.
+        #
+        #     This should not be set when using the client side event reporting with
+        #     GTM or JavaScript tag in
+        #     {::Google::Cloud::Retail::V2::UserEventService::Client#collect_user_event UserEventService.CollectUserEvent}
+        #     or if
+        #     {::Google::Cloud::Retail::V2::UserInfo#direct_user_request direct_user_request}
+        #     is set.
+        # @!attribute [rw] direct_user_request
+        #   @return [::Boolean]
+        #     True if the request is made directly from the end user, in which case the
+        #     {::Google::Cloud::Retail::V2::UserInfo#ip_address ip_address} and
+        #     {::Google::Cloud::Retail::V2::UserInfo#user_agent user_agent} can be populated
+        #     from the HTTP request. This flag should be set only if the API request is
+        #     made directly from the end user such as a mobile app (and not if a gateway
+        #     or a server is processing and pushing the user events).
+        #
+        #     This should not be set when using the JavaScript tag in
+        #     {::Google::Cloud::Retail::V2::UserEventService::Client#collect_user_event UserEventService.CollectUserEvent}.
+        class UserInfo
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/retail/v2/import_config.rb

@@ -0,0 +1,270 @@
+# frozen_string_literal: true
+
+# Copyright 2021 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 Cloud
+    module Retail
+      module V2
+        # Google Cloud Storage location for input content.
+        # format.
+        # @!attribute [rw] input_uris
+        #   @return [::Array<::String>]
+        #     Required. Google Cloud Storage URIs to input files. URI can be up to
+        #     2000 characters long. URIs can match the full object path (for example,
+        #     gs://bucket/directory/object.json) or a pattern matching one or more
+        #     files, such as gs://bucket/directory/*.json. A request can
+        #     contain at most 100 files, and each file can be up to 2 GB. See
+        #     [Importing product information](/recommendations-ai/docs/upload-catalog)
+        #     for the expected file format and setup instructions.
+        # @!attribute [rw] data_schema
+        #   @return [::String]
+        #     The schema to use when parsing the data from the source.
+        #
+        #     Supported values for product imports:
+        #
+        #     * `product` (default): One JSON {::Google::Cloud::Retail::V2::Product Product}
+        #     per line. Each product must
+        #       have a valid {::Google::Cloud::Retail::V2::Product#id Product.id}.
+        #     * `product_merchant_center`: See [Importing catalog data from Merchant
+        #       Center](/retail/recommendations-ai/docs/upload-catalog#mc).
+        #
+        #     Supported values for user events imports:
+        #
+        #     * `user_event` (default): One JSON
+        #     {::Google::Cloud::Retail::V2::UserEvent UserEvent} per line.
+        #     * `user_event_ga360`: Using
+        #       https://support.google.com/analytics/answer/3437719?hl=en.
+        class GcsSource
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # BigQuery source import data from.
+        # @!attribute [rw] project_id
+        #   @return [::String]
+        #     The project id (can be project # or id) that the BigQuery source is in with
+        #     a length limit of 128 characters. If not specified, inherits the project
+        #     id from the parent request.
+        # @!attribute [rw] dataset_id
+        #   @return [::String]
+        #     Required. The BigQuery data set to copy the data from with a length limit
+        #     of 1,024 characters.
+        # @!attribute [rw] table_id
+        #   @return [::String]
+        #     Required. The BigQuery table to copy the data from with a length limit of
+        #     1,024 characters.
+        # @!attribute [rw] gcs_staging_dir
+        #   @return [::String]
+        #     Intermediate Cloud Storage directory used for the import with a length
+        #     limit of 2,000 characters. Can be specified if one wants to have the
+        #     BigQuery export to a specific Cloud Storage directory.
+        # @!attribute [rw] data_schema
+        #   @return [::String]
+        #     The schema to use when parsing the data from the source.
+        #
+        #     Supported values for product imports:
+        #
+        #     * `product` (default): One JSON {::Google::Cloud::Retail::V2::Product Product}
+        #     per line. Each product must
+        #       have a valid {::Google::Cloud::Retail::V2::Product#id Product.id}.
+        #     * `product_merchant_center`: See [Importing catalog data from Merchant
+        #       Center](/retail/recommendations-ai/docs/upload-catalog#mc).
+        #
+        #     Supported values for user events imports:
+        #
+        #     * `user_event` (default): One JSON
+        #     {::Google::Cloud::Retail::V2::UserEvent UserEvent} per line.
+        #     * `user_event_ga360`: Using
+        #       https://support.google.com/analytics/answer/3437719?hl=en.
+        class BigQuerySource
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The inline source for the input config for ImportProducts method.
+        # @!attribute [rw] products
+        #   @return [::Array<::Google::Cloud::Retail::V2::Product>]
+        #     Required. A list of products to update/create. Each product must have a
+        #     valid {::Google::Cloud::Retail::V2::Product#id Product.id}. Recommended max of
+        #     10k items.
+        class ProductInlineSource
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The inline source for the input config for ImportUserEvents method.
+        # @!attribute [rw] user_events
+        #   @return [::Array<::Google::Cloud::Retail::V2::UserEvent>]
+        #     Required. A list of user events to import. Recommended max of 10k items.
+        class UserEventInlineSource
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Configuration of destination for Import related errors.
+        # @!attribute [rw] gcs_prefix
+        #   @return [::String]
+        #     Google Cloud Storage path for import errors. This must be an empty,
+        #     existing Cloud Storage bucket. Import errors will be written to a file in
+        #     this bucket, one per line, as a JSON-encoded
+        #     `google.rpc.Status` message.
+        class ImportErrorsConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for Import methods.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required.
+        #     "projects/1234/locations/global/catalogs/default_catalog/branches/default_branch"
+        #
+        #     If no updateMask is specified, requires products.create permission.
+        #     If updateMask is specified, requires products.update permission.
+        # @!attribute [rw] input_config
+        #   @return [::Google::Cloud::Retail::V2::ProductInputConfig]
+        #     Required. The desired input location of the data.
+        # @!attribute [rw] errors_config
+        #   @return [::Google::Cloud::Retail::V2::ImportErrorsConfig]
+        #     The desired location of errors incurred during the Import.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Indicates which fields in the provided imported 'products' to update. If
+        #     not set, will by default update all fields.
+        class ImportProductsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for the ImportUserEvents request.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. "projects/1234/locations/global/catalogs/default_catalog"
+        # @!attribute [rw] input_config
+        #   @return [::Google::Cloud::Retail::V2::UserEventInputConfig]
+        #     Required. The desired input location of the data.
+        # @!attribute [rw] errors_config
+        #   @return [::Google::Cloud::Retail::V2::ImportErrorsConfig]
+        #     The desired location of errors incurred during the Import. Cannot be set
+        #     for inline user event imports.
+        class ImportUserEventsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The input config source for products.
+        # @!attribute [rw] product_inline_source
+        #   @return [::Google::Cloud::Retail::V2::ProductInlineSource]
+        #     The Inline source for the input content for products.
+        # @!attribute [rw] gcs_source
+        #   @return [::Google::Cloud::Retail::V2::GcsSource]
+        #     Google Cloud Storage location for the input content.
+        # @!attribute [rw] big_query_source
+        #   @return [::Google::Cloud::Retail::V2::BigQuerySource]
+        #     BigQuery input source.
+        class ProductInputConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The input config source for user events.
+        # @!attribute [rw] user_event_inline_source
+        #   @return [::Google::Cloud::Retail::V2::UserEventInlineSource]
+        #     Required. The Inline source for the input content for UserEvents.
+        # @!attribute [rw] gcs_source
+        #   @return [::Google::Cloud::Retail::V2::GcsSource]
+        #     Required. Google Cloud Storage location for the input content.
+        # @!attribute [rw] big_query_source
+        #   @return [::Google::Cloud::Retail::V2::BigQuerySource]
+        #     Required. BigQuery input source.
+        class UserEventInputConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata related to the progress of the Import operation. This will be
+        # returned by the google.longrunning.Operation.metadata field.
+        # @!attribute [rw] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Operation create time.
+        # @!attribute [rw] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Operation last update time. If the operation is done, this is also the
+        #     finish time.
+        # @!attribute [rw] success_count
+        #   @return [::Integer]
+        #     Count of entries that were processed successfully.
+        # @!attribute [rw] failure_count
+        #   @return [::Integer]
+        #     Count of entries that encountered errors while processing.
+        class ImportMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response of the
+        # {::Google::Cloud::Retail::V2::ImportProductsRequest ImportProductsRequest}. If the
+        # long running operation is done, then this message is returned by the
+        # google.longrunning.Operations.response field if the operation was successful.
+        # @!attribute [rw] error_samples
+        #   @return [::Array<::Google::Rpc::Status>]
+        #     A sample of errors encountered while processing the request.
+        # @!attribute [rw] errors_config
+        #   @return [::Google::Cloud::Retail::V2::ImportErrorsConfig]
+        #     Echoes the destination for the complete errors in the request if set.
+        class ImportProductsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response of the ImportUserEventsRequest. If the long running
+        # operation was successful, then this message is returned by the
+        # google.longrunning.Operations.response field if the operation was successful.
+        # @!attribute [rw] error_samples
+        #   @return [::Array<::Google::Rpc::Status>]
+        #     A sample of errors encountered while processing the request.
+        # @!attribute [rw] errors_config
+        #   @return [::Google::Cloud::Retail::V2::ImportErrorsConfig]
+        #     Echoes the destination for the complete errors if this field was set in
+        #     the request.
+        # @!attribute [rw] import_summary
+        #   @return [::Google::Cloud::Retail::V2::UserEventImportSummary]
+        #     Aggregated statistics of user event import status.
+        class ImportUserEventsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A summary of import result. The UserEventImportSummary summarizes
+        # the import status for user events.
+        # @!attribute [rw] joined_events_count
+        #   @return [::Integer]
+        #     Count of user events imported with complete existing catalog information.
+        # @!attribute [rw] unjoined_events_count
+        #   @return [::Integer]
+        #     Count of user events imported, but with catalog information not found
+        #     in the imported catalog.
+        class UserEventImportSummary
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end