npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@datafire/google_analytics

v6.0.0

Published

DataFire integration for Google Analytics API

Downloads

3

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

datafiredatafire

Keywords

Readme

@datafire/google_analytics

Client library for Google Analytics API

Installation and Usage

npm install --save @datafire/google_analytics
let google_analytics = require('@datafire/google_analytics').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

Views and manages your Google Analytics data.

Actions

oauthCallback

Exchange the code passed to your redirect URI for an access_token

google_analytics.oauthCallback({
  "code": ""
}, context)

Input

  • input object
    • code required string

Output

  • output object
    • access_token string
    • refresh_token string
    • token_type string
    • scope string
    • expiration string

oauthRefresh

Exchange a refresh_token for an access_token

google_analytics.oauthRefresh(null, context)

Input

This action has no parameters

Output

  • output object
    • access_token string
    • refresh_token string
    • token_type string
    • scope string
    • expiration string

analytics.data.ga.get

Returns Analytics data for a view (profile).

google_analytics.analytics.data.ga.get({
  "ids": "",
  "start-date": "",
  "end-date": "",
  "metrics": ""
}, context)

Input

  • input object
    • ids required string: Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.
    • start-date required string: Start date for fetching Analytics data. Requests can specify a start date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is 7daysAgo.
    • end-date required string: End date for fetching Analytics data. Request can should specify an end date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is yesterday.
    • metrics required string: A comma-separated list of Analytics metrics. E.g., 'ga:sessions,ga:pageviews'. At least one metric must be specified.
    • dimensions string: A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'.
    • filters string: A comma-separated list of dimension or metric filters to be applied to Analytics data.
    • include-empty-rows boolean: The response will include empty rows if this parameter is set to true, the default is true
    • max-results integer: The maximum number of entries to include in this feed.
    • output string (values: dataTable, json): The selected format for the response. Default format is JSON.
    • samplingLevel string (values: DEFAULT, FASTER, HIGHER_PRECISION): The desired sampling level.
    • segment string: An Analytics segment to be applied to data.
    • sort string: A comma-separated list of dimensions or metrics that determine the sort order for Analytics data.
    • start-index integer: An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

analytics.data.mcf.get

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

google_analytics.analytics.data.mcf.get({
  "ids": "",
  "start-date": "",
  "end-date": "",
  "metrics": ""
}, context)

Input

  • input object
    • ids required string: Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.
    • start-date required string: Start date for fetching Analytics data. Requests can specify a start date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is 7daysAgo.
    • end-date required string: End date for fetching Analytics data. Requests can specify a start date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is 7daysAgo.
    • metrics required string: A comma-separated list of Multi-Channel Funnels metrics. E.g., 'mcf:totalConversions,mcf:totalConversionValue'. At least one metric must be specified.
    • dimensions string: A comma-separated list of Multi-Channel Funnels dimensions. E.g., 'mcf:source,mcf:medium'.
    • filters string: A comma-separated list of dimension or metric filters to be applied to the Analytics data.
    • max-results integer: The maximum number of entries to include in this feed.
    • samplingLevel string (values: DEFAULT, FASTER, HIGHER_PRECISION): The desired sampling level.
    • sort string: A comma-separated list of dimensions or metrics that determine the sort order for the Analytics data.
    • start-index integer: An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

analytics.data.realtime.get

Returns real time data for a view (profile).

google_analytics.analytics.data.realtime.get({
  "ids": "",
  "metrics": ""
}, context)

Input

  • input object
    • ids required string: Unique table ID for retrieving real time data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.
    • metrics required string: A comma-separated list of real time metrics. E.g., 'rt:activeUsers'. At least one metric must be specified.
    • dimensions string: A comma-separated list of real time dimensions. E.g., 'rt:medium,rt:city'.
    • filters string: A comma-separated list of dimension or metric filters to be applied to real time data.
    • max-results integer: The maximum number of entries to include in this feed.
    • sort string: A comma-separated list of dimensions or metrics that determine the sort order for real time data.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

analytics.management.accountSummaries.list

Lists account summaries (lightweight tree comprised of accounts/properties/profiles) to which the user has access.

google_analytics.analytics.management.accountSummaries.list({}, context)

Input

  • input object
    • max-results integer: The maximum number of account summaries to include in this response, where the largest acceptable value is 1000.
    • start-index integer: An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

analytics.management.accounts.list

Lists all accounts to which the user has access.

google_analytics.analytics.management.accounts.list({}, context)

Input

  • input object
    • max-results integer: The maximum number of accounts to include in this response.
    • start-index integer: An index of the first account to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

analytics.management.accountUserLinks.list

Lists account-user links for a given account.

google_analytics.analytics.management.accountUserLinks.list({
  "accountId": ""
}, context)

Input

  • input object
    • accountId required string: Account ID to retrieve the user links for.
    • max-results integer: The maximum number of account-user links to include in this response.
    • start-index integer: An index of the first account-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

analytics.management.accountUserLinks.insert

Adds a new user to the given account.

google_analytics.analytics.management.accountUserLinks.insert({
  "accountId": ""
}, context)

Input

  • input object
    • accountId required string: Account ID to create the user link for.
    • body EntityUserLink
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

analytics.management.accountUserLinks.delete

Removes a user from the given account.

google_analytics.analytics.management.accountUserLinks.delete({
  "accountId": "",
  "linkId": ""
}, context)

Input

  • input object
    • accountId required string: Account ID to delete the user link for.
    • linkId required string: Link ID to delete the user link for.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

Output schema unknown

analytics.management.accountUserLinks.update

Updates permissions for an existing user on the given account.

google_analytics.analytics.management.accountUserLinks.update({
  "accountId": "",
  "linkId": ""
}, context)

Input

  • input object
    • accountId required string: Account ID to update the account-user link for.
    • linkId required string: Link ID to update the account-user link for.
    • body EntityUserLink
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

analytics.management.filters.list

Lists all filters for an account

google_analytics.analytics.management.filters.list({
  "accountId": ""
}, context)

Input

  • input object
    • accountId required string: Account ID to retrieve filters for.
    • max-results integer: The maximum number of filters to include in this response.
    • start-index integer: An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

analytics.management.filters.insert

Create a new filter.

google_analytics.analytics.management.filters.insert({
  "accountId": ""
}, context)

Input

  • input object
    • accountId required string: Account ID to create filter for.
    • body Filter
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

analytics.management.filters.delete

Delete a filter.

google_analytics.analytics.management.filters.delete({
  "accountId": "",
  "filterId": ""
}, context)

Input

  • input object
    • accountId required string: Account ID to delete the filter for.
    • filterId required string: ID of the filter to be deleted.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

analytics.management.filters.get

Returns filters to which the user has access.

google_analytics.analytics.management.filters.get({
  "accountId": "",
  "filterId": ""
}, context)

Input

  • input object
    • accountId required string: Account ID to retrieve filters for.
    • filterId required string: Filter ID to retrieve filters for.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

analytics.management.filters.patch

Updates an existing filter. This method supports patch semantics.

google_analytics.analytics.management.filters.patch({
  "accountId": "",
  "filterId": ""
}, context)

Input

  • input object
    • accountId required string: Account ID to which the filter belongs.
    • filterId required string: ID of the filter to be updated.
    • body Filter
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

analytics.management.filters.update

Updates an existing filter.

google_analytics.analytics.management.filters.update({
  "accountId": "",
  "filterId": ""
}, context)

Input

  • input object
    • accountId required string: Account ID to which the filter belongs.
    • filterId required string: ID of the filter to be updated.
    • body Filter
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

analytics.management.webproperties.list

Lists web properties to which the user has access.

google_analytics.analytics.management.webproperties.list({
  "accountId": ""
}, context)

Input

  • input object
    • accountId required string: Account ID to retrieve web properties for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to.
    • max-results integer: The maximum number of web properties to include in this response.
    • start-index integer: An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

analytics.management.webproperties.insert

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.

google_analytics.analytics.management.webproperties.insert({
  "accountId": ""
}, context)

Input

  • input object
    • accountId required string: Account ID to create the web property for.
    • body Webproperty
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

analytics.management.webproperties.get

Gets a web property to which the user has access.

google_analytics.analytics.management.webproperties.get({
  "accountId": "",
  "webPropertyId": ""
}, context)

Input

  • input object
    • accountId required string: Account ID to retrieve the web property for.
    • webPropertyId required string: ID to retrieve the web property for.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

analytics.management.webproperties.patch

Updates an existing web property. This method supports patch semantics.

google_analytics.analytics.management.webproperties.patch({
  "accountId": "",
  "webPropertyId": ""
}, context)

Input

  • input object
    • accountId required string: Account ID to which the web property belongs
    • webPropertyId required string: Web property ID
    • body Webproperty
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

analytics.management.webproperties.update

Updates an existing web property.

google_analytics.analytics.management.webproperties.update({
  "accountId": "",
  "webPropertyId": ""
}, context)

Input

  • input object
    • accountId required string: Account ID to which the web property belongs
    • webPropertyId required string: Web property ID
    • body Webproperty
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

analytics.management.customDataSources.list

List custom data sources to which the user has access.

google_analytics.analytics.management.customDataSources.list({
  "accountId": "",
  "webPropertyId": ""
}, context)

Input

  • input object
    • accountId required string: Account Id for the custom data sources to retrieve.
    • webPropertyId required string: Web property Id for the custom data sources to retrieve.
    • max-results integer: The maximum number of custom data sources to include in this response.
    • start-index integer: A 1-based index of the first custom data source to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

analytics.management.uploads.deleteUploadData

Delete data associated with a previous upload.

google_analytics.analytics.management.uploads.deleteUploadData({
  "accountId": "",
  "webPropertyId": "",
  "customDataSourceId": ""
}, context)

Input

  • input object
    • accountId required string: Account Id for the uploads to be deleted.
    • webPropertyId required string: Web property Id for the uploads to be deleted.
    • customDataSourceId required string: Custom data source Id for the uploads to be deleted.
    • body AnalyticsDataimportDeleteUploadDataRequest
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

Output schema unknown

analytics.management.uploads.list

List uploads to which the user has access.

google_analytics.analytics.management.uploads.list({
  "accountId": "",
  "webPropertyId": "",
  "customDataSourceId": ""
}, context)

Input

  • input object
    • accountId required string: Account Id for the uploads to retrieve.
    • webPropertyId required string: Web property Id for the uploads to retrieve.
    • customDataSourceId required string: Custom data source Id for uploads to retrieve.
    • max-results integer: The maximum number of uploads to include in this response.
    • start-index integer: A 1-based index of the first upload to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

analytics.management.uploads.uploadData

Upload data for a custom data source.

google_analytics.analytics.management.uploads.uploadData({
  "accountId": "",
  "webPropertyId": "",
  "customDataSourceId": ""
}, context)

Input

  • input object
    • accountId required string: Account Id associated with the upload.
    • webPropertyId required string: Web property UA-string associated with the upload.
    • customDataSourceId required string: Custom data source Id to which the data being uploaded belongs.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

analytics.management.uploads.get

List uploads to which the user has access.

google_analytics.analytics.management.uploads.get({
  "accountId": "",
  "webPropertyId": "",
  "customDataSourceId": "",
  "uploadId": ""
}, context)

Input

  • input object
    • accountId required string: Account Id for the upload to retrieve.
    • webPropertyId required string: Web property Id for the upload to retrieve.
    • customDataSourceId required string: Custom data source Id for upload to retrieve.
    • uploadId required string: Upload Id to retrieve.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

analytics.management.customDimensions.list

Lists custom dimensions to which the user has access.

google_analytics.analytics.management.customDimensions.list({
  "accountId": "",
  "webPropertyId": ""
}, context)

Input

  • input object
    • accountId required string: Account ID for the custom dimensions to retrieve.
    • webPropertyId required string: Web property ID for the custom dimensions to retrieve.
    • max-results integer: The maximum number of custom dimensions to include in this response.
    • start-index integer: An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

analytics.management.customDimensions.insert

Create a new custom dimension.

google_analytics.analytics.management.customDimensions.insert({
  "accountId": "",
  "webPropertyId": ""
}, context)

Input

  • input object
    • accountId required string: Account ID for the custom dimension to create.
    • webPropertyId required string: Web property ID for the custom dimension to create.
    • body CustomDimension
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

analytics.management.customDimensions.get

Get a custom dimension to which the user has access.

google_analytics.analytics.management.customDimensions.get({
  "accountId": "",
  "webPropertyId": "",
  "customDimensionId": ""
}, context)

Input

  • input object
    • accountId required string: Account ID for the custom dimension to retrieve.
    • webPropertyId required string: Web property ID for the custom dimension to retrieve.
    • customDimensionId required string: The ID of the custom dimension to retrieve.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

analytics.management.customDimensions.patch

Updates an existing custom dimension. This method supports patch semantics.

google_analytics.analytics.management.customDimensions.patch({
  "accountId": "",
  "webPropertyId": "",
  "customDimensionId": ""
}, context)

Input

  • input object
    • accountId required string: Account ID for the custom dimension to update.
    • webPropertyId required string: Web property ID for the custom dimension to update.
    • customDimensionId required string: Custom dimension ID for the custom dimension to update.
    • ignoreCustomDataSourceLinks boolean: Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set.
    • body CustomDimension
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

analytics.management.customDimensions.update

Updates an existing custom dimension.

google_analytics.analytics.management.customDimensions.update({
  "accountId": "",
  "webPropertyId": "",
  "customDimensionId": ""
}, context)

Input

  • input object
    • accountId required string: Account ID for the custom dimension to update.
    • webPropertyId required string: Web property ID for the custom dimension to update.
    • customDimensionId required string: Custom dimension ID for the custom dimension to update.
    • ignoreCustomDataSourceLinks boolean: Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set.
    • body CustomDimension
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

analytics.management.customMetrics.list

Lists custom metrics to which the user has access.

google_analytics.analytics.management.customMetrics.list({
  "accountId": "",
  "webPropertyId": ""
}, context)

Input

  • input object
    • accountId required string: Account ID for the custom metrics to retrieve.
    • webPropertyId required string: Web property ID for the custom metrics to retrieve.
    • max-results integer: The maximum number of custom metrics to include in this response.
    • start-index integer: An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

analytics.management.customMetrics.insert

Create a new custom metric.

google_analytics.analytics.management.customMetrics.insert({
  "accountId": "",
  "webPropertyId": ""
}, context)

Input

  • input object
    • accountId required string: Account ID for the custom metric to create.
    • webPropertyId required string: Web property ID for the custom dimension to create.
    • body CustomMetric
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

analytics.management.customMetrics.get

Get a custom metric to which the user has access.

google_analytics.analytics.management.customMetrics.get({
  "accountId": "",
  "webPropertyId": "",
  "customMetricId": ""
}, context)

Input

  • input object
    • accountId required string: Account ID for the custom metric to retrieve.
    • webPropertyId required string: Web property ID for the custom metric to retrieve.
    • customMetricId required string: The ID of the custom metric to retrieve.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

analytics.management.customMetrics.patch

Updates an existing custom metric. This method supports patch semantics.

google_analytics.analytics.management.customMetrics.patch({
  "accountId": "",
  "webPropertyId": "",
  "customMetricId": ""
}, context)

Input

  • input object
    • accountId required string: Account ID for the custom metric to update.
    • webPropertyId required string: Web property ID for the custom metric to update.
    • customMetricId required string: Custom metric ID for the custom metric to update.
    • ignoreCustomDataSourceLinks boolean: Force the update and ignore any warnings related to the custom metric being linked to a custom data source / data set.
    • body CustomMetric
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

analytics.management.customMetrics.update

Updates an existing custom metric.

google_analytics.analytics.management.customMetrics.update({
  "accountId": "",
  "webPropertyId": "",
  "customMetricId": ""
}, context)

Input

  • input object
    • accountId required string: Account ID for the custom metric to update.
    • webPropertyId required string: Web property ID for the custom metric to update.
    • customMetricId required string: Custom metric ID for the custom metric to update.
    • ignoreCustomDataSourceLinks boolean: Force the update and ignore any warnings related to the custom metric being linked to a custom data source / data set.
    • body CustomMetric
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

analytics.management.webPropertyAdWordsLinks.list

Lists webProperty-Google Ads links for a given web property.

google_analytics.analytics.management.webPropertyAdWordsLinks.list({
  "accountId": "",
  "webPropertyId": ""
}, context)

Input

  • input object
    • accountId required string: ID of the account which the given web property belongs to.
    • webPropertyId required string: Web property ID to retrieve the Google Ads links for.
    • max-results integer: The maximum number of webProperty-Google Ads links to include in this response.
    • start-index integer: An index of the first webProperty-Google Ads link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

analytics.management.webPropertyAdWordsLinks.insert

Creates a webProperty-Google Ads link.

google_analytics.analytics.management.webPropertyAdWordsLinks.insert({
  "accountId": "",
  "webPropertyId": ""
}, context)

Input

  • input object
    • accountId required string: ID of the Google Analytics account to create the link for.
    • webPropertyId required string: Web property ID to create the link for.
    • body EntityAdWordsLink
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

analytics.management.webPropertyAdWordsLinks.delete

Deletes a web property-Google Ads link.

google_analytics.analytics.management.webPropertyAdWordsLinks.delete({
  "accountId": "",
  "webPropertyId": "",
  "webPropertyAdWordsLinkId": ""
}, context)

Input

  • input object
    • accountId required string: ID of the account which the given web property belongs to.
    • webPropertyId required string: Web property ID to delete the Google Ads link for.
    • webPropertyAdWordsLinkId required string: Web property Google Ads link ID.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

Output schema unknown

analytics.management.webPropertyAdWordsLinks.get

Returns a web property-Google Ads link to which the user has access.

google_analytics.analytics.management.webPropertyAdWordsLinks.get({
  "accountId": "",
  "webPropertyId": "",
  "webPropertyAdWordsLinkId": ""
}, context)

Input

  • input object
    • accountId required string: ID of the account which the given web property belongs to.
    • webPropertyId required string: Web property ID to retrieve the Google Ads link for.
    • webPropertyAdWordsLinkId required string: Web property-Google Ads link ID.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

analytics.management.webPropertyAdWordsLinks.patch

Updates an existing webProperty-Google Ads link. This method supports patch semantics.

google_analytics.analytics.management.webPropertyAdWordsLinks.patch({
  "accountId": "",
  "webPropertyId": "",
  "webPropertyAdWordsLinkId": ""
}, context)

Input

  • input object
    • accountId required string: ID of the account which the given web property belongs to.
    • webPropertyId required string: Web property ID to retrieve the Google Ads link for.
    • webPropertyAdWordsLinkId required string: Web property-Google Ads link ID.
    • body EntityAdWordsLink
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

analytics.management.webPropertyAdWordsLinks.update

Updates an existing webProperty-Google Ads link.

google_analytics.analytics.management.webPropertyAdWordsLinks.update({
  "accountId": "",
  "webPropertyId": "",
  "webPropertyAdWordsLinkId": ""
}, context)

Input

  • input object
    • accountId required string: ID of the account which the given web property belongs to.
    • webPropertyId required string: Web property ID to retrieve the Google Ads link for.
    • webPropertyAdWordsLinkId required string: Web property-Google Ads link ID.
    • body EntityAdWordsLink
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

analytics.management.webpropertyUserLinks.list

Lists webProperty-user links for a given web property.

google_analytics.analytics.management.webpropertyUserLinks.list({
  "accountId": "",
  "webPropertyId": ""
}, context)

Input

  • input object
    • accountId required string: Account ID which the given web property belongs to.
    • webPropertyId required string: Web Property ID for the webProperty-user links to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to.
    • max-results integer: The maximum number of webProperty-user Links to include in this response.
    • start-index integer: An index of the first webProperty-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

analytics.management.webpropertyUserLinks.insert

Adds a new user to the given web property.

google_analytics.analytics.management.webpropertyUserLinks.insert({
  "accountId": "",
  "webPropertyId": ""
}, context)

Input

  • input object
    • accountId required string: Account ID to create the user link for.
    • webPropertyId required string: Web Property ID to create the user link for.
    • body EntityUserLink
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

analytics.management.webpropertyUserLinks.delete

Removes a user from the given web property.

google_analytics.analytics.management.webpropertyUserLinks.delete({
  "accountId": "",
  "webPropertyId": "",
  "linkId": ""
}, context)

Input

  • input object
    • accountId required string: Account ID to delete the user link for.
    • webPropertyId required string: Web Property ID to delete the user link for.
    • linkId required string: Link ID to delete the user link for.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

Output schema unknown

analytics.management.webpropertyUserLinks.update

Updates permissions for an existing user on the given web property.

google_analytics.analytics.management.webpropertyUserLinks.update({
  "accountId": "",
  "webPropertyId": "",
  "linkId": ""
}, context)

Input

  • input object
    • accountId required string: Account ID to update the account-user link for.
    • webPropertyId required string: Web property ID to update the account-user link for.
    • linkId required string: Link ID to update the account-user link for.
    • body EntityUserLink
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

analytics.management.profiles.list

Lists views (profiles) to which the user has access.

google_analytics.analytics.management.profiles.list({
  "accountId": "",
  "webPropertyId": ""
}, context)

Input

  • input object
    • accountId required string: Account ID for the view (profiles) to retrieve. Can either be a specific account ID or '~all', which refers to all the accounts to which the user has access.
    • webPropertyId required string: Web property ID for the views (profiles) to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties to which the user has access.
    • max-results integer: The maximum number of views (profiles) to include in this response.
    • start-index integer: An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

analytics.management.profiles.insert

Create a new view (profile).

google_analytics.analytics.management.profiles.insert({
  "accountId": "",
  "webPropertyId": ""
}, context)

Input

  • input object
    • accountId required string: Account ID to create the view (profile) for.
    • webPropertyId required string: Web property ID to create the view (profile) for.
    • body Profile
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

analytics.management.profiles.delete

Deletes a view (profile).

google_analytics.analytics.management.profiles.delete({
  "accountId": "",
  "webPropertyId": "",
  "profileId": ""
}, context)

Input

  • input object
    • accountId required string: Account ID to delete the view (profile) for.
    • webPropertyId required string: Web property ID to delete the view (profile) for.
    • profileId required string: ID of the view (profile) to be deleted.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

Output schema unknown

analytics.management.profiles.get

Gets a view (profile) to which the user has access.

google_analytics.analytics.management.profiles.get({
  "accountId": "",
  "webPropertyId": "",
  "profileId": ""
}, context)

Input

  • input object
    • accountId required string: Account ID to retrieve the view (profile) for.
    • webPropertyId required string: Web property ID to retrieve the view (profile) for.
    • profileId required string: View (Profile) ID to retrieve the view (profile) for.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

analytics.management.profiles.patch

Updates an existing view (profile). This method supports patch semantics.

google_analytics.analytics.management.profiles.patch({
  "accountId": "",
  "webPropertyId": "",
  "profileId": ""
}, context)

Input

  • input object
    • accountId required string: Account ID to which the view (profile) belongs
    • webPropertyId required string: Web property ID to which the view (profile) belongs
    • profileId required string: ID of the view (profile) to be