google_api_analytics_reporting v0.13.0 GoogleApi.AnalyticsReporting.V4.Model.Dimension View Source

Dimensions are attributes of your data. For example, the dimension ga:city indicates the city, for example, "Paris" or "New York", from which a session originates.

Attributes

  • histogramBuckets (type: list(String.t), default: nil) - If non-empty, we place dimension values into buckets after string to int64. Dimension values that are not the string representation of an integral value will be converted to zero. The bucket values have to be in increasing order. Each bucket is closed on the lower end, and open on the upper end. The "first" bucket includes all values less than the first boundary, the "last" bucket includes all values up to infinity. Dimension values that fall in a bucket get transformed to a new dimension value. For example, if one gives a list of "0, 1, 3, 4, 7", then we return the following buckets:

    • bucket #1: values < 0, dimension value "<0"
    • bucket #2: values in [0,1), dimension value "0"
    • bucket #3: values in [1,3), dimension value "1-2"
    • bucket #4: values in [3,4), dimension value "3"
    • bucket #5: values in [4,7), dimension value "4-6"
    • bucket #6: values >= 7, dimension value "7+"

    NOTE: If you are applying histogram mutation on any dimension, and using that dimension in sort, you will want to use the sort type HISTOGRAM_BUCKET for that purpose. Without that the dimension values will be sorted according to dictionary (lexicographic) order. For example the ascending dictionary order is:

    "<50", "1001+", "121-1000", "50-120"

    And the ascending HISTOGRAM_BUCKET order is:

    "<50", "50-120", "121-1000", "1001+"

    The client has to explicitly request "orderType": "HISTOGRAM_BUCKET" for a histogram-mutated dimension.

  • name (type: String.t, default: nil) - Name of the dimension to fetch, for example ga:browser.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Link to this type

t()

View Source
t() :: %GoogleApi.AnalyticsReporting.V4.Model.Dimension{
  histogramBuckets: [String.t()],
  name: String.t()
}

Link to this section Functions

Link to this function

decode(value, options)

View Source
decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.