google-api-client 0.42.0 → 0.43.0

data/generated/google/apis/youtube_analytics_v2/classes.rb

@@ -26,9 +26,8 @@ module Google
       class EmptyResponse
         include Google::Apis::Core::Hashable
       
-        # Request Error information.
-        # The presence of an error field signals that the operation
-        # has failed.
+        # Request Error information. The presence of an error field signals that the
+        # operation has failed.
         # Corresponds to the JSON property `errors`
         # @return [Google::Apis::YoutubeAnalyticsV2::Errors]
         attr_accessor :errors
@@ -47,52 +46,44 @@ module Google
       class ErrorProto
         include Google::Apis::Core::Hashable
       
-        # Error arguments, to be used when building user-friendly error messages
-        # given the error domain and code.  Different error codes require different
-        # arguments.
+        # Error arguments, to be used when building user-friendly error messages given
+        # the error domain and code. Different error codes require different arguments.
         # Corresponds to the JSON property `argument`
         # @return [Array<String>]
         attr_accessor :argument
       
-        # Error code in the error domain. This should correspond to
-        # a value of the enum type whose name is in domain. See
-        # the core error domain in error_domain.proto.
+        # Error code in the error domain. This should correspond to a value of the enum
+        # type whose name is in domain. See the core error domain in error_domain.proto.
         # Corresponds to the JSON property `code`
         # @return [String]
         attr_accessor :code
       
-        # Debugging information, which should not be
-        # shared externally.
+        # Debugging information, which should not be shared externally.
         # Corresponds to the JSON property `debugInfo`
         # @return [String]
         attr_accessor :debug_info
       
-        # Error domain. RoSy services can define their own
-        # domain and error codes. This should normally be
-        # the name of an enum type, such as: gdata.CoreErrorDomain
+        # Error domain. RoSy services can define their own domain and error codes. This
+        # should normally be the name of an enum type, such as: gdata.CoreErrorDomain
         # Corresponds to the JSON property `domain`
         # @return [String]
         attr_accessor :domain
       
-        # A short explanation for the error, which can be shared outside Google.
-        # Please set domain, code and arguments whenever possible instead of this
-        # error message so that external APIs can build safe error messages
-        # themselves.
-        # External messages built in a RoSy interface will most likely refer to
-        # information and concepts that are not available externally and should not
-        # be exposed. It is safer if external APIs can understand the errors and
-        # decide what the error message should look like.
+        # A short explanation for the error, which can be shared outside Google. Please
+        # set domain, code and arguments whenever possible instead of this error message
+        # so that external APIs can build safe error messages themselves. External
+        # messages built in a RoSy interface will most likely refer to information and
+        # concepts that are not available externally and should not be exposed. It is
+        # safer if external APIs can understand the errors and decide what the error
+        # message should look like.
         # Corresponds to the JSON property `externalErrorMessage`
         # @return [String]
         attr_accessor :external_error_message
       
-        # Location of the error, as specified by the location type.
-        # If location_type is PATH, this should be a path to a field that's
-        # relative to the request, using FieldPath notation
-        # (net/proto2/util/public/field_path.h).
-        # Examples:
-        # authenticated_user.gaia_id
-        # resource.address[2].country
+        # Location of the error, as specified by the location type. If location_type is
+        # PATH, this should be a path to a field that's relative to the request, using
+        # FieldPath notation (net/proto2/util/public/field_path.h). Examples:
+        # authenticated_user.gaia_id resource.address[2].country
         # Corresponds to the JSON property `location`
         # @return [String]
         attr_accessor :location
@@ -118,15 +109,13 @@ module Google
         end
       end
       
-      # Request Error information.
-      # The presence of an error field signals that the operation
-      # has failed.
+      # Request Error information. The presence of an error field signals that the
+      # operation has failed.
       class Errors
         include Google::Apis::Core::Hashable
       
-        # Global error code. Deprecated and ignored.
-        # Set custom error codes in ErrorProto.domain and ErrorProto.code
-        # instead.
+        # Global error code. Deprecated and ignored. Set custom error codes in
+        # ErrorProto.domain and ErrorProto.code instead.
         # Corresponds to the JSON property `code`
         # @return [String]
         attr_accessor :code
@@ -136,8 +125,8 @@ module Google
         # @return [Array<Google::Apis::YoutubeAnalyticsV2::ErrorProto>]
         attr_accessor :error
       
-        # Request identifier generated by the service, which can be
-        # used to identify the error in the logs
+        # Request identifier generated by the service, which can be used to identify the
+        # error in the logs
         # Corresponds to the JSON property `requestId`
         # @return [String]
         attr_accessor :request_id
@@ -163,9 +152,8 @@ module Google
         # @return [Google::Apis::YoutubeAnalyticsV2::GroupContentDetails]
         attr_accessor :content_details
       
-        # Request Error information.
-        # The presence of an error field signals that the operation
-        # has failed.
+        # Request Error information. The presence of an error field signals that the
+        # operation has failed.
         # Corresponds to the JSON property `errors`
         # @return [Google::Apis::YoutubeAnalyticsV2::Errors]
         attr_accessor :errors
@@ -214,12 +202,9 @@ module Google
         # @return [Fixnum]
         attr_accessor :item_count
       
-        # The type of resources that the group contains.
-        # Valid values for this property are:
-        # * `youtube#channel`
-        # * `youtube#playlist`
-        # * `youtube#video`
-        # * `youtubePartner#asset`
+        # The type of resources that the group contains. Valid values for this property
+        # are: * `youtube#channel` * `youtube#playlist` * `youtube#video` * `
+        # youtubePartner#asset`
         # Corresponds to the JSON property `itemType`
         # @return [String]
         attr_accessor :item_type
@@ -239,9 +224,8 @@ module Google
       class GroupItem
         include Google::Apis::Core::Hashable
       
-        # Request Error information.
-        # The presence of an error field signals that the operation
-        # has failed.
+        # Request Error information. The presence of an error field signals that the
+        # operation has failed.
         # Corresponds to the JSON property `errors`
         # @return [Google::Apis::YoutubeAnalyticsV2::Errors]
         attr_accessor :errors
@@ -251,19 +235,17 @@ module Google
         # @return [String]
         attr_accessor :etag
       
-        # The ID that YouTube uses to uniquely identify the group that contains the
-        # item.
+        # The ID that YouTube uses to uniquely identify the group that contains the item.
         # Corresponds to the JSON property `groupId`
         # @return [String]
         attr_accessor :group_id
       
-        # The ID that YouTube uses to uniquely identify the `channel`, `video`,
-        # `playlist`, or `asset` resource that is included in the group. Note that
-        # this ID refers specifically to the inclusion of that resource in a
-        # particular group and is different than the channel ID, video ID,
-        # playlist ID, or asset ID that uniquely identifies the resource itself.
-        # The `resource.id` property's value specifies the unique channel, video,
-        # playlist, or asset ID.
+        # The ID that YouTube uses to uniquely identify the `channel`, `video`, `
+        # playlist`, or `asset` resource that is included in the group. Note that this
+        # ID refers specifically to the inclusion of that resource in a particular group
+        # and is different than the channel ID, video ID, playlist ID, or asset ID that
+        # uniquely identifies the resource itself. The `resource.id` property's value
+        # specifies the unique channel, video, playlist, or asset ID.
         # Corresponds to the JSON property `id`
         # @return [String]
         attr_accessor :id
@@ -304,12 +286,9 @@ module Google
         # @return [String]
         attr_accessor :id
       
-        # Identifies the type of resource being added to the group.
-        # Valid values for this property are:
-        # * `youtube#channel`
-        # * `youtube#playlist`
-        # * `youtube#video`
-        # * `youtubePartner#asset`
+        # Identifies the type of resource being added to the group. Valid values for
+        # this property are: * `youtube#channel` * `youtube#playlist` * `youtube#video` *
+        # `youtubePartner#asset`
         # Corresponds to the JSON property `kind`
         # @return [String]
         attr_accessor :kind
@@ -329,8 +308,8 @@ module Google
       class GroupSnippet
         include Google::Apis::Core::Hashable
       
-        # The date and time that the group was created. The value is specified in
-        # ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
+        # The date and time that the group was created. The value is specified in ISO
+        # 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
         # Corresponds to the JSON property `publishedAt`
         # @return [String]
         attr_accessor :published_at
@@ -355,9 +334,8 @@ module Google
       class ListGroupItemsResponse
         include Google::Apis::Core::Hashable
       
-        # Request Error information.
-        # The presence of an error field signals that the operation
-        # has failed.
+        # Request Error information. The presence of an error field signals that the
+        # operation has failed.
         # Corresponds to the JSON property `errors`
         # @return [Google::Apis::YoutubeAnalyticsV2::Errors]
         attr_accessor :errors
@@ -367,14 +345,14 @@ module Google
         # @return [String]
         attr_accessor :etag
       
-        # A list of groups that match the API request parameters. Each item in the
-        # list represents a `groupItem` resource.
+        # A list of groups that match the API request parameters. Each item in the list
+        # represents a `groupItem` resource.
         # Corresponds to the JSON property `items`
         # @return [Array<Google::Apis::YoutubeAnalyticsV2::GroupItem>]
         attr_accessor :items
       
-        # Identifies the API resource's type. The value will be
-        # `youtube#groupItemListResponse`.
+        # Identifies the API resource's type. The value will be `youtube#
+        # groupItemListResponse`.
         # Corresponds to the JSON property `kind`
         # @return [String]
         attr_accessor :kind
@@ -396,9 +374,8 @@ module Google
       class ListGroupsResponse
         include Google::Apis::Core::Hashable
       
-        # Request Error information.
-        # The presence of an error field signals that the operation
-        # has failed.
+        # Request Error information. The presence of an error field signals that the
+        # operation has failed.
         # Corresponds to the JSON property `errors`
         # @return [Google::Apis::YoutubeAnalyticsV2::Errors]
         attr_accessor :errors
@@ -408,14 +385,14 @@ module Google
         # @return [String]
         attr_accessor :etag
       
-        # A list of groups that match the API request parameters. Each item in the
-        # list represents a `group` resource.
+        # A list of groups that match the API request parameters. Each item in the list
+        # represents a `group` resource.
         # Corresponds to the JSON property `items`
         # @return [Array<Google::Apis::YoutubeAnalyticsV2::Group>]
         attr_accessor :items
       
-        # Identifies the API resource's type. The value will be
-        # `youtube#groupListResponse`.
+        # Identifies the API resource's type. The value will be `youtube#
+        # groupListResponse`.
         # Corresponds to the JSON property `kind`
         # @return [String]
         attr_accessor :kind
@@ -444,42 +421,38 @@ module Google
       class QueryResponse
         include Google::Apis::Core::Hashable
       
-        # This value specifies information about the data returned in the `rows`
-        # fields. Each item in the `columnHeaders` list identifies a field returned
-        # in the `rows` value, which contains a list of comma-delimited data. The
-        # `columnHeaders` list will begin with the dimensions specified in the API
-        # request, which will be followed by the metrics specified in the API
-        # request. The order of both dimensions and metrics will match the ordering
-        # in the API request. For example, if the API request contains the parameters
-        # `dimensions=ageGroup,gender&metrics=viewerPercentage`, the API response
-        # will return columns in this order: `ageGroup`, `gender`,
-        # `viewerPercentage`.
+        # This value specifies information about the data returned in the `rows` fields.
+        # Each item in the `columnHeaders` list identifies a field returned in the `rows`
+        # value, which contains a list of comma-delimited data. The `columnHeaders`
+        # list will begin with the dimensions specified in the API request, which will
+        # be followed by the metrics specified in the API request. The order of both
+        # dimensions and metrics will match the ordering in the API request. For example,
+        # if the API request contains the parameters `dimensions=ageGroup,gender&
+        # metrics=viewerPercentage`, the API response will return columns in this order:
+        # `ageGroup`, `gender`, `viewerPercentage`.
         # Corresponds to the JSON property `columnHeaders`
         # @return [Array<Google::Apis::YoutubeAnalyticsV2::ResultTableColumnHeader>]
         attr_accessor :column_headers
       
-        # Request Error information.
-        # The presence of an error field signals that the operation
-        # has failed.
+        # Request Error information. The presence of an error field signals that the
+        # operation has failed.
         # Corresponds to the JSON property `errors`
         # @return [Google::Apis::YoutubeAnalyticsV2::Errors]
         attr_accessor :errors
       
-        # This value specifies the type of data included in the API response.
-        # For the query method, the kind property value will be
-        # `youtubeAnalytics#resultTable`.
+        # This value specifies the type of data included in the API response. For the
+        # query method, the kind property value will be `youtubeAnalytics#resultTable`.
         # Corresponds to the JSON property `kind`
         # @return [String]
         attr_accessor :kind
       
-        # The list contains all rows of the result table. Each item in the list is
-        # an array that contains comma-delimited data corresponding to a single row
-        # of data. The order of the comma-delimited data fields will match the
-        # order of the columns listed in the `columnHeaders` field.
-        # If no data is available for the given query, the `rows` element will be
-        # omitted from the response.
-        # The response for a query with the `day` dimension will not contain rows for
-        # the most recent days.
+        # The list contains all rows of the result table. Each item in the list is an
+        # array that contains comma-delimited data corresponding to a single row of data.
+        # The order of the comma-delimited data fields will match the order of the
+        # columns listed in the `columnHeaders` field. If no data is available for the
+        # given query, the `rows` element will be omitted from the response. The
+        # response for a query with the `day` dimension will not contain rows for the
+        # most recent days.
         # Corresponds to the JSON property `rows`
         # @return [Array<Array<Object>>]
         attr_accessor :rows