blob: 944f2843cf9ce0011310c98c4185e673cdf72b8e [file] [log] [blame]
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/analytics": {
"description": "View and manage your Google Analytics data"
},
"https://www.googleapis.com/auth/analytics.edit": {
"description": "Edit Google Analytics management entities"
},
"https://www.googleapis.com/auth/analytics.manage.users": {
"description": "Manage Google Analytics Account users by email address"
},
"https://www.googleapis.com/auth/analytics.manage.users.readonly": {
"description": "View Google Analytics user permissions"
},
"https://www.googleapis.com/auth/analytics.provision": {
"description": "Create a new Google Analytics account along with its default property and view"
},
"https://www.googleapis.com/auth/analytics.readonly": {
"description": "View your Google Analytics data"
},
"https://www.googleapis.com/auth/analytics.user.deletion": {
"description": "Manage Google Analytics user deletion requests"
}
}
}
},
"basePath": "/analytics/v3/",
"baseUrl": "https://www.googleapis.com/analytics/v3/",
"batchPath": "batch/analytics/v3",
"description": "Views and manages your Google Analytics data.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/analytics/",
"etag": "\"J3WqvAcMk4eQjJXvfSI4Yr8VouA/ICz6S7dLg1NqZR9DoI37oXz6hEo\"",
"icons": {
"x16": "https://www.google.com/images/icons/product/analytics-16.png",
"x32": "https://www.google.com/images/icons/product/analytics-32.png"
},
"id": "analytics:v3",
"kind": "discovery#restDescription",
"name": "analytics",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"alt": {
"default": "json",
"description": "Data format for the response.",
"enum": [
"json"
],
"enumDescriptions": [
"Responses with Content-Type of application/json"
],
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "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.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "false",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"location": "query",
"type": "string"
},
"userIp": {
"description": "Deprecated. Please use quotaUser instead.",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"data": {
"resources": {
"ga": {
"methods": {
"get": {
"description": "Returns Analytics data for a view (profile).",
"httpMethod": "GET",
"id": "analytics.data.ga.get",
"parameterOrder": [
"ids",
"start-date",
"end-date",
"metrics"
],
"parameters": {
"dimensions": {
"description": "A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'.",
"location": "query",
"pattern": "(ga:.+)?",
"type": "string"
},
"end-date": {
"description": "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.",
"location": "query",
"pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}|today|yesterday|[0-9]+(daysAgo)",
"required": true,
"type": "string"
},
"filters": {
"description": "A comma-separated list of dimension or metric filters to be applied to Analytics data.",
"location": "query",
"pattern": "ga:.+",
"type": "string"
},
"ids": {
"description": "Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.",
"location": "query",
"pattern": "ga:[0-9]+",
"required": true,
"type": "string"
},
"include-empty-rows": {
"description": "The response will include empty rows if this parameter is set to true, the default is true",
"location": "query",
"type": "boolean"
},
"max-results": {
"description": "The maximum number of entries to include in this feed.",
"format": "int32",
"location": "query",
"type": "integer"
},
"metrics": {
"description": "A comma-separated list of Analytics metrics. E.g., 'ga:sessions,ga:pageviews'. At least one metric must be specified.",
"location": "query",
"pattern": "ga:.+",
"required": true,
"type": "string"
},
"output": {
"description": "The selected format for the response. Default format is JSON.",
"enum": [
"dataTable",
"json"
],
"enumDescriptions": [
"Returns the response in Google Charts Data Table format. This is useful in creating visualization using Google Charts.",
"Returns the response in standard JSON format."
],
"location": "query",
"type": "string"
},
"samplingLevel": {
"description": "The desired sampling level.",
"enum": [
"DEFAULT",
"FASTER",
"HIGHER_PRECISION"
],
"enumDescriptions": [
"Returns response with a sample size that balances speed and accuracy.",
"Returns a fast response with a smaller sample size.",
"Returns a more accurate response using a large sample size, but this may result in the response being slower."
],
"location": "query",
"type": "string"
},
"segment": {
"description": "An Analytics segment to be applied to data.",
"location": "query",
"type": "string"
},
"sort": {
"description": "A comma-separated list of dimensions or metrics that determine the sort order for Analytics data.",
"location": "query",
"pattern": "(-)?ga:.+",
"type": "string"
},
"start-date": {
"description": "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.",
"location": "query",
"pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}|today|yesterday|[0-9]+(daysAgo)",
"required": true,
"type": "string"
},
"start-index": {
"description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
"format": "int32",
"location": "query",
"minimum": "1",
"type": "integer"
}
},
"path": "data/ga",
"response": {
"$ref": "GaData"
},
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.readonly"
]
}
}
},
"mcf": {
"methods": {
"get": {
"description": "Returns Analytics Multi-Channel Funnels data for a view (profile).",
"httpMethod": "GET",
"id": "analytics.data.mcf.get",
"parameterOrder": [
"ids",
"start-date",
"end-date",
"metrics"
],
"parameters": {
"dimensions": {
"description": "A comma-separated list of Multi-Channel Funnels dimensions. E.g., 'mcf:source,mcf:medium'.",
"location": "query",
"pattern": "(mcf:.+)?",
"type": "string"
},
"end-date": {
"description": "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.",
"location": "query",
"pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}|today|yesterday|[0-9]+(daysAgo)",
"required": true,
"type": "string"
},
"filters": {
"description": "A comma-separated list of dimension or metric filters to be applied to the Analytics data.",
"location": "query",
"pattern": "mcf:.+",
"type": "string"
},
"ids": {
"description": "Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.",
"location": "query",
"pattern": "ga:[0-9]+",
"required": true,
"type": "string"
},
"max-results": {
"description": "The maximum number of entries to include in this feed.",
"format": "int32",
"location": "query",
"type": "integer"
},
"metrics": {
"description": "A comma-separated list of Multi-Channel Funnels metrics. E.g., 'mcf:totalConversions,mcf:totalConversionValue'. At least one metric must be specified.",
"location": "query",
"pattern": "mcf:.+",
"required": true,
"type": "string"
},
"samplingLevel": {
"description": "The desired sampling level.",
"enum": [
"DEFAULT",
"FASTER",
"HIGHER_PRECISION"
],
"enumDescriptions": [
"Returns response with a sample size that balances speed and accuracy.",
"Returns a fast response with a smaller sample size.",
"Returns a more accurate response using a large sample size, but this may result in the response being slower."
],
"location": "query",
"type": "string"
},
"sort": {
"description": "A comma-separated list of dimensions or metrics that determine the sort order for the Analytics data.",
"location": "query",
"pattern": "(-)?mcf:.+",
"type": "string"
},
"start-date": {
"description": "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.",
"location": "query",
"pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}|today|yesterday|[0-9]+(daysAgo)",
"required": true,
"type": "string"
},
"start-index": {
"description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
"format": "int32",
"location": "query",
"minimum": "1",
"type": "integer"
}
},
"path": "data/mcf",
"response": {
"$ref": "McfData"
},
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.readonly"
]
}
}
},
"realtime": {
"methods": {
"get": {
"description": "Returns real time data for a view (profile).",
"httpMethod": "GET",
"id": "analytics.data.realtime.get",
"parameterOrder": [
"ids",
"metrics"
],
"parameters": {
"dimensions": {
"description": "A comma-separated list of real time dimensions. E.g., 'rt:medium,rt:city'.",
"location": "query",
"pattern": "(ga:.+)|(rt:.+)",
"type": "string"
},
"filters": {
"description": "A comma-separated list of dimension or metric filters to be applied to real time data.",
"location": "query",
"pattern": "(ga:.+)|(rt:.+)",
"type": "string"
},
"ids": {
"description": "Unique table ID for retrieving real time data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.",
"location": "query",
"pattern": "ga:[0-9]+",
"required": true,
"type": "string"
},
"max-results": {
"description": "The maximum number of entries to include in this feed.",
"format": "int32",
"location": "query",
"type": "integer"
},
"metrics": {
"description": "A comma-separated list of real time metrics. E.g., 'rt:activeUsers'. At least one metric must be specified.",
"location": "query",
"pattern": "(ga:.+)|(rt:.+)",
"required": true,
"type": "string"
},
"sort": {
"description": "A comma-separated list of dimensions or metrics that determine the sort order for real time data.",
"location": "query",
"pattern": "(-)?((ga:.+)|(rt:.+))",
"type": "string"
}
},
"path": "data/realtime",
"response": {
"$ref": "RealtimeData"
},
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.readonly"
]
}
}
}
}
},
"management": {
"resources": {
"accountSummaries": {
"methods": {
"list": {
"description": "Lists account summaries (lightweight tree comprised of accounts/properties/profiles) to which the user has access.",
"httpMethod": "GET",
"id": "analytics.management.accountSummaries.list",
"parameters": {
"max-results": {
"description": "The maximum number of account summaries to include in this response, where the largest acceptable value is 1000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"start-index": {
"description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
"format": "int32",
"location": "query",
"minimum": "1",
"type": "integer"
}
},
"path": "management/accountSummaries",
"response": {
"$ref": "AccountSummaries"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
]
}
}
},
"accountUserLinks": {
"methods": {
"delete": {
"description": "Removes a user from the given account.",
"httpMethod": "DELETE",
"id": "analytics.management.accountUserLinks.delete",
"parameterOrder": [
"accountId",
"linkId"
],
"parameters": {
"accountId": {
"description": "Account ID to delete the user link for.",
"location": "path",
"required": true,
"type": "string"
},
"linkId": {
"description": "Link ID to delete the user link for.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "management/accounts/{accountId}/entityUserLinks/{linkId}",
"scopes": [
"https://www.googleapis.com/auth/analytics.manage.users"
]
},
"insert": {
"description": "Adds a new user to the given account.",
"httpMethod": "POST",
"id": "analytics.management.accountUserLinks.insert",
"parameterOrder": [
"accountId"
],
"parameters": {
"accountId": {
"description": "Account ID to create the user link for.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "management/accounts/{accountId}/entityUserLinks",
"request": {
"$ref": "EntityUserLink"
},
"response": {
"$ref": "EntityUserLink"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.manage.users"
]
},
"list": {
"description": "Lists account-user links for a given account.",
"httpMethod": "GET",
"id": "analytics.management.accountUserLinks.list",
"parameterOrder": [
"accountId"
],
"parameters": {
"accountId": {
"description": "Account ID to retrieve the user links for.",
"location": "path",
"required": true,
"type": "string"
},
"max-results": {
"description": "The maximum number of account-user links to include in this response.",
"format": "int32",
"location": "query",
"type": "integer"
},
"start-index": {
"description": "An index of the first account-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
"format": "int32",
"location": "query",
"minimum": "1",
"type": "integer"
}
},
"path": "management/accounts/{accountId}/entityUserLinks",
"response": {
"$ref": "EntityUserLinks"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.manage.users",
"https://www.googleapis.com/auth/analytics.manage.users.readonly"
]
},
"update": {
"description": "Updates permissions for an existing user on the given account.",
"httpMethod": "PUT",
"id": "analytics.management.accountUserLinks.update",
"parameterOrder": [
"accountId",
"linkId"
],
"parameters": {
"accountId": {
"description": "Account ID to update the account-user link for.",
"location": "path",
"required": true,
"type": "string"
},
"linkId": {
"description": "Link ID to update the account-user link for.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "management/accounts/{accountId}/entityUserLinks/{linkId}",
"request": {
"$ref": "EntityUserLink"
},
"response": {
"$ref": "EntityUserLink"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.manage.users"
]
}
}
},
"accounts": {
"methods": {
"list": {
"description": "Lists all accounts to which the user has access.",
"httpMethod": "GET",
"id": "analytics.management.accounts.list",
"parameters": {
"max-results": {
"description": "The maximum number of accounts to include in this response.",
"format": "int32",
"location": "query",
"type": "integer"
},
"start-index": {
"description": "An index of the first account to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
"format": "int32",
"location": "query",
"minimum": "1",
"type": "integer"
}
},
"path": "management/accounts",
"response": {
"$ref": "Accounts"
},
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
]
}
}
},
"clientId": {
"methods": {
"hashClientId": {
"description": "Hashes the given Client ID.",
"httpMethod": "POST",
"id": "analytics.management.clientId.hashClientId",
"path": "management/clientId:hashClientId",
"request": {
"$ref": "HashClientIdRequest"
},
"response": {
"$ref": "HashClientIdResponse"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
]
}
}
},
"customDataSources": {
"methods": {
"list": {
"description": "List custom data sources to which the user has access.",
"httpMethod": "GET",
"id": "analytics.management.customDataSources.list",
"parameterOrder": [
"accountId",
"webPropertyId"
],
"parameters": {
"accountId": {
"description": "Account Id for the custom data sources to retrieve.",
"location": "path",
"pattern": "\\d+",
"required": true,
"type": "string"
},
"max-results": {
"description": "The maximum number of custom data sources to include in this response.",
"format": "int32",
"location": "query",
"minimum": "1",
"type": "integer"
},
"start-index": {
"description": "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.",
"format": "int32",
"location": "query",
"minimum": "1",
"type": "integer"
},
"webPropertyId": {
"description": "Web property Id for the custom data sources to retrieve.",
"location": "path",
"pattern": "UA-(\\d+)-(\\d+)",
"required": true,
"type": "string"
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources",
"response": {
"$ref": "CustomDataSources"
},
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
]
}
}
},
"customDimensions": {
"methods": {
"get": {
"description": "Get a custom dimension to which the user has access.",
"httpMethod": "GET",
"id": "analytics.management.customDimensions.get",
"parameterOrder": [
"accountId",
"webPropertyId",
"customDimensionId"
],
"parameters": {
"accountId": {
"description": "Account ID for the custom dimension to retrieve.",
"location": "path",
"required": true,
"type": "string"
},
"customDimensionId": {
"description": "The ID of the custom dimension to retrieve.",
"location": "path",
"required": true,
"type": "string"
},
"webPropertyId": {
"description": "Web property ID for the custom dimension to retrieve.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions/{customDimensionId}",
"response": {
"$ref": "CustomDimension"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
]
},
"insert": {
"description": "Create a new custom dimension.",
"httpMethod": "POST",
"id": "analytics.management.customDimensions.insert",
"parameterOrder": [
"accountId",
"webPropertyId"
],
"parameters": {
"accountId": {
"description": "Account ID for the custom dimension to create.",
"location": "path",
"required": true,
"type": "string"
},
"webPropertyId": {
"description": "Web property ID for the custom dimension to create.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions",
"request": {
"$ref": "CustomDimension"
},
"response": {
"$ref": "CustomDimension"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
]
},
"list": {
"description": "Lists custom dimensions to which the user has access.",
"httpMethod": "GET",
"id": "analytics.management.customDimensions.list",
"parameterOrder": [
"accountId",
"webPropertyId"
],
"parameters": {
"accountId": {
"description": "Account ID for the custom dimensions to retrieve.",
"location": "path",
"required": true,
"type": "string"
},
"max-results": {
"description": "The maximum number of custom dimensions to include in this response.",
"format": "int32",
"location": "query",
"type": "integer"
},
"start-index": {
"description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
"format": "int32",
"location": "query",
"minimum": "1",
"type": "integer"
},
"webPropertyId": {
"description": "Web property ID for the custom dimensions to retrieve.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions",
"response": {
"$ref": "CustomDimensions"
},
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.readonly"
]
},
"patch": {
"description": "Updates an existing custom dimension. This method supports patch semantics.",
"httpMethod": "PATCH",
"id": "analytics.management.customDimensions.patch",
"parameterOrder": [
"accountId",
"webPropertyId",
"customDimensionId"
],
"parameters": {
"accountId": {
"description": "Account ID for the custom dimension to update.",
"location": "path",
"required": true,
"type": "string"
},
"customDimensionId": {
"description": "Custom dimension ID for the custom dimension to update.",
"location": "path",
"required": true,
"type": "string"
},
"ignoreCustomDataSourceLinks": {
"default": "false",
"description": "Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set.",
"location": "query",
"type": "boolean"
},
"webPropertyId": {
"description": "Web property ID for the custom dimension to update.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions/{customDimensionId}",
"request": {
"$ref": "CustomDimension"
},
"response": {
"$ref": "CustomDimension"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
]
},
"update": {
"description": "Updates an existing custom dimension.",
"httpMethod": "PUT",
"id": "analytics.management.customDimensions.update",
"parameterOrder": [
"accountId",
"webPropertyId",
"customDimensionId"
],
"parameters": {
"accountId": {
"description": "Account ID for the custom dimension to update.",
"location": "path",
"required": true,
"type": "string"
},
"customDimensionId": {
"description": "Custom dimension ID for the custom dimension to update.",
"location": "path",
"required": true,
"type": "string"
},
"ignoreCustomDataSourceLinks": {
"default": "false",
"description": "Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set.",
"location": "query",
"type": "boolean"
},
"webPropertyId": {
"description": "Web property ID for the custom dimension to update.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions/{customDimensionId}",
"request": {
"$ref": "CustomDimension"
},
"response": {
"$ref": "CustomDimension"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
]
}
}
},
"customMetrics": {
"methods": {
"get": {
"description": "Get a custom metric to which the user has access.",
"httpMethod": "GET",
"id": "analytics.management.customMetrics.get",
"parameterOrder": [
"accountId",
"webPropertyId",
"customMetricId"
],
"parameters": {
"accountId": {
"description": "Account ID for the custom metric to retrieve.",
"location": "path",
"required": true,
"type": "string"
},
"customMetricId": {
"description": "The ID of the custom metric to retrieve.",
"location": "path",
"required": true,
"type": "string"
},
"webPropertyId": {
"description": "Web property ID for the custom metric to retrieve.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics/{customMetricId}",
"response": {
"$ref": "CustomMetric"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
]
},
"insert": {
"description": "Create a new custom metric.",
"httpMethod": "POST",
"id": "analytics.management.customMetrics.insert",
"parameterOrder": [
"accountId",
"webPropertyId"
],
"parameters": {
"accountId": {
"description": "Account ID for the custom metric to create.",
"location": "path",
"required": true,
"type": "string"
},
"webPropertyId": {
"description": "Web property ID for the custom dimension to create.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics",
"request": {
"$ref": "CustomMetric"
},
"response": {
"$ref": "CustomMetric"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
]
},
"list": {
"description": "Lists custom metrics to which the user has access.",
"httpMethod": "GET",
"id": "analytics.management.customMetrics.list",
"parameterOrder": [
"accountId",
"webPropertyId"
],
"parameters": {
"accountId": {
"description": "Account ID for the custom metrics to retrieve.",
"location": "path",
"required": true,
"type": "string"
},
"max-results": {
"description": "The maximum number of custom metrics to include in this response.",
"format": "int32",
"location": "query",
"type": "integer"
},
"start-index": {
"description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
"format": "int32",
"location": "query",
"minimum": "1",
"type": "integer"
},
"webPropertyId": {
"description": "Web property ID for the custom metrics to retrieve.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics",
"response": {
"$ref": "CustomMetrics"
},
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.readonly"
]
},
"patch": {
"description": "Updates an existing custom metric. This method supports patch semantics.",
"httpMethod": "PATCH",
"id": "analytics.management.customMetrics.patch",
"parameterOrder": [
"accountId",
"webPropertyId",
"customMetricId"
],
"parameters": {
"accountId": {
"description": "Account ID for the custom metric to update.",
"location": "path",
"required": true,
"type": "string"
},
"customMetricId": {
"description": "Custom metric ID for the custom metric to update.",
"location": "path",
"required": true,
"type": "string"
},
"ignoreCustomDataSourceLinks": {
"default": "false",
"description": "Force the update and ignore any warnings related to the custom metric being linked to a custom data source / data set.",
"location": "query",
"type": "boolean"
},
"webPropertyId": {
"description": "Web property ID for the custom metric to update.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics/{customMetricId}",
"request": {
"$ref": "CustomMetric"
},
"response": {
"$ref": "CustomMetric"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
]
},
"update": {
"description": "Updates an existing custom metric.",
"httpMethod": "PUT",
"id": "analytics.management.customMetrics.update",
"parameterOrder": [
"accountId",
"webPropertyId",
"customMetricId"
],
"parameters": {
"accountId": {
"description": "Account ID for the custom metric to update.",
"location": "path",
"required": true,
"type": "string"
},
"customMetricId": {
"description": "Custom metric ID for the custom metric to update.",
"location": "path",
"required": true,
"type": "string"
},
"ignoreCustomDataSourceLinks": {
"default": "false",
"description": "Force the update and ignore any warnings related to the custom metric being linked to a custom data source / data set.",
"location": "query",
"type": "boolean"
},
"webPropertyId": {
"description": "Web property ID for the custom metric to update.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics/{customMetricId}",
"request": {
"$ref": "CustomMetric"
},
"response": {
"$ref": "CustomMetric"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
]
}
}
},
"experiments": {
"methods": {
"delete": {
"description": "Delete an experiment.",
"httpMethod": "DELETE",
"id": "analytics.management.experiments.delete",
"parameterOrder": [
"accountId",
"webPropertyId",
"profileId",
"experimentId"
],
"parameters": {
"accountId": {
"description": "Account ID to which the experiment belongs",
"location": "path",
"required": true,
"type": "string"
},
"experimentId": {
"description": "ID of the experiment to delete",
"location": "path",
"required": true,
"type": "string"
},
"profileId": {
"description": "View (Profile) ID to which the experiment belongs",
"location": "path",
"required": true,
"type": "string"
},
"webPropertyId": {
"description": "Web property ID to which the experiment belongs",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}",
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.edit"
]
},
"get": {
"description": "Returns an experiment to which the user has access.",
"httpMethod": "GET",
"id": "analytics.management.experiments.get",
"parameterOrder": [
"accountId",
"webPropertyId",
"profileId",
"experimentId"
],
"parameters": {
"accountId": {
"description": "Account ID to retrieve the experiment for.",
"location": "path",
"required": true,
"type": "string"
},
"experimentId": {
"description": "Experiment ID to retrieve the experiment for.",
"location": "path",
"required": true,
"type": "string"
},
"profileId": {
"description": "View (Profile) ID to retrieve the experiment for.",
"location": "path",
"required": true,
"type": "string"
},
"webPropertyId": {
"description": "Web property ID to retrieve the experiment for.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}",
"response": {
"$ref": "Experiment"
},
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
]
},
"insert": {
"description": "Create a new experiment.",
"httpMethod": "POST",
"id": "analytics.management.experiments.insert",
"parameterOrder": [
"accountId",
"webPropertyId",
"profileId"
],
"parameters": {
"accountId": {
"description": "Account ID to create the experiment for.",
"location": "path",
"required": true,
"type": "string"
},
"profileId": {
"description": "View (Profile) ID to create the experiment for.",
"location": "path",
"required": true,
"type": "string"
},
"webPropertyId": {
"description": "Web property ID to create the experiment for.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments",
"request": {
"$ref": "Experiment"
},
"response": {
"$ref": "Experiment"
},
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.edit"
]
},
"list": {
"description": "Lists experiments to which the user has access.",
"httpMethod": "GET",
"id": "analytics.management.experiments.list",
"parameterOrder": [
"accountId",
"webPropertyId",
"profileId"
],
"parameters": {
"accountId": {
"description": "Account ID to retrieve experiments for.",
"location": "path",
"pattern": "\\d+",
"required": true,
"type": "string"
},
"max-results": {
"description": "The maximum number of experiments to include in this response.",
"format": "int32",
"location": "query",
"type": "integer"
},
"profileId": {
"description": "View (Profile) ID to retrieve experiments for.",
"location": "path",
"pattern": "\\d+",
"required": true,
"type": "string"
},
"start-index": {
"description": "An index of the first experiment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
"format": "int32",
"location": "query",
"minimum": "1",
"type": "integer"
},
"webPropertyId": {
"description": "Web property ID to retrieve experiments for.",
"location": "path",
"pattern": "UA-(\\d+)-(\\d+)",
"required": true,
"type": "string"
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments",
"response": {
"$ref": "Experiments"
},
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
]
},
"patch": {
"description": "Update an existing experiment. This method supports patch semantics.",
"httpMethod": "PATCH",
"id": "analytics.management.experiments.patch",
"parameterOrder": [
"accountId",
"webPropertyId",
"profileId",
"experimentId"
],
"parameters": {
"accountId": {
"description": "Account ID of the experiment to update.",
"location": "path",
"required": true,
"type": "string"
},
"experimentId": {
"description": "Experiment ID of the experiment to update.",
"location": "path",
"required": true,
"type": "string"
},
"profileId": {
"description": "View (Profile) ID of the experiment to update.",
"location": "path",
"required": true,
"type": "string"
},
"webPropertyId": {
"description": "Web property ID of the experiment to update.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}",
"request": {
"$ref": "Experiment"
},
"response": {
"$ref": "Experiment"
},
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.edit"
]
},
"update": {
"description": "Update an existing experiment.",
"httpMethod": "PUT",
"id": "analytics.management.experiments.update",
"parameterOrder": [
"accountId",
"webPropertyId",
"profileId",
"experimentId"
],
"parameters": {
"accountId": {
"description": "Account ID of the experiment to update.",
"location": "path",
"required": true,
"type": "string"
},
"experimentId": {
"description": "Experiment ID of the experiment to update.",
"location": "path",
"required": true,
"type": "string"
},
"profileId": {
"description": "View (Profile) ID of the experiment to update.",
"location": "path",
"required": true,
"type": "string"
},
"webPropertyId": {
"description": "Web property ID of the experiment to update.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}",
"request": {
"$ref": "Experiment"
},
"response": {
"$ref": "Experiment"
},
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.edit"
]
}
}
},
"filters": {
"methods": {
"delete": {
"description": "Delete a filter.",
"httpMethod": "DELETE",
"id": "analytics.management.filters.delete",
"parameterOrder": [
"accountId",
"filterId"
],
"parameters": {
"accountId": {
"description": "Account ID to delete the filter for.",
"location": "path",
"required": true,
"type": "string"
},
"filterId": {
"description": "ID of the filter to be deleted.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "management/accounts/{accountId}/filters/{filterId}",
"response": {
"$ref": "Filter"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
]
},
"get": {
"description": "Returns a filters to which the user has access.",
"httpMethod": "GET",
"id": "analytics.management.filters.get",
"parameterOrder": [
"accountId",
"filterId"
],
"parameters": {
"accountId": {
"description": "Account ID to retrieve filters for.",
"location": "path",
"required": true,
"type": "string"
},
"filterId": {
"description": "Filter ID to retrieve filters for.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "management/accounts/{accountId}/filters/{filterId}",
"response": {
"$ref": "Filter"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
]
},
"insert": {
"description": "Create a new filter.",
"httpMethod": "POST",
"id": "analytics.management.filters.insert",
"parameterOrder": [
"accountId"
],
"parameters": {
"accountId": {
"description": "Account ID to create filter for.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "management/accounts/{accountId}/filters",
"request": {
"$ref": "Filter"
},
"response": {
"$ref": "Filter"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
]
},
"list": {
"description": "Lists all filters for an account",
"httpMethod": "GET",
"id": "analytics.management.filters.list",
"parameterOrder": [
"accountId"
],
"parameters": {
"accountId": {
"description": "Account ID to retrieve filters for.",
"location": "path",
"pattern": "\\d+",
"required": true,
"type": "string"
},
"max-results": {
"description": "The maximum number of filters to include in this response.",
"format": "int32",
"location": "query",
"type": "integer"
},
"start-index": {
"description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
"format": "int32",
"location": "query",
"minimum": "1",
"type": "integer"
}
},
"path": "management/accounts/{accountId}/filters",
"response": {
"$ref": "Filters"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
]
},
"patch": {
"description": "Updates an existing filter. This method supports patch semantics.",
"httpMethod": "PATCH",
"id": "analytics.management.filters.patch",
"parameterOrder": [
"accountId",
"filterId"
],
"parameters": {
"accountId": {
"description": "Account ID to which the filter belongs.",
"location": "path",
"required": true,
"type": "string"
},
"filterId": {
"description": "ID of the filter to be updated.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "management/accounts/{accountId}/filters/{filterId}",
"request": {
"$ref": "Filter"
},
"response": {
"$ref": "Filter"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
]
},
"update": {
"description": "Updates an existing filter.",
"httpMethod": "PUT",
"id": "analytics.management.filters.update",
"parameterOrder": [
"accountId",
"filterId"
],
"parameters": {
"accountId": {
"description": "Account ID to which the filter belongs.",
"location": "path",
"required": true,
"type": "string"
},
"filterId": {
"description": "ID of the filter to be updated.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "management/accounts/{accountId}/filters/{filterId}",
"request": {
"$ref": "Filter"
},
"response": {
"$ref": "Filter"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
]
}
}
},
"goals": {
"methods": {
"get": {
"description": "Gets a goal to which the user has access.",
"httpMethod": "GET",
"id": "analytics.management.goals.get",
"parameterOrder": [
"accountId",
"webPropertyId",
"profileId",
"goalId"
],
"parameters": {
"accountId": {
"description": "Account ID to retrieve the goal for.",
"location": "path",
"required": true,
"type": "string"
},
"goalId": {
"description": "Goal ID to retrieve the goal for.",
"location": "path",
"required": true,
"type": "string"
},
"profileId": {
"description": "View (Profile) ID to retrieve the goal for.",
"location": "path",
"required": true,
"type": "string"
},
"webPropertyId": {
"description": "Web property ID to retrieve the goal for.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals/{goalId}",
"response": {
"$ref": "Goal"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
]
},
"insert": {
"description": "Create a new goal.",
"httpMethod": "POST",
"id": "analytics.management.goals.insert",
"parameterOrder": [
"accountId",
"webPropertyId",
"profileId"
],
"parameters": {
"accountId": {
"description": "Account ID to create the goal for.",
"location": "path",
"required": true,
"type": "string"
},
"profileId": {
"description": "View (Profile) ID to create the goal for.",
"location": "path",
"required": true,
"type": "string"
},
"webPropertyId": {
"description": "Web property ID to create the goal for.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals",
"request": {
"$ref": "Goal"
},
"response": {
"$ref": "Goal"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
]
},
"list": {
"description": "Lists goals to which the user has access.",
"httpMethod": "GET",
"id": "analytics.management.goals.list",
"parameterOrder": [
"accountId",
"webPropertyId",
"profileId"
],
"parameters": {
"accountId": {
"description": "Account ID to retrieve goals for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to.",
"location": "path",
"required": true,
"type": "string"
},
"max-results": {
"description": "The maximum number of goals to include in this response.",
"format": "int32",
"location": "query",
"type": "integer"
},
"profileId": {
"description": "View (Profile) ID to retrieve goals for. Can either be a specific view (profile) ID or '~all', which refers to all the views (profiles) that user has access to.",
"location": "path",
"required": true,
"type": "string"
},
"start-index": {
"description": "An index of the first goal to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
"format": "int32",
"location": "query",
"minimum": "1",
"type": "integer"
},
"webPropertyId": {
"description": "Web property ID to retrieve goals for. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals",
"response": {
"$ref": "Goals"
},
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
]
},
"patch": {
"description": "Updates an existing goal. This method supports patch semantics.",
"httpMethod": "PATCH",
"id": "analytics.management.goals.patch",
"parameterOrder": [
"accountId",
"webPropertyId",
"profileId",
"goalId"
],
"parameters": {
"accountId": {
"description": "Account ID to update the goal.",
"location": "path",
"required": true,
"type": "string"
},
"goalId": {
"description": "Index of the goal to be updated.",
"location": "path",
"required": true,
"type": "string"
},
"profileId": {
"description": "View (Profile) ID to update the goal.",
"location": "path",
"required": true,
"type": "string"
},
"webPropertyId": {
"description": "Web property ID to update the goal.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals/{goalId}",
"request": {
"$ref": "Goal"
},
"response": {
"$ref": "Goal"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
]
},
"update": {
"description": "Updates an existing goal.",
"httpMethod": "PUT",
"id": "analytics.management.goals.update",
"parameterOrder": [
"accountId",
"webPropertyId",
"profileId",
"goalId"
],
"parameters": {
"accountId": {
"description": "Account ID to update the goal.",
"location": "path",
"required": true,
"type": "string"
},
"goalId": {
"description": "Index of the goal to be updated.",
"location": "path",
"required": true,
"type": "string"
},
"profileId": {
"description": "View (Profile) ID to update the goal.",
"location": "path",
"required": true,
"type": "string"
},
"webPropertyId": {
"description": "Web property ID to update the goal.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals/{goalId}",
"request": {
"$ref": "Goal"
},
"response": {
"$ref": "Goal"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
]
}
}
},
"profileFilterLinks": {
"methods": {
"delete": {
"description": "Delete a profile filter link.",
"httpMethod": "DELETE",
"id": "analytics.management.profileFilterLinks.delete",
"parameterOrder": [
"accountId",
"webPropertyId",
"profileId",
"linkId"
],
"parameters": {
"accountId": {
"description": "Account ID to which the profile filter link belongs.",
"location": "path",
"pattern": "\\d+",
"required": true,
"type": "string"
},
"linkId": {
"description": "ID of the profile filter link to delete.",
"location": "path",
"pattern": "\\d+:\\d+",
"required": true,
"type": "string"
},
"profileId": {
"description": "Profile ID to which the filter link belongs.",
"location": "path",
"pattern": "\\d+",
"required": true,
"type": "string"
},
"webPropertyId": {
"description": "Web property Id to which the profile filter link belongs.",
"location": "path",
"pattern": "UA-(\\d+)-(\\d+)",
"required": true,
"type": "string"
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}",
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
]
},
"get": {
"description": "Returns a single profile filter link.",
"httpMethod": "GET",
"id": "analytics.management.profileFilterLinks.get",
"parameterOrder": [
"accountId",
"webPropertyId",
"profileId",
"linkId"
],
"parameters": {
"accountId": {
"description": "Account ID to retrieve profile filter link for.",
"location": "path",
"pattern": "\\d+",
"required": true,
"type": "string"
},
"linkId": {
"description": "ID of the profile filter link.",
"location": "path",
"pattern": "\\d+:\\d+",
"required": true,
"type": "string"
},
"profileId": {
"description": "Profile ID to retrieve filter link for.",
"location": "path",
"pattern": "\\d+",
"required": true,
"type": "string"
},
"webPropertyId": {
"description": "Web property Id to retrieve profile filter link for.",
"location": "path",
"pattern": "UA-(\\d+)-(\\d+)",
"required": true,
"type": "string"
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}",
"response": {
"$ref": "ProfileFilterLink"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
]
},
"insert": {
"description": "Create a new profile filter link.",
"httpMethod": "POST",
"id": "analytics.management.profileFilterLinks.insert",
"parameterOrder": [
"accountId",
"webPropertyId",
"profileId"
],
"parameters": {
"accountId": {
"description": "Account ID to create profile filter link for.",
"location": "path",
"pattern": "\\d+",
"required": true,
"type": "string"
},
"profileId": {
"description": "Profile ID to create filter link for.",
"location": "path",
"pattern": "\\d+",
"required": true,
"type": "string"
},
"webPropertyId": {
"description": "Web property Id to create profile filter link for.",
"location": "path",
"pattern": "UA-(\\d+)-(\\d+)",
"required": true,
"type": "string"
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks",
"request": {
"$ref": "ProfileFilterLink"
},
"response": {
"$ref": "ProfileFilterLink"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
]
},
"list": {
"description": "Lists all profile filter links for a profile.",
"httpMethod": "GET",
"id": "analytics.management.profileFilterLinks.list",
"parameterOrder": [
"accountId",
"webPropertyId",
"profileId"
],
"parameters": {
"accountId": {
"description": "Account ID to retrieve profile filter links for.",
"location": "path",
"pattern": "\\d+",
"required": true,
"type": "string"
},
"max-results": {
"description": "The maximum number of profile filter links to include in this response.",
"format": "int32",
"location": "query",
"type": "integer"
},
"profileId": {
"description": "Profile ID to retrieve filter links for. Can either be a specific profile ID or '~all', which refers to all the profiles that user has access to.",
"location": "path",
"required": true,
"type": "string"
},
"start-index": {
"description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
"format": "int32",
"location": "query",
"minimum": "1",
"type": "integer"
},
"webPropertyId": {
"description": "Web property Id for profile filter links for. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks",
"response": {
"$ref": "ProfileFilterLinks"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
]
},
"patch": {
"description": "Update an existing profile filter link. This method supports patch semantics.",
"httpMethod": "PATCH",
"id": "analytics.management.profileFilterLinks.patch",
"parameterOrder": [
"accountId",
"webPropertyId",
"profileId",
"linkId"
],
"parameters": {
"accountId": {
"description": "Account ID to which profile filter link belongs.",
"location": "path",
"pattern": "\\d+",
"required": true,
"type": "string"
},
"linkId": {
"description": "ID of the profile filter link to be updated.",
"location": "path",
"pattern": "\\d+:\\d+",
"required": true,
"type": "string"
},
"profileId": {
"description": "Profile ID to which filter link belongs",
"location": "path",
"pattern": "\\d+",
"required": true,
"type": "string"
},
"webPropertyId": {
"description": "Web property Id to which profile filter link belongs",
"location": "path",
"pattern": "UA-(\\d+)-(\\d+)",
"required": true,
"type": "string"
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}",
"request": {
"$ref": "ProfileFilterLink"
},
"response": {
"$ref": "ProfileFilterLink"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
]
},
"update": {
"description": "Update an existing profile filter link.",
"httpMethod": "PUT",
"id": "analytics.management.profileFilterLinks.update",
"parameterOrder": [
"accountId",
"webPropertyId",
"profileId",
"linkId"
],
"parameters": {
"accountId": {
"description": "Account ID to which profile filter link belongs.",
"location": "path",
"pattern": "\\d+",
"required": true,
"type": "string"
},
"linkId": {
"description": "ID of the profile filter link to be updated.",
"location": "path",
"pattern": "\\d+:\\d+",
"required": true,
"type": "string"
},
"profileId": {
"description": "Profile ID to which filter link belongs",
"location": "path",
"pattern": "\\d+",
"required": true,
"type": "string"
},
"webPropertyId": {
"description": "Web property Id to which profile filter link belongs",
"location": "path",
"pattern": "UA-(\\d+)-(\\d+)",
"required": true,
"type": "string"
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}",
"request": {
"$ref": "ProfileFilterLink"
},
"response": {
"$ref": "ProfileFilterLink"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
]
}
}
},
"profileUserLinks": {
"methods": {
"delete": {
"description": "Removes a user from the given view (profile).",
"httpMethod": "DELETE",
"id": "analytics.management.profileUserLinks.delete",
"parameterOrder": [
"accountId",
"webPropertyId",
"profileId",
"linkId"
],
"parameters": {
"accountId": {
"description": "Account ID to delete the user link for.",
"location": "path",
"required": true,
"type": "string"
},
"linkId": {
"description": "Link ID to delete the user link for.",
"location": "path",
"required": true,
"type": "string"
},
"profileId": {
"description": "View (Profile) ID to delete the user link for.",
"location": "path",
"required": true,
"type": "string"
},
"webPropertyId": {
"description": "Web Property ID to delete the user link for.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks/{linkId}",
"scopes": [
"https://www.googleapis.com/auth/analytics.manage.users"
]
},
"insert": {
"description": "Adds a new user to the given view (profile).",
"httpMethod": "POST",
"id": "analytics.management.profileUserLinks.insert",
"parameterOrder": [
"accountId",
"webPropertyId",
"profileId"
],
"parameters": {
"accountId": {
"description": "Account ID to create the user link for.",
"location": "path",
"required": true,
"type": "string"
},
"profileId": {
"description": "View (Profile) ID to create the user link for.",
"location": "path",
"required": true,
"type": "string"
},
"webPropertyId": {
"description": "Web Property ID to create the user link for.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks",
"request": {
"$ref": "EntityUserLink"
},
"response": {
"$ref": "EntityUserLink"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.manage.users"
]
},
"list": {
"description": "Lists profile-user links for a given view (profile).",
"httpMethod": "GET",
"id": "analytics.management.profileUserLinks.list",
"parameterOrder": [
"accountId",
"webPropertyId",
"profileId"
],
"parameters": {
"accountId": {
"description": "Account ID which the given view (profile) belongs to.",
"location": "path",
"required": true,
"type": "string"
},
"max-results": {
"description": "The maximum number of profile-user links to include in this response.",
"format": "int32",
"location": "query",
"type": "integer"
},
"profileId": {
"description": "View (Profile) ID to retrieve the profile-user links for. Can either be a specific profile ID or '~all', which refers to all the profiles that user has access to.",
"location": "path",
"required": true,
"type": "string"
},
"start-index": {
"description": "An index of the first profile-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
"format": "int32",
"location": "query",
"minimum": "1",
"type": "integer"
},
"webPropertyId": {
"description": "Web Property ID which the given view (profile) belongs to. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks",
"response": {
"$ref": "EntityUserLinks"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.manage.users",
"https://www.googleapis.com/auth/analytics.manage.users.readonly"
]
},
"update": {
"description": "Updates permissions for an existing user on the given view (profile).",
"httpMethod": "PUT",
"id": "analytics.management.profileUserLinks.update",
"parameterOrder": [
"accountId",
"webPropertyId",
"profileId",
"linkId"
],
"parameters": {
"accountId": {
"description": "Account ID to update the user link for.",
"location": "path",
"required": true,
"type": "string"
},
"linkId": {
"description": "Link ID to update the user link for.",
"location": "path",
"required": true,
"type": "string"
},
"profileId": {
"description": "View (Profile ID) to update the user link for.",
"location": "path",
"required": true,
"type": "string"
},
"webPropertyId": {
"description": "Web Property ID to update the user link for.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks/{linkId}",
"request": {
"$ref": "EntityUserLink"
},
"response": {
"$ref": "EntityUserLink"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.manage.users"
]
}
}
},
"profiles": {
"methods": {
"delete": {
"description": "Deletes a view (profile).",
"httpMethod": "DELETE",
"id": "analytics.management.profiles.delete",
"parameterOrder": [
"accountId",
"webPropertyId",
"profileId"
],
"parameters": {
"accountId": {
"description": "Account ID to delete the view (profile) for.",
"location": "path",
"required": true,
"type": "string"
},
"profileId": {
"description": "ID of the view (profile) to be deleted.",
"location": "path",
"required": true,
"type": "string"
},
"webPropertyId": {
"description": "Web property ID to delete the view (profile) for.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}",
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
]
},
"get": {
"description": "Gets a view (profile) to which the user has access.",
"httpMethod": "GET",
"id": "analytics.management.profiles.get",
"parameterOrder": [
"accountId",
"webPropertyId",
"profileId"
],
"parameters": {
"accountId": {
"description": "Account ID to retrieve the view (profile) for.",
"location": "path",
"pattern": "[0-9]+",
"required": true,
"type": "string"
},
"profileId": {
"description": "View (Profile) ID to retrieve the view (profile) for.",
"location": "path",
"pattern": "[0-9]+",
"required": true,
"type": "string"
},
"webPropertyId": {
"description": "Web property ID to retrieve the view (profile) for.",
"location": "path",
"pattern": "UA-[0-9]+-[0-9]+",
"required": true,
"type": "string"
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}",
"response": {
"$ref": "Profile"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
]
},
"insert": {
"description": "Create a new view (profile).",
"httpMethod": "POST",
"id": "analytics.management.profiles.insert",
"parameterOrder": [
"accountId",
"webPropertyId"
],
"parameters": {
"accountId": {
"description": "Account ID to create the view (profile) for.",
"location": "path",
"required": true,
"type": "string"
},
"webPropertyId": {
"description": "Web property ID to create the view (profile) for.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles",
"request": {
"$ref": "Profile"
},
"response": {
"$ref": "Profile"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
]
},
"list": {
"description": "Lists views (profiles) to which the user has access.",
"httpMethod": "GET",
"id": "analytics.management.profiles.list",
"parameterOrder": [
"accountId",
"webPropertyId"
],
"parameters": {
"accountId": {
"description": "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.",
"location": "path",
"required": true,
"type": "string"
},
"max-results": {
"description": "The maximum number of views (profiles) to include in this response.",
"format": "int32",
"location": "query",
"type": "integer"
},
"start-index": {
"description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
"format": "int32",
"location": "query",
"minimum": "1",
"type": "integer"
},
"webPropertyId": {
"description": "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.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles",
"response": {
"$ref": "Profiles"
},
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
]
},
"patch": {
"description": "Updates an existing view (profile). This method supports patch semantics.",
"httpMethod": "PATCH",
"id": "analytics.management.profiles.patch",
"parameterOrder": [
"accountId",
"webPropertyId",
"profileId"
],
"parameters": {
"accountId": {
"description": "Account ID to which the view (profile) belongs",
"location": "path",
"required": true,
"type": "string"
},
"profileId": {
"description": "ID of the view (profile) to be updated.",
"location": "path",
"required": true,
"type": "string"
},
"webPropertyId": {
"description": "Web property ID to which the view (profile) belongs",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}",
"request": {
"$ref": "Profile"
},
"response": {
"$ref": "Profile"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
]
},
"update": {
"description": "Updates an existing view (profile).",
"httpMethod": "PUT",
"id": "analytics.management.profiles.update",
"parameterOrder": [
"accountId",
"webPropertyId",
"profileId"
],
"parameters": {
"accountId": {
"description": "Account ID to which the view (profile) belongs",
"location": "path",
"required": true,
"type": "string"
},
"profileId": {
"description": "ID of the view (profile) to be updated.",
"location": "path",
"required": true,
"type": "string"
},
"webPropertyId": {
"description": "Web property ID to which the view (profile) belongs",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}",
"request": {
"$ref": "Profile"
},
"response": {
"$ref": "Profile"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
]
}
}
},
"remarketingAudience": {
"methods": {
"delete": {
"description": "Delete a remarketing audience.",
"httpMethod": "DELETE",
"id": "analytics.management.remarketingAudience.delete",
"parameterOrder": [
"accountId",
"webPropertyId",
"remarketingAudienceId"
],
"parameters": {
"accountId": {
"description": "Account ID to which the remarketing audience belongs.",
"location": "path",
"required": true,
"type": "string"
},
"remarketingAudienceId": {
"description": "The ID of the remarketing audience to delete.",
"location": "path",
"required": true,
"type": "string"
},
"webPropertyId": {
"description": "Web property ID to which the remarketing audience belongs.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences/{remarketingAudienceId}",
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
]
},
"get": {
"description": "Gets a remarketing audience to which the user has access.",
"httpMethod": "GET",
"id": "analytics.management.remarketingAudience.get",
"parameterOrder": [
"accountId",
"webPropertyId",
"remarketingAudienceId"
],
"parameters": {
"accountId": {
"description": "The account ID of the remarketing audience to retrieve.",
"location": "path",
"required": true,
"type": "string"
},
"remarketingAudienceId": {
"description": "The ID of the remarketing audience to retrieve.",
"location": "path",
"required": true,
"type": "string"
},
"webPropertyId": {
"description": "The web property ID of the remarketing audience to retrieve.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences/{remarketingAudienceId}",
"response": {
"$ref": "RemarketingAudience"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
]
},
"insert": {
"description": "Creates a new remarketing audience.",
"httpMethod": "POST",
"id": "analytics.management.remarketingAudience.insert",
"parameterOrder": [
"accountId",
"webPropertyId"
],
"parameters": {
"accountId": {
"description": "The account ID for which to create the remarketing audience.",
"location": "path",
"required": true,
"type": "string"
},
"webPropertyId": {
"description": "Web property ID for which to create the remarketing audience.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences",
"request": {
"$ref": "RemarketingAudience"
},
"response": {
"$ref": "RemarketingAudience"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
]
},
"list": {
"description": "Lists remarketing audiences to which the user has access.",
"httpMethod": "GET",
"id": "analytics.management.remarketingAudience.list",
"parameterOrder": [
"accountId",
"webPropertyId"
],
"parameters": {
"accountId": {
"description": "The account ID of the remarketing audiences to retrieve.",
"location": "path",
"required": true,
"type": "string"
},
"max-results": {
"description": "The maximum number of remarketing audiences to include in this response.",
"format": "int32",
"location": "query",
"type": "integer"
},
"start-index": {
"description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
"format": "int32",
"location": "query",
"minimum": "1",
"type": "integer"
},
"type": {
"default": "all",
"location": "query",
"type": "string"
},
"webPropertyId": {
"description": "The web property ID of the remarketing audiences to retrieve.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences",
"response": {
"$ref": "RemarketingAudiences"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
]
},
"patch": {
"description": "Updates an existing remarketing audience. This method supports patch semantics.",
"httpMethod": "PATCH",
"id": "analytics.management.remarketingAudience.patch",
"parameterOrder": [
"accountId",
"webPropertyId",
"remarketingAudienceId"
],
"parameters": {
"accountId": {
"description": "The account ID of the remarketing audience to update.",
"location": "path",
"required": true,
"type": "string"
},
"remarketingAudienceId": {
"description": "The ID of the remarketing audience to update.",
"location": "path",
"required": true,
"type": "string"
},
"webPropertyId": {
"description": "The web property ID of the remarketing audience to update.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences/{remarketingAudienceId}",
"request": {
"$ref": "RemarketingAudience"
},
"response": {
"$ref": "RemarketingAudience"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
]