Class RVGoogleAnalyticsDataSourceItem

Google Analytics data source item.

Hierarchy

  • RVDataSourceItem
    • RVGoogleAnalyticsDataSourceItem

Index

Constructors

constructor

Accessors

dataSource

  • get dataSource(): RVDashboardDataSource
  • set dataSource(value: RVDashboardDataSource): void
  • Reference to the data source object this item belongs to.

    Returns RVDashboardDataSource

  • Reference to the data source object this item belongs to.

    Parameters

    • value: RVDashboardDataSource

    Returns void

defaultRefreshRate

  • get defaultRefreshRate(): null | number
  • set defaultRefreshRate(v: null | number): void
  • Default value to use for "Refresh Data" setting for visualizations created using this item, expressed in minutes (e.g. 1440 = 1 day). A value of N means that whenever the visualization requests data, the engine will return data found in the cache if it's not older than N minutes -this means, if the engine fetched it from the datasource no more than N minutes before-. If not set it will use the default value set in the data source object.

    Returns null | number

  • Default value to use for "Refresh Data" setting for visualizations created using this item, expressed in minutes (e.g. 1440 = 1 day). A value of N means that whenever the visualization requests data, the engine will return data found in the cache if it's not older than N minutes -this means, if the engine fetched it from the datasource no more than N minutes before-. If not set it will use the default value set in the data source object.

    Parameters

    • v: null | number

    Returns void

description

  • get description(): nullableString
  • set description(value: nullableString): void
  • Description of this data source item.

    Returns nullableString

  • Description of this data source item.

    Parameters

    • value: nullableString

    Returns void

dimensions

  • get dimensions(): nullableString
  • set dimensions(value: nullableString): void
  • Names of the dimensions to request, comma separated.

    Returns nullableString

  • Names of the dimensions to request, comma separated.

    Parameters

    • value: nullableString

    Returns void

endDate

  • get endDate(): nullableDate
  • set endDate(value: nullableDate): void
  • End date to use when requesting data.

    Returns nullableDate

  • End date to use when requesting data.

    Parameters

    • value: nullableDate

    Returns void

filters

  • get filters(): nullableString
  • set filters(value: nullableString): void
  • Optional filters string as specified by Google Analytics, this value is sent as-is in the "filters" parameter.

    Returns nullableString

  • Optional filters string as specified by Google Analytics, this value is sent as-is in the "filters" parameter.

    Parameters

    • value: nullableString

    Returns void

id

  • get id(): nullableString
  • set id(value: nullableString): void
  • The value that identifies this item in the data source, it might be for example the name of the schema concatenated with the table name.

    Returns nullableString

  • The value that identifies this item in the data source, it might be for example the name of the schema concatenated with the table name.

    Parameters

    • value: nullableString

    Returns void

identifiers

  • get identifiers(): nullableString
  • set identifiers(value: nullableString): void
  • Profile identifiers to get data from

    Returns nullableString

  • Profile identifiers to get data from

    Parameters

    • value: nullableString

    Returns void

metrics

  • get metrics(): nullableString
  • set metrics(value: nullableString): void
  • Names of the metrics to request, comma separated.

    Returns nullableString

  • Names of the metrics to request, comma separated.

    Parameters

    • value: nullableString

    Returns void

resource

  • The type of resource, one of "Profiles" (the list of profiles in the account) or "Report" (to get analytics data).

    Returns RVGoogleAnalyticsResourceType

  • The type of resource, one of "Profiles" (the list of profiles in the account) or "Report" (to get analytics data).

    Parameters

    Returns void

segment

  • get segment(): nullableString
  • set segment(value: nullableString): void
  • Optional segment name

    Returns nullableString

  • Optional segment name

    Parameters

    • value: nullableString

    Returns void

startDate

  • get startDate(): nullableDate
  • set startDate(value: nullableDate): void
  • Start date to use when requesting data.

    Returns nullableDate

  • Start date to use when requesting data.

    Parameters

    • value: nullableDate

    Returns void

subtitle

  • get subtitle(): nullableString
  • set subtitle(value: nullableString): void
  • The subtitle of the data source, if not null will be displayed to users instead of connection information like host and database name.

    Returns nullableString

  • The subtitle of the data source, if not null will be displayed to users instead of connection information like host and database name.

    Parameters

    • value: nullableString

    Returns void

title

  • get title(): nullableString
  • set title(value: nullableString): void
  • The title of the item, as displayed to the user, it might be for example the name of the table in a database.

    Returns nullableString

  • The title of the item, as displayed to the user, it might be for example the name of the table in a database.

    Parameters

    • value: nullableString

    Returns void