google-analytics-data-v1beta 0.8.1 → 0.10.0

data/proto_docs/google/analytics/data/v1beta/analytics_data_api.rb

@@ -71,7 +71,8 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # The dimensions and metrics currently accepted in reporting methods.
+        # The dimensions, metrics and comparisons currently accepted in reporting
+        # methods.
         # @!attribute [rw] name
         #   @return [::String]
         #     Resource name of this metadata.
@@ -556,6 +557,232 @@ module Google
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
+
+        # A request to retrieve configuration metadata about a specific audience
+        # export.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The audience export resource name.
+        #     Format: `properties/{property}/audienceExports/{audience_export}`
+        class GetAudienceExportRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A request to list all audience exports for a property.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. All audience exports for this property will be listed in the
+        #     response. Format: `properties/{property}`
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Optional. The maximum number of audience exports to return. The service may
+        #     return fewer than this value. If unspecified, at most 200 audience exports
+        #     will be returned. The maximum value is 1000 (higher values will be coerced
+        #     to the maximum).
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     Optional. A page token, received from a previous `ListAudienceExports`
+        #     call. Provide this to retrieve the subsequent page.
+        #
+        #     When paginating, all other parameters provided to `ListAudienceExports`
+        #     must match the call that provided the page token.
+        class ListAudienceExportsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A list of all audience exports for a property.
+        # @!attribute [rw] audience_exports
+        #   @return [::Array<::Google::Analytics::Data::V1beta::AudienceExport>]
+        #     Each audience export for a property.
+        # @!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 ListAudienceExportsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A request to create a new audience export.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent resource where this audience export will be created.
+        #     Format: `properties/{property}`
+        # @!attribute [rw] audience_export
+        #   @return [::Google::Analytics::Data::V1beta::AudienceExport]
+        #     Required. The audience export to create.
+        class CreateAudienceExportRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # An audience export is a list of users in an audience at the time of the
+        # list's creation. One audience may have multiple audience exports created for
+        # different days.
+        # @!attribute [r] name
+        #   @return [::String]
+        #     Output only. Identifier. The audience export resource name assigned during
+        #     creation. This resource name identifies this `AudienceExport`.
+        #
+        #     Format: `properties/{property}/audienceExports/{audience_export}`
+        # @!attribute [rw] audience
+        #   @return [::String]
+        #     Required. The audience resource name. This resource name identifies the
+        #     audience being listed and is shared between the Analytics Data & Admin
+        #     APIs.
+        #
+        #     Format: `properties/{property}/audiences/{audience}`
+        # @!attribute [r] audience_display_name
+        #   @return [::String]
+        #     Output only. The descriptive display name for this audience. For example,
+        #     "Purchasers".
+        # @!attribute [rw] dimensions
+        #   @return [::Array<::Google::Analytics::Data::V1beta::AudienceDimension>]
+        #     Required. The dimensions requested and displayed in the query response.
+        # @!attribute [r] state
+        #   @return [::Google::Analytics::Data::V1beta::AudienceExport::State]
+        #     Output only. The current state for this AudienceExport.
+        # @!attribute [r] begin_creating_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time when CreateAudienceExport was called and the
+        #     AudienceExport began the `CREATING` state.
+        # @!attribute [r] creation_quota_tokens_charged
+        #   @return [::Integer]
+        #     Output only. The total quota tokens charged during creation of the
+        #     AudienceExport. Because this token count is based on activity from the
+        #     `CREATING` state, this tokens charged will be fixed once an AudienceExport
+        #     enters the `ACTIVE` or `FAILED` states.
+        # @!attribute [r] row_count
+        #   @return [::Integer]
+        #     Output only. The total number of rows in the AudienceExport result.
+        # @!attribute [r] error_message
+        #   @return [::String]
+        #     Output only. Error message is populated when an audience export fails
+        #     during creation. A common reason for such a failure is quota exhaustion.
+        # @!attribute [r] percentage_completed
+        #   @return [::Float]
+        #     Output only. The percentage completed for this audience export ranging
+        #     between 0 to 100.
+        class AudienceExport
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The AudienceExport currently exists in this state.
+          module State
+            # Unspecified state will never be used.
+            STATE_UNSPECIFIED = 0
+
+            # The AudienceExport is currently creating and will be available in the
+            # future. Creating occurs immediately after the CreateAudienceExport call.
+            CREATING = 1
+
+            # The AudienceExport is fully created and ready for querying. An
+            # AudienceExport is updated to active asynchronously from a request; this
+            # occurs some time (for example 15 minutes) after the initial create call.
+            ACTIVE = 2
+
+            # The AudienceExport failed to be created. It is possible that
+            # re-requesting this audience export will succeed.
+            FAILED = 3
+          end
+        end
+
+        # This metadata is currently blank.
+        class AudienceExportMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A request to list users in an audience export.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the audience export to retrieve users from.
+        #     Format: `properties/{property}/audienceExports/{audience_export}`
+        # @!attribute [rw] offset
+        #   @return [::Integer]
+        #     Optional. The row count of the start row. The first row is counted as row
+        #     0.
+        #
+        #     When paging, the first request does not specify offset; or equivalently,
+        #     sets offset to 0; the first request returns the first `limit` of rows. The
+        #     second request sets offset to the `limit` of the first request; the second
+        #     request returns the second `limit` of rows.
+        #
+        #     To learn more about this pagination parameter, see
+        #     [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
+        # @!attribute [rw] limit
+        #   @return [::Integer]
+        #     Optional. The number of rows to return. If unspecified, 10,000 rows are
+        #     returned. The API returns a maximum of 250,000 rows per request, no matter
+        #     how many you ask for. `limit` must be positive.
+        #
+        #     The API can also return fewer rows than the requested `limit`, if there
+        #     aren't as many dimension values as the `limit`.
+        #
+        #     To learn more about this pagination parameter, see
+        #     [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
+        class QueryAudienceExportRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A list of users in an audience export.
+        # @!attribute [rw] audience_export
+        #   @return [::Google::Analytics::Data::V1beta::AudienceExport]
+        #     Configuration data about AudienceExport being queried. Returned to help
+        #     interpret the audience rows in this response. For example, the dimensions
+        #     in this AudienceExport correspond to the columns in the AudienceRows.
+        # @!attribute [rw] audience_rows
+        #   @return [::Array<::Google::Analytics::Data::V1beta::AudienceRow>]
+        #     Rows for each user in an audience export. The number of rows in this
+        #     response will be less than or equal to request's page size.
+        # @!attribute [rw] row_count
+        #   @return [::Integer]
+        #     The total number of rows in the AudienceExport result. `rowCount` is
+        #     independent of the number of rows returned in the response, the `limit`
+        #     request parameter, and the `offset` request parameter. For example if a
+        #     query returns 175 rows and includes `limit` of 50 in the API request, the
+        #     response will contain `rowCount` of 175 but only 50 rows.
+        #
+        #     To learn more about this pagination parameter, see
+        #     [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
+        class QueryAudienceExportResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Dimension value attributes for the audience user row.
+        # @!attribute [rw] dimension_values
+        #   @return [::Array<::Google::Analytics::Data::V1beta::AudienceDimensionValue>]
+        #     Each dimension value attribute for an audience user. One dimension value
+        #     will be added for each dimension column requested.
+        class AudienceRow
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # An audience dimension is a user attribute. Specific user attributed are
+        # requested and then later returned in the `QueryAudienceExportResponse`.
+        # @!attribute [rw] dimension_name
+        #   @return [::String]
+        #     Optional. The API name of the dimension. See the [API
+        #     Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-api-schema#dimensions)
+        #     for the list of dimension names.
+        class AudienceDimension
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The value of a dimension.
+        # @!attribute [rw] value
+        #   @return [::String]
+        #     Value as a string if the dimension type is a string.
+        class AudienceDimensionValue
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
       end
     end
   end

data/proto_docs/google/analytics/data/v1beta/data.rb

@@ -88,7 +88,16 @@ module Google
         #   @return [::String]
         #     The name of the dimension. See the [API
         #     Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions)
-        #     for the list of dimension names.
+        #     for the list of dimension names supported by core reporting methods such
+        #     as `runReport` and `batchRunReports`. See
+        #     [Realtime
+        #     Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-api-schema#dimensions)
+        #     for the list of dimension names supported by the `runRealtimeReport`
+        #     method. See
+        #     [Funnel
+        #     Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/exploration-api-schema#dimensions)
+        #     for the list of dimension names supported by the `runFunnelReport`
+        #     method.
         #
         #     If `dimensionExpression` is specified, `name` can be any string that you
         #     would like within the allowed character set. For example if a
@@ -162,7 +171,16 @@ module Google
         #   @return [::String]
         #     The name of the metric. See the [API
         #     Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics)
-        #     for the list of metric names.
+        #     for the list of metric names supported by core reporting methods such
+        #     as `runReport` and `batchRunReports`. See
+        #     [Realtime
+        #     Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-api-schema#metrics)
+        #     for the list of metric names supported by the `runRealtimeReport`
+        #     method. See
+        #     [Funnel
+        #     Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/exploration-api-schema#metrics)
+        #     for the list of metric names supported by the `runFunnelReport`
+        #     method.
         #
         #     If `expression` is specified, `name` can be any string that you would like
         #     within the allowed character set. For example if `expression` is
@@ -667,9 +685,17 @@ module Google
         #     possible for a request to be subject to thresholding thresholding and no
         #     data is absent from the report, and this happens when all data is above the
         #     thresholds. To learn more, see [Data
-        #     thresholds](https://support.google.com/analytics/answer/9383630) and [About
-        #     Demographics and
-        #     Interests](https://support.google.com/analytics/answer/2799357).
+        #     thresholds](https://support.google.com/analytics/answer/9383630).
+        # @!attribute [rw] sampling_metadatas
+        #   @return [::Array<::Google::Analytics::Data::V1beta::SamplingMetadata>]
+        #     If this report results is
+        #     [sampled](https://support.google.com/analytics/answer/13331292), this
+        #     describes the percentage of events used in this report. One
+        #     `samplingMetadatas` is populated for each date range. Each
+        #     `samplingMetadatas` corresponds to a date range in order that date ranges
+        #     were specified in the request.
+        #
+        #     However if the results are not sampled, this field will not be defined.
         class ResponseMetaData
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -701,6 +727,30 @@ module Google
           end
         end
 
+        # If this report results is
+        # [sampled](https://support.google.com/analytics/answer/13331292), this
+        # describes the percentage of events used in this report. Sampling is the
+        # practice of analyzing a subset of all data in order to uncover the meaningful
+        # information in the larger data set.
+        # @!attribute [rw] samples_read_count
+        #   @return [::Integer]
+        #     The total number of events read in this sampled report for a date range.
+        #     This is the size of the subset this property's data that was analyzed in
+        #     this report.
+        # @!attribute [rw] sampling_space_size
+        #   @return [::Integer]
+        #     The total number of events present in this property's data that could
+        #     have been analyzed in this report for a date range. Sampling
+        #     uncovers the meaningful information about the larger data set, and this
+        #     is the size of the larger data set.
+        #
+        #     To calculate the percentage of available data that was used in this
+        #     report, compute `samplesReadCount/samplingSpaceSize`.
+        class SamplingMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # Describes a dimension column in the report. Dimensions requested in a report
         # produce column entries within rows and DimensionHeaders. However, dimensions
         # used exclusively within filters or expressions do not produce columns in a

data/proto_docs/google/api/client.rb

@@ -304,6 +304,19 @@ module Google
     #                seconds: 360 # 6 minutes
     #              total_poll_timeout:
     #                 seconds: 54000 # 90 minutes
+    # @!attribute [rw] auto_populated_fields
+    #   @return [::Array<::String>]
+    #     List of top-level fields of the request message, that should be
+    #     automatically populated by the client libraries based on their
+    #     (google.api.field_info).format. Currently supported format: UUID4.
+    #
+    #     Example of a YAML configuration:
+    #
+    #      publishing:
+    #        method_settings:
+    #          - selector: google.example.v1.ExampleService.CreateExample
+    #            auto_populated_fields:
+    #            - request_id
     class MethodSettings
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/api/field_behavior.rb

@@ -66,6 +66,20 @@ module Google
       # a non-empty value will be returned. The user will not be aware of what
       # non-empty value to expect.
       NON_EMPTY_DEFAULT = 7
+
+      # Denotes that the field in a resource (a message annotated with
+      # google.api.resource) is used in the resource name to uniquely identify the
+      # resource. For AIP-compliant APIs, this should only be applied to the
+      # `name` field on the resource.
+      #
+      # This behavior should not be applied to references to other resources within
+      # the message.
+      #
+      # The identifier field of resources often have different field behavior
+      # depending on the request it is embedded in (e.g. for Create methods name
+      # is optional and unused, while for Update methods it is required). Instead
+      # of method-specific annotations, only `IDENTIFIER` is required.
+      IDENTIFIER = 8
     end
   end
 end

data/proto_docs/google/longrunning/operations.rb

@@ -0,0 +1,164 @@
+# frozen_string_literal: true
+
+# Copyright 2023 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 Longrunning
+    # This resource represents a long-running operation that is the result of a
+    # network API call.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The server-assigned name, which is only unique within the same service that
+    #     originally returns it. If you use the default HTTP mapping, the
+    #     `name` should be a resource name ending with `operations/{unique_id}`.
+    # @!attribute [rw] metadata
+    #   @return [::Google::Protobuf::Any]
+    #     Service-specific metadata associated with the operation.  It typically
+    #     contains progress information and common metadata such as create time.
+    #     Some services might not provide such metadata.  Any method that returns a
+    #     long-running operation should document the metadata type, if any.
+    # @!attribute [rw] done
+    #   @return [::Boolean]
+    #     If the value is `false`, it means the operation is still in progress.
+    #     If `true`, the operation is completed, and either `error` or `response` is
+    #     available.
+    # @!attribute [rw] error
+    #   @return [::Google::Rpc::Status]
+    #     The error result of the operation in case of failure or cancellation.
+    # @!attribute [rw] response
+    #   @return [::Google::Protobuf::Any]
+    #     The normal response of the operation in case of success.  If the original
+    #     method returns no data on success, such as `Delete`, the response is
+    #     `google.protobuf.Empty`.  If the original method is standard
+    #     `Get`/`Create`/`Update`, the response should be the resource.  For other
+    #     methods, the response should have the type `XxxResponse`, where `Xxx`
+    #     is the original method name.  For example, if the original method name
+    #     is `TakeSnapshot()`, the inferred response type is
+    #     `TakeSnapshotResponse`.
+    class Operation
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # The request message for Operations.GetOperation.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The name of the operation resource.
+    class GetOperationRequest
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # The request message for Operations.ListOperations.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The name of the operation's parent resource.
+    # @!attribute [rw] filter
+    #   @return [::String]
+    #     The standard list filter.
+    # @!attribute [rw] page_size
+    #   @return [::Integer]
+    #     The standard list page size.
+    # @!attribute [rw] page_token
+    #   @return [::String]
+    #     The standard list page token.
+    class ListOperationsRequest
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # The response message for Operations.ListOperations.
+    # @!attribute [rw] operations
+    #   @return [::Array<::Google::Longrunning::Operation>]
+    #     A list of operations that matches the specified filter in the request.
+    # @!attribute [rw] next_page_token
+    #   @return [::String]
+    #     The standard List next-page token.
+    class ListOperationsResponse
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # The request message for Operations.CancelOperation.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The name of the operation resource to be cancelled.
+    class CancelOperationRequest
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # The request message for Operations.DeleteOperation.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The name of the operation resource to be deleted.
+    class DeleteOperationRequest
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # The request message for Operations.WaitOperation.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The name of the operation resource to wait on.
+    # @!attribute [rw] timeout
+    #   @return [::Google::Protobuf::Duration]
+    #     The maximum duration to wait before timing out. If left blank, the wait
+    #     will be at most the time permitted by the underlying HTTP/RPC protocol.
+    #     If RPC context deadline is also specified, the shorter one will be used.
+    class WaitOperationRequest
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # A message representing the message types used by a long-running operation.
+    #
+    # Example:
+    #
+    #   rpc LongRunningRecognize(LongRunningRecognizeRequest)
+    #       returns (google.longrunning.Operation) {
+    #     option (google.longrunning.operation_info) = {
+    #       response_type: "LongRunningRecognizeResponse"
+    #       metadata_type: "LongRunningRecognizeMetadata"
+    #     };
+    #   }
+    # @!attribute [rw] response_type
+    #   @return [::String]
+    #     Required. The message name of the primary return type for this
+    #     long-running operation.
+    #     This type will be used to deserialize the LRO's response.
+    #
+    #     If the response is in a different package from the rpc, a fully-qualified
+    #     message name must be used (e.g. `google.protobuf.Struct`).
+    #
+    #     Note: Altering this value constitutes a breaking change.
+    # @!attribute [rw] metadata_type
+    #   @return [::String]
+    #     Required. The message name of the metadata type for this long-running
+    #     operation.
+    #
+    #     If the response is in a different package from the rpc, a fully-qualified
+    #     message name must be used (e.g. `google.protobuf.Struct`).
+    #
+    #     Note: Altering this value constitutes a breaking change.
+    class OperationInfo
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

data/proto_docs/google/protobuf/any.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+# Copyright 2023 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 Protobuf
+    # `Any` contains an arbitrary serialized protocol buffer message along with a
+    # URL that describes the type of the serialized message.
+    #
+    # Protobuf library provides support to pack/unpack Any values in the form
+    # of utility functions or additional generated methods of the Any type.
+    #
+    # Example 1: Pack and unpack a message in C++.
+    #
+    #     Foo foo = ...;
+    #     Any any;
+    #     any.PackFrom(foo);
+    #     ...
+    #     if (any.UnpackTo(&foo)) {
+    #       ...
+    #     }
+    #
+    # Example 2: Pack and unpack a message in Java.
+    #
+    #     Foo foo = ...;
+    #     Any any = Any.pack(foo);
+    #     ...
+    #     if (any.is(Foo.class)) {
+    #       foo = any.unpack(Foo.class);
+    #     }
+    #     // or ...
+    #     if (any.isSameTypeAs(Foo.getDefaultInstance())) {
+    #       foo = any.unpack(Foo.getDefaultInstance());
+    #     }
+    #
+    #  Example 3: Pack and unpack a message in Python.
+    #
+    #     foo = Foo(...)
+    #     any = Any()
+    #     any.Pack(foo)
+    #     ...
+    #     if any.Is(Foo.DESCRIPTOR):
+    #       any.Unpack(foo)
+    #       ...
+    #
+    #  Example 4: Pack and unpack a message in Go
+    #
+    #      foo := &pb.Foo{...}
+    #      any, err := anypb.New(foo)
+    #      if err != nil {
+    #        ...
+    #      }
+    #      ...
+    #      foo := &pb.Foo{}
+    #      if err := any.UnmarshalTo(foo); err != nil {
+    #        ...
+    #      }
+    #
+    # The pack methods provided by protobuf library will by default use
+    # 'type.googleapis.com/full.type.name' as the type URL and the unpack
+    # methods only use the fully qualified type name after the last '/'
+    # in the type URL, for example "foo.bar.com/x/y.z" will yield type
+    # name "y.z".
+    #
+    # JSON
+    # ====
+    # The JSON representation of an `Any` value uses the regular
+    # representation of the deserialized, embedded message, with an
+    # additional field `@type` which contains the type URL. Example:
+    #
+    #     package google.profile;
+    #     message Person {
+    #       string first_name = 1;
+    #       string last_name = 2;
+    #     }
+    #
+    #     {
+    #       "@type": "type.googleapis.com/google.profile.Person",
+    #       "firstName": <string>,
+    #       "lastName": <string>
+    #     }
+    #
+    # If the embedded message type is well-known and has a custom JSON
+    # representation, that representation will be embedded adding a field
+    # `value` which holds the custom JSON in addition to the `@type`
+    # field. Example (for message [google.protobuf.Duration][]):
+    #
+    #     {
+    #       "@type": "type.googleapis.com/google.protobuf.Duration",
+    #       "value": "1.212s"
+    #     }
+    # @!attribute [rw] type_url
+    #   @return [::String]
+    #     A URL/resource name that uniquely identifies the type of the serialized
+    #     protocol buffer message. This string must contain at least
+    #     one "/" character. The last segment of the URL's path must represent
+    #     the fully qualified name of the type (as in
+    #     `path/google.protobuf.Duration`). The name should be in a canonical form
+    #     (e.g., leading "." is not accepted).
+    #
+    #     In practice, teams usually precompile into the binary all types that they
+    #     expect it to use in the context of Any. However, for URLs which use the
+    #     scheme `http`, `https`, or no scheme, one can optionally set up a type
+    #     server that maps type URLs to message definitions as follows:
+    #
+    #     * If no scheme is provided, `https` is assumed.
+    #     * An HTTP GET on the URL must yield a [google.protobuf.Type][]
+    #       value in binary format, or produce an error.
+    #     * Applications are allowed to cache lookup results based on the
+    #       URL, or have them precompiled into a binary to avoid any
+    #       lookup. Therefore, binary compatibility needs to be preserved
+    #       on changes to types. (Use versioned type names to manage
+    #       breaking changes.)
+    #
+    #     Note: this functionality is not currently available in the official
+    #     protobuf release, and it is not used for type URLs beginning with
+    #     type.googleapis.com.
+    #
+    #     Schemes other than `http`, `https` (or the empty scheme) might be
+    #     used with implementation specific semantics.
+    # @!attribute [rw] value
+    #   @return [::String]
+    #     Must be a valid serialized protocol buffer of the above specified type.
+    class Any
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end