Class GoogleAnalyticsReportReader

Method Details

• getViewId

  public String getViewId()

• addDateRange

  public GoogleAnalyticsReportReader addDateRange(String startDate, String endDate)

  Adds a date range to the report, such as DATE_30_DAYS_AGO to DATE_TODAY; must be called before open().

• addMetric

  public GoogleAnalyticsReportReader addMetric(String expression)

  Adds a metric expression to the report; must be called before open().

• addMetric

  public GoogleAnalyticsReportReader addMetric(String expression, String alias)

  Adds a metric expression with an alias to the report; must be called before open().

• addDimension

  public GoogleAnalyticsReportReader addDimension(String name)

  Adds a dimension to the report; must be called before open().

• open

  public void open() throws DataException

  Description copied from class: DataEndpoint

  Makes this endpoint ready for reading or writing.

  Overrides:

  open in class IntegrationReader

  Throws:

  DataException

• close

  public void close() throws DataException

  Description copied from class: DataEndpoint

  Indicates that this endpoint has finished reading or writing.

  Overrides:

  close in class GoogleApiReader

  Throws:

  DataException

• readImpl

  protected Record readImpl() throws Throwable

  Description copied from class: DataReader

  Overridden by subclasses to read the next record from this DataReader. The default implementation of DataReader.read() now insures that this method will not be called again after it returns a null.

  If no record is available, null will be returned.

  Contract for subclasses (see also docs/authoring/DataReader.md):

  • Return null exactly once to signal end-of-stream.
  • Do not call this method directly — DataReader.read() is the template method that wraps exceptions, increments the record count, and tracks lineage.
  • Do not call DataEndpoint.incrementRecordCount() here; DataReader.read() already does.
  • Throw raw exceptions; DataReader.read() wraps them via exception(throwable).

  Specified by:

  readImpl in class DataReader

  Throws:

  Throwable

• addExceptionProperties

  public DataException addExceptionProperties(DataException exception)

  Description copied from class: Endpoint

  Adds this endpoint's current state to a DataException. Since this method is called whenever an exception is thrown, subclasses should override it to add their specific information.

  Overrides:

  addExceptionProperties in class GoogleApiReader