Module google_analytics3::api [−][src]
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. |
| AccountTreeRequest | 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. |
| AccountTreeResponse | 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). |
| 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 Google Ads 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 |
| DataRealtimeGetCall | Returns real time data for a view (profile). |
| EntityAdWordsLink | JSON template for Analytics Entity Google Ads Link. |
| EntityAdWordsLinkEntity | Web property being linked. |
| EntityAdWordsLinks | An entity Google Ads link collection provides a list of GA-Google Ads 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. |
| 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. |
| HashClientIdRequest | JSON template for a hash Client Id request resource. |
| HashClientIdResponse | JSON template for a hash Client Id response resource. |
| 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. |
| ManagementClientIdHashClientIdCall | Hashes the given Client ID. |
| 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 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 |
| 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). |
| ManagementRemarketingAudienceDeleteCall | Delete a remarketing audience. |
| 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-Google Ads link. |
| ManagementWebPropertyAdWordsLinkGetCall | Returns a web property-Google Ads link to which the user has access. |
| ManagementWebPropertyAdWordsLinkInsertCall | Creates a webProperty-Google Ads link. |
| ManagementWebPropertyAdWordsLinkListCall | Lists webProperty-Google Ads links for a given web property. |
| ManagementWebPropertyAdWordsLinkPatchCall | Updates an existing webProperty-Google Ads link. This method supports patch semantics. |
| ManagementWebPropertyAdWordsLinkUpdateCall | Updates an existing webProperty-Google Ads 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 |
| 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. |
| ProvisioningCreateAccountTreeCall | Provision account. |
| ProvisioningMethods | A builder providing access to all methods supported on provisioning resources.
It is not used directly, but through the |
| 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. |
| UserDeletionMethods | A builder providing access to all methods supported on userDeletion resources.
It is not used directly, but through the |
| UserDeletionRequest | JSON template for a user deletion request resource. |
| UserDeletionRequestId | User ID. |
| UserDeletionUserDeletionRequestUpsertCall | Insert or update a user deletion requests. |
| 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
| Scope | Identifies the an OAuth2 authorization scope. A scope is needed when requesting an authorization token. |