Crate google_analytics3

This documentation was generated from analytics crate version 1.0.4+20161004, where 20161004 is the exact revision of the analytics:v3 schema built by the mako code generator v1.0.4.

Everything else about the analytics v3 API can be found at the official documentation site. The original source code is on github.

Features

Handle the following Resources with ease from the central hub ...

• data
  • ga get, mcf get and realtime get
• management
  • account summaries list, account user links delete, account user links insert, account user links list, account user links update, accounts list, custom data sources list, custom dimensions get, custom dimensions insert, custom dimensions list, custom dimensions patch, custom dimensions update, custom metrics get, custom metrics insert, custom metrics list, custom metrics patch, custom metrics update, experiments delete, experiments get, experiments insert, experiments list, experiments patch, experiments update, filters delete, filters get, filters insert, filters list, filters patch, filters update, goals get, goals insert, goals list, goals patch, goals update, profile filter links delete, profile filter links get, profile filter links insert, profile filter links list, profile filter links patch, profile filter links update, profile user links delete, profile user links insert, profile user links list, profile user links update, profiles delete, profiles get, profiles insert, profiles list, profiles patch, profiles update, remarketing audience get, remarketing audience insert, remarketing audience list, remarketing audience patch, remarketing audience update, segments list, unsampled reports delete, unsampled reports get, unsampled reports insert, unsampled reports list, uploads delete upload data, uploads get, uploads list, uploads upload data, web property ad words links delete, web property ad words links get, web property ad words links insert, web property ad words links list, web property ad words links patch, web property ad words links update, webproperties get, webproperties insert, webproperties list, webproperties patch, webproperties update, webproperty user links delete, webproperty user links insert, webproperty user links list and webproperty user links update
• metadata
  • columns list
• provisioning
  • create account ticket

Upload supported by ...

• uploads upload data management

Not what you are looking for ? Find all other Google APIs in their Rust documentation index.

Structure of this Library

The API is structured into the following primary items:

• Hub
  • a central object to maintain state and allow accessing all Activities
  • creates Method Builders which in turn allow access to individual Call Builders
• Resources
  • primary types that you can apply Activities to
  • a collection of properties and Parts
  • Parts
    • a collection of properties
    • never directly used in Activities
• Activities
  • operations to apply to Resources

All structures are marked with applicable traits to further categorize them and ease browsing.

Generally speaking, you can invoke Activities like this:

let r = hub.resource().activity(...).doit()

Or specifically ...

let r = hub.management().webproperty_user_links_insert(...).doit()
let r = hub.management().profile_user_links_insert(...).doit()
let r = hub.management().profile_user_links_update(...).doit()
let r = hub.management().account_user_links_update(...).doit()
let r = hub.management().webproperty_user_links_update(...).doit()
let r = hub.management().account_user_links_insert(...).doit()

The resource() and activity(...) calls create builders. The second one dealing with Activities supports various methods to configure the impending operation (not shown here). It is made such that all required arguments have to be specified right away (i.e. (...)), whereas all optional ones can be build up as desired. The doit() method performs the actual communication with the server and returns the respective result.

Usage

Setting up your Project

To use this library, you would put the following lines into your Cargo.toml file:

[dependencies]
google-analytics3 = "*"

A complete example

extern crate hyper;
extern crate yup_oauth2 as oauth2;
extern crate google_analytics3 as analytics3;
use analytics3::EntityUserLink;
use analytics3::{Result, Error};
use std::default::Default;
use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage};
use analytics3::Analytics;
 
// Get an ApplicationSecret instance by some means. It contains the `client_id` and 
// `client_secret`, among other things.
let secret: ApplicationSecret = Default::default();
// Instantiate the authenticator. It will choose a suitable authentication flow for you, 
// unless you replace  `None` with the desired Flow.
// Provide your own `AuthenticatorDelegate` to adjust the way it operates and get feedback about 
// what's going on. You probably want to bring in your own `TokenStorage` to persist tokens and
// retrieve them from storage.
let auth = Authenticator::new(&secret, DefaultAuthenticatorDelegate,
                              hyper::Client::new(),
                              <MemoryStorage as Default>::default(), None);
let mut hub = Analytics::new(hyper::Client::new(), auth);
// As the method needs a request, you would usually fill it with the desired information
// into the respective structure. Some of the parts shown here might not be applicable !
// Values shown here are possibly random and not representative !
let mut req = EntityUserLink::default();
 
// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.management().profile_user_links_update(req, "accountId", "webPropertyId", "profileId", "linkId")
             .doit();
 
match result {
    Err(e) => match e {
        // The Error enum provides details about what exactly happened.
        // You can also just use its `Debug`, `Display` or `Error` traits
         Error::HttpError(_)
        |Error::MissingAPIKey
        |Error::MissingToken(_)
        |Error::Cancelled
        |Error::UploadSizeLimitExceeded(_, _)
        |Error::Failure(_)
        |Error::BadRequest(_)
        |Error::FieldClash(_)
        |Error::JsonDecodeError(_, _) => println!("{}", e),
    },
    Ok(res) => println!("Success: {:?}", res),
}

Handling Errors

All errors produced by the system are provided either as Result enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the Hub Delegate, or the Authenticator Delegate.

When delegates handle errors or intermediate values, they may have a chance to instruct the system to retry. This makes the system potentially resilient to all kinds of errors.

Uploads and Downloads

If a method supports downloads, the response body, which is part of the Result, should be read by you to obtain the media. If such a method also supports a Response Result, it will return that by default. You can see it as meta-data for the actual media. To trigger a media download, you will have to set up the builder by making this call: .param("alt", "media").

Methods supporting uploads can do so using up to 2 different protocols: simple and resumable. The distinctiveness of each is represented by customized doit(...) methods, which are then named upload(...) and upload_resumable(...) respectively.

Customization and Callbacks

You may alter the way an doit() method is called by providing a delegate to the Method Builder before making the final doit() call. Respective methods will be called to provide progress information, as well as determine whether the system should retry on failure.

The delegate trait is default-implemented, allowing you to customize it with minimal effort.

Optional Parts in Server-Requests

All structures provided by this library are made to be enocodable and decodable via json. Optionals are used to indicate that partial requests are responses are valid. Most optionals are are considered Parts which are identifiable by name, which will be sent to the server to indicate either the set parts of the request or the desired parts in the response.

Builder Arguments

Using method builders, you are able to prepare an action call by repeatedly calling it's methods. These will always take a single argument, for which the following statements are true.

• PODs are handed by copy
• strings are passed as &str
• request values are moved

Arguments will always be copied or cloned into the builder, to make them independent of their original life times.

Structs

Account	JSON template for Analytics account entry.
AccountChildLink	Child link for an account entry. Points to the list of web properties for this account.
AccountPermissions	Permissions the user has for this account.
AccountRef	JSON template for a linked account.
AccountSummaries	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.
AccountSummary	JSON template for an Analytics AccountSummary. An AccountSummary is a lightweight tree comprised of properties/profiles.
AccountTicket	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.
Accounts	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.
AdWordsAccount	JSON template for an AdWords account.
Analytics	Central instance to access all Analytics related resource activities
AnalyticsDataimportDeleteUploadDataRequest	Request template for the delete upload data request.
Column	JSON template for a metadata column.
Columns	Lists columns (dimensions and metrics) for a particular report type.
CustomDataSource	JSON template for an Analytics custom data source.
CustomDataSourceChildLink	There is no detailed description.
CustomDataSourceParentLink	Parent link for this custom data source. Points to the web property to which this custom data source belongs.
CustomDataSources	Lists Analytics custom data sources to which the user has access. Each resource in the collection corresponds to a single Analytics custom data source.
CustomDimension	JSON template for Analytics Custom Dimension.
CustomDimensionParentLink	Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
CustomDimensions	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.
CustomMetric	JSON template for Analytics Custom Metric.
CustomMetricParentLink	Parent link for the custom metric. Points to the property to which the custom metric belongs.
CustomMetrics	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.
DataGaGetCall	Returns Analytics data for a view (profile).
DataMcfGetCall	Returns Analytics Multi-Channel Funnels data for a view (profile).
DataMethods	A builder providing access to all methods supported on data resources. It is not used directly, but through the Analytics hub.
DataRealtimeGetCall	Returns real time data for a view (profile).
DefaultDelegate	A delegate with a conservative default implementation, which is used if no other delegate is set.
EntityAdWordsLink	JSON template for Analytics Entity AdWords Link.
EntityAdWordsLinkEntity	Web property being linked.
EntityAdWordsLinks	An entity AdWords link collection provides a list of GA-AdWords links Each resource in this collection corresponds to a single link.
EntityUserLink	JSON template for an Analytics Entity-User Link. Returns permissions that a user has for an entity.
EntityUserLinkEntity	Entity for this link. It can be an account, a web property, or a view (profile).
EntityUserLinkPermissions	Permissions the user has for this entity.
EntityUserLinks	An entity user link collection provides a list of Analytics ACL links Each resource in this collection corresponds to a single link.
ErrorResponse	A utility to represent detailed errors we might see in case there are BadRequests. The latter happen if the sent parameters or request structures are unsound
Experiment	JSON template for Analytics experiment resource.
ExperimentParentLink	Parent link for an experiment. Points to the view (profile) to which this experiment belongs.
ExperimentVariations	Array of variations. The first variation in the array is the original. The number of variations may not change once an experiment is in the RUNNING state. At least two variations are required before status can be set to RUNNING.
Experiments	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.
Filter	JSON template for an Analytics account filter.
FilterAdvancedDetails	Details for the filter of the type ADVANCED.
FilterExpression	JSON template for an Analytics filter expression.
FilterLowercaseDetails	Details for the filter of the type LOWER.
FilterParentLink	Parent link for this filter. Points to the account to which this filter belongs.
FilterRef	JSON template for a profile filter link.
FilterSearchAndReplaceDetails	Details for the filter of the type SEARCH_AND_REPLACE.
FilterUppercaseDetails	Details for the filter of the type UPPER.
Filters	A filter collection lists filters created by users in an Analytics account. Each resource in the collection corresponds to a filter.
GaData	Analytics data for a given view (profile).
GaDataColumnHeaders	Column headers that list dimension names followed by the metric names. The order of dimensions and metrics is same as specified in the request.
GaDataDataTable	There is no detailed description.
GaDataDataTableCols	There is no detailed description.
GaDataDataTableRows	There is no detailed description.
GaDataDataTableRowsC	There is no detailed description.
GaDataProfileInfo	Information for the view (profile), for which the Analytics data was requested.
GaDataQuery	Analytics data request query parameters.
Goal	JSON template for Analytics goal resource.
GoalEventDetails	Details for the goal of the type EVENT.
GoalEventDetailsEventConditions	List of event conditions.
GoalParentLink	Parent link for a goal. Points to the view (profile) to which this goal belongs.
GoalUrlDestinationDetails	Details for the goal of the type URL_DESTINATION.
GoalUrlDestinationDetailsSteps	List of steps configured for this goal funnel.
GoalVisitNumPagesDetails	Details for the goal of the type VISIT_NUM_PAGES.
GoalVisitTimeOnSiteDetails	Details for the goal of the type VISIT_TIME_ON_SITE.
Goals	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.
IncludeConditions	JSON template for an Analytics Remarketing Include Conditions.
LinkedForeignAccount	JSON template for an Analytics Remarketing Audience Foreign Link.
ManagementAccountListCall	Lists all accounts to which the user has access.
ManagementAccountSummaryListCall	Lists account summaries (lightweight tree comprised of accounts/properties/profiles) to which the user has access.
ManagementAccountUserLinkDeleteCall	Removes a user from the given account.
ManagementAccountUserLinkInsertCall	Adds a new user to the given account.
ManagementAccountUserLinkListCall	Lists account-user links for a given account.
ManagementAccountUserLinkUpdateCall	Updates permissions for an existing user on the given account.
ManagementCustomDataSourceListCall	List custom data sources to which the user has access.
ManagementCustomDimensionGetCall	Get a custom dimension to which the user has access.
ManagementCustomDimensionInsertCall	Create a new custom dimension.
ManagementCustomDimensionListCall	Lists custom dimensions to which the user has access.
ManagementCustomDimensionPatchCall	Updates an existing custom dimension. This method supports patch semantics.
ManagementCustomDimensionUpdateCall	Updates an existing custom dimension.
ManagementCustomMetricGetCall	Get a custom metric to which the user has access.
ManagementCustomMetricInsertCall	Create a new custom metric.
ManagementCustomMetricListCall	Lists custom metrics to which the user has access.
ManagementCustomMetricPatchCall	Updates an existing custom metric. This method supports patch semantics.
ManagementCustomMetricUpdateCall	Updates an existing custom metric.
ManagementExperimentDeleteCall	Delete an experiment.
ManagementExperimentGetCall	Returns an experiment to which the user has access.
ManagementExperimentInsertCall	Create a new experiment.
ManagementExperimentListCall	Lists experiments to which the user has access.
ManagementExperimentPatchCall	Update an existing experiment. This method supports patch semantics.
ManagementExperimentUpdateCall	Update an existing experiment.
ManagementFilterDeleteCall	Delete a filter.
ManagementFilterGetCall	Returns a filters to which the user has access.
ManagementFilterInsertCall	Create a new filter.
ManagementFilterListCall	Lists all filters for an account
ManagementFilterPatchCall	Updates an existing filter. This method supports patch semantics.
ManagementFilterUpdateCall	Updates an existing filter.
ManagementGoalGetCall	Gets a goal to which the user has access.
ManagementGoalInsertCall	Create a new goal.
ManagementGoalListCall	Lists goals to which the user has access.
ManagementGoalPatchCall	Updates an existing goal. This method supports patch semantics.
ManagementGoalUpdateCall	Updates an existing goal.
ManagementMethods	A builder providing access to all methods supported on management resources. It is not used directly, but through the Analytics hub.
ManagementProfileDeleteCall	Deletes a view (profile).
ManagementProfileFilterLinkDeleteCall	Delete a profile filter link.
ManagementProfileFilterLinkGetCall	Returns a single profile filter link.
ManagementProfileFilterLinkInsertCall	Create a new profile filter link.
ManagementProfileFilterLinkListCall	Lists all profile filter links for a profile.
ManagementProfileFilterLinkPatchCall	Update an existing profile filter link. This method supports patch semantics.
ManagementProfileFilterLinkUpdateCall	Update an existing profile filter link.
ManagementProfileGetCall	Gets a view (profile) to which the user has access.
ManagementProfileInsertCall	Create a new view (profile).
ManagementProfileListCall	Lists views (profiles) to which the user has access.
ManagementProfilePatchCall	Updates an existing view (profile). This method supports patch semantics.
ManagementProfileUpdateCall	Updates an existing view (profile).
ManagementProfileUserLinkDeleteCall	Removes a user from the given view (profile).
ManagementProfileUserLinkInsertCall	Adds a new user to the given view (profile).
ManagementProfileUserLinkListCall	Lists profile-user links for a given view (profile).
ManagementProfileUserLinkUpdateCall	Updates permissions for an existing user on the given view (profile).
ManagementRemarketingAudienceGetCall	Gets a remarketing audience to which the user has access.
ManagementRemarketingAudienceInsertCall	Creates a new remarketing audience.
ManagementRemarketingAudienceListCall	Lists remarketing audiences to which the user has access.
ManagementRemarketingAudiencePatchCall	Updates an existing remarketing audience. This method supports patch semantics.
ManagementRemarketingAudienceUpdateCall	Updates an existing remarketing audience.
ManagementSegmentListCall	Lists segments to which the user has access.
ManagementUnsampledReportDeleteCall	Deletes an unsampled report.
ManagementUnsampledReportGetCall	Returns a single unsampled report.
ManagementUnsampledReportInsertCall	Create a new unsampled report.
ManagementUnsampledReportListCall	Lists unsampled reports to which the user has access.
ManagementUploadDeleteUploadDataCall	Delete data associated with a previous upload.
ManagementUploadGetCall	List uploads to which the user has access.
ManagementUploadListCall	List uploads to which the user has access.
ManagementUploadUploadDataCall	Upload data for a custom data source.
ManagementWebPropertyAdWordsLinkDeleteCall	Deletes a web property-AdWords link.
ManagementWebPropertyAdWordsLinkGetCall	Returns a web property-AdWords link to which the user has access.
ManagementWebPropertyAdWordsLinkInsertCall	Creates a webProperty-AdWords link.
ManagementWebPropertyAdWordsLinkListCall	Lists webProperty-AdWords links for a given web property.
ManagementWebPropertyAdWordsLinkPatchCall	Updates an existing webProperty-AdWords link. This method supports patch semantics.
ManagementWebPropertyAdWordsLinkUpdateCall	Updates an existing webProperty-AdWords link.
ManagementWebpropertyGetCall	Gets a web property to which the user has access.
ManagementWebpropertyInsertCall	Create a new property if the account has fewer than 20 properties. Web properties are visible in the Google Analytics interface only if they have at least one profile.
ManagementWebpropertyListCall	Lists web properties to which the user has access.
ManagementWebpropertyPatchCall	Updates an existing web property. This method supports patch semantics.
ManagementWebpropertyUpdateCall	Updates an existing web property.
ManagementWebpropertyUserLinkDeleteCall	Removes a user from the given web property.
ManagementWebpropertyUserLinkInsertCall	Adds a new user to the given web property.
ManagementWebpropertyUserLinkListCall	Lists webProperty-user links for a given web property.
ManagementWebpropertyUserLinkUpdateCall	Updates permissions for an existing user on the given web property.
McfData	Multi-Channel Funnels data for a given view (profile).
McfDataColumnHeaders	Column headers that list dimension names followed by the metric names. The order of dimensions and metrics is same as specified in the request.
McfDataProfileInfo	Information for the view (profile), for which the Analytics data was requested.
McfDataQuery	Analytics data request query parameters.
McfDataRows	A union object representing a dimension or metric value. Only one of "primitiveValue" or "conversionPathValue" attribute will be populated.
McfDataRowsConversionPathValue	A conversion path dimension value, containing a list of interactions with their attributes.
MetadataColumnListCall	Lists all columns for a report type
MetadataMethods	A builder providing access to all methods supported on metadata resources. It is not used directly, but through the Analytics hub.
MethodInfo	Contains information about an API request.
MultiPartReader	Provides a Read interface that converts multiple parts into the protocol identified by RFC2387. Note: This implementation is just as rich as it needs to be to perform uploads to google APIs, and might not be a fully-featured implementation.
Profile	JSON template for an Analytics view (profile).
ProfileChildLink	Child link for this view (profile). Points to the list of goals for this view (profile).
ProfileFilterLink	JSON template for an Analytics profile filter link.
ProfileFilterLinks	A profile filter link collection lists profile filter links between profiles and filters. Each resource in the collection corresponds to a profile filter link.
ProfileParentLink	Parent link for this view (profile). Points to the web property to which this view (profile) belongs.
ProfilePermissions	Permissions the user has for this view (profile).
ProfileRef	JSON template for a linked view (profile).
ProfileSummary	JSON template for an Analytics ProfileSummary. ProfileSummary returns basic information (i.e., summary) for a profile.
Profiles	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).
ProvisioningCreateAccountTicketCall	Creates an account ticket.
ProvisioningMethods	A builder providing access to all methods supported on provisioning resources. It is not used directly, but through the Analytics hub.
RealtimeData	Real time data for a given view (profile).
RealtimeDataColumnHeaders	Column headers that list dimension names followed by the metric names. The order of dimensions and metrics is same as specified in the request.
RealtimeDataProfileInfo	Information for the view (profile), for which the real time data was requested.
RealtimeDataQuery	Real time data request query parameters.
RemarketingAudience	JSON template for an Analytics remarketing audience.
RemarketingAudienceAudienceDefinition	The simple audience definition that will cause a user to be added to an audience.
RemarketingAudienceStateBasedAudienceDefinition	A state based audience definition that will cause a user to be added or removed from an audience.
RemarketingAudienceStateBasedAudienceDefinitionExcludeConditions	Defines the conditions to exclude users from the audience.
RemarketingAudiences	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.
Segment	JSON template for an Analytics segment.
Segments	An segment collection lists Analytics segments that the user has access to. Each resource in the collection corresponds to a single Analytics segment.
UnsampledReport	JSON template for Analytics unsampled report resource.
UnsampledReportCloudStorageDownloadDetails	Download details for a file stored in Google Cloud Storage.
UnsampledReportDriveDownloadDetails	Download details for a file stored in Google Drive.
UnsampledReports	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.
Upload	Metadata returned for an upload operation.
Uploads	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.
UserRef	JSON template for a user reference.
WebPropertyRef	JSON template for a web property reference.
WebPropertySummary	JSON template for an Analytics WebPropertySummary. WebPropertySummary returns basic information (i.e., summary) for a web property.
Webproperties	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.
Webproperty	JSON template for an Analytics web property.
WebpropertyChildLink	Child link for this web property. Points to the list of views (profiles) for this web property.
WebpropertyParentLink	Parent link for this web property. Points to the account to which this web property belongs.
WebpropertyPermissions	Permissions the user has for this web property.

Enums

Error
Scope	Identifies the an OAuth2 authorization scope. A scope is needed when requesting an authorization token.

Traits

CallBuilder	Identifies types which represent builders for a particular resource method
Delegate	A trait specifying functionality to help controlling any request performed by the API. The trait has a conservative default implementation.
Hub	Identifies the Hub. There is only one per library, this trait is supposed to make intended use more explicit. The hub allows to access all resource methods more easily.
MethodsBuilder	Identifies types for building methods of a particular resource type
NestedType	Identifies types which are only used by other types internally. They have no special meaning, this trait just marks them for completeness.
Part	Identifies types which are only used as part of other types, which usually are carrying the Resource trait.
ReadSeek	A utility to specify reader types which provide seeking capabilities too
RequestValue	Identifies types which are used in API requests.
Resource	Identifies types which can be inserted and deleted. Types with this trait are most commonly used by clients of this API.
ResponseResult	Identifies types which are used in API responses.
ToParts	A trait for all types that can convert themselves into a parts string

Functions

remove_json_null_values

Type Definitions

Result

A universal result type used as return for all calls.