GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaReportingDataAnnotation (google_api_analytics_admin v0.26.0)

View Source

A Reporting Data Annotation is a comment connected to certain dates for reporting data.

Attributes

  • annotationDate (type: GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleTypeDate.t, default: nil) - If set, the Reporting Data Annotation is for a specific date represented by this field. The date must be a valid date with year, month and day set. The date may be in the past, present, or future.
  • annotationDateRange (type: GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaReportingDataAnnotationDateRange.t, default: nil) - If set, the Reporting Data Annotation is for a range of dates represented by this field.
  • color (type: String.t, default: nil) - Required. The color used for display of this Reporting Data Annotation.
  • description (type: String.t, default: nil) - Optional. Description for this Reporting Data Annotation.
  • name (type: String.t, default: nil) - Required. Identifier. Resource name of this Reporting Data Annotation. Format: 'properties/{property_id}/reportingDataAnnotations/{reporting_data_annotation}' Format: 'properties/123/reportingDataAnnotations/456'
  • systemGenerated (type: boolean(), default: nil) - Output only. If true, this annotation was generated by the Google Analytics system. System-generated annotations cannot be updated or deleted.
  • title (type: String.t, default: nil) - Required. Human-readable title for this Reporting Data Annotation.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
  %GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaReportingDataAnnotation{
    annotationDate:
      GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleTypeDate.t() | nil,
    annotationDateRange:
      GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaReportingDataAnnotationDateRange.t()
      | nil,
    color: String.t() | nil,
    description: String.t() | nil,
    name: String.t() | nil,
    systemGenerated: boolean() | nil,
    title: String.t() | nil
  }

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.