Current section

Files

Jump to
google_api_analytics lib google_api analytics v3 model realtime_data.ex
Raw

lib/google_api/analytics/v3/model/realtime_data.ex

# Copyright 2019 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
#
# http://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.
# NOTE: This file is auto generated by the elixir code generator program.
# Do not edit this file manually.
defmodule GoogleApi.Analytics.V3.Model.RealtimeData do
@moduledoc """
Real time data for a given view (profile).
## Attributes
* `columnHeaders` (*type:* `list(GoogleApi.Analytics.V3.Model.RealtimeDataColumnHeaders.t)`, *default:* `nil`) - Column headers that list dimension names followed by the metric names. The order of dimensions and metrics is same as specified in the request.
* `id` (*type:* `String.t`, *default:* `nil`) - Unique ID for this data response.
* `kind` (*type:* `String.t`, *default:* `analytics#realtimeData`) - Resource type.
* `profileInfo` (*type:* `GoogleApi.Analytics.V3.Model.RealtimeDataProfileInfo.t`, *default:* `nil`) - Information for the view (profile), for which the real time data was requested.
* `query` (*type:* `GoogleApi.Analytics.V3.Model.RealtimeDataQuery.t`, *default:* `nil`) - Real time data request query parameters.
* `rows` (*type:* `list(list(String.t))`, *default:* `nil`) - Real time data rows, where each row contains a list of dimension values followed by the metric values. The order of dimensions and metrics is same as specified in the request.
* `selfLink` (*type:* `String.t`, *default:* `nil`) - Link to this page.
* `totalResults` (*type:* `integer()`, *default:* `nil`) - The total number of rows for the query, regardless of the number of rows in the response.
* `totalsForAllResults` (*type:* `map()`, *default:* `nil`) - Total values for the requested metrics over all the results, not just the results returned in this response. The order of the metric totals is same as the metric order specified in the request.
"""
use GoogleApi.Gax.ModelBase
@type t :: %__MODULE__{
:columnHeaders =>
list(GoogleApi.Analytics.V3.Model.RealtimeDataColumnHeaders.t()) | nil,
:id => String.t() | nil,
:kind => String.t() | nil,
:profileInfo => GoogleApi.Analytics.V3.Model.RealtimeDataProfileInfo.t() | nil,
:query => GoogleApi.Analytics.V3.Model.RealtimeDataQuery.t() | nil,
:rows => list(list(String.t())) | nil,
:selfLink => String.t() | nil,
:totalResults => integer() | nil,
:totalsForAllResults => map() | nil
}
field(:columnHeaders, as: GoogleApi.Analytics.V3.Model.RealtimeDataColumnHeaders, type: :list)
field(:id)
field(:kind)
field(:profileInfo, as: GoogleApi.Analytics.V3.Model.RealtimeDataProfileInfo)
field(:query, as: GoogleApi.Analytics.V3.Model.RealtimeDataQuery)
field(:rows, type: :listlist)
field(:selfLink)
field(:totalResults)
field(:totalsForAllResults, type: :map)
end
defimpl Poison.Decoder, for: GoogleApi.Analytics.V3.Model.RealtimeData do
def decode(value, options) do
GoogleApi.Analytics.V3.Model.RealtimeData.decode(value, options)
end
end
defimpl Poison.Encoder, for: GoogleApi.Analytics.V3.Model.RealtimeData do
def encode(value, options) do
GoogleApi.Gax.ModelBase.encode(value, options)
end
end