Class: Google::Analytics::Data::V1beta::CohortsRange

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/analytics/data/v1beta/data.rb

Overview

Configures the extended reporting date range for a cohort report. Specifies an offset duration to follow the cohorts over.

Defined Under Namespace

Modules: Granularity

Instance Attribute Summary collapse

Instance Attribute Details

#end_offset ⇒ ::Integer

Returns Required. endOffset specifies the end date of the extended reporting date range for a cohort report. endOffset can be any positive integer but is commonly set to 5 to 10 so that reports contain data on the cohort for the next several granularity time periods.

If granularity is DAILY, the endDate of the extended reporting date range is endDate of the cohort plus endOffset days.

If granularity is WEEKLY, the endDate of the extended reporting date range is endDate of the cohort plus endOffset * 7 days.

If granularity is MONTHLY, the endDate of the extended reporting date range is endDate of the cohort plus endOffset * 30 days.

Returns:

  • (::Integer) —

    Required. endOffset specifies the end date of the extended reporting date range for a cohort report. endOffset can be any positive integer but is commonly set to 5 to 10 so that reports contain data on the cohort for the next several granularity time periods.

    If granularity is DAILY, the endDate of the extended reporting date range is endDate of the cohort plus endOffset days.

    If granularity is WEEKLY, the endDate of the extended reporting date range is endDate of the cohort plus endOffset * 7 days.

    If granularity is MONTHLY, the endDate of the extended reporting date range is endDate of the cohort plus endOffset * 30 days.



631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
 
# File 'proto_docs/google/analytics/data/v1beta/data.rb', line 631

class CohortsRange
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The granularity used to interpret the `startOffset` and `endOffset` for the
  # extended reporting date range for a cohort report.
  module Granularity
    # Should never be specified.
    GRANULARITY_UNSPECIFIED = 0

    # Daily granularity. Commonly used if the cohort's `dateRange` is a single
    # day and the request contains `cohortNthDay`.
    DAILY = 1

    # Weekly granularity. Commonly used if the cohort's `dateRange` is a week
    # in duration (starting on Sunday and ending on Saturday) and the request
    # contains `cohortNthWeek`.
    WEEKLY = 2

    # Monthly granularity. Commonly used if the cohort's `dateRange` is a month
    # in duration and the request contains `cohortNthMonth`.
    MONTHLY = 3
  end
end

#granularity ⇒ ::Google::Analytics::Data::V1beta::CohortsRange::Granularity

Returns Required. The granularity used to interpret the startOffset and endOffset for the extended reporting date range for a cohort report.

Returns:



631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
 
# File 'proto_docs/google/analytics/data/v1beta/data.rb', line 631

class CohortsRange
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The granularity used to interpret the `startOffset` and `endOffset` for the
  # extended reporting date range for a cohort report.
  module Granularity
    # Should never be specified.
    GRANULARITY_UNSPECIFIED = 0

    # Daily granularity. Commonly used if the cohort's `dateRange` is a single
    # day and the request contains `cohortNthDay`.
    DAILY = 1

    # Weekly granularity. Commonly used if the cohort's `dateRange` is a week
    # in duration (starting on Sunday and ending on Saturday) and the request
    # contains `cohortNthWeek`.
    WEEKLY = 2

    # Monthly granularity. Commonly used if the cohort's `dateRange` is a month
    # in duration and the request contains `cohortNthMonth`.
    MONTHLY = 3
  end
end

#start_offset ⇒ ::Integer

Returns startOffset specifies the start date of the extended reporting date range for a cohort report. startOffset is commonly set to 0 so that reports contain data from the acquisition of the cohort forward.

If granularity is DAILY, the startDate of the extended reporting date range is startDate of the cohort plus startOffset days.

If granularity is WEEKLY, the startDate of the extended reporting date range is startDate of the cohort plus startOffset * 7 days.

If granularity is MONTHLY, the startDate of the extended reporting date range is startDate of the cohort plus startOffset * 30 days.

Returns:

  • (::Integer) —

    startOffset specifies the start date of the extended reporting date range for a cohort report. startOffset is commonly set to 0 so that reports contain data from the acquisition of the cohort forward.

    If granularity is DAILY, the startDate of the extended reporting date range is startDate of the cohort plus startOffset days.

    If granularity is WEEKLY, the startDate of the extended reporting date range is startDate of the cohort plus startOffset * 7 days.

    If granularity is MONTHLY, the startDate of the extended reporting date range is startDate of the cohort plus startOffset * 30 days.



631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
 
# File 'proto_docs/google/analytics/data/v1beta/data.rb', line 631

class CohortsRange
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The granularity used to interpret the `startOffset` and `endOffset` for the
  # extended reporting date range for a cohort report.
  module Granularity
    # Should never be specified.
    GRANULARITY_UNSPECIFIED = 0

    # Daily granularity. Commonly used if the cohort's `dateRange` is a single
    # day and the request contains `cohortNthDay`.
    DAILY = 1

    # Weekly granularity. Commonly used if the cohort's `dateRange` is a week
    # in duration (starting on Sunday and ending on Saturday) and the request
    # contains `cohortNthWeek`.
    WEEKLY = 2

    # Monthly granularity. Commonly used if the cohort's `dateRange` is a month
    # in duration and the request contains `cohortNthMonth`.
    MONTHLY = 3
  end
end