Class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaReportingDataAnnotation

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/analyticsadmin_v1alpha/classes.rb,
lib/google/apis/analyticsadmin_v1alpha/representations.rb,
lib/google/apis/analyticsadmin_v1alpha/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAnalyticsAdminV1alphaReportingDataAnnotation

Returns a new instance of GoogleAnalyticsAdminV1alphaReportingDataAnnotation.



5049
5050
5051
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 5049

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#annotation_date ⇒ Google::Apis::AnalyticsadminV1alpha::GoogleTypeDate

Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type. TimeOfDay * google.type.DateTime * google.protobuf.Timestamp Corresponds to the JSON property annotationDate

Returns:



5012
5013
5014
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 5012

def annotation_date
  @annotation_date
end

#annotation_date_range ⇒ Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaReportingDataAnnotationDateRange

Represents a Reporting Data Annotation's date range, both start and end dates are inclusive. Time zones are based on the parent property. Corresponds to the JSON property annotationDateRange

Returns:



5018
5019
5020
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 5018

def annotation_date_range
  @annotation_date_range
end

#color ⇒ String

Required. The color used for display of this Reporting Data Annotation. Corresponds to the JSON property color

Returns:

  • (String) 


5023
5024
5025
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 5023

def color
  @color
end

#description ⇒ String

Optional. Description for this Reporting Data Annotation. Corresponds to the JSON property description

Returns:

  • (String) 


5028
5029
5030
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 5028

def description
  @description
end

#name ⇒ String

Required. Identifier. Resource name of this Reporting Data Annotation. Format: 'properties/property_id/reportingDataAnnotations/reporting_data_annotation' Format: 'properties/123/reportingDataAnnotations/456' Corresponds to the JSON property name

Returns:

  • (String) 


5035
5036
5037
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 5035

def name
  @name
end

#system_generated ⇒ Boolean Also known as: system_generated?

Output only. If true, this annotation was generated by the Google Analytics system. System-generated annotations cannot be updated or deleted. Corresponds to the JSON property systemGenerated

Returns:

  • (Boolean) 


5041
5042
5043
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 5041

def system_generated
  @system_generated
end

#title ⇒ String

Required. Human-readable title for this Reporting Data Annotation. Corresponds to the JSON property title

Returns:

  • (String) 


5047
5048
5049
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 5047

def title
  @title
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5054
5055
5056
5057
5058
5059
5060
5061
5062
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 5054

def update!(**args)
  @annotation_date = args[:annotation_date] if args.key?(:annotation_date)
  @annotation_date_range = args[:annotation_date_range] if args.key?(:annotation_date_range)
  @color = args[:color] if args.key?(:color)
  @description = args[:description] if args.key?(:description)
  @name = args[:name] if args.key?(:name)
  @system_generated = args[:system_generated] if args.key?(:system_generated)
  @title = args[:title] if args.key?(:title)
end