Class google.gdata.analytics.DataSource

Object
   |
   +--google.gdata.analytics.DataSource

class google.gdata.analytics.DataSource

Describes a data source.
Defined in gdata.js

Field Detail

$propertiesClass_

Object $propertiesClass_

$tableIdClass_

Object $tableIdClass_

$tableNameClass_

Object $tableNameClass_

google.gdata.analytics.DataSource

google.gdata.analytics.DataSource(<Object> opt_params)

Constructs a data source using an object parameter whose property names match the setter method to use for each property.

Parameters:
opt_params - Optional parameters, each of which is used as the sole parameter to the associated setter method: properties, tableId, and tableName.

addProperty

void addProperty(<google.gdata.analytics.Property|Object> property)

Adds a new property.

Parameters:
property - Property to add, or object to use as a parameter to the google.gdata.analytics.Property constructor.

getProperties

Array.<google.gdata.analytics.Property> getProperties()

Returns the properties.

Returns:
Properties.

getPropertyValue

string|null getPropertyValue(<string> name)

Gets the property with the given name from this data source.

Parameters:
name - The name of the property to retrieve

Returns:
The value of the named property, or null if the named property is not present in this data source

getTableId

google.gdata.analytics.TableId|undefined getTableId()

Returns the data source ID. This element is required.

Returns:
Data source ID or undefined for none.

getTableName

google.gdata.analytics.TableName|undefined getTableName()

Returns the table name. This element is required.

Returns:
Table name or undefined for none.

setProperties

void setProperties(<Array.<google.gdata.analytics.Property>|Array.<Object>|undefined> properties)

Sets the properties.

Parameters:
properties - Properties, where each property is added using the addProperty() function, or undefined to clear the properties.

setTableId

void setTableId(<google.gdata.analytics.TableId|Object|undefined> tableId)

Sets the data source ID. This element is required.

Parameters:
tableId - Data source ID, or object to use as a parameter to the google.gdata.analytics.TableId constructor, or undefined for none.

setTableName

void setTableName(<google.gdata.analytics.TableName|Object|undefined> tableName)

Sets the table name. This element is required.

Parameters:
tableName - Table name, or object to use as a parameter to the google.gdata.analytics.TableName constructor, or undefined for none.