google_api_analytics v0.7.0 API Reference

Modules

API calls for all endpoints tagged Data.

API calls for all endpoints tagged Management.

API calls for all endpoints tagged Metadata.

API calls for all endpoints tagged Provisioning.

API calls for all endpoints tagged UserDeletion.

Handle Tesla connections for GoogleApi.Analytics.V3.

JSON template for Analytics account entry.

Child link for an account entry. Points to the list of web properties for this account.

Permissions the user has for this account.

JSON template for a linked account.

An AccountSummary collection lists a summary of accounts, properties and views (profiles) to which the user has access. Each resource in the collection corresponds to a single AccountSummary.

JSON template for an Analytics AccountSummary. An AccountSummary is a lightweight tree comprised of properties/profiles.

JSON template for an Analytics account ticket. The account ticket consists of the ticket ID and the basic information for the account, property and profile.

JSON template for an Analytics account tree requests. The account tree request is used in the provisioning api to create an account, property, and view (profile). It contains the basic information required to make these fields.

JSON template for an Analytics account tree response. The account tree response is used in the provisioning api to return the result of creating an account, property, and view (profile).

An account collection provides a list of Analytics accounts to which a user has access. The account collection is the entry point to all management information. Each resource in the collection corresponds to a single Analytics account.

JSON template for an Google Ads account.

Request template for the delete upload data request.

JSON template for a metadata column.

Lists columns (dimensions and metrics) for a particular report type.

JSON template for an Analytics custom data source.

Attributes

  • href (type: String.t, default: nil) - Link to the list of daily uploads for this custom data source. Link to the list of uploads for this custom data source.
  • type (type: String.t, default: nil) - Value is "analytics#dailyUploads". Value is "analytics#uploads".

Parent link for this custom data source. Points to the web property to which this custom data source belongs.

Lists Analytics custom data sources to which the user has access. Each resource in the collection corresponds to a single Analytics custom data source.

JSON template for Analytics Custom Dimension.

Parent link for the custom dimension. Points to the property to which the custom dimension belongs.

A custom dimension collection lists Analytics custom dimensions to which the user has access. Each resource in the collection corresponds to a single Analytics custom dimension.

JSON template for Analytics Custom Metric.

Parent link for the custom metric. Points to the property to which the custom metric belongs.

A custom metric collection lists Analytics custom metrics to which the user has access. Each resource in the collection corresponds to a single Analytics custom metric.

JSON template for Analytics Entity Google Ads Link.

An entity Google Ads link collection provides a list of GA-Google Ads links Each resource in this collection corresponds to a single link.

JSON template for an Analytics Entity-User Link. Returns permissions that a user has for an entity.

Entity for this link. It can be an account, a web property, or a view (profile).

Permissions the user has for this entity.

An entity user link collection provides a list of Analytics ACL links Each resource in this collection corresponds to a single link.

JSON template for Analytics experiment resource.

Parent link for an experiment. Points to the view (profile) to which this experiment belongs.

Attributes

  • name (type: String.t, default: nil) - The name of the variation. This field is required when creating an experiment. This field may not be changed for an experiment whose status is ENDED.
  • status (type: String.t, default: nil) - Status of the variation. Possible values: "ACTIVE", "INACTIVE". INACTIVE variations are not served. This field may not be changed for an experiment whose status is ENDED.
  • url (type: String.t, default: nil) - The URL of the variation. This field may not be changed for an experiment whose status is RUNNING or ENDED.
  • weight (type: float(), default: nil) - Weight that this variation should receive. Only present if the experiment is running. This field is read-only.
  • won (type: boolean(), default: nil) - True if the experiment has ended and this variation performed (statistically) significantly better than the original. This field is read-only.

An experiment collection lists Analytics experiments to which the user has access. Each view (profile) can have a set of experiments. Each resource in the Experiment collection corresponds to a single Analytics experiment.

JSON template for an Analytics account filter.

Details for the filter of the type ADVANCED.

JSON template for an Analytics filter expression.

Details for the filter of the type LOWER.

Parent link for this filter. Points to the account to which this filter belongs.

JSON template for a profile filter link.

Details for the filter of the type SEARCH_AND_REPLACE.

Details for the filter of the type UPPER.

A filter collection lists filters created by users in an Analytics account. Each resource in the collection corresponds to a filter.

Analytics data for a given view (profile).

Attributes

  • columnType (type: String.t, default: nil) - Column Type. Either DIMENSION or METRIC.
  • dataType (type: String.t, default: nil) - Data type. Dimension column headers have only STRING as the data type. Metric column headers have data types for metric values such as INTEGER, DOUBLE, CURRENCY etc.
  • name (type: String.t, default: nil) - Column name.

Attributes

  • cols (type: list(GoogleApi.Analytics.V3.Model.GaDataDataTableCols.t), default: nil) -
  • rows (type: list(GoogleApi.Analytics.V3.Model.GaDataDataTableRows.t), default: nil) -

Attributes

  • id (type: String.t, default: nil) -
  • label (type: String.t, default: nil) -
  • type (type: String.t, default: nil) -

Attributes

  • c (type: list(GoogleApi.Analytics.V3.Model.GaDataDataTableRowsC.t), default: nil) -

Attributes

  • v (type: String.t, default: nil) -

Information for the view (profile), for which the Analytics data was requested.

Analytics data request query parameters.

JSON template for Analytics goal resource.

Details for the goal of the type EVENT.

Attributes

  • comparisonType (type: String.t, default: nil) - Type of comparison. Possible values are LESS_THAN, GREATER_THAN or EQUAL.
  • comparisonValue (type: String.t, default: nil) - Value used for this comparison.
  • expression (type: String.t, default: nil) - Expression used for this match.
  • matchType (type: String.t, default: nil) - Type of the match to be performed. Possible values are REGEXP, BEGINS_WITH, or EXACT.
  • type (type: String.t, default: nil) - Type of this event condition. Possible values are CATEGORY, ACTION, LABEL, or VALUE.

Parent link for a goal. Points to the view (profile) to which this goal belongs.

Details for the goal of the type URL_DESTINATION.

Attributes

  • name (type: String.t, default: nil) - Step name.
  • number (type: integer(), default: nil) - Step number.
  • url (type: String.t, default: nil) - URL for this step.

Details for the goal of the type VISIT_NUM_PAGES.

Details for the goal of the type VISIT_TIME_ON_SITE.

A goal collection lists Analytics goals to which the user has access. Each view (profile) can have a set of goals. Each resource in the Goal collection corresponds to a single Analytics goal.

JSON template for a hash Client Id request resource.

JSON template for a hash Client Id response resource.

JSON template for an Analytics Remarketing Include Conditions.

JSON template for an Analytics Remarketing Audience Foreign Link.

Multi-Channel Funnels data for a given view (profile).

Attributes

  • columnType (type: String.t, default: nil) - Column Type. Either DIMENSION or METRIC.
  • dataType (type: String.t, default: nil) - Data type. Dimension and metric values data types such as INTEGER, DOUBLE, CURRENCY, MCF_SEQUENCE etc.
  • name (type: String.t, default: nil) - Column name.

Information for the view (profile), for which the Analytics data was requested.

Analytics data request query parameters.

A union object representing a dimension or metric value. Only one of "primitiveValue" or "conversionPathValue" attribute will be populated.

Attributes

  • interactionType (type: String.t, default: nil) - Type of an interaction on conversion path. Such as CLICK, IMPRESSION etc.
  • nodeValue (type: String.t, default: nil) - Node value of an interaction on conversion path. Such as source, medium etc.

JSON template for an Analytics view (profile).

Child link for this view (profile). Points to the list of goals for this view (profile).

JSON template for an Analytics profile filter link.

A profile filter link collection lists profile filter links between profiles and filters. Each resource in the collection corresponds to a profile filter link.

Parent link for this view (profile). Points to the web property to which this view (profile) belongs.

Permissions the user has for this view (profile).

JSON template for a linked view (profile).

JSON template for an Analytics ProfileSummary. ProfileSummary returns basic information (i.e., summary) for a profile.

A view (profile) collection lists Analytics views (profiles) to which the user has access. Each resource in the collection corresponds to a single Analytics view (profile).

Real time data for a given view (profile).

Attributes

  • columnType (type: String.t, default: nil) - Column Type. Either DIMENSION or METRIC.
  • dataType (type: String.t, default: nil) - Data type. Dimension column headers have only STRING as the data type. Metric column headers have data types for metric values such as INTEGER, DOUBLE, CURRENCY etc.
  • name (type: String.t, default: nil) - Column name.

Information for the view (profile), for which the real time data was requested.

Real time data request query parameters.

JSON template for an Analytics remarketing audience.

The simple audience definition that will cause a user to be added to an audience.

A state based audience definition that will cause a user to be added or removed from an audience.

A remarketing audience collection lists Analytics remarketing audiences to which the user has access. Each resource in the collection corresponds to a single Analytics remarketing audience.

JSON template for an Analytics segment.

An segment collection lists Analytics segments that the user has access to. Each resource in the collection corresponds to a single Analytics segment.

JSON template for Analytics unsampled report resource.

Download details for a file stored in Google Cloud Storage.

Download details for a file stored in Google Drive.

An unsampled report collection lists Analytics unsampled reports to which the user has access. Each view (profile) can have a set of unsampled reports. Each resource in the unsampled report collection corresponds to a single Analytics unsampled report.

Metadata returned for an upload operation.

Upload collection lists Analytics uploads to which the user has access. Each custom data source can have a set of uploads. Each resource in the upload collection corresponds to a single Analytics data upload.

JSON template for a user deletion request resource.

JSON template for a user reference.

JSON template for a web property reference.

JSON template for an Analytics WebPropertySummary. WebPropertySummary returns basic information (i.e., summary) for a web property.

A web property collection lists Analytics web properties to which the user has access. Each resource in the collection corresponds to a single Analytics web property.

JSON template for an Analytics web property.

Child link for this web property. Points to the list of views (profiles) for this web property.

Parent link for this web property. Points to the account to which this web property belongs.

Permissions the user has for this web property.