Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
{
"baseUrl": "https://www.googleapis.com/analytics/v3/",
"parameters": {
"key": {
"type": "string",
"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"
},
"oauth_token": {
"type": "string",
"location": "query",
"description": "OAuth 2.0 token for the current user."
},
"userIp": {
"type": "string",
"description": "Deprecated. Please use quotaUser instead.",
"location": "query"
},
"quotaUser": {
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"type": "string",
"location": "query"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"type": "string",
"location": "query"
},
"prettyPrint": {
"location": "query",
"type": "boolean",
"default": "false",
"description": "Returns response with indentations and line breaks."
},
"alt": {
"default": "json",
"location": "query",
"enumDescriptions": [
"Responses with Content-Type of application/json"
],
"enum": [
"json"
],
"description": "Data format for the response.",
"type": "string"
}
},
"resources": {
"userDeletion": {
"resources": {
"userDeletionRequest": {
"methods": {
"upsert": {
"description": "Insert or update a user deletion requests.",
"id": "analytics.userDeletion.userDeletionRequest.upsert",
"response": {
"$ref": "UserDeletionRequest"
},
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/analytics.user.deletion"
],
"path": "userDeletion/userDeletionRequests:upsert",
"request": {
"$ref": "UserDeletionRequest"
}
}
}
}
}
},
"provisioning": {
"methods": {
"createAccountTree": {
"scopes": [
"https://www.googleapis.com/auth/analytics.provision"
],
"id": "analytics.provisioning.createAccountTree",
"httpMethod": "POST",
"description": "Provision account.",
"path": "provisioning/createAccountTree",
"request": {
"$ref": "AccountTreeRequest"
},
"response": {
"$ref": "AccountTreeResponse"
}
},
"createAccountTicket": {
"path": "provisioning/createAccountTicket",
"httpMethod": "POST",
"response": {
"$ref": "AccountTicket"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.provision"
],
"request": {
"$ref": "AccountTicket"
},
"id": "analytics.provisioning.createAccountTicket",
"description": "Creates an account ticket."
}
}
},
"management": {
"resources": {
"accountSummaries": {
"methods": {
"list": {
"parameters": {
"start-index": {
"location": "query",
"format": "int32",
"type": "integer",
"description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
"minimum": "1"
},
"max-results": {
"location": "query",
"description": "The maximum number of account summaries to include in this response, where the largest acceptable value is 1000.",
"type": "integer",
"format": "int32"
}
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
],
"id": "analytics.management.accountSummaries.list",
"httpMethod": "GET",
"description": "Lists account summaries (lightweight tree comprised of accounts/properties/profiles) to which the user has access.",
"path": "management/accountSummaries",
"response": {
"$ref": "AccountSummaries"
}
}
}
},
"goals": {
"methods": {
"get": {
"id": "analytics.management.goals.get",
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals/{goalId}",
"scopes": [
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
],
"parameters": {
"goalId": {
"location": "path",
"type": "string",
"required": true,
"description": "Goal ID to retrieve the goal for."
},
"accountId": {
"required": true,
"description": "Account ID to retrieve the goal for.",
"type": "string",
"location": "path"
},
"webPropertyId": {
"location": "path",
"required": true,
"description": "Web property ID to retrieve the goal for.",
"type": "string"
},
"profileId": {
"description": "View (Profile) ID to retrieve the goal for.",
"location": "path",
"type": "string",
"required": true
}
},
"httpMethod": "GET",
"description": "Gets a goal to which the user has access.",
"parameterOrder": [
"accountId",
"webPropertyId",
"profileId",
"goalId"
],
"response": {
"$ref": "Goal"
}
},
"insert": {
"parameters": {
"accountId": {
"location": "path",
"required": true,
"description": "Account ID to create the goal for.",
"type": "string"
},
"profileId": {
"description": "View (Profile) ID to create the goal for.",
"type": "string",
"location": "path",
"required": true
},
"webPropertyId": {
"description": "Web property ID to create the goal for.",
"required": true,
"location": "path",
"type": "string"
}
},
"id": "analytics.management.goals.insert",
"description": "Create a new goal.",
"request": {
"$ref": "Goal"
},
"response": {
"$ref": "Goal"
},
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
],
"parameterOrder": [
"accountId",
"webPropertyId",
"profileId"
],
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals"
},
"update": {
"parameters": {
"goalId": {
"description": "Index of the goal to be updated.",
"location": "path",
"required": true,
"type": "string"
},
"accountId": {
"type": "string",
"description": "Account ID to update the goal.",
"location": "path",
"required": true
},
"profileId": {
"location": "path",
"type": "string",
"required": true,
"description": "View (Profile) ID to update the goal."
},
"webPropertyId": {
"required": true,
"description": "Web property ID to update the goal.",
"type": "string",
"location": "path"
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals/{goalId}",
"response": {
"$ref": "Goal"
},
"parameterOrder": [
"accountId",
"webPropertyId",
"profileId",
"goalId"
],
"id": "analytics.management.goals.update",
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
],
"httpMethod": "PUT",
"request": {
"$ref": "Goal"
},
"description": "Updates an existing goal."
},
"list": {
"parameterOrder": [
"accountId",
"webPropertyId",
"profileId"
],
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
],
"response": {
"$ref": "Goals"
},
"description": "Lists goals to which the user has access.",
"id": "analytics.management.goals.list",
"parameters": {
"webPropertyId": {
"type": "string",
"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
},
"profileId": {
"required": true,
"location": "path",
"type": "string",
"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."
},
"start-index": {
"minimum": "1",
"type": "integer",
"location": "query",
"description": "An index of the first goal to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
"format": "int32"
},
"max-results": {
"format": "int32",
"location": "query",
"description": "The maximum number of goals to include in this response.",
"type": "integer"
},
"accountId": {
"type": "string",
"location": "path",
"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.",
"required": true
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals",
"httpMethod": "GET"
},
"patch": {
"parameterOrder": [
"accountId",
"webPropertyId",
"profileId",
"goalId"
],
"request": {
"$ref": "Goal"
},
"httpMethod": "PATCH",
"description": "Updates an existing goal. This method supports patch semantics.",
"parameters": {
"profileId": {
"type": "string",
"description": "View (Profile) ID to update the goal.",
"location": "path",
"required": true
},
"goalId": {
"required": true,
"description": "Index of the goal to be updated.",
"location": "path",
"type": "string"
},
"accountId": {
"type": "string",
"location": "path",
"description": "Account ID to update the goal.",
"required": true
},
"webPropertyId": {
"type": "string",
"required": true,
"location": "path",
"description": "Web property ID to update the goal."
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals/{goalId}",
"response": {
"$ref": "Goal"
},
"id": "analytics.management.goals.patch",
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
]
}
}
},
"webproperties": {
"methods": {
"insert": {
"request": {
"$ref": "Webproperty"
},
"parameters": {
"accountId": {
"required": true,
"type": "string",
"description": "Account ID to create the web property for.",
"location": "path"
}
},
"path": "management/accounts/{accountId}/webproperties",
"response": {
"$ref": "Webproperty"
},
"description": "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.",
"parameterOrder": [
"accountId"
],
"id": "analytics.management.webproperties.insert",
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
],
"httpMethod": "POST"
},
"get": {
"scopes": [
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
],
"parameters": {
"webPropertyId": {
"required": true,
"type": "string",
"pattern": "UA-[0-9]+-[0-9]+",
"location": "path",
"description": "ID to retrieve the web property for."
},
"accountId": {
"type": "string",
"description": "Account ID to retrieve the web property for.",
"location": "path",
"required": true,
"pattern": "[0-9]+"
}
},
"parameterOrder": [
"accountId",
"webPropertyId"
],
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}",
"description": "Gets a web property to which the user has access.",
"id": "analytics.management.webproperties.get",
"response": {
"$ref": "Webproperty"
},
"httpMethod": "GET"
},
"patch": {
"parameters": {
"accountId": {
"description": "Account ID to which the web property belongs",
"required": true,
"location": "path",
"type": "string"
},
"webPropertyId": {
"type": "string",
"description": "Web property ID",
"required": true,
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
],
"parameterOrder": [
"accountId",
"webPropertyId"
],
"httpMethod": "PATCH",
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}",
"response": {
"$ref": "Webproperty"
},
"id": "analytics.management.webproperties.patch",
"request": {
"$ref": "Webproperty"
},
"description": "Updates an existing web property. This method supports patch semantics."
},
"list": {
"path": "management/accounts/{accountId}/webproperties",
"description": "Lists web properties to which the user has access.",
"response": {
"$ref": "Webproperties"
},
"id": "analytics.management.webproperties.list",
"parameterOrder": [
"accountId"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
],
"parameters": {
"max-results": {
"format": "int32",
"type": "integer",
"location": "query",
"description": "The maximum number of web properties to include in this response."
},
"start-index": {
"location": "query",
"minimum": "1",
"type": "integer",
"description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
"format": "int32"
},
"accountId": {
"required": true,
"location": "path",
"description": "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.",
"type": "string"
}
}
},
"update": {
"description": "Updates an existing web property.",
"id": "analytics.management.webproperties.update",
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}",
"parameters": {
"accountId": {
"description": "Account ID to which the web property belongs",
"location": "path",
"type": "string",
"required": true
},
"webPropertyId": {
"location": "path",
"required": true,
"description": "Web property ID",
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
],
"parameterOrder": [
"accountId",
"webPropertyId"
],
"request": {
"$ref": "Webproperty"
},
"httpMethod": "PUT",
"response": {
"$ref": "Webproperty"
}
}
}
},
"experiments": {
"methods": {
"get": {
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
],
"id": "analytics.management.experiments.get",
"parameters": {
"experimentId": {
"required": true,
"location": "path",
"description": "Experiment ID to retrieve the experiment for.",
"type": "string"
},
"profileId": {
"type": "string",
"required": true,
"description": "View (Profile) ID to retrieve the experiment for.",
"location": "path"
},
"webPropertyId": {
"required": true,
"location": "path",
"type": "string",
"description": "Web property ID to retrieve the experiment for."
},
"accountId": {
"description": "Account ID to retrieve the experiment for.",
"required": true,
"location": "path",
"type": "string"
}
},
"description": "Returns an experiment to which the user has access.",
"response": {
"$ref": "Experiment"
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}",
"parameterOrder": [
"accountId",
"webPropertyId",
"profileId",
"experimentId"
]
},
"update": {
"description": "Update an existing experiment.",
"parameterOrder": [
"accountId",
"webPropertyId",
"profileId",
"experimentId"
],
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.edit"
],
"id": "analytics.management.experiments.update",
"httpMethod": "PUT",
"parameters": {
"accountId": {
"required": true,
"type": "string",
"location": "path",
"description": "Account ID of the experiment to update."
},
"profileId": {
"location": "path",
"required": true,
"type": "string",
"description": "View (Profile) ID of the experiment to update."
},
"experimentId": {
"description": "Experiment ID of the experiment to update.",
"required": true,
"type": "string",
"location": "path"
},
"webPropertyId": {
"type": "string",
"location": "path",
"required": true,
"description": "Web property ID of the experiment to update."
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}",
"response": {
"$ref": "Experiment"
},
"request": {
"$ref": "Experiment"
}
},
"insert": {
"parameters": {
"profileId": {
"location": "path",
"description": "View (Profile) ID to create the experiment for.",
"required": true,
"type": "string"
},
"webPropertyId": {
"type": "string",
"required": true,
"location": "path",
"description": "Web property ID to create the experiment for."
},
"accountId": {
"type": "string",
"required": true,
"description": "Account ID to create the experiment for.",
"location": "path"
}
},
"request": {
"$ref": "Experiment"
},
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.edit"
],
"parameterOrder": [
"accountId",
"webPropertyId",
"profileId"
],
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments",
"httpMethod": "POST",
"description": "Create a new experiment.",
"response": {
"$ref": "Experiment"
},
"id": "analytics.management.experiments.insert"
},
"delete": {
"parameters": {
"accountId": {
"type": "string",
"required": true,
"description": "Account ID to which the experiment belongs",
"location": "path"
},
"experimentId": {
"location": "path",
"description": "ID of the experiment to delete",
"type": "string",
"required": true
},
"profileId": {
"type": "string",
"required": true,
"description": "View (Profile) ID to which the experiment belongs",
"location": "path"
},
"webPropertyId": {
"required": true,
"location": "path",
"type": "string",
"description": "Web property ID to which the experiment belongs"
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}",
"parameterOrder": [
"accountId",
"webPropertyId",
"profileId",
"experimentId"
],
"id": "analytics.management.experiments.delete",
"description": "Delete an experiment.",
"httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.edit"
]
},
"patch": {
"request": {
"$ref": "Experiment"
},
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.edit"
],
"parameterOrder": [
"accountId",
"webPropertyId",
"profileId",
"experimentId"
],
"description": "Update an existing experiment. This method supports patch semantics.",
"httpMethod": "PATCH",
"parameters": {
"experimentId": {
"location": "path",
"type": "string",
"required": true,
"description": "Experiment ID of the experiment to update."
},
"accountId": {
"type": "string",
"location": "path",
"required": true,
"description": "Account ID of the experiment to update."
},
"webPropertyId": {
"type": "string",
"location": "path",
"description": "Web property ID of the experiment to update.",
"required": true
},
"profileId": {
"required": true,
"type": "string",
"description": "View (Profile) ID of the experiment to update.",
"location": "path"
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}",
"id": "analytics.management.experiments.patch",
"response": {
"$ref": "Experiment"
}
},
"list": {
"parameters": {
"accountId": {
"description": "Account ID to retrieve experiments for.",
"location": "path",
"type": "string",
"required": true,
"pattern": "\\d+"
},
"start-index": {
"minimum": "1",
"description": "An index of the first experiment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
"location": "query",
"format": "int32",
"type": "integer"
},
"max-results": {
"format": "int32",
"type": "integer",
"location": "query",
"description": "The maximum number of experiments to include in this response."
},
"profileId": {
"pattern": "\\d+",
"type": "string",
"description": "View (Profile) ID to retrieve experiments for.",
"location": "path",
"required": true
},
"webPropertyId": {
"location": "path",
"required": true,
"pattern": "UA-(\\d+)-(\\d+)",
"type": "string",
"description": "Web property ID to retrieve experiments for."
}
},
"parameterOrder": [
"accountId",
"webPropertyId",
"profileId"
],
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
],
"id": "analytics.management.experiments.list",
"response": {
"$ref": "Experiments"
},
"description": "Lists experiments to which the user has access.",
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments",
"httpMethod": "GET"
}
}
},
"filters": {
"methods": {
"get": {
"httpMethod": "GET",
"id": "analytics.management.filters.get",
"parameterOrder": [
"accountId",
"filterId"
],
"description": "Returns filters to which the user has access.",
"scopes": [
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
],
"response": {
"$ref": "Filter"
},
"parameters": {
"accountId": {
"required": true,
"description": "Account ID to retrieve filters for.",
"type": "string",
"location": "path"
},
"filterId": {
"description": "Filter ID to retrieve filters for.",
"type": "string",
"location": "path",
"required": true
}
},
"path": "management/accounts/{accountId}/filters/{filterId}"
},
"list": {
"description": "Lists all filters for an account",
"response": {
"$ref": "Filters"
},
"parameterOrder": [
"accountId"
],
"parameters": {
"max-results": {
"description": "The maximum number of filters to include in this response.",
"location": "query",
"format": "int32",
"type": "integer"
},
"accountId": {
"type": "string",
"required": true,
"pattern": "\\d+",
"location": "path",
"description": "Account ID to retrieve filters for."
},
"start-index": {
"type": "integer",
"minimum": "1",
"description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
"location": "query",
"format": "int32"
}
},
"httpMethod": "GET",
"id": "analytics.management.filters.list",
"scopes": [
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
],
"path": "management/accounts/{accountId}/filters"
},
"delete": {
"response": {
"$ref": "Filter"
},
"parameterOrder": [
"accountId",
"filterId"
],
"description": "Delete a filter.",
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
],
"httpMethod": "DELETE",
"path": "management/accounts/{accountId}/filters/{filterId}",
"parameters": {
"filterId": {
"location": "path",
"type": "string",
"description": "ID of the filter to be deleted.",
"required": true
},
"accountId": {
"type": "string",
"description": "Account ID to delete the filter for.",
"required": true,
"location": "path"
}
},
"id": "analytics.management.filters.delete"
},
"insert": {
"response": {
"$ref": "Filter"
},
"path": "management/accounts/{accountId}/filters",
"description": "Create a new filter.",
"parameterOrder": [
"accountId"
],
"parameters": {
"accountId": {
"required": true,
"location": "path",
"type": "string",
"description": "Account ID to create filter for."
}
},
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
],
"id": "analytics.management.filters.insert",
"request": {
"$ref": "Filter"
}
},
"update": {
"id": "analytics.management.filters.update",
"request": {
"$ref": "Filter"
},
"description": "Updates an existing filter.",
"parameters": {
"accountId": {
"required": true,
"location": "path",
"description": "Account ID to which the filter belongs.",
"type": "string"
},
"filterId": {
"type": "string",
"required": true,
"location": "path",
"description": "ID of the filter to be updated."
}
},
"path": "management/accounts/{accountId}/filters/{filterId}",
"httpMethod": "PUT",
"parameterOrder": [
"accountId",
"filterId"
],
"response": {
"$ref": "Filter"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
]
},
"patch": {
"id": "analytics.management.filters.patch",
"description": "Updates an existing filter. This method supports patch semantics.",
"request": {
"$ref": "Filter"
},
"parameters": {
"accountId": {
"location": "path",
"type": "string",
"description": "Account ID to which the filter belongs.",
"required": true
},
"filterId": {
"description": "ID of the filter to be updated.",
"location": "path",
"required": true,
"type": "string"
}
},
"response": {
"$ref": "Filter"
},
"httpMethod": "PATCH",
"parameterOrder": [
"accountId",
"filterId"
],
"path": "management/accounts/{accountId}/filters/{filterId}",
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
]
}
}
},
"segments": {
"methods": {
"list": {
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
],
"description": "Lists segments to which the user has access.",
"parameters": {
"max-results": {
"location": "query",
"format": "int32",
"description": "The maximum number of segments to include in this response.",
"type": "integer"
},
"start-index": {
"location": "query",
"description": "An index of the first segment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
"minimum": "1",
"type": "integer",
"format": "int32"
}
},
"path": "management/segments",
"response": {
"$ref": "Segments"
},
"id": "analytics.management.segments.list",
"httpMethod": "GET"
}
}
},
"webPropertyAdWordsLinks": {
"methods": {
"patch": {
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}",
"httpMethod": "PATCH",
"description": "Updates an existing webProperty-Google Ads link. This method supports patch semantics.",
"id": "analytics.management.webPropertyAdWordsLinks.patch",
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
],
"parameterOrder": [
"accountId",
"webPropertyId",
"webPropertyAdWordsLinkId"
],
"response": {
"$ref": "EntityAdWordsLink"
},
"parameters": {
"webPropertyAdWordsLinkId": {
"type": "string",
"location": "path",
"description": "Web property-Google Ads link ID.",
"required": true
},
"accountId": {
"description": "ID of the account which the given web property belongs to.",
"location": "path",
"required": true,
"type": "string"
},
"webPropertyId": {
"description": "Web property ID to retrieve the Google Ads link for.",
"location": "path",
"required": true,
"type": "string"
}
},
"request": {
"$ref": "EntityAdWordsLink"
}
},
"list": {
"response": {
"$ref": "EntityAdWordsLinks"
},
"description": "Lists webProperty-Google Ads links for a given web property.",
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks",
"parameters": {
"webPropertyId": {
"required": true,
"location": "path",
"type": "string",
"description": "Web property ID to retrieve the Google Ads links for."
},
"start-index": {
"description": "An index of the first webProperty-Google Ads link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
"location": "query",
"type": "integer",
"minimum": "1",
"format": "int32"
},
"accountId": {
"pattern": "\\d+",
"type": "string",
"required": true,
"description": "ID of the account which the given web property belongs to.",
"location": "path"
},
"max-results": {
"location": "query",
"description": "The maximum number of webProperty-Google Ads links to include in this response.",
"format": "int32",
"type": "integer"
}
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
],
"parameterOrder": [
"accountId",
"webPropertyId"
],
"id": "analytics.management.webPropertyAdWordsLinks.list",
"httpMethod": "GET"
},
"get": {
"id": "analytics.management.webPropertyAdWordsLinks.get",
"scopes": [
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
],
"parameterOrder": [
"accountId",
"webPropertyId",
"webPropertyAdWordsLinkId"
],
"description": "Returns a web property-Google Ads link to which the user has access.",
"httpMethod": "GET",
"parameters": {
"webPropertyId": {
"description": "Web property ID to retrieve the Google Ads link for.",
"type": "string",
"required": true,
"location": "path"
},
"accountId": {
"location": "path",
"required": true,
"type": "string",
"description": "ID of the account which the given web property belongs to."
},
"webPropertyAdWordsLinkId": {
"description": "Web property-Google Ads link ID.",
"required": true,
"type": "string",
"location": "path"
}
},
"response": {
"$ref": "EntityAdWordsLink"
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}"
},
"update": {
"parameterOrder": [
"accountId",
"webPropertyId",
"webPropertyAdWordsLinkId"
],
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
],
"description": "Updates an existing webProperty-Google Ads link.",
"response": {
"$ref": "EntityAdWordsLink"
},
"parameters": {
"accountId": {
"description": "ID of the account which the given web property belongs to.",
"required": true,
"type": "string",
"location": "path"
},
"webPropertyId": {
"required": true,
"type": "string",
"location": "path",
"description": "Web property ID to retrieve the Google Ads link for."
},
"webPropertyAdWordsLinkId": {
"description": "Web property-Google Ads link ID.",
"location": "path",
"required": true,
"type": "string"
}
},
"id": "analytics.management.webPropertyAdWordsLinks.update",
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}",
"httpMethod": "PUT",
"request": {
"$ref": "EntityAdWordsLink"
}
},
"delete": {
"httpMethod": "DELETE",
"parameterOrder": [
"accountId",
"webPropertyId",
"webPropertyAdWordsLinkId"
],
"parameters": {
"webPropertyAdWordsLinkId": {
"required": true,
"description": "Web property Google Ads link ID.",
"location": "path",
"type": "string"
},
"accountId": {
"description": "ID of the account which the given web property belongs to.",
"location": "path",
"type": "string",
"required": true
},
"webPropertyId": {
"description": "Web property ID to delete the Google Ads link for.",
"required": true,
"type": "string",
"location": "path"
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}",
"id": "analytics.management.webPropertyAdWordsLinks.delete",
"description": "Deletes a web property-Google Ads link.",
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
]
},
"insert": {
"parameters": {
"accountId": {
"description": "ID of the Google Analytics account to create the link for.",
"required": true,
"type": "string",
"location": "path"
},
"webPropertyId": {
"required": true,
"type": "string",
"location": "path",
"description": "Web property ID to create the link for."
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks",
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
],
"description": "Creates a webProperty-Google Ads link.",
"request": {
"$ref": "EntityAdWordsLink"
},
"parameterOrder": [
"accountId",
"webPropertyId"
],
"httpMethod": "POST",
"id": "analytics.management.webPropertyAdWordsLinks.insert",
"response": {
"$ref": "EntityAdWordsLink"
}
}
}
},
"customMetrics": {
"methods": {
"patch": {
"parameters": {
"accountId": {
"type": "string",
"required": true,
"description": "Account ID for the custom metric to update.",
"location": "path"
},
"ignoreCustomDataSourceLinks": {
"location": "query",
"description": "Force the update and ignore any warnings related to the custom metric being linked to a custom data source / data set.",
"type": "boolean",
"default": "false"
},
"webPropertyId": {
"description": "Web property ID for the custom metric to update.",
"type": "string",
"location": "path",
"required": true
},
"customMetricId": {
"description": "Custom metric ID for the custom metric to update.",
"type": "string",
"location": "path",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
],
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics/{customMetricId}",
"httpMethod": "PATCH",
"description": "Updates an existing custom metric. This method supports patch semantics.",
"parameterOrder": [
"accountId",
"webPropertyId",
"customMetricId"
],
"id": "analytics.management.customMetrics.patch",
"request": {
"$ref": "CustomMetric"
},
"response": {
"$ref": "CustomMetric"
}
},
"get": {
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics/{customMetricId}",
"scopes": [
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
],
"httpMethod": "GET",
"parameterOrder": [
"accountId",
"webPropertyId",
"customMetricId"
],
"description": "Get a custom metric to which the user has access.",
"id": "analytics.management.customMetrics.get",
"response": {
"$ref": "CustomMetric"
},
"parameters": {
"customMetricId": {
"location": "path",
"description": "The ID of the custom metric to retrieve.",
"required": true,
"type": "string"
},
"accountId": {
"description": "Account ID for the custom metric to retrieve.",
"type": "string",
"location": "path",
"required": true
},
"webPropertyId": {
"type": "string",
"location": "path",
"required": true,
"description": "Web property ID for the custom metric to retrieve."
}
}
},
"list": {
"httpMethod": "GET",
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics",
"id": "analytics.management.customMetrics.list",
"response": {
"$ref": "CustomMetrics"
},
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.readonly"
],
"description": "Lists custom metrics to which the user has access.",
"parameters": {
"max-results": {
"location": "query",
"description": "The maximum number of custom metrics to include in this response.",
"type": "integer",
"format": "int32"
},
"accountId": {
"required": true,
"type": "string",
"location": "path",
"description": "Account ID for the custom metrics to retrieve."
},
"start-index": {
"type": "integer",
"minimum": "1",
"format": "int32",
"location": "query",
"description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter."
},
"webPropertyId": {
"location": "path",
"description": "Web property ID for the custom metrics to retrieve.",
"required": true,
"type": "string"
}
},
"parameterOrder": [
"accountId",
"webPropertyId"
]
},
"update": {
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics/{customMetricId}",
"id": "analytics.management.customMetrics.update",
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
],
"response": {
"$ref": "CustomMetric"
},
"request": {
"$ref": "CustomMetric"
},
"description": "Updates an existing custom metric.",
"httpMethod": "PUT",
"parameters": {
"customMetricId": {
"required": true,
"type": "string",
"location": "path",
"description": "Custom metric ID for the custom metric to update."
},
"accountId": {
"type": "string",
"required": true,
"location": "path",
"description": "Account ID for the custom metric to update."
},
"ignoreCustomDataSourceLinks": {
"description": "Force the update and ignore any warnings related to the custom metric being linked to a custom data source / data set.",
"default": "false",
"location": "query",
"type": "boolean"
},
"webPropertyId": {
"location": "path",
"required": true,
"description": "Web property ID for the custom metric to update.",
"type": "string"
}
},
"parameterOrder": [
"accountId",
"webPropertyId",
"customMetricId"
]
},
"insert": {
"request": {
"$ref": "CustomMetric"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
],
"httpMethod": "POST",
"parameterOrder": [
"accountId",
"webPropertyId"
],
"id": "analytics.management.customMetrics.insert",
"parameters": {
"webPropertyId": {
"description": "Web property ID for the custom dimension to create.",
"required": true,
"location": "path",
"type": "string"
},
"accountId": {
"location": "path",
"required": true,
"type": "string",
"description": "Account ID for the custom metric to create."
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics",
"response": {
"$ref": "CustomMetric"
},
"description": "Create a new custom metric."
}
}
},
"profileUserLinks": {
"methods": {
"insert": {
"httpMethod": "POST",
"request": {
"$ref": "EntityUserLink"
},
"description": "Adds a new user to the given view (profile).",
"id": "analytics.management.profileUserLinks.insert",
"response": {
"$ref": "EntityUserLink"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.manage.users"
],
"parameters": {
"accountId": {
"location": "path",
"required": true,
"type": "string",
"description": "Account ID to create the user link for."
},
"profileId": {
"type": "string",
"description": "View (Profile) ID to create the user link for.",
"location": "path",
"required": true
},
"webPropertyId": {
"description": "Web Property ID to create the user link for.",
"location": "path",
"required": true,
"type": "string"
}
},
"parameterOrder": [
"accountId",
"webPropertyId",
"profileId"
],
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks"
},
"delete": {
"httpMethod": "DELETE",
"description": "Removes a user from the given view (profile).",
"id": "analytics.management.profileUserLinks.delete",
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks/{linkId}",
"parameters": {
"linkId": {
"description": "Link ID to delete the user link for.",
"type": "string",
"required": true,
"location": "path"
},
"accountId": {
"type": "string",
"description": "Account ID to delete the user link for.",
"required": true,
"location": "path"
},
"webPropertyId": {
"description": "Web Property ID to delete the user link for.",
"type": "string",
"location": "path",
"required": true
},
"profileId": {
"type": "string",
"location": "path",
"required": true,
"description": "View (Profile) ID to delete the user link for."
}
},
"scopes": [
"https://www.googleapis.com/auth/analytics.manage.users"
],
"parameterOrder": [
"accountId",
"webPropertyId",
"profileId",
"linkId"
]
},
"list": {
"response": {
"$ref": "EntityUserLinks"
},
"id": "analytics.management.profileUserLinks.list",
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks",
"parameterOrder": [
"accountId",
"webPropertyId",
"profileId"
],
"description": "Lists profile-user links for a given view (profile).",
"parameters": {
"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.",
"type": "string",
"location": "path",
"required": true
},
"webPropertyId": {
"location": "path",
"required": true,
"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.",
"type": "string"
},
"accountId": {
"type": "string",
"description": "Account ID which the given view (profile) belongs to.",
"required": true,
"location": "path"
},
"max-results": {
"format": "int32",
"location": "query",
"description": "The maximum number of profile-user links to include in this response.",
"type": "integer"
},
"start-index": {
"format": "int32",
"description": "An index of the first profile-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
"location": "query",
"minimum": "1",
"type": "integer"
}
},
"scopes": [
"https://www.googleapis.com/auth/analytics.manage.users",
"https://www.googleapis.com/auth/analytics.manage.users.readonly"
],
"httpMethod": "GET"
},
"update": {
"parameterOrder": [
"accountId",
"webPropertyId",
"profileId",
"linkId"
],
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks/{linkId}",
"scopes": [
"https://www.googleapis.com/auth/analytics.manage.users"
],
"description": "Updates permissions for an existing user on the given view (profile).",
"request": {
"$ref": "EntityUserLink"
},
"httpMethod": "PUT",
"parameters": {
"linkId": {
"location": "path",
"required": true,
"type": "string",
"description": "Link ID to update the user link for."
},
"webPropertyId": {
"description": "Web Property ID to update the user link for.",
"type": "string",
"required": true,
"location": "path"
},
"profileId": {
"description": "View (Profile ID) to update the user link for.",
"location": "path",
"type": "string",
"required": true
},
"accountId": {
"location": "path",
"required": true,
"type": "string",
"description": "Account ID to update the user link for."
}
},
"response": {
"$ref": "EntityUserLink"
},
"id": "analytics.management.profileUserLinks.update"
}
}
},
"unsampledReports": {
"methods": {
"list": {
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
],
"response": {
"$ref": "UnsampledReports"
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports",
"parameterOrder": [
"accountId",
"webPropertyId",
"profileId"
],
"parameters": {
"accountId": {
"description": "Account ID to retrieve unsampled reports for. Must be a specific account ID, ~all is not supported.",
"location": "path",
"required": true,
"type": "string"
},
"webPropertyId": {
"description": "Web property ID to retrieve unsampled reports for. Must be a specific web property ID, ~all is not supported.",
"type": "string",
"required": true,
"location": "path"
},
"profileId": {
"description": "View (Profile) ID to retrieve unsampled reports for. Must be a specific view (profile) ID, ~all is not supported.",
"required": true,
"location": "path",
"type": "string"
},
"max-results": {
"description": "The maximum number of unsampled reports to include in this response.",
"type": "integer",
"format": "int32",
"location": "query"
},
"start-index": {
"format": "int32",
"location": "query",
"description": "An index of the first unsampled report to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
"type": "integer",
"minimum": "1"
}
},
"id": "analytics.management.unsampledReports.list",
"httpMethod": "GET",
"description": "Lists unsampled reports to which the user has access."
},
"get": {
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
],
"parameters": {
"unsampledReportId": {
"type": "string",
"description": "ID of the unsampled report to retrieve.",
"required": true,
"location": "path"
},
"profileId": {
"type": "string",
"location": "path",
"required": true,
"description": "View (Profile) ID to retrieve unsampled report for."
},
"accountId": {
"required": true,
"location": "path",
"type": "string",
"description": "Account ID to retrieve unsampled report for."
},
"webPropertyId": {
"required": true,
"location": "path",
"type": "string",
"description": "Web property ID to retrieve unsampled reports for."
}
},
"id": "analytics.management.unsampledReports.get",
"response": {
"$ref": "UnsampledReport"
},
"description": "Returns a single unsampled report.",
"parameterOrder": [
"accountId",
"webPropertyId",
"profileId",
"unsampledReportId"
],
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports/{unsampledReportId}"
},
"delete": {
"id": "analytics.management.unsampledReports.delete",
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports/{unsampledReportId}",
"httpMethod": "DELETE",
"parameterOrder": [
"accountId",
"webPropertyId",
"profileId",
"unsampledReportId"
],
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
],
"description": "Deletes an unsampled report.",
"parameters": {
"unsampledReportId": {
"location": "path",
"type": "string",
"required": true,
"description": "ID of the unsampled report to be deleted."
},
"webPropertyId": {
"location": "path",
"description": "Web property ID to delete the unsampled reports for.",
"required": true,
"type": "string"
},
"accountId": {
"required": true,
"type": "string",
"description": "Account ID to delete the unsampled report for.",
"location": "path"
},
"profileId": {
"type": "string",
"location": "path",
"required": true,
"description": "View (Profile) ID to delete the unsampled report for."
}
}
},
"insert": {
"request": {
"$ref": "UnsampledReport"
},
"httpMethod": "POST",
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports",
"description": "Create a new unsampled report.",
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.edit"
],
"id": "analytics.management.unsampledReports.insert",
"response": {
"$ref": "UnsampledReport"
},
"parameterOrder": [
"accountId",
"webPropertyId",
"profileId"
],
"parameters": {
"profileId": {
"type": "string",
"required": true,
"description": "View (Profile) ID to create the unsampled report for.",
"location": "path"
},
"webPropertyId": {
"description": "Web property ID to create the unsampled report for.",
"type": "string",
"required": true,
"location": "path"
},
"accountId": {
"description": "Account ID to create the unsampled report for.",
"required": true,
"location": "path",
"type": "string"
}
}
}
}
},
"profileFilterLinks": {
"methods": {
"delete": {
"id": "analytics.management.profileFilterLinks.delete",
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}",
"parameterOrder": [
"accountId",
"webPropertyId",
"profileId",
"linkId"
],
"parameters": {
"profileId": {
"description": "Profile ID to which the filter link belongs.",
"required": true,
"location": "path",
"type": "string",
"pattern": "\\d+"
},
"accountId": {
"pattern": "\\d+",
"type": "string",
"description": "Account ID to which the profile filter link belongs.",
"location": "path",
"required": true
},
"linkId": {
"required": true,
"location": "path",
"type": "string",
"pattern": "\\d+:\\d+",
"description": "ID of the profile filter link to delete."
},
"webPropertyId": {
"location": "path",
"type": "string",
"required": true,
"pattern": "UA-(\\d+)-(\\d+)",
"description": "Web property Id to which the profile filter link belongs."
}
},
"httpMethod": "DELETE",
"description": "Delete a profile filter link.",
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
]
},
"list": {
"httpMethod": "GET",
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks",
"parameters": {
"max-results": {
"format": "int32",
"description": "The maximum number of profile filter links to include in this response.",
"location": "query",
"type": "integer"
},
"webPropertyId": {
"required": true,
"location": "path",
"type": "string",
"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."
},
"start-index": {
"location": "query",
"format": "int32",
"description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
"minimum": "1",
"type": "integer"
},
"accountId": {
"location": "path",
"type": "string",
"description": "Account ID to retrieve profile filter links for.",
"pattern": "\\d+",
"required": true
},
"profileId": {
"type": "string",
"location": "path",
"required": true,
"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."
}
},
"description": "Lists all profile filter links for a profile.",
"scopes": [
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
],
"parameterOrder": [
"accountId",
"webPropertyId",
"profileId"
],
"response": {
"$ref": "ProfileFilterLinks"
},
"id": "analytics.management.profileFilterLinks.list"
},
"insert": {
"parameters": {
"webPropertyId": {
"type": "string",
"required": true,
"description": "Web property Id to create profile filter link for.",
"location": "path",
"pattern": "UA-(\\d+)-(\\d+)"
},
"accountId": {
"type": "string",
"description": "Account ID to create profile filter link for.",
"pattern": "\\d+",
"required": true,
"location": "path"
},
"profileId": {
"type": "string",
"required": true,
"location": "path",
"pattern": "\\d+",
"description": "Profile ID to create filter link for."
}
},
"httpMethod": "POST",
"description": "Create a new profile filter link.",
"request": {
"$ref": "ProfileFilterLink"
},
"parameterOrder": [
"accountId",
"webPropertyId",
"profileId"
],
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks",
"id": "analytics.management.profileFilterLinks.insert",
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
],
"response": {
"$ref": "ProfileFilterLink"
}
},
"update": {
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
],
"httpMethod": "PUT",
"description": "Update an existing profile filter link.",
"parameters": {
"webPropertyId": {
"location": "path",
"description": "Web property Id to which profile filter link belongs",
"pattern": "UA-(\\d+)-(\\d+)",
"type": "string",
"required": true
},
"linkId": {
"required": true,
"description": "ID of the profile filter link to be updated.",
"location": "path",
"type": "string",
"pattern": "\\d+:\\d+"
},
"profileId": {
"type": "string",
"location": "path",
"pattern": "\\d+",
"description": "Profile ID to which filter link belongs",
"required": true
},
"accountId": {
"description": "Account ID to which profile filter link belongs.",
"pattern": "\\d+",
"required": true,
"location": "path",
"type": "string"
}
},
"response": {
"$ref": "ProfileFilterLink"
},
"request": {
"$ref": "ProfileFilterLink"
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}",
"parameterOrder": [
"accountId",
"webPropertyId",
"profileId",
"linkId"
],
"id": "analytics.management.profileFilterLinks.update"
},
"get": {
"scopes": [
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
],
"parameters": {
"profileId": {
"pattern": "\\d+",
"description": "Profile ID to retrieve filter link for.",
"type": "string",
"required": true,
"location": "path"
},
"linkId": {
"location": "path",
"description": "ID of the profile filter link.",
"type": "string",
"required": true,
"pattern": "\\d+:\\d+"
},
"webPropertyId": {
"location": "path",
"pattern": "UA-(\\d+)-(\\d+)",
"required": true,
"type": "string",
"description": "Web property Id to retrieve profile filter link for."
},
"accountId": {
"location": "path",
"description": "Account ID to retrieve profile filter link for.",
"type": "string",
"required": true,
"pattern": "\\d+"
}
},
"id": "analytics.management.profileFilterLinks.get",
"description": "Returns a single profile filter link.",
"parameterOrder": [
"accountId",
"webPropertyId",
"profileId",
"linkId"
],
"response": {
"$ref": "ProfileFilterLink"
},
"httpMethod": "GET",
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}"
},
"patch": {
"parameterOrder": [
"accountId",
"webPropertyId",
"profileId",
"linkId"
],
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}",
"description": "Update an existing profile filter link. This method supports patch semantics.",
"request": {
"$ref": "ProfileFilterLink"
},
"response": {
"$ref": "ProfileFilterLink"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
],
"parameters": {
"webPropertyId": {
"description": "Web property Id to which profile filter link belongs",
"location": "path",
"required": true,
"type": "string",
"pattern": "UA-(\\d+)-(\\d+)"
},
"accountId": {
"description": "Account ID to which profile filter link belongs.",
"location": "path",
"pattern": "\\d+",
"type": "string",
"required": true
},
"linkId": {
"pattern": "\\d+:\\d+",
"location": "path",
"type": "string",
"required": true,
"description": "ID of the profile filter link to be updated."
},
"profileId": {
"location": "path",
"required": true,
"type": "string",
"description": "Profile ID to which filter link belongs",
"pattern": "\\d+"
}
},
"httpMethod": "PATCH",
"id": "analytics.management.profileFilterLinks.patch"
}
}
},
"profiles": {
"methods": {
"update": {
"response": {
"$ref": "Profile"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
],
"id": "analytics.management.profiles.update",
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}",
"httpMethod": "PUT",
"request": {
"$ref": "Profile"
},
"parameterOrder": [
"accountId",
"webPropertyId",
"profileId"
],
"parameters": {
"webPropertyId": {
"type": "string",
"required": true,
"location": "path",
"description": "Web property ID to which the view (profile) belongs"
},
"profileId": {
"location": "path",
"description": "ID of the view (profile) to be updated.",
"type": "string",
"required": true
},
"accountId": {
"location": "path",
"required": true,
"description": "Account ID to which the view (profile) belongs",
"type": "string"
}
},
"description": "Updates an existing view (profile)."
},
"delete": {
"id": "analytics.management.profiles.delete",
"parameters": {
"accountId": {
"location": "path",
"type": "string",
"required": true,
"description": "Account ID to delete the view (profile) for."
},
"profileId": {
"location": "path",
"required": true,
"type": "string",
"description": "ID of the view (profile) to be deleted."
},
"webPropertyId": {
"type": "string",
"required": true,
"description": "Web property ID to delete the view (profile) for.",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
],
"httpMethod": "DELETE",
"description": "Deletes a view (profile).",
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}",
"parameterOrder": [
"accountId",
"webPropertyId",
"profileId"
]
},
"get": {
"description": "Gets a view (profile) to which the user has access.",
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
],
"parameters": {
"profileId": {
"pattern": "[0-9]+",
"type": "string",
"location": "path",
"description": "View (Profile) ID to retrieve the view (profile) for.",
"required": true
},
"accountId": {
"type": "string",
"description": "Account ID to retrieve the view (profile) for.",
"pattern": "[0-9]+",
"required": true,
"location": "path"
},
"webPropertyId": {
"pattern": "UA-[0-9]+-[0-9]+",
"description": "Web property ID to retrieve the view (profile) for.",
"location": "path",
"type": "string",
"required": true
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}",
"parameterOrder": [
"accountId",
"webPropertyId",
"profileId"
],
"id": "analytics.management.profiles.get",
"response": {
"$ref": "Profile"
}
},
"list": {
"description": "Lists views (profiles) to which the user has access.",
"response": {
"$ref": "Profiles"
},
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
],
"httpMethod": "GET",
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles",
"id": "analytics.management.profiles.list",
"parameterOrder": [
"accountId",
"webPropertyId"
],
"parameters": {
"start-index": {
"format": "int32",
"type": "integer",
"minimum": "1",
"description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
"location": "query"
},
"accountId": {
"location": "path",
"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.",
"required": true,
"type": "string"
},
"max-results": {
"description": "The maximum number of views (profiles) to include in this response.",
"location": "query",
"format": "int32",
"type": "integer"
},
"webPropertyId": {
"location": "path",
"type": "string",
"required": true,
"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."
}
}
},
"patch": {
"parameterOrder": [
"accountId",
"webPropertyId",
"profileId"
],
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}",
"parameters": {
"webPropertyId": {
"required": true,
"description": "Web property ID to which the view (profile) belongs",
"location": "path",
"type": "string"
},
"accountId": {
"required": true,
"type": "string",
"description": "Account ID to which the view (profile) belongs",
"location": "path"
},
"profileId": {
"location": "path",
"description": "ID of the view (profile) to be updated.",
"required": true,
"type": "string"
}
},
"response": {
"$ref": "Profile"
},
"httpMethod": "PATCH",
"id": "analytics.management.profiles.patch",
"description": "Updates an existing view (profile). This method supports patch semantics.",
"request": {
"$ref": "Profile"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
]
},
"insert": {
"id": "analytics.management.profiles.insert",
"parameters": {
"webPropertyId": {
"required": true,
"type": "string",
"description": "Web property ID to create the view (profile) for.",
"location": "path"
},
"accountId": {
"location": "path",
"description": "Account ID to create the view (profile) for.",
"type": "string",
"required": true
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles",
"request": {
"$ref": "Profile"
},
"response": {
"$ref": "Profile"
},
"parameterOrder": [
"accountId",
"webPropertyId"
],
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
],
"description": "Create a new view (profile).",
"httpMethod": "POST"
}
}
},
"uploads": {
"methods": {
"deleteUploadData": {
"description": "Delete data associated with a previous upload.",
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.edit"
],
"parameters": {
"accountId": {
"location": "path",
"pattern": "\\d+",
"required": true,
"type": "string",
"description": "Account Id for the uploads to be deleted."
},
"webPropertyId": {
"pattern": "UA-(\\d+)-(\\d+)",
"type": "string",
"required": true,
"description": "Web property Id for the uploads to be deleted.",
"location": "path"
},
"customDataSourceId": {
"pattern": ".{22}",
"type": "string",
"location": "path",
"description": "Custom data source Id for the uploads to be deleted.",
"required": true
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/deleteUploadData",
"httpMethod": "POST",
"id": "analytics.management.uploads.deleteUploadData",
"request": {
"$ref": "AnalyticsDataimportDeleteUploadDataRequest"
},
"parameterOrder": [
"accountId",
"webPropertyId",
"customDataSourceId"
]
},
"uploadData": {
"httpMethod": "POST",
"id": "analytics.management.uploads.uploadData",
"response": {
"$ref": "Upload"
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads",
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.edit"
],
"supportsMediaUpload": true,
"mediaUpload": {
"protocols": {
"resumable": {
"path": "/resumable/upload/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads",
"multipart": true
},
"simple": {
"path": "/upload/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads",
"multipart": true
}
},
"accept": [
"application/octet-stream"
],
"maxSize": "1GB"
},
"description": "Upload data for a custom data source.",
"parameterOrder": [
"accountId",
"webPropertyId",
"customDataSourceId"
],
"parameters": {
"accountId": {
"location": "path",
"required": true,
"pattern": "\\d+",
"description": "Account Id associated with the upload.",
"type": "string"
},
"customDataSourceId": {
"type": "string",
"location": "path",
"required": true,
"description": "Custom data source Id to which the data being uploaded belongs."
},
"webPropertyId": {
"required": true,
"type": "string",
"location": "path",
"pattern": "UA-\\d+-\\d+",
"description": "Web property UA-string associated with the upload."
}
}
},
"list": {
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads",
"response": {
"$ref": "Uploads"
},
"parameterOrder": [
"accountId",
"webPropertyId",
"customDataSourceId"
],
"description": "List uploads to which the user has access.",
"id": "analytics.management.uploads.list",
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
],
"httpMethod": "GET",
"parameters": {
"accountId": {
"description": "Account Id for the uploads to retrieve.",
"pattern": "\\d+",
"type": "string",
"location": "path",
"required": true
},
"webPropertyId": {
"required": true,
"type": "string",
"description": "Web property Id for the uploads to retrieve.",
"pattern": "UA-(\\d+)-(\\d+)",
"location": "path"
},
"start-index": {
"minimum": "1",
"location": "query",
"description": "A 1-based index of the first upload to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
"format": "int32",
"type": "integer"
},
"max-results": {
"minimum": "1",
"location": "query",
"format": "int32",
"type": "integer",
"description": "The maximum number of uploads to include in this response."
},
"customDataSourceId": {
"type": "string",
"pattern": ".{22}",
"required": true,
"description": "Custom data source Id for uploads to retrieve.",
"location": "path"
}
}
},
"get": {
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
],
"httpMethod": "GET",
"parameters": {
"accountId": {
"pattern": "\\d+",
"required": true,
"description": "Account Id for the upload to retrieve.",
"type": "string",
"location": "path"
},
"webPropertyId": {
"required": true,
"description": "Web property Id for the upload to retrieve.",
"type": "string",
"pattern": "UA-(\\d+)-(\\d+)",
"location": "path"
},
"uploadId": {
"pattern": ".{22}",
"required": true,
"location": "path",
"description": "Upload Id to retrieve.",
"type": "string"
},
"customDataSourceId": {
"type": "string",
"description": "Custom data source Id for upload to retrieve.",
"location": "path",
"pattern": ".{22}",
"required": true
}
},
"parameterOrder": [
"accountId",
"webPropertyId",
"customDataSourceId",
"uploadId"
],
"description": "List uploads to which the user has access.",
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads/{uploadId}",
"response": {
"$ref": "Upload"
},
"id": "analytics.management.uploads.get"
}
}
},
"customDimensions": {
"methods": {
"list": {
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions",
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.readonly"
],
"parameters": {
"webPropertyId": {
"location": "path",
"required": true,
"description": "Web property ID for the custom dimensions to retrieve.",
"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"
},
"accountId": {
"description": "Account ID for the custom dimensions to retrieve.",
"location": "path",
"type": "string",
"required": true
},
"max-results": {
"description": "The maximum number of custom dimensions to include in this response.",
"location": "query",
"type": "integer",
"format": "int32"
}
},
"parameterOrder": [
"accountId",
"webPropertyId"
],
"description": "Lists custom dimensions to which the user has access.",
"id": "analytics.management.customDimensions.list",
"response": {
"$ref": "CustomDimensions"
}
},
"update": {
"httpMethod": "PUT",
"id": "analytics.management.customDimensions.update",
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
],
"request": {
"$ref": "CustomDimension"
},
"parameters": {
"webPropertyId": {
"type": "string",
"description": "Web property ID for the custom dimension to update.",
"required": true,
"location": "path"
},
"customDimensionId": {
"type": "string",
"location": "path",
"description": "Custom dimension ID for the custom dimension to update.",
"required": true
},
"accountId": {
"location": "path",
"type": "string",
"description": "Account ID for the custom dimension to update.",
"required": true
},
"ignoreCustomDataSourceLinks": {
"default": "false",
"type": "boolean",
"description": "Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set.",
"location": "query"
}
},
"response": {
"$ref": "CustomDimension"
},
"description": "Updates an existing custom dimension.",
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions/{customDimensionId}",
"parameterOrder": [
"accountId",
"webPropertyId",
"customDimensionId"
]
},
"patch": {
"id": "analytics.management.customDimensions.patch",
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions/{customDimensionId}",
"response": {
"$ref": "CustomDimension"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
],
"parameterOrder": [
"accountId",
"webPropertyId",
"customDimensionId"
],
"parameters": {
"webPropertyId": {
"required": true,
"description": "Web property ID for the custom dimension to update.",
"location": "path",
"type": "string"
},
"ignoreCustomDataSourceLinks": {
"location": "query",
"type": "boolean",
"default": "false",
"description": "Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set."
},
"customDimensionId": {
"description": "Custom dimension ID for the custom dimension to update.",
"location": "path",
"type": "string",
"required": true
},
"accountId": {
"type": "string",
"required": true,
"location": "path",
"description": "Account ID for the custom dimension to update."
}
},
"description": "Updates an existing custom dimension. This method supports patch semantics.",
"request": {
"$ref": "CustomDimension"
},
"httpMethod": "PATCH"
},
"insert": {
"parameters": {
"accountId": {
"description": "Account ID for the custom dimension to create.",
"location": "path",
"required": true,
"type": "string"
},
"webPropertyId": {
"required": true,
"location": "path",
"description": "Web property ID for the custom dimension to create.",
"type": "string"
}
},
"response": {
"$ref": "CustomDimension"
},
"description": "Create a new custom dimension.",
"parameterOrder": [
"accountId",
"webPropertyId"
],
"id": "analytics.management.customDimensions.insert",
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions",
"request": {
"$ref": "CustomDimension"
},
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
]
},
"get": {
"response": {
"$ref": "CustomDimension"
},
"parameters": {
"webPropertyId": {
"required": true,
"type": "string",
"location": "path",
"description": "Web property ID for the custom dimension to retrieve."
},
"accountId": {
"required": true,
"type": "string",
"location": "path",
"description": "Account ID for the custom dimension to retrieve."
},
"customDimensionId": {
"required": true,
"description": "The ID of the custom dimension to retrieve.",
"location": "path",
"type": "string"
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions/{customDimensionId}",
"httpMethod": "GET",
"parameterOrder": [
"accountId",
"webPropertyId",
"customDimensionId"
],
"id": "analytics.management.customDimensions.get",
"description": "Get a custom dimension to which the user has access.",
"scopes": [
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
]
}
}
},
"accountUserLinks": {
"methods": {
"update": {
"id": "analytics.management.accountUserLinks.update",
"httpMethod": "PUT",
"parameterOrder": [
"accountId",
"linkId"
],
"description": "Updates permissions for an existing user on the given account.",
"request": {
"$ref": "EntityUserLink"
},
"path": "management/accounts/{accountId}/entityUserLinks/{linkId}",
"parameters": {
"linkId": {
"location": "path",
"type": "string",
"required": true,
"description": "Link ID to update the account-user link for."
},
"accountId": {
"location": "path",
"required": true,
"type": "string",
"description": "Account ID to update the account-user link for."
}
},
"scopes": [
"https://www.googleapis.com/auth/analytics.manage.users"
],
"response": {
"$ref": "EntityUserLink"
}
},
"insert": {
"httpMethod": "POST",
"id": "analytics.management.accountUserLinks.insert",
"parameters": {
"accountId": {
"location": "path",
"type": "string",
"required": true,
"description": "Account ID to create the user link for."
}
},
"path": "management/accounts/{accountId}/entityUserLinks",
"parameterOrder": [
"accountId"
],
"response": {
"$ref": "EntityUserLink"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.manage.users"
],
"request": {
"$ref": "EntityUserLink"
},
"description": "Adds a new user to the given account."
},
"delete": {
"parameterOrder": [
"accountId",
"linkId"
],
"httpMethod": "DELETE",
"path": "management/accounts/{accountId}/entityUserLinks/{linkId}",
"description": "Removes a user from the given account.",
"scopes": [
"https://www.googleapis.com/auth/analytics.manage.users"
],
"parameters": {
"accountId": {
"description": "Account ID to delete the user link for.",
"type": "string",
"location": "path",
"required": true
},
"linkId": {
"description": "Link ID to delete the user link for.",
"location": "path",
"type": "string",
"required": true
}
},
"id": "analytics.management.accountUserLinks.delete"
},
"list": {
"httpMethod": "GET",
"path": "management/accounts/{accountId}/entityUserLinks",
"description": "Lists account-user links for a given account.",
"scopes": [
"https://www.googleapis.com/auth/analytics.manage.users",
"https://www.googleapis.com/auth/analytics.manage.users.readonly"
],
"parameters": {
"accountId": {
"description": "Account ID to retrieve the user links for.",
"type": "string",
"required": true,
"location": "path"
},
"start-index": {
"type": "integer",
"description": "An index of the first account-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
"minimum": "1",
"location": "query",
"format": "int32"
},
"max-results": {
"description": "The maximum number of account-user links to include in this response.",
"location": "query",
"type": "integer",
"format": "int32"
}
},
"id": "analytics.management.accountUserLinks.list",
"response": {
"$ref": "EntityUserLinks"
},
"parameterOrder": [
"accountId"
]
}
}
},
"clientId": {
"methods": {
"hashClientId": {
"request": {
"$ref": "HashClientIdRequest"
},
"response": {
"$ref": "HashClientIdResponse"
},
"id": "analytics.management.clientId.hashClientId",
"scopes": [
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
],
"httpMethod": "POST",
"path": "management/clientId:hashClientId",
"description": "Hashes the given Client ID."
}
}
},
"customDataSources": {
"methods": {
"list": {
"parameterOrder": [
"accountId",
"webPropertyId"
],
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
],
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources",
"description": "List custom data sources to which the user has access.",
"response": {
"$ref": "CustomDataSources"
},
"parameters": {
"max-results": {
"format": "int32",
"description": "The maximum number of custom data sources to include in this response.",
"location": "query",
"minimum": "1",
"type": "integer"
},
"start-index": {
"type": "integer",
"format": "int32",
"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.",
"minimum": "1",
"location": "query"
},
"accountId": {
"required": true,
"type": "string",
"description": "Account Id for the custom data sources to retrieve.",
"location": "path",
"pattern": "\\d+"
},
"webPropertyId": {
"pattern": "UA-(\\d+)-(\\d+)",
"description": "Web property Id for the custom data sources to retrieve.",
"required": true,
"type": "string",
"location": "path"
}
},
"httpMethod": "GET",
"id": "analytics.management.customDataSources.list"
}
}
},
"webpropertyUserLinks": {
"methods": {
"insert": {
"scopes": [
"https://www.googleapis.com/auth/analytics.manage.users"
],
"description": "Adds a new user to the given web property.",
"request": {
"$ref": "EntityUserLink"
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks",
"httpMethod": "POST",
"response": {
"$ref": "EntityUserLink"
},
"parameterOrder": [
"accountId",
"webPropertyId"
],
"id": "analytics.management.webpropertyUserLinks.insert",
"parameters": {
"webPropertyId": {
"type": "string",
"required": true,
"description": "Web Property ID to create the user link for.",
"location": "path"
},
"accountId": {
"location": "path",
"description": "Account ID to create the user link for.",
"required": true,
"type": "string"
}
}
},
"list": {
"scopes": [
"https://www.googleapis.com/auth/analytics.manage.users",
"https://www.googleapis.com/auth/analytics.manage.users.readonly"
],
"description": "Lists webProperty-user links for a given web property.",
"response": {
"$ref": "EntityUserLinks"
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks",
"id": "analytics.management.webpropertyUserLinks.list",
"httpMethod": "GET",
"parameters": {
"start-index": {
"minimum": "1",
"location": "query",
"description": "An index of the first webProperty-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
"format": "int32",
"type": "integer"
},
"max-results": {
"description": "The maximum number of webProperty-user Links to include in this response.",
"format": "int32",
"location": "query",
"type": "integer"
},
"webPropertyId": {
"description": "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.",
"location": "path",
"type": "string",
"required": true
},
"accountId": {
"location": "path",
"type": "string",
"description": "Account ID which the given web property belongs to.",
"required": true
}
},
"parameterOrder": [
"accountId",
"webPropertyId"
]
},
"delete": {
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks/{linkId}",
"scopes": [
"https://www.googleapis.com/auth/analytics.manage.users"
],
"description": "Removes a user from the given web property.",
"httpMethod": "DELETE",
"parameterOrder": [
"accountId",
"webPropertyId",
"linkId"
],
"id": "analytics.management.webpropertyUserLinks.delete",
"parameters": {
"webPropertyId": {
"required": true,
"description": "Web Property ID to delete the user link for.",
"location": "path",
"type": "string"
},
"accountId": {
"description": "Account ID to delete the user link for.",
"type": "string",
"location": "path",
"required": true
},
"linkId": {
"type": "string",
"description": "Link ID to delete the user link for.",
"required": true,
"location": "path"
}
}
},
"update": {
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks/{linkId}",
"request": {
"$ref": "EntityUserLink"
},
"response": {
"$ref": "EntityUserLink"
},
"parameters": {
"webPropertyId": {
"description": "Web property ID to update the account-user link for.",
"type": "string",
"location": "path",
"required": true
},
"linkId": {
"description": "Link ID to update the account-user link for.",
"location": "path",
"type": "string",
"required": true
},
"accountId": {
"required": true,
"location": "path",
"description": "Account ID to update the account-user link for.",
"type": "string"
}
},
"id": "analytics.management.webpropertyUserLinks.update",
"httpMethod": "PUT",
"scopes": [
"https://www.googleapis.com/auth/analytics.manage.users"
],
"parameterOrder": [
"accountId",
"webPropertyId",
"linkId"
],
"description": "Updates permissions for an existing user on the given web property."
}
}
},
"accounts": {
"methods": {
"list": {
"response": {
"$ref": "Accounts"
},
"path": "management/accounts",
"description": "Lists all accounts to which the user has access.",
"httpMethod": "GET",
"id": "analytics.management.accounts.list",
"parameters": {
"max-results": {
"location": "query",
"format": "int32",
"type": "integer",
"description": "The maximum number of accounts to include in this response."
},
"start-index": {
"type": "integer",
"location": "query",
"minimum": "1",
"format": "int32",
"description": "An index of the first account to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter."
}
},
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
]
}
}
},
"remarketingAudience": {
"methods": {
"list": {
"parameterOrder": [
"accountId",
"webPropertyId"
],
"httpMethod": "GET",
"parameters": {
"accountId": {
"location": "path",
"type": "string",
"description": "The account ID of the remarketing audiences to retrieve.",
"required": true
},
"start-index": {
"format": "int32",
"description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
"minimum": "1",
"location": "query",
"type": "integer"
},
"type": {
"default": "all",
"location": "query",
"type": "string"
},
"max-results": {
"description": "The maximum number of remarketing audiences to include in this response.",
"type": "integer",
"location": "query",
"format": "int32"
},
"webPropertyId": {
"type": "string",
"location": "path",
"description": "The web property ID of the remarketing audiences to retrieve.",
"required": true
}
},
"id": "analytics.management.remarketingAudience.list",
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences",
"scopes": [
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
],
"description": "Lists remarketing audiences to which the user has access.",
"response": {
"$ref": "RemarketingAudiences"
}
},
"update": {
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
],
"request": {
"$ref": "RemarketingAudience"
},
"parameterOrder": [
"accountId",
"webPropertyId",
"remarketingAudienceId"
],
"id": "analytics.management.remarketingAudience.update",
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences/{remarketingAudienceId}",
"response": {
"$ref": "RemarketingAudience"
},
"description": "Updates an existing remarketing audience.",
"httpMethod": "PUT",
"parameters": {
"remarketingAudienceId": {
"type": "string",
"required": true,
"location": "path",
"description": "The ID of the remarketing audience to update."
},
"webPropertyId": {
"location": "path",
"description": "The web property ID of the remarketing audience to update.",
"type": "string",
"required": true
},
"accountId": {
"required": true,
"description": "The account ID of the remarketing audience to update.",
"type": "string",
"location": "path"
}
}
},
"insert": {
"id": "analytics.management.remarketingAudience.insert",
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences",
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
],
"response": {
"$ref": "RemarketingAudience"
},
"description": "Creates a new remarketing audience.",
"request": {
"$ref": "RemarketingAudience"
},
"parameters": {
"accountId": {
"type": "string",
"required": true,
"description": "The account ID for which to create the remarketing audience.",
"location": "path"
},
"webPropertyId": {
"required": true,
"type": "string",
"location": "path",
"description": "Web property ID for which to create the remarketing audience."
}
},
"parameterOrder": [
"accountId",
"webPropertyId"
],
"httpMethod": "POST"
},
"delete": {
"httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
],
"parameterOrder": [
"accountId",
"webPropertyId",
"remarketingAudienceId"
],
"id": "analytics.management.remarketingAudience.delete",
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences/{remarketingAudienceId}",
"description": "Delete a remarketing audience.",
"parameters": {
"webPropertyId": {
"location": "path",
"required": true,
"type": "string",
"description": "Web property ID to which the remarketing audience belongs."
},
"accountId": {
"location": "path",
"type": "string",
"description": "Account ID to which the remarketing audience belongs.",
"required": true
},
"remarketingAudienceId": {
"required": true,
"type": "string",
"description": "The ID of the remarketing audience to delete.",
"location": "path"
}
}
},
"patch": {
"parameterOrder": [
"accountId",
"webPropertyId",
"remarketingAudienceId"
],
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences/{remarketingAudienceId}",
"response": {
"$ref": "RemarketingAudience"
},
"httpMethod": "PATCH",
"parameters": {
"webPropertyId": {
"required": true,
"location": "path",
"description": "The web property ID of the remarketing audience to update.",
"type": "string"
},
"accountId": {
"description": "The account ID of the remarketing audience to update.",
"required": true,
"type": "string",
"location": "path"
},
"remarketingAudienceId": {
"type": "string",
"required": true,
"location": "path",
"description": "The ID of the remarketing audience to update."
}
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
],
"description": "Updates an existing remarketing audience. This method supports patch semantics.",
"request": {
"$ref": "RemarketingAudience"
},
"id": "analytics.management.remarketingAudience.patch"
},
"get": {
"parameters": {
"webPropertyId": {
"required": true,
"type": "string",
"location": "path",
"description": "The web property ID of the remarketing audience to retrieve."
},
"accountId": {
"type": "string",
"location": "path",
"description": "The account ID of the remarketing audience to retrieve.",
"required": true
},
"remarketingAudienceId": {
"location": "path",
"type": "string",
"required": true,
"description": "The ID of the remarketing audience to retrieve."
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences/{remarketingAudienceId}",
"httpMethod": "GET",
"id": "analytics.management.remarketingAudience.get",
"scopes": [
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
],
"response": {
"$ref": "RemarketingAudience"
},
"description": "Gets a remarketing audience to which the user has access.",
"parameterOrder": [
"accountId",
"webPropertyId",
"remarketingAudienceId"
]
}
}
}
}
},
"data": {
"resources": {
"ga": {
"methods": {
"get": {
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.readonly"
],
"response": {
"$ref": "GaData"
},
"httpMethod": "GET",
"description": "Returns Analytics data for a view (profile).",
"id": "analytics.data.ga.get",
"parameterOrder": [
"ids",
"start-date",
"end-date",
"metrics"
],
"parameters": {
"samplingLevel": {
"type": "string",
"description": "The desired sampling level.",
"location": "query",
"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."
],
"enum": [
"DEFAULT",
"FASTER",
"HIGHER_PRECISION"
]
},
"segment": {
"type": "string",
"location": "query",
"description": "An Analytics segment to be applied to data."
},
"ids": {
"location": "query",
"description": "Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.",
"type": "string",
"required": true,
"pattern": "ga:[0-9]+"
},
"end-date": {
"location": "query",
"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.",
"required": true,
"pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}|today|yesterday|[0-9]+(daysAgo)",
"type": "string"
},
"filters": {
"description": "A comma-separated list of dimension or metric filters to be applied to Analytics data.",
"pattern": "ga:.+",
"location": "query",
"type": "string"
},
"start-index": {
"format": "int32",
"description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
"minimum": "1",
"type": "integer",
"location": "query"
},
"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.",
"required": true,
"type": "string",
"pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}|today|yesterday|[0-9]+(daysAgo)",
"location": "query"
},
"max-results": {
"description": "The maximum number of entries to include in this feed.",
"format": "int32",
"location": "query",
"type": "integer"
},
"sort": {
"type": "string",
"location": "query",
"pattern": "(-)?ga:.+",
"description": "A comma-separated list of dimensions or metrics that determine the sort order for Analytics data."
},
"output": {
"description": "The selected format for the response. Default format is JSON.",
"type": "string",
"enum": [
"dataTable",
"json"
],
"location": "query",
"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."
]
},
"dimensions": {
"location": "query",
"pattern": "(ga:.+)?",
"description": "A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'.",
"type": "string"
},
"include-empty-rows": {
"description": "The response will include empty rows if this parameter is set to true, the default is true",
"type": "boolean",
"location": "query"
},
"metrics": {
"location": "query",
"pattern": "ga:.+",
"description": "A comma-separated list of Analytics metrics. E.g., 'ga:sessions,ga:pageviews'. At least one metric must be specified.",
"required": true,
"type": "string"
}
},
"path": "data/ga"
}
}
},
"realtime": {
"methods": {
"get": {
"parameters": {
"max-results": {
"type": "integer",
"location": "query",
"description": "The maximum number of entries to include in this feed.",
"format": "int32"
},
"sort": {
"type": "string",
"description": "A comma-separated list of dimensions or metrics that determine the sort order for real time data.",
"pattern": "(-)?((ga:.+)|(rt:.+))",
"location": "query"
},
"dimensions": {
"type": "string",
"description": "A comma-separated list of real time dimensions. E.g., 'rt:medium,rt:city'.",
"pattern": "(ga:.+)|(rt:.+)",
"location": "query"
},
"metrics": {
"required": true,
"type": "string",
"pattern": "(ga:.+)|(rt:.+)",
"location": "query",
"description": "A comma-separated list of real time metrics. E.g., 'rt:activeUsers'. At least one metric must be specified."
},
"ids": {
"required": true,
"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.",
"type": "string",
"pattern": "ga:[0-9]+",
"location": "query"
},
"filters": {
"location": "query",
"pattern": "(ga:.+)|(rt:.+)",
"description": "A comma-separated list of dimension or metric filters to be applied to real time data.",
"type": "string"
}
},
"description": "Returns real time data for a view (profile).",
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.readonly"
],
"path": "data/realtime",
"id": "analytics.data.realtime.get",
"httpMethod": "GET",
"response": {
"$ref": "RealtimeData"
},
"parameterOrder": [
"ids",
"metrics"
]
}
}
},
"mcf": {
"methods": {
"get": {
"response": {
"$ref": "McfData"
},
"parameterOrder": [
"ids",
"start-date",
"end-date",
"metrics"
],
"id": "analytics.data.mcf.get",
"httpMethod": "GET",
"parameters": {
"dimensions": {
"pattern": "(mcf:.+)?",
"description": "A comma-separated list of Multi-Channel Funnels dimensions. E.g., 'mcf:source,mcf:medium'.",
"location": "query",
"type": "string"
},
"max-results": {
"format": "int32",
"location": "query",
"description": "The maximum number of entries to include in this feed.",
"type": "integer"
},
"samplingLevel": {
"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."
],
"enum": [
"DEFAULT",
"FASTER",
"HIGHER_PRECISION"
],
"description": "The desired sampling level.",
"type": "string",
"location": "query"
},
"metrics": {
"required": true,
"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:.+",
"type": "string"
},
"ids": {
"required": true,
"type": "string",
"pattern": "ga:[0-9]+",
"location": "query",
"description": "Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID."
},
"start-index": {
"type": "integer",
"description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
"location": "query",
"minimum": "1",
"format": "int32"
},
"sort": {
"pattern": "(-)?mcf:.+",
"description": "A comma-separated list of dimensions or metrics that determine the sort order for the Analytics data.",
"type": "string",
"location": "query"
},
"filters": {
"description": "A comma-separated list of dimension or metric filters to be applied to the Analytics data.",
"type": "string",
"location": "query",
"pattern": "mcf:.+"
},
"start-date": {
"type": "string",
"required": true,
"location": "query",
"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.",
"pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}|today|yesterday|[0-9]+(daysAgo)"
},
"end-date": {
"pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}|today|yesterday|[0-9]+(daysAgo)",
"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.",
"type": "string",
"required": true,
"location": "query"
}
},
"description": "Returns Analytics Multi-Channel Funnels data for a view (profile).",
"path": "data/mcf",
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.readonly"
]
}
}
}
}
},
"metadata": {
"resources": {
"columns": {
"methods": {
"list": {
"parameterOrder": [
"reportType"
],
"path": "metadata/{reportType}/columns",
"description": "Lists all columns for a report type",
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
],
"id": "analytics.metadata.columns.list",
"parameters": {
"reportType": {
"description": "Report type. Allowed Values: 'ga'. Where 'ga' corresponds to the Core Reporting API",
"required": true,
"type": "string",
"location": "path",
"pattern": "ga"
}
},
"response": {
"$ref": "Columns"
},
"httpMethod": "GET"
}
}
}
}
}
},
"icons": {
"x16": "https://www.google.com/images/icons/product/analytics-16.png",
"x32": "https://www.google.com/images/icons/product/analytics-32.png"
},
"rootUrl": "https://www.googleapis.com/",
"ownerName": "Google",
"revision": "20190807",
"title": "Google Analytics API",
"id": "analytics:v3",
"ownerDomain": "google.com",
"basePath": "/analytics/v3/",
"protocol": "rest",
"schemas": {
"UnsampledReports": {
"type": "object",
"id": "UnsampledReports",
"properties": {
"totalResults": {
"description": "The total number of results for the query, regardless of the number of resources in the result.",
"format": "int32",
"type": "integer"
},
"kind": {
"description": "Collection type.",
"type": "string",
"default": "analytics#unsampledReports"
},
"nextLink": {
"description": "Link to next page for this unsampled report collection.",
"type": "string"
},
"itemsPerPage": {
"description": "The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.",
"type": "integer",
"format": "int32"
},
"startIndex": {
"type": "integer",
"description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.",
"format": "int32"
},
"username": {
"description": "Email ID of the authenticated user",
"type": "string"
},
"previousLink": {
"type": "string",
"description": "Link to previous page for this unsampled report collection."
},
"items": {
"items": {
"$ref": "UnsampledReport"
},
"type": "array",
"description": "A list of unsampled reports."
}
},
"description": "An unsampled report collection lists Analytics unsampled reports to which the user has access. Each view (profile) can have a set of unsampled reports. Each resource in the unsampled report collection corresponds to a single Analytics unsampled report."
},
"EntityAdWordsLinks": {
"id": "EntityAdWordsLinks",
"description": "An entity Google Ads link collection provides a list of GA-Google Ads links Each resource in this collection corresponds to a single link.",
"type": "object",
"properties": {
"totalResults": {
"type": "integer",
"format": "int32",
"description": "The total number of results for the query, regardless of the number of results in the response."
},
"startIndex": {
"type": "integer",
"description": "The starting index of the entries, which is 1 by default or otherwise specified by the start-index query parameter.",
"format": "int32"
},
"previousLink": {
"description": "Previous link for this Google Ads link collection.",
"type": "string"
},
"kind": {
"description": "Collection type.",
"type": "string",
"default": "analytics#entityAdWordsLinks"
},
"nextLink": {
"description": "Next link for this Google Ads link collection.",
"type": "string"
},
"items": {
"description": "A list of entity Google Ads links.",
"items": {
"$ref": "EntityAdWordsLink"
},
"type": "array"
},
"itemsPerPage": {
"type": "integer",
"description": "The maximum number of entries the response can contain, regardless of the actual number of entries returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.",
"format": "int32"
}
}
},
"IncludeConditions": {
"description": "JSON template for an Analytics Remarketing Include Conditions.",
"type": "object",
"id": "IncludeConditions",
"properties": {
"daysToLookBack": {
"type": "integer",
"description": "The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience.",
"format": "int32"
},
"isSmartList": {
"description": "Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577",
"type": "boolean"
},
"kind": {
"type": "string",
"default": "analytics#includeConditions",
"description": "Resource type for include conditions."
},
"segment": {
"type": "string",
"description": "The segment condition that will cause a user to be added to an audience."
},
"membershipDurationDays": {
"description": "Number of days (in the range 1 to 540) a user remains in the audience.",
"type": "integer",
"format": "int32"
}
}
},
"LinkedForeignAccount": {
"type": "object",
"description": "JSON template for an Analytics Remarketing Audience Foreign Link.",
"id": "LinkedForeignAccount",
"properties": {
"linkedAccountId": {
"type": "string",
"description": "The foreign account ID. For example the an Google Ads `linkedAccountId` has the following format XXX-XXX-XXXX."
},
"webPropertyId": {
"description": "Web property ID of the form UA-XXXXX-YY to which this linked foreign account belongs.",
"type": "string"
},
"accountId": {
"type": "string",
"description": "Account ID to which this linked foreign account belongs."
},
"id": {
"type": "string",
"description": "Entity ad account link ID."
},
"kind": {
"description": "Resource type for linked foreign account.",
"type": "string",
"default": "analytics#linkedForeignAccount"
},
"eligibleForSearch": {
"description": "Boolean indicating whether this is eligible for search.",
"type": "boolean",
"readOnly": true
},
"internalWebPropertyId": {
"readOnly": true,
"type": "string",
"description": "Internal ID for the web property to which this linked foreign account belongs."
},
"status": {
"description": "The status of this foreign account link.",
"type": "string"
},
"type": {
"description": "The type of the foreign account. For example, `ADWORDS_LINKS`, `DBM_LINKS`, `MCC_LINKS` or `OPTIMIZE`.",
"type": "string"
},
"remarketingAudienceId": {
"description": "Remarketing audience ID to which this linked foreign account belongs.",
"type": "string"
}
}
},
"Columns": {
"description": "Lists columns (dimensions and metrics) for a particular report type.",
"id": "Columns",
"type": "object",
"properties": {
"attributeNames": {
"items": {
"type": "string"
},
"type": "array",
"description": "List of attributes names returned by columns."
},
"items": {
"items": {
"$ref": "Column"
},
"description": "List of columns for a report type.",
"type": "array"
},
"totalResults": {
"format": "int32",
"description": "Total number of columns returned in the response.",
"type": "integer"
},
"kind": {
"description": "Collection type.",
"default": "analytics#columns",
"type": "string"
},
"etag": {
"type": "string",
"description": "Etag of collection. This etag can be compared with the last response etag to check if response has changed."
}
}
},
"ProfileSummary": {
"properties": {
"kind": {
"type": "string",
"default": "analytics#profileSummary",
"description": "Resource type for Analytics ProfileSummary."
},
"name": {
"description": "View (profile) name.",
"type": "string"
},
"id": {
"type": "string",
"description": "View (profile) ID."
},
"starred": {
"type": "boolean",
"description": "Indicates whether this view (profile) is starred or not."
},
"type": {
"description": "View (Profile) type. Supported types: WEB or APP.",
"type": "string"
}
},
"description": "JSON template for an Analytics ProfileSummary. ProfileSummary returns basic information (i.e., summary) for a profile.",
"type": "object",
"id": "ProfileSummary"
},
"Experiment": {
"id": "Experiment",
"type": "object",
"description": "JSON template for Analytics experiment resource.",
"properties": {
"trafficCoverage": {
"format": "double",
"description": "A floating-point number in (0, 1]. Specifies the fraction of the traffic that participates in the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.",
"type": "number"
},
"status": {
"type": "string",
"description": "Experiment status. Possible values: \"DRAFT\", \"READY_TO_RUN\", \"RUNNING\", \"ENDED\". Experiments can be created in the \"DRAFT\", \"READY_TO_RUN\" or \"RUNNING\" state. This field is required when creating an experiment.",
"annotations": {
"required": [
"analytics.management.experiments.insert",
"analytics.management.experiments.update"
]
}
},
"editableInGaUi": {
"type": "boolean",
"description": "If true, the end user will be able to edit the experiment via the Google Analytics user interface."
},
"updated": {
"description": "Time the experiment was last modified. This field is read-only.",
"format": "date-time",
"type": "string"
},
"objectiveMetric": {
"type": "string",
"description": "The metric that the experiment is optimizing. Valid values: \"ga:goal(n)Completions\", \"ga:adsenseAdsClicks\", \"ga:adsenseAdsViewed\", \"ga:adsenseRevenue\", \"ga:bounces\", \"ga:pageviews\", \"ga:sessionDuration\", \"ga:transactions\", \"ga:transactionRevenue\". This field is required if status is \"RUNNING\" and servingFramework is one of \"REDIRECT\" or \"API\"."
},
"accountId": {
"description": "Account ID to which this experiment belongs. This field is read-only.",
"type": "string"
},
"minimumExperimentLengthInDays": {
"description": "An integer number in [3, 90]. Specifies the minimum length of the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.",
"format": "int32",
"type": "integer"
},
"snippet": {
"description": "The snippet of code to include on the control page(s). This field is read-only.",
"type": "string"
},
"description": {
"type": "string",
"description": "Notes about this experiment."
},
"servingFramework": {
"description": "The framework used to serve the experiment variations and evaluate the results. One of: \n- REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results.\n- API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation.\n- EXTERNAL: The variations will be served externally and the chosen variation reported to Google Analytics. The caller is responsible for serving the selected variation and evaluating the results.",
"type": "string"
},
"kind": {
"description": "Resource type for an Analytics experiment. This field is read-only.",
"default": "analytics#experiment",
"type": "string"
},
"optimizationType": {
"type": "string",
"description": "Whether the objectiveMetric should be minimized or maximized. Possible values: \"MAXIMUM\", \"MINIMUM\". Optional--defaults to \"MAXIMUM\". Cannot be specified without objectiveMetric. Cannot be modified when status is \"RUNNING\" or \"ENDED\"."
},
"created": {
"type": "string",
"format": "date-time",
"description": "Time the experiment was created. This field is read-only."
},
"id": {
"annotations": {
"required": [
"analytics.management.experiments.patch",
"analytics.management.experiments.update"
]
},
"description": "Experiment ID. Required for patch and update. Disallowed for create.",
"type": "string"
},
"winnerFound": {
"type": "boolean",
"description": "Boolean specifying whether a winner has been found for this experiment. This field is read-only."
},
"equalWeighting": {
"type": "boolean",
"description": "Boolean specifying whether to distribute traffic evenly across all variations. If the value is False, content experiments follows the default behavior of adjusting traffic dynamically based on variation performance. Optional -- defaults to False. This field may not be changed for an experiment whose status is ENDED."
},
"endTime": {
"type": "string",
"format": "date-time",
"description": "The ending time of the experiment (the time the status changed from RUNNING to ENDED). This field is present only if the experiment has ended. This field is read-only."
},
"startTime": {
"description": "The starting time of the experiment (the time the status changed from READY_TO_RUN to RUNNING). This field is present only if the experiment has started. This field is read-only.",
"type": "string",
"format": "date-time"
},
"name": {
"type": "string",
"description": "Experiment name. This field may not be changed for an experiment whose status is ENDED. This field is required when creating an experiment.",
"annotations": {
"required": [
"analytics.management.experiments.insert",
"analytics.management.experiments.update"
]
}
},
"profileId": {
"type": "string",
"description": "View (Profile) ID to which this experiment belongs. This field is read-only."
},
"reasonExperimentEnded": {
"type": "string",
"description": "Why the experiment ended. Possible values: \"STOPPED_BY_USER\", \"WINNER_FOUND\", \"EXPERIMENT_EXPIRED\", \"ENDED_WITH_NO_WINNER\", \"GOAL_OBJECTIVE_CHANGED\". \"ENDED_WITH_NO_WINNER\" means that the experiment didn't expire but no winner was projected to be found. If the experiment status is changed via the API to ENDED this field is set to STOPPED_BY_USER. This field is read-only."
},
"webPropertyId": {
"description": "Web property ID to which this experiment belongs. The web property ID is of the form UA-XXXXX-YY. This field is read-only.",
"type": "string"
},
"parentLink": {
"properties": {
"href": {
"description": "Link to the view (profile) to which this experiment belongs. This field is read-only.",
"type": "string"
},
"type": {
"description": "Value is \"analytics#profile\". This field is read-only.",
"default": "analytics#profile",
"type": "string"
}
},
"type": "object",
"description": "Parent link for an experiment. Points to the view (profile) to which this experiment belongs."
},
"rewriteVariationUrlsAsOriginal": {
"description": "Boolean specifying whether variations URLS are rewritten to match those of the original. This field may not be changed for an experiments whose status is ENDED.",
"type": "boolean"
},
"winnerConfidenceLevel": {
"description": "A floating-point number in (0, 1). Specifies the necessary confidence level to choose a winner. This field may not be changed for an experiments whose status is ENDED.",
"type": "number",
"format": "double"
},
"internalWebPropertyId": {
"description": "Internal ID for the web property to which this experiment belongs. This field is read-only.",
"type": "string"
},
"selfLink": {
"description": "Link for this experiment. This field is read-only.",
"type": "string"
},
"variations": {
"type": "array",
"description": "Array of variations. The first variation in the array is the original. The number of variations may not change once an experiment is in the RUNNING state. At least two variations are required before status can be set to RUNNING.",
"items": {
"type": "object",
"properties": {
"name": {
"description": "The name of the variation. This field is required when creating an experiment. This field may not be changed for an experiment whose status is ENDED.",
"annotations": {
"required": [
"analytics.management.experiments.insert",
"analytics.management.experiments.update"
]
},
"type": "string"
},
"url": {
"type": "string",
"description": "The URL of the variation. This field may not be changed for an experiment whose status is RUNNING or ENDED."
},
"status": {
"description": "Status of the variation. Possible values: \"ACTIVE\", \"INACTIVE\". INACTIVE variations are not served. This field may not be changed for an experiment whose status is ENDED.",
"type": "string"
},
"won": {
"description": "True if the experiment has ended and this variation performed (statistically) significantly better than the original. This field is read-only.",
"type": "boolean"
},
"weight": {
"format": "double",
"type": "number",
"description": "Weight that this variation should receive. Only present if the experiment is running. This field is read-only."
}
}
}
}
}
},
"ProfileFilterLinks": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "A list of profile filter links.",
"items": {
"$ref": "ProfileFilterLink"
}
},
"previousLink": {
"description": "Link to previous page for this profile filter link collection.",
"type": "string"
},
"startIndex": {
"format": "int32",
"type": "integer",
"description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter."
},
"kind": {
"type": "string",
"default": "analytics#profileFilterLinks",
"description": "Collection type."
},
"itemsPerPage": {
"type": "integer",
"format": "int32",
"description": "The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter."
},
"nextLink": {
"description": "Link to next page for this profile filter link collection.",
"type": "string"
},
"totalResults": {
"format": "int32",
"type": "integer",
"description": "The total number of results for the query, regardless of the number of results in the response."
},
"username": {
"description": "Email ID of the authenticated user",
"type": "string"
}
},
"description": "A profile filter link collection lists profile filter links between profiles and filters. Each resource in the collection corresponds to a profile filter link.",
"id": "ProfileFilterLinks"
},
"UserRef": {
"type": "object",
"id": "UserRef",
"description": "JSON template for a user reference.",
"properties": {
"kind": {
"type": "string",
"default": "analytics#userRef"
},
"email": {
"type": "string",
"description": "Email ID of this user."
},
"id": {
"type": "string",
"description": "User ID."
}
}
},
"CustomDataSources": {
"properties": {
"itemsPerPage": {
"format": "int32",
"type": "integer",
"description": "The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter."
},
"nextLink": {
"type": "string",
"description": "Link to next page for this custom data source collection."
},
"startIndex": {
"format": "int32",
"description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.",
"type": "integer"
},
"kind": {
"default": "analytics#customDataSources",
"type": "string",
"description": "Collection type."
},
"items": {
"items": {
"$ref": "CustomDataSource"
},
"description": "Collection of custom data sources.",
"type": "array"
},
"username": {
"type": "string",
"description": "Email ID of the authenticated user"
},
"previousLink": {
"description": "Link to previous page for this custom data source collection.",
"type": "string"
},
"totalResults": {
"type": "integer",
"description": "The total number of results for the query, regardless of the number of results in the response.",
"format": "int32"
}
},
"type": "object",
"id": "CustomDataSources",
"description": "Lists Analytics custom data sources to which the user has access. Each resource in the collection corresponds to a single Analytics custom data source."
},
"AccountTreeResponse": {
"properties": {
"webproperty": {
"$ref": "Webproperty",
"description": "Web property for the account."
},
"profile": {
"description": "View (Profile) for the account.",
"$ref": "Profile"
},
"account": {
"description": "The account created.",
"$ref": "Account"
},
"kind": {
"default": "analytics#accountTreeResponse",
"description": "Resource type for account ticket.",
"type": "string"
}
},
"description": "JSON template for an Analytics account tree response. The account tree response is used in the provisioning api to return the result of creating an account, property, and view (profile).",
"type": "object",
"id": "AccountTreeResponse"
},
"CustomMetric": {
"description": "JSON template for Analytics Custom Metric.",
"type": "object",
"id": "CustomMetric",
"properties": {
"webPropertyId": {
"description": "Property ID.",
"type": "string"
},
"name": {
"description": "Name of the custom metric.",
"type": "string"
},
"parentLink": {
"properties": {
"href": {
"description": "Link to the property to which the custom metric belongs.",
"type": "string"
},
"type": {
"description": "Type of the parent link. Set to \"analytics#webproperty\".",
"type": "string",
"default": "analytics#webproperty"
}
},
"type": "object",
"description": "Parent link for the custom metric. Points to the property to which the custom metric belongs."
},
"kind": {
"default": "analytics#customMetric",
"type": "string",
"readOnly": true,
"description": "Kind value for a custom metric. Set to \"analytics#customMetric\". It is a read-only field."
},
"updated": {
"format": "date-time",
"readOnly": true,
"description": "Time the custom metric was last modified.",
"type": "string"
},
"active": {
"type": "boolean",
"description": "Boolean indicating whether the custom metric is active."
},
"accountId": {
"description": "Account ID.",
"type": "string"
},
"index": {
"description": "Index of the custom metric.",
"readOnly": true,
"format": "int32",
"type": "integer"
},
"type": {
"type": "string",
"description": "Data type of custom metric."
},
"max_value": {
"type": "string",
"description": "Max value of custom metric."
},
"id": {
"description": "Custom metric ID.",
"type": "string"
},
"selfLink": {
"description": "Link for the custom metric",
"readOnly": true,
"type": "string"
},
"created": {
"readOnly": true,
"type": "string",
"description": "Time the custom metric was created.",
"format": "date-time"
},
"min_value": {
"description": "Min value of custom metric.",
"type": "string"
},
"scope": {
"description": "Scope of the custom metric: HIT or PRODUCT.",
"type": "string"
}
}
},
"ProfileFilterLink": {
"type": "object",
"id": "ProfileFilterLink",
"description": "JSON template for an Analytics profile filter link.",
"properties": {
"kind": {
"type": "string",
"default": "analytics#profileFilterLink",
"description": "Resource type for Analytics filter.",
"readOnly": true
},
"rank": {
"type": "integer",
"format": "int32",
"description": "The rank of this profile filter link relative to the other filters linked to the same profile.\nFor readonly (i.e., list and get) operations, the rank always starts at 1.\nFor write (i.e., create, update, or delete) operations, you may specify a value between 0 and 255 inclusively, [0, 255]. In order to insert a link at the end of the list, either don't specify a rank or set a rank to a number greater than the largest rank in the list. In order to insert a link to the beginning of the list specify a rank that is less than or equal to 1. The new link will move all existing filters with the same or lower rank down the list. After the link is inserted/updated/deleted all profile filter links will be renumbered starting at 1."
},
"filterRef": {
"$ref": "FilterRef",
"description": "Filter for this link."
},
"id": {
"type": "string",
"description": "Profile filter link ID."
},
"profileRef": {
"description": "View (Profile) for this link.",
"$ref": "ProfileRef"
},
"selfLink": {
"readOnly": true,
"description": "Link for this profile filter link.",
"type": "string"
}
}
},
"EntityAdWordsLink": {
"description": "JSON template for Analytics Entity Google Ads Link.",
"properties": {
"name": {
"annotations": {
"required": [
"analytics.management.webPropertyAdWordsLinks.insert",
"analytics.management.webPropertyAdWordsLinks.update"
]
},
"description": "Name of the link. This field is required when creating a Google Ads link.",
"type": "string"
},
"entity": {
"properties": {
"webPropertyRef": {
"$ref": "WebPropertyRef"
}
},
"description": "Web property being linked.",
"type": "object"
},
"kind": {
"default": "analytics#entityAdWordsLink",
"type": "string",
"description": "Resource type for entity Google Ads link."
},
"profileIds": {
"items": {
"type": "string"
},
"type": "array",
"description": "IDs of linked Views (Profiles) represented as strings."
},
"adWordsAccounts": {
"items": {
"$ref": "AdWordsAccount"
},
"description": "A list of Google Ads client accounts. These cannot be MCC accounts. This field is required when creating a Google Ads link. It cannot be empty.",
"annotations": {
"required": [
"analytics.management.webPropertyAdWordsLinks.insert",
"analytics.management.webPropertyAdWordsLinks.update"
]
},
"type": "array"
},
"id": {
"description": "Entity Google Ads link ID",
"type": "string"
},
"selfLink": {
"description": "URL link for this Google Analytics - Google Ads link.",
"type": "string"
}
},
"type": "object",
"id": "EntityAdWordsLink"
},
"Column": {
"properties": {
"id": {
"description": "Column id.",
"type": "string"
},
"kind": {
"description": "Resource type for Analytics column.",
"default": "analytics#column",
"type": "string"
},
"attributes": {
"description": "Map of attribute name and value for this column.",
"additionalProperties": {
"description": "The name of the attribute.",
"type": "string"
},
"type": "object"
}
},
"description": "JSON template for a metadata column.",
"id": "Column",
"type": "object"
},
"CustomMetrics": {
"description": "A custom metric collection lists Analytics custom metrics to which the user has access. Each resource in the collection corresponds to a single Analytics custom metric.",
"id": "CustomMetrics",
"properties": {
"previousLink": {
"description": "Link to previous page for this custom metric collection.",
"type": "string"
},
"items": {
"items": {
"$ref": "CustomMetric"
},
"description": "Collection of custom metrics.",
"type": "array"
},
"itemsPerPage": {
"type": "integer",
"description": "The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.",
"format": "int32"
},
"kind": {
"default": "analytics#customMetrics",
"description": "Collection type.",
"type": "string"
},
"totalResults": {
"description": "The total number of results for the query, regardless of the number of results in the response.",
"format": "int32",
"type": "integer"
},
"startIndex": {
"description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.",
"format": "int32",
"type": "integer"
},
"nextLink": {
"description": "Link to next page for this custom metric collection.",
"type": "string"
},
"username": {
"description": "Email ID of the authenticated user",
"type": "string"
}
},
"type": "object"
},
"UserDeletionRequest": {
"type": "object",
"properties": {
"webPropertyId": {
"description": "Web property ID of the form UA-XXXXX-YY.",
"type": "string"
},
"propertyId": {
"type": "string",
"description": "Property ID"
},
"kind": {
"description": "Value is \"analytics#userDeletionRequest\".",
"default": "analytics#userDeletionRequest",
"type": "string"
},
"firebaseProjectId": {
"description": "Firebase Project Id",
"type": "string"
},
"id": {
"properties": {
"type": {
"description": "Type of user",
"type": "string"
},
"userId": {
"type": "string",
"description": "The User's id"
}
},
"description": "User ID.",
"type": "object"
},
"deletionRequestTime": {
"readOnly": true,
"format": "date-time",
"description": "This marks the point in time for which all user data before should be deleted",
"type": "string"
}
},
"description": "JSON template for a user deletion request resource.",
"id": "UserDeletionRequest"
},
"Accounts": {
"type": "object",
"properties": {
"startIndex": {
"description": "The starting index of the entries, which is 1 by default or otherwise specified by the start-index query parameter.",
"type": "integer",
"format": "int32"
},
"kind": {
"description": "Collection type.",
"default": "analytics#accounts",
"type": "string"
},
"totalResults": {
"type": "integer",
"format": "int32",
"description": "The total number of results for the query, regardless of the number of results in the response."
},
"previousLink": {
"description": "Previous link for this account collection.",
"type": "string"
},
"items": {
"type": "array",
"items": {
"$ref": "Account"
},
"description": "A list of accounts."
},
"username": {
"description": "Email ID of the authenticated user",
"type": "string"
},
"itemsPerPage": {
"format": "int32",
"description": "The maximum number of entries the response can contain, regardless of the actual number of entries returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.",
"type": "integer"
},
"nextLink": {
"description": "Next link for this account collection.",
"type": "string"
}
},
"description": "An account collection provides a list of Analytics accounts to which a user has access. The account collection is the entry point to all management information. Each resource in the collection corresponds to a single Analytics account.",
"id": "Accounts"
},
"AccountSummary": {
"description": "JSON template for an Analytics AccountSummary. An AccountSummary is a lightweight tree comprised of properties/profiles.",
"type": "object",
"properties": {
"webProperties": {
"type": "array",
"description": "List of web properties under this account.",
"items": {
"$ref": "WebPropertySummary"
}
},
"kind": {
"type": "string",
"description": "Resource type for Analytics AccountSummary.",
"default": "analytics#accountSummary"
},
"name": {
"type": "string",
"description": "Account name."
},
"id": {
"description": "Account ID.",
"type": "string"
},
"starred": {
"type": "boolean",
"description": "Indicates whether this account is starred or not."
}
},
"id": "AccountSummary"
},
"AccountRef": {
"properties": {
"id": {
"description": "Account ID.",
"type": "string"
},
"kind": {
"default": "analytics#accountRef",
"type": "string",
"description": "Analytics account reference."
},
"name": {
"description": "Account name.",
"type": "string"
},
"href": {
"type": "string",
"description": "Link for this account."
}
},
"type": "object",
"description": "JSON template for a linked account.",
"id": "AccountRef"
},
"CustomDataSource": {
"id": "CustomDataSource",
"description": "JSON template for an Analytics custom data source.",
"properties": {
"webPropertyId": {
"description": "Web property ID of the form UA-XXXXX-YY to which this custom data source belongs.",
"type": "string"
},
"childLink": {
"properties": {
"type": {
"description": "Value is \"analytics#dailyUploads\". Value is \"analytics#uploads\".",
"type": "string"
},
"href": {
"description": "Link to the list of daily uploads for this custom data source. Link to the list of uploads for this custom data source.",
"type": "string"
}
},
"type": "object"
},
"kind": {
"description": "Resource type for Analytics custom data source.",
"default": "analytics#customDataSource",
"type": "string"
},
"updated": {
"type": "string",
"format": "date-time",
"description": "Time this custom data source was last modified."
},
"selfLink": {
"type": "string",
"description": "Link for this Analytics custom data source."
},
"name": {
"description": "Name of this custom data source.",
"type": "string"
},
"schema": {
"description": "Collection of schema headers of the custom data source.",
"items": {
"type": "string"
},
"type": "array"
},
"parentLink": {
"type": "object",
"properties": {
"href": {
"type": "string",
"description": "Link to the web property to which this custom data source belongs."
},
"type": {
"type": "string",
"default": "analytics#webproperty",
"description": "Value is \"analytics#webproperty\"."
}
},
"description": "Parent link for this custom data source. Points to the web property to which this custom data source belongs."
},
"uploadType": {
"description": "Upload type of the custom data source.",
"type": "string"
},
"accountId": {
"type": "string",
"description": "Account ID to which this custom data source belongs."
},
"description": {
"description": "Description of custom data source.",
"type": "string"
},
"importBehavior": {
"type": "string"
},
"type": {
"type": "string",
"description": "Type of the custom data source."
},
"created": {
"type": "string",
"description": "Time this custom data source was created.",
"format": "date-time"
},
"id": {
"description": "Custom data source ID.",
"type": "string"
},
"profilesLinked": {
"description": "IDs of views (profiles) linked to the custom data source.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Filters": {
"description": "A filter collection lists filters created by users in an Analytics account. Each resource in the collection corresponds to a filter.",
"properties": {
"nextLink": {
"description": "Link to next page for this filter collection.",
"type": "string"
},
"items": {
"type": "array",
"description": "A list of filters.",
"items": {
"$ref": "Filter"
}
},
"itemsPerPage": {
"type": "integer",
"description": "The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.",
"format": "int32"
},
"username": {
"description": "Email ID of the authenticated user",
"type": "string"
},
"kind": {
"type": "string",
"default": "analytics#filters",
"description": "Collection type."
},
"totalResults": {
"description": "The total number of results for the query, regardless of the number of results in the response.",
"type": "integer",
"format": "int32"
},
"previousLink": {
"description": "Link to previous page for this filter collection.",
"type": "string"
},
"startIndex": {
"description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.",
"type": "integer",
"format": "int32"
}
},
"id": "Filters",
"type": "object"
},
"Goal": {
"type": "object",
"properties": {
"internalWebPropertyId": {
"type": "string",
"description": "Internal ID for the web property to which this goal belongs."
},
"urlDestinationDetails": {
"properties": {
"steps": {
"description": "List of steps configured for this goal funnel.",
"items": {
"type": "object",
"properties": {
"url": {
"description": "URL for this step.",
"type": "string"
},
"number": {
"format": "int32",
"type": "integer",
"description": "Step number."
},
"name": {
"description": "Step name.",
"type": "string"
}
}
},
"type": "array"
},
"caseSensitive": {
"type": "boolean",
"description": "Determines if the goal URL must exactly match the capitalization of visited URLs."
},
"matchType": {
"description": "Match type for the goal URL. Possible values are HEAD, EXACT, or REGEX.",
"type": "string"
},
"firstStepRequired": {
"type": "boolean",
"description": "Determines if the first step in this goal is required."
},
"url": {
"type": "string",
"description": "URL for this goal."
}
},
"type": "object",
"description": "Details for the goal of the type URL_DESTINATION."
},
"selfLink": {
"type": "string",
"description": "Link for this goal."
},
"parentLink": {
"type": "object",
"description": "Parent link for a goal. Points to the view (profile) to which this goal belongs.",
"properties": {
"href": {
"description": "Link to the view (profile) to which this goal belongs.",
"type": "string"
},
"type": {
"type": "string",
"default": "analytics#profile",
"description": "Value is \"analytics#profile\"."
}
}
},
"accountId": {
"type": "string",
"description": "Account ID to which this goal belongs."
},
"visitNumPagesDetails": {
"type": "object",
"description": "Details for the goal of the type VISIT_NUM_PAGES.",
"properties": {
"comparisonType": {
"description": "Type of comparison. Possible values are LESS_THAN, GREATER_THAN, or EQUAL.",
"type": "string"
},
"comparisonValue": {
"type": "string",
"format": "int64",
"description": "Value used for this comparison."
}
}
},
"created": {
"description": "Time this goal was created.",
"format": "date-time",
"type": "string"
},
"value": {
"type": "number",
"description": "Goal value.",
"format": "float"
},
"name": {
"type": "string",
"description": "Goal name."
},
"kind": {
"description": "Resource type for an Analytics goal.",
"type": "string",
"default": "analytics#goal"
},
"type": {
"type": "string",
"description": "Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT."
},
"visitTimeOnSiteDetails": {
"description": "Details for the goal of the type VISIT_TIME_ON_SITE.",
"type": "object",
"properties": {
"comparisonType": {
"description": "Type of comparison. Possible values are LESS_THAN or GREATER_THAN.",
"type": "string"
},
"comparisonValue": {
"type": "string",
"description": "Value used for this comparison.",
"format": "int64"
}
}
},
"updated": {
"format": "date-time",
"type": "string",
"description": "Time this goal was last modified."
},
"id": {
"description": "Goal ID.",
"type": "string"
},
"eventDetails": {
"description": "Details for the goal of the type EVENT.",
"properties": {
"useEventValue": {
"description": "Determines if the event value should be used as the value for this goal.",
"type": "boolean"
},
"eventConditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"comparisonType": {
"description": "Type of comparison. Possible values are LESS_THAN, GREATER_THAN or EQUAL.",
"type": "string"
},
"matchType": {
"type": "string",
"description": "Type of the match to be performed. Possible values are REGEXP, BEGINS_WITH, or EXACT."
},
"comparisonValue": {
"description": "Value used for this comparison.",
"format": "int64",
"type": "string"
},
"expression": {
"type": "string",
"description": "Expression used for this match."
},
"type": {
"description": "Type of this event condition. Possible values are CATEGORY, ACTION, LABEL, or VALUE.",
"type": "string"
}
}
},
"description": "List of event conditions."
}
},
"type": "object"
},
"webPropertyId": {
"description": "Web property ID to which this goal belongs. The web property ID is of the form UA-XXXXX-YY.",
"type": "string"
},
"active": {
"type": "boolean",
"description": "Determines whether this goal is active."
},
"profileId": {
"description": "View (Profile) ID to which this goal belongs.",
"type": "string"
}
},
"description": "JSON template for Analytics goal resource.",
"id": "Goal"
},
"EntityUserLinks": {
"id": "EntityUserLinks",
"type": "object",
"properties": {
"totalResults": {
"format": "int32",
"type": "integer",
"description": "The total number of results for the query, regardless of the number of results in the response."
},
"previousLink": {
"type": "string",
"description": "Previous link for this account collection."
},
"kind": {
"description": "Collection type.",
"default": "analytics#entityUserLinks",
"type": "string"
},
"startIndex": {
"description": "The starting index of the entries, which is 1 by default or otherwise specified by the start-index query parameter.",
"format": "int32",
"type": "integer"
},
"itemsPerPage": {
"type": "integer",
"format": "int32",
"description": "The maximum number of entries the response can contain, regardless of the actual number of entries returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter."
},
"items": {
"type": "array",
"items": {
"$ref": "EntityUserLink"
},
"description": "A list of entity user links."
},
"nextLink": {
"type": "string",
"description": "Next link for this account collection."
}
},
"description": "An entity user link collection provides a list of Analytics ACL links Each resource in this collection corresponds to a single link."
},
"RemarketingAudience": {
"properties": {
"created": {
"format": "date-time",
"description": "Time this remarketing audience was created.",
"readOnly": true,
"type": "string"
},
"id": {
"description": "Remarketing Audience ID.",
"type": "string"
},
"audienceDefinition": {
"properties": {
"includeConditions": {
"description": "Defines the conditions to include users to the audience.",
"$ref": "IncludeConditions"
}
},
"description": "The simple audience definition that will cause a user to be added to an audience.",
"type": "object"
},
"stateBasedAudienceDefinition": {
"properties": {
"excludeConditions": {
"description": "Defines the conditions to exclude users from the audience.",
"properties": {
"exclusionDuration": {
"type": "string",
"description": "Whether to make the exclusion TEMPORARY or PERMANENT."
},
"segment": {
"description": "The segment condition that will cause a user to be removed from an audience.",
"type": "string"
}
},
"type": "object"
},
"includeConditions": {
"$ref": "IncludeConditions",
"description": "Defines the conditions to include users to the audience."
}
},
"type": "object",
"description": "A state based audience definition that will cause a user to be added or removed from an audience."
},
"linkedAdAccounts": {
"items": {
"$ref": "LinkedForeignAccount"
},
"type": "array",
"description": "The linked ad accounts associated with this remarketing audience. A remarketing audience can have only one linkedAdAccount currently."
},
"audienceType": {
"type": "string",
"description": "The type of audience, either SIMPLE or STATE_BASED."
},
"linkedViews": {
"items": {
"type": "string"
},
"description": "The views (profiles) that this remarketing audience is linked to.",
"type": "array"
},
"kind": {
"description": "Collection type.",
"default": "analytics#remarketingAudience",
"type": "string"
},
"internalWebPropertyId": {
"readOnly": true,
"description": "Internal ID for the web property to which this remarketing audience belongs.",
"type": "string"
},
"webPropertyId": {
"description": "Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs.",
"type": "string"
},
"description": {
"type": "string",
"description": "The description of this remarketing audience.",
"readOnly": true
},
"name": {
"description": "The name of this remarketing audience.",
"type": "string"
},
"accountId": {
"description": "Account ID to which this remarketing audience belongs.",
"type": "string"
},
"updated": {
"description": "Time this remarketing audience was last modified.",
"readOnly": true,
"format": "date-time",
"type": "string"
}
},
"type": "object",
"description": "JSON template for an Analytics remarketing audience.",
"id": "RemarketingAudience"
},
"Account": {
"id": "Account",
"description": "JSON template for Analytics account entry.",
"properties": {
"selfLink": {
"description": "Link for this account.",
"type": "string"
},
"id": {
"type": "string",
"description": "Account ID."
},
"created": {
"type": "string",
"format": "date-time",
"description": "Time the account was created."
},
"name": {
"description": "Account name.",
"type": "string"
},
"starred": {
"description": "Indicates whether this account is starred or not.",
"type": "boolean"
},
"kind": {
"type": "string",
"default": "analytics#account",
"description": "Resource type for Analytics account."
},
"permissions": {
"description": "Permissions the user has for this account.",
"type": "object",
"properties": {
"effective": {
"readOnly": true,
"type": "array",
"description": "All the permissions that the user has for this account. These include any implied permissions (e.g., EDIT implies VIEW).",
"items": {
"type": "string"
}
}
}
},
"updated": {
"type": "string",
"format": "date-time",
"description": "Time the account was last modified."
},
"childLink": {
"properties": {
"href": {
"description": "Link to the list of web properties for this account.",
"type": "string"
},
"type": {
"description": "Type of the child link. Its value is \"analytics#webproperties\".",
"default": "analytics#webproperties",
"type": "string"
}
},
"type": "object",
"description": "Child link for an account entry. Points to the list of web properties for this account."
}
},
"type": "object"
},
"Segment": {
"description": "JSON template for an Analytics segment.",
"id": "Segment",
"type": "object",
"properties": {
"created": {
"description": "Time the segment was created.",
"format": "date-time",
"type": "string"
},
"selfLink": {
"description": "Link for this segment.",
"type": "string"
},
"definition": {
"description": "Segment definition.",
"type": "string"
},
"type": {
"description": "Type for a segment. Possible values are \"BUILT_IN\" or \"CUSTOM\".",
"type": "string"
},
"updated": {
"format": "date-time",
"type": "string",
"description": "Time the segment was last modified."
},
"kind": {
"default": "analytics#segment",
"description": "Resource type for Analytics segment.",
"type": "string"
},
"name": {
"type": "string",
"description": "Segment name."
},
"id": {
"type": "string",
"description": "Segment ID."
},
"segmentId": {
"type": "string",
"description": "Segment ID. Can be used with the 'segment' parameter in Core Reporting API."
}
}
},
"EntityUserLink": {
"description": "JSON template for an Analytics Entity-User Link. Returns permissions that a user has for an entity.",
"type": "object",
"properties": {
"entity": {
"type": "object",
"description": "Entity for this link. It can be an account, a web property, or a view (profile).",
"properties": {
"profileRef": {
"description": "View (Profile) for this link.",
"$ref": "ProfileRef"
},
"accountRef": {
"$ref": "AccountRef",
"description": "Account for this link."
},
"webPropertyRef": {
"description": "Web property for this link.",
"$ref": "WebPropertyRef"
}
}
},
"kind": {
"description": "Resource type for entity user link.",
"type": "string",
"default": "analytics#entityUserLink"
},
"id": {
"description": "Entity user link ID",
"type": "string"
},
"permissions": {
"properties": {
"effective": {
"readOnly": true,
"items": {
"type": "string"
},
"description": "Effective permissions represent all the permissions that a user has for this entity. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent entity. Effective permissions are read-only.",
"type": "array"
},
"local": {
"type": "array",
"description": "Permissions that a user has been assigned at this very level. Does not include any implied or inherited permissions. Local permissions are modifiable.",
"items": {
"type": "string"
}
}
},
"description": "Permissions the user has for this entity.",
"type": "object"
},
"selfLink": {
"type": "string",
"description": "Self link for this resource."
},
"userRef": {
"description": "User reference.",
"$ref": "UserRef"
}
},
"id": "EntityUserLink"
},
"CustomDimension": {
"type": "object",
"id": "CustomDimension",
"properties": {
"name": {
"description": "Name of the custom dimension.",
"type": "string"
},
"id": {
"type": "string",
"description": "Custom dimension ID."
},
"kind": {
"default": "analytics#customDimension",
"description": "Kind value for a custom dimension. Set to \"analytics#customDimension\". It is a read-only field.",
"readOnly": true,
"type": "string"
},
"scope": {
"description": "Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.",
"type": "string"
},
"created": {
"format": "date-time",
"type": "string",
"readOnly": true,
"description": "Time the custom dimension was created."
},
"index": {
"description": "Index of the custom dimension.",
"type": "integer",
"format": "int32",
"readOnly": true
},
"selfLink": {
"readOnly": true,
"type": "string",
"description": "Link for the custom dimension"
},
"webPropertyId": {
"description": "Property ID.",
"type": "string"
},
"active": {
"type": "boolean",
"description": "Boolean indicating whether the custom dimension is active."
},
"parentLink": {
"properties": {
"href": {
"type": "string",
"description": "Link to the property to which the custom dimension belongs."
},
"type": {
"description": "Type of the parent link. Set to \"analytics#webproperty\".",
"default": "analytics#webproperty",
"type": "string"
}
},
"type": "object",
"description": "Parent link for the custom dimension. Points to the property to which the custom dimension belongs."
},
"accountId": {
"description": "Account ID.",
"type": "string"
},
"updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "Time the custom dimension was last modified."
}
},
"description": "JSON template for Analytics Custom Dimension."
},
"Goals": {
"description": "A goal collection lists Analytics goals to which the user has access. Each view (profile) can have a set of goals. Each resource in the Goal collection corresponds to a single Analytics goal.",
"type": "object",
"id": "Goals",
"properties": {
"items": {
"items": {
"$ref": "Goal"
},
"type": "array",
"description": "A list of goals."
},
"startIndex": {
"format": "int32",
"type": "integer",
"description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter."
},
"previousLink": {
"description": "Link to previous page for this goal collection.",
"type": "string"
},
"username": {
"description": "Email ID of the authenticated user",
"type": "string"
},
"nextLink": {
"type": "string",
"description": "Link to next page for this goal collection."
},
"kind": {
"description": "Collection type.",
"type": "string",
"default": "analytics#goals"
},
"totalResults": {
"description": "The total number of results for the query, regardless of the number of resources in the result.",
"format": "int32",
"type": "integer"
},
"itemsPerPage": {
"format": "int32",
"description": "The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.",
"type": "integer"
}
}
},
"Uploads": {
"description": "Upload collection lists Analytics uploads to which the user has access. Each custom data source can have a set of uploads. Each resource in the upload collection corresponds to a single Analytics data upload.",
"properties": {
"nextLink": {
"description": "Link to next page for this upload collection.",
"type": "string"
},
"totalResults": {
"type": "integer",
"description": "The total number of results for the query, regardless of the number of resources in the result.",
"format": "int32"
},
"previousLink": {
"description": "Link to previous page for this upload collection.",
"type": "string"
},
"startIndex": {
"type": "integer",
"description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.",
"format": "int32"
},
"items": {
"description": "A list of uploads.",
"type": "array",
"items": {
"$ref": "Upload"
}
},
"itemsPerPage": {
"format": "int32",
"type": "integer",
"description": "The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter."
},
"kind": {
"description": "Collection type.",
"default": "analytics#uploads",
"type": "string"
}
},
"id": "Uploads",
"type": "object"
},
"AdWordsAccount": {
"id": "AdWordsAccount",
"type": "object",
"properties": {
"autoTaggingEnabled": {
"type": "boolean",
"description": "True if auto-tagging is enabled on the Google Ads account. Read-only after the insert operation."
},
"customerId": {
"annotations": {
"required": [
"analytics.management.webPropertyAdWordsLinks.insert",
"analytics.management.webPropertyAdWordsLinks.update"
]
},
"type": "string",
"description": "Customer ID. This field is required when creating a Google Ads link."
},
"kind": {
"default": "analytics#adWordsAccount",
"description": "Resource type for Google Ads account.",
"type": "string"
}
},
"description": "JSON template for an Google Ads account."
},
"WebPropertySummary": {
"properties": {
"profiles": {
"description": "List of profiles under this web property.",
"items": {
"$ref": "ProfileSummary"
},
"type": "array"
},
"kind": {
"default": "analytics#webPropertySummary",
"type": "string",
"description": "Resource type for Analytics WebPropertySummary."
},
"websiteUrl": {
"description": "Website url for this web property.",
"type": "string"
},
"name": {
"description": "Web property name.",
"type": "string"
},
"internalWebPropertyId": {
"type": "string",
"description": "Internal ID for this web property."
},
"id": {
"type": "string",
"description": "Web property ID of the form UA-XXXXX-YY."
},
"starred": {
"type": "boolean",
"description": "Indicates whether this web property is starred or not."
},
"level": {
"description": "Level for this web property. Possible values are STANDARD or PREMIUM.",
"type": "string"
}
},
"description": "JSON template for an Analytics WebPropertySummary. WebPropertySummary returns basic information (i.e., summary) for a web property.",
"type": "object",
"id": "WebPropertySummary"
},
"Experiments": {
"id": "Experiments",
"description": "An experiment collection lists Analytics experiments to which the user has access. Each view (profile) can have a set of experiments. Each resource in the Experiment collection corresponds to a single Analytics experiment.",
"properties": {
"startIndex": {
"type": "integer",
"description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.",
"format": "int32"
},
"totalResults": {
"description": "The total number of results for the query, regardless of the number of resources in the result.",
"format": "int32",
"type": "integer"
},
"itemsPerPage": {
"type": "integer",
"format": "int32",
"description": "The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter."
},
"kind": {
"type": "string",
"default": "analytics#experiments",
"description": "Collection type."
},
"nextLink": {
"description": "Link to next page for this experiment collection.",
"type": "string"
},
"previousLink": {
"description": "Link to previous page for this experiment collection.",
"type": "string"
},
"items": {
"items": {
"$ref": "Experiment"
},
"type": "array",
"description": "A list of experiments."
},
"username": {
"description": "Email ID of the authenticated user",
"type": "string"
}
},
"type": "object"
},
"Webproperties": {
"description": "A web property collection lists Analytics web properties to which the user has access. Each resource in the collection corresponds to a single Analytics web property.",
"properties": {
"kind": {
"type": "string",
"description": "Collection type.",
"default": "analytics#webproperties"
},
"previousLink": {
"description": "Link to previous page for this web property collection.",
"type": "string"
},
"totalResults": {
"description": "The total number of results for the query, regardless of the number of results in the response.",
"type": "integer",
"format": "int32"
},
"items": {
"items": {
"$ref": "Webproperty"
},
"type": "array",
"description": "A list of web properties."
},
"startIndex": {
"format": "int32",
"type": "integer",
"description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter."
},
"itemsPerPage": {
"type": "integer",
"format": "int32",
"description": "The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter."
},
"nextLink": {
"description": "Link to next page for this web property collection.",
"type": "string"
},
"username": {
"description": "Email ID of the authenticated user",
"type": "string"
}
},
"id": "Webproperties",
"type": "object"
},
"RealtimeData": {
"id": "RealtimeData",
"properties": {
"columnHeaders": {
"items": {
"properties": {
"columnType": {
"description": "Column Type. Either DIMENSION or METRIC.",
"type": "string"
},
"name": {
"type": "string",
"description": "Column name."
},
"dataType": {
"type": "string",
"description": "Data type. Dimension column headers have only STRING as the data type. Metric column headers have data types for metric values such as INTEGER, DOUBLE, CURRENCY etc."
}
},
"type": "object"
},
"description": "Column headers that list dimension names followed by the metric names. The order of dimensions and metrics is same as specified in the request.",
"type": "array"
},
"id": {
"type": "string",
"description": "Unique ID for this data response."
},
"rows": {
"description": "Real time data rows, where each row contains a list of dimension values followed by the metric values. The order of dimensions and metrics is same as specified in the request.",
"items": {
"type": "array",
"items": {
"type": "string"
}
},
"type": "array"
},
"selfLink": {
"description": "Link to this page.",
"type": "string"
},
"totalResults": {
"type": "integer",
"description": "The total number of rows for the query, regardless of the number of rows in the response.",
"format": "int32"
},
"totalsForAllResults": {
"description": "Total values for the requested metrics over all the results, not just the results returned in this response. The order of the metric totals is same as the metric order specified in the request.",
"type": "object",
"additionalProperties": {
"type": "string",
"description": "Key-value pair for the total value of a metric. Key is the metric name and the value is the total value for that metric."
}
},
"kind": {
"type": "string",
"default": "analytics#realtimeData",
"description": "Resource type."
},
"profileInfo": {
"description": "Information for the view (profile), for which the real time data was requested.",
"properties": {
"tableId": {
"description": "Table ID for view (profile).",
"type": "string"
},
"internalWebPropertyId": {
"description": "Internal ID for the web property to which this view (profile) belongs.",
"type": "string"
},
"profileName": {
"description": "View (Profile) name.",
"type": "string"
},
"webPropertyId": {
"description": "Web Property ID to which this view (profile) belongs.",
"type": "string"
},
"profileId": {
"description": "View (Profile) ID.",
"type": "string"
},
"accountId": {
"description": "Account ID to which this view (profile) belongs.",
"type": "string"
}
},
"type": "object"
},
"query": {
"type": "object",
"description": "Real time data request query parameters.",
"properties": {
"sort": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of dimensions or metrics based on which real time data is sorted."
},
"dimensions": {
"description": "List of real time dimensions.",
"type": "string"
},
"max-results": {
"type": "integer",
"description": "Maximum results per page.",
"format": "int32"
},
"filters": {
"type": "string",
"description": "Comma-separated list of dimension or metric filters."
},
"metrics": {
"items": {
"type": "string"
},
"type": "array",
"description": "List of real time metrics."
},
"ids": {
"type": "string",
"description": "Unique table ID."
}
}
}
},
"description": "Real time data for a given view (profile).",
"type": "object"
},
"AccountTicket": {
"description": "JSON template for an Analytics account ticket. The account ticket consists of the ticket ID and the basic information for the account, property and profile.",
"type": "object",
"id": "AccountTicket",
"properties": {
"redirectUri": {
"description": "Redirect URI where the user will be sent after accepting Terms of Service. Must be configured in APIs console as a callback URL.",
"type": "string"
},
"id": {
"description": "Account ticket ID used to access the account ticket.",
"type": "string"
},
"profile": {
"$ref": "Profile",
"description": "View (Profile) for the account."
},
"webproperty": {
"$ref": "Webproperty",
"description": "Web property for the account."
},
"account": {
"description": "Account for this ticket.",
"$ref": "Account"
},
"kind": {
"description": "Resource type for account ticket.",
"default": "analytics#accountTicket",
"type": "string"
}
}
},
"Filter": {
"properties": {
"includeDetails": {
"description": "Details for the filter of the type INCLUDE.",
"$ref": "FilterExpression"
},
"advancedDetails": {
"type": "object",
"properties": {
"outputConstructor": {
"type": "string",
"description": "Expression used to construct the output value."
},
"fieldBRequired": {
"description": "Indicates if field B is required to match.",
"type": "boolean"
},
"fieldB": {
"type": "string",
"description": "Field B."
},
"fieldBIndex": {
"description": "The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.",
"format": "int32",
"type": "integer"
},
"outputToFieldIndex": {
"format": "int32",
"description": "The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.",
"type": "integer"
},
"fieldARequired": {
"type": "boolean",
"description": "Indicates if field A is required to match."
},
"overrideOutputField": {
"type": "boolean",
"description": "Indicates if the existing value of the output field, if any, should be overridden by the output expression."
},
"extractA": {
"type": "string",
"description": "Expression to extract from field A."
},
"outputToField": {
"description": "Output field.",
"type": "string"
},
"extractB": {
"description": "Expression to extract from field B.",
"type": "string"
},
"fieldAIndex": {
"type": "integer",
"description": "The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.",
"format": "int32"
},
"fieldA": {
"type": "string",
"description": "Field A."
},
"caseSensitive": {
"description": "Indicates if the filter expressions are case sensitive.",
"type": "boolean"
}
},
"description": "Details for the filter of the type ADVANCED."
},
"id": {
"type": "string",
"description": "Filter ID."
},
"excludeDetails": {
"description": "Details for the filter of the type EXCLUDE.",
"$ref": "FilterExpression"
},
"kind": {
"readOnly": true,
"default": "analytics#filter",
"description": "Resource type for Analytics filter.",
"type": "string"
},
"name": {
"type": "string",
"description": "Name of this filter.",
"annotations": {
"required": [
"analytics.management.filters.insert",
"analytics.management.filters.update"
]
}
},
"lowercaseDetails": {
"type": "object",
"description": "Details for the filter of the type LOWER.",
"properties": {
"field": {
"description": "Field to use in the filter.",
"type": "string"
},
"fieldIndex": {
"description": "The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.",
"type": "integer",
"format": "int32"
}
}
},
"searchAndReplaceDetails": {
"type": "object",
"description": "Details for the filter of the type SEARCH_AND_REPLACE.",
"properties": {
"searchString": {
"description": "Term to search.",
"type": "string"
},
"replaceString": {
"type": "string",
"description": "Term to replace the search term with."
},
"caseSensitive": {
"description": "Determines if the filter is case sensitive.",
"type": "boolean"
},
"fieldIndex": {
"description": "The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.",
"type": "integer",
"format": "int32"
},
"field": {
"type": "string",
"description": "Field to use in the filter."
}
}
},
"accountId": {
"description": "Account ID to which this filter belongs.",
"type": "string"
},
"parentLink": {
"type": "object",
"properties": {
"type": {
"default": "analytics#account",
"type": "string",
"description": "Value is \"analytics#account\"."
},
"href": {
"type": "string",
"description": "Link to the account to which this filter belongs."
}
},
"description": "Parent link for this filter. Points to the account to which this filter belongs."
},
"uppercaseDetails": {
"type": "object",
"description": "Details for the filter of the type UPPER.",
"properties": {
"fieldIndex": {
"format": "int32",
"type": "integer",
"description": "The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION."
},
"field": {
"description": "Field to use in the filter.",
"type": "string"
}
}
},
"updated": {
"description": "Time this filter was last modified.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"type": {
"type": "string",
"description": "Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED.",
"annotations": {
"required": [
"analytics.management.filters.insert",
"analytics.management.filters.update"
]
}
},
"created": {
"format": "date-time",
"type": "string",
"description": "Time this filter was created.",
"readOnly": true
},
"selfLink": {
"description": "Link for this filter.",
"readOnly": true,
"type": "string"
}
},
"type": "object",
"id": "Filter",
"description": "JSON template for an Analytics account filter."
},
"FilterRef": {
"properties": {
"accountId": {
"type": "string",
"description": "Account ID to which this filter belongs.",
"readOnly": true
},
"id": {
"annotations": {
"required": [
"analytics.management.profileFilterLinks.insert"
]
},
"type": "string",
"description": "Filter ID."
},
"kind": {
"default": "analytics#filterRef",
"type": "string",
"description": "Kind value for filter reference."
},
"name": {
"type": "string",
"readOnly": true,
"description": "Name of this filter."
},
"href": {
"type": "string",
"description": "Link for this filter."
}
},
"description": "JSON template for a profile filter link.",
"type": "object",
"id": "FilterRef"
},
"HashClientIdResponse": {
"description": "JSON template for a hash Client Id response resource.",
"id": "HashClientIdResponse",
"properties": {
"kind": {
"type": "string",
"default": "analytics#hashClientIdResponse"
},
"webPropertyId": {
"type": "string"
},
"clientId": {
"type": "string"
},
"hashedClientId": {
"type": "string"
}
},
"type": "object"
},
"Webproperty": {
"properties": {
"selfLink": {
"description": "Link for this web property.",
"type": "string",
"readOnly": true
},
"accountId": {
"type": "string",
"description": "Account ID to which this web property belongs."
},
"industryVertical": {
"type": "string",
"description": "The industry vertical/category selected for this web property."
},
"starred": {
"description": "Indicates whether this web property is starred or not.",
"type": "boolean"
},
"dataRetentionResetOnNewActivity": {
"description": "Set to true to reset the retention period of the user identifier with each new event from that user (thus setting the expiration date to current time plus retention period).\nSet to false to delete data associated with the user identifier automatically after the rentention period.\nThis property cannot be set on insert.",
"type": "boolean"
},
"defaultProfileId": {
"format": "int64",
"description": "Default view (profile) ID.",
"type": "string"
},
"name": {
"description": "Name of this web property.",
"type": "string"
},
"updated": {
"readOnly": true,
"description": "Time this web property was last modified.",
"type": "string",
"format": "date-time"
},
"id": {
"description": "Web property ID of the form UA-XXXXX-YY.",
"type": "string"
},
"permissions": {
"type": "object",
"description": "Permissions the user has for this web property.",
"properties": {
"effective": {
"readOnly": true,
"type": "array",
"description": "All the permissions that the user has for this web property. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent account.",
"items": {
"type": "string"
}
}
}
},
"kind": {
"readOnly": true,
"type": "string",
"description": "Resource type for Analytics WebProperty.",
"default": "analytics#webproperty"
},
"websiteUrl": {
"type": "string",
"description": "Website url for this web property."
},
"parentLink": {
"description": "Parent link for this web property. Points to the account to which this web property belongs.",
"type": "object",
"properties": {
"type": {
"description": "Type of the parent link. Its value is \"analytics#account\".",
"type": "string",
"default": "analytics#account"
},
"href": {
"type": "string",
"description": "Link to the account for this web property."
}
}
},
"created": {
"format": "date-time",
"type": "string",
"readOnly": true,
"description": "Time this web property was created."
},
"level": {
"readOnly": true,
"type": "string",
"description": "Level for this web property. Possible values are STANDARD or PREMIUM."
},
"profileCount": {
"format": "int32",
"readOnly": true,
"type": "integer",
"description": "View (Profile) count for this web property."
},
"internalWebPropertyId": {
"type": "string",
"readOnly": true,
"description": "Internal ID for this web property."
},
"childLink": {
"description": "Child link for this web property. Points to the list of views (profiles) for this web property.",
"type": "object",
"properties": {
"href": {
"description": "Link to the list of views (profiles) for this web property.",
"type": "string"
},
"type": {
"description": "Type of the parent link. Its value is \"analytics#profiles\".",
"type": "string",
"default": "analytics#profiles"
}
}
},
"dataRetentionTtl": {
"description": "The length of time for which user and event data is retained.\nThis property cannot be set on insert.",
"type": "string"
}
},
"id": "Webproperty",
"description": "JSON template for an Analytics web property.",
"type": "object"
},
"FilterExpression": {
"id": "FilterExpression",
"properties": {
"expressionValue": {
"description": "Filter expression value",
"type": "string"
},
"field": {
"type": "string",
"description": "Field to filter. Possible values: \n- Content and Traffic \n- PAGE_REQUEST_URI, \n- PAGE_HOSTNAME, \n- PAGE_TITLE, \n- REFERRAL, \n- COST_DATA_URI (Campaign target URL), \n- HIT_TYPE, \n- INTERNAL_SEARCH_TERM, \n- INTERNAL_SEARCH_TYPE, \n- SOURCE_PROPERTY_TRACKING_ID, \n- Campaign or AdGroup \n- CAMPAIGN_SOURCE, \n- CAMPAIGN_MEDIUM, \n- CAMPAIGN_NAME, \n- CAMPAIGN_AD_GROUP, \n- CAMPAIGN_TERM, \n- CAMPAIGN_CONTENT, \n- CAMPAIGN_CODE, \n- CAMPAIGN_REFERRAL_PATH, \n- E-Commerce \n- TRANSACTION_COUNTRY, \n- TRANSACTION_REGION, \n- TRANSACTION_CITY, \n- TRANSACTION_AFFILIATION (Store or order location), \n- ITEM_NAME, \n- ITEM_CODE, \n- ITEM_VARIATION, \n- TRANSACTION_ID, \n- TRANSACTION_CURRENCY_CODE, \n- PRODUCT_ACTION_TYPE, \n- Audience/Users \n- BROWSER, \n- BROWSER_VERSION, \n- BROWSER_SIZE, \n- PLATFORM, \n- PLATFORM_VERSION, \n- LANGUAGE, \n- SCREEN_RESOLUTION, \n- SCREEN_COLORS, \n- JAVA_ENABLED (Boolean Field), \n- FLASH_VERSION, \n- GEO_SPEED (Connection speed), \n- VISITOR_TYPE, \n- GEO_ORGANIZATION (ISP organization), \n- GEO_DOMAIN, \n- GEO_IP_ADDRESS, \n- GEO_IP_VERSION, \n- Location \n- GEO_COUNTRY, \n- GEO_REGION, \n- GEO_CITY, \n- Event \n- EVENT_CATEGORY, \n- EVENT_ACTION, \n- EVENT_LABEL, \n- Other \n- CUSTOM_FIELD_1, \n- CUSTOM_FIELD_2, \n- USER_DEFINED_VALUE, \n- Application \n- APP_ID, \n- APP_INSTALLER_ID, \n- APP_NAME, \n- APP_VERSION, \n- SCREEN, \n- IS_APP (Boolean Field), \n- IS_FATAL_EXCEPTION (Boolean Field), \n- EXCEPTION_DESCRIPTION, \n- Mobile device \n- IS_MOBILE (Boolean Field, Deprecated. Use DEVICE_CATEGORY=mobile), \n- IS_TABLET (Boolean Field, Deprecated. Use DEVICE_CATEGORY=tablet), \n- DEVICE_CATEGORY, \n- MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field), \n- MOBILE_HAS_NFC_SUPPORT (Boolean Field), \n- MOBILE_HAS_CELLULAR_RADIO (Boolean Field), \n- MOBILE_HAS_WIFI_SUPPORT (Boolean Field), \n- MOBILE_BRAND_NAME, \n- MOBILE_MODEL_NAME, \n- MOBILE_MARKETING_NAME, \n- MOBILE_POINTING_METHOD, \n- Social \n- SOCIAL_NETWORK, \n- SOCIAL_ACTION, \n- SOCIAL_ACTION_TARGET, \n- Custom dimension \n- CUSTOM_DIMENSION (See accompanying field index),"
},
"fieldIndex": {
"format": "int32",
"type": "integer",
"description": "The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION."
},
"kind": {
"default": "analytics#filterExpression",
"description": "Kind value for filter expression",
"type": "string"
},
"matchType": {
"description": "Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, or MATCHES. GEO_DOMAIN, GEO_IP_ADDRESS, PAGE_REQUEST_URI, or PAGE_HOSTNAME filters can use any match type; all other filters must use MATCHES.",
"type": "string"
},
"caseSensitive": {
"description": "Determines if the filter is case sensitive.",
"type": "boolean"
}
},
"description": "JSON template for an Analytics filter expression.",
"type": "object"
},
"ProfileRef": {
"description": "JSON template for a linked view (profile).",
"type": "object",
"id": "ProfileRef",
"properties": {
"internalWebPropertyId": {
"type": "string",
"description": "Internal ID for the web property to which this view (profile) belongs."
},
"webPropertyId": {
"description": "Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.",
"type": "string"
},
"accountId": {
"type": "string",
"description": "Account ID to which this view (profile) belongs."
},
"id": {
"type": "string",
"description": "View (Profile) ID."
},
"href": {
"type": "string",
"description": "Link for this view (profile)."
},
"kind": {
"description": "Analytics view (profile) reference.",
"type": "string",
"default": "analytics#profileRef"
},
"name": {
"type": "string",
"description": "Name of this view (profile)."
}
}
},
"RemarketingAudiences": {
"properties": {
"username": {
"description": "Email ID of the authenticated user",
"type": "string"
},
"items": {
"type": "array",
"items": {
"$ref": "RemarketingAudience"
},
"description": "A list of remarketing audiences."
},
"nextLink": {
"description": "Link to next page for this remarketing audience collection.",
"type": "string"
},
"kind": {
"default": "analytics#remarketingAudiences",
"description": "Collection type.",
"type": "string"
},
"itemsPerPage": {
"type": "integer",
"format": "int32",
"description": "The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter."
},
"totalResults": {
"format": "int32",
"type": "integer",
"description": "The total number of results for the query, regardless of the number of results in the response."
},
"startIndex": {
"description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.",
"type": "integer",
"format": "int32"
},
"previousLink": {
"type": "string",
"description": "Link to previous page for this view (profile) collection."
}
},
"description": "A remarketing audience collection lists Analytics remarketing audiences to which the user has access. Each resource in the collection corresponds to a single Analytics remarketing audience.",
"type": "object",
"id": "RemarketingAudiences"
},
"Profile": {
"properties": {
"eCommerceTracking": {
"type": "boolean",
"description": "Indicates whether ecommerce tracking is enabled for this view (profile)."
},
"excludeQueryParameters": {
"description": "The query parameters that are excluded from this view (profile).",
"type": "string"
},
"botFilteringEnabled": {
"type": "boolean",
"description": "Indicates whether bot filtering is enabled for this view (profile)."
},
"created": {
"type": "string",
"description": "Time this view (profile) was created.",
"readOnly": true,
"format": "date-time"
},
"timezone": {
"description": "Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database.",
"type": "string"
},
"selfLink": {
"description": "Link for this view (profile).",
"readOnly": true,
"type": "string"
},
"starred": {
"description": "Indicates whether this view (profile) is starred or not.",
"type": "boolean"
},
"permissions": {
"properties": {
"effective": {
"items": {
"type": "string"
},
"readOnly": true,
"type": "array",
"description": "All the permissions that the user has for this view (profile). These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent web property."
}
},
"type": "object",
"description": "Permissions the user has for this view (profile)."
},
"childLink": {
"description": "Child link for this view (profile). Points to the list of goals for this view (profile).",
"properties": {
"type": {
"description": "Value is \"analytics#goals\".",
"type": "string",
"default": "analytics#goals"
},
"href": {
"description": "Link to the list of goals for this view (profile).",
"type": "string"
}
},
"type": "object"
},
"currency": {
"description": "The currency type associated with this view (profile), defaults to USD. The supported values are:\nUSD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL",
"type": "string"
},
"webPropertyId": {
"description": "Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.",
"type": "string",
"readOnly": true
},
"stripSiteSearchCategoryParameters": {
"type": "boolean",
"description": "Whether or not Analytics will strip search category parameters from the URLs in your reports."
},
"name": {
"description": "Name of this view (profile).",
"type": "string"
},
"kind": {
"type": "string",
"default": "analytics#profile",
"readOnly": true,
"description": "Resource type for Analytics view (profile)."
},
"siteSearchQueryParameters": {
"type": "string",
"description": "The site search query parameters for this view (profile)."
},
"id": {
"type": "string",
"description": "View (Profile) ID."
},
"defaultPage": {
"type": "string",
"description": "Default page for this view (profile)."
},
"stripSiteSearchQueryParameters": {
"type": "boolean",
"description": "Whether or not Analytics will strip search query parameters from the URLs in your reports."
},
"enhancedECommerceTracking": {
"description": "Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled.",
"type": "boolean"
},
"accountId": {
"type": "string",
"description": "Account ID to which this view (profile) belongs."
},
"internalWebPropertyId": {
"type": "string",
"readOnly": true,
"description": "Internal ID for the web property to which this view (profile) belongs."
},
"siteSearchCategoryParameters": {
"description": "Site search category parameters for this view (profile).",
"type": "string"
},
"parentLink": {
"description": "Parent link for this view (profile). Points to the web property to which this view (profile) belongs.",
"properties": {
"href": {
"description": "Link to the web property to which this view (profile) belongs.",
"type": "string"
},
"type": {
"type": "string",
"description": "Value is \"analytics#webproperty\".",
"default": "analytics#webproperty"
}
},
"type": "object"
},
"type": {
"type": "string",
"description": "View (Profile) type. Supported types: WEB or APP."
},
"websiteUrl": {
"type": "string",
"description": "Website URL for this view (profile)."
},
"updated": {
"description": "Time this view (profile) was last modified.",
"readOnly": true,
"format": "date-time",
"type": "string"
}
},
"description": "JSON template for an Analytics view (profile).",
"type": "object",
"id": "Profile"
},
"Upload": {
"properties": {
"status": {
"description": "Upload status. Possible values: PENDING, COMPLETED, FAILED, DELETING, DELETED.",
"type": "string"
},
"uploadTime": {
"description": "Time this file is uploaded.",
"format": "date-time",
"type": "string"
},
"customDataSourceId": {
"type": "string",
"description": "Custom data source Id to which this data import belongs."
},
"id": {
"description": "A unique ID for this upload.",
"type": "string"
},
"accountId": {
"type": "string",
"description": "Account Id to which this upload belongs.",
"format": "int64"
},
"kind": {
"default": "analytics#upload",
"type": "string",
"description": "Resource type for Analytics upload."
},
"errors": {
"description": "Data import errors collection.",
"items": {
"type": "string"
},
"type": "array"
}
},
"id": "Upload",
"type": "object",
"description": "Metadata returned for an upload operation."
},
"AccountSummaries": {
"properties": {
"kind": {
"description": "Collection type.",
"type": "string",
"default": "analytics#accountSummaries"
},
"totalResults": {
"format": "int32",
"description": "The total number of results for the query, regardless of the number of results in the response.",
"type": "integer"
},
"items": {
"type": "array",
"items": {
"$ref": "AccountSummary"
},
"description": "A list of AccountSummaries."
},
"previousLink": {
"description": "Link to previous page for this AccountSummary collection.",
"type": "string"
},
"nextLink": {
"type": "string",
"description": "Link to next page for this AccountSummary collection."
},
"startIndex": {
"format": "int32",
"type": "integer",
"description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter."
},
"itemsPerPage": {
"format": "int32",
"type": "integer",
"description": "The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter."
},
"username": {
"description": "Email ID of the authenticated user",
"type": "string"
}
},
"id": "AccountSummaries",
"description": "An AccountSummary collection lists a summary of accounts, properties and views (profiles) to which the user has access. Each resource in the collection corresponds to a single AccountSummary.",
"type": "object"
},
"CustomDimensions": {
"type": "object",
"properties": {
"nextLink": {
"type": "string",
"description": "Link to next page for this custom dimension collection."
},
"previousLink": {
"description": "Link to previous page for this custom dimension collection.",
"type": "string"
},
"totalResults": {
"type": "integer",
"format": "int32",
"description": "The total number of results for the query, regardless of the number of results in the response."
},
"itemsPerPage": {
"description": "The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.",
"format": "int32",
"type": "integer"
},
"startIndex": {
"type": "integer",
"description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.",
"format": "int32"
},
"items": {
"items": {
"$ref": "CustomDimension"
},
"type": "array",
"description": "Collection of custom dimensions."
},
"kind": {
"description": "Collection type.",
"default": "analytics#customDimensions",
"type": "string"
},
"username": {
"type": "string",
"description": "Email ID of the authenticated user"
}
},
"description": "A custom dimension collection lists Analytics custom dimensions to which the user has access. Each resource in the collection corresponds to a single Analytics custom dimension.",
"id": "CustomDimensions"
},
"AnalyticsDataimportDeleteUploadDataRequest": {
"properties": {
"customDataImportUids": {
"type": "array",
"description": "A list of upload UIDs.",
"items": {
"type": "string"
}
}
},
"id": "AnalyticsDataimportDeleteUploadDataRequest",
"description": "Request template for the delete upload data request.",
"type": "object"
},
"Segments": {
"properties": {
"startIndex": {
"description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.",
"format": "int32",
"type": "integer"
},
"previousLink": {
"description": "Link to previous page for this segment collection.",
"type": "string"
},
"kind": {
"description": "Collection type for segments.",
"default": "analytics#segments",
"type": "string"
},
"items": {
"items": {
"$ref": "Segment"
},
"type": "array",
"description": "A list of segments."
},
"nextLink": {
"description": "Link to next page for this segment collection.",
"type": "string"
},
"totalResults": {
"format": "int32",
"description": "The total number of results for the query, regardless of the number of results in the response.",
"type": "integer"
},
"username": {
"description": "Email ID of the authenticated user",
"type": "string"
},
"itemsPerPage": {
"type": "integer",
"description": "The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.",
"format": "int32"
}
},
"type": "object",
"id": "Segments",
"description": "An segment collection lists Analytics segments that the user has access to. Each resource in the collection corresponds to a single Analytics segment."
},
"HashClientIdRequest": {
"id": "HashClientIdRequest",
"type": "object",
"description": "JSON template for a hash Client Id request resource.",
"properties": {
"clientId": {
"type": "string"
},
"kind": {
"type": "string",
"default": "analytics#hashClientIdRequest"
},
"webPropertyId": {
"type": "string"
}
}
},
"Profiles": {
"type": "object",
"id": "Profiles",
"description": "A view (profile) collection lists Analytics views (profiles) to which the user has access. Each resource in the collection corresponds to a single Analytics view (profile).",
"properties": {
"totalResults": {
"type": "integer",
"format": "int32",
"description": "The total number of results for the query, regardless of the number of results in the response."
},
"startIndex": {
"type": "integer",
"format": "int32",
"description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter."
},
"nextLink": {
"description": "Link to next page for this view (profile) collection.",
"type": "string"
},
"previousLink": {
"type": "string",
"description": "Link to previous page for this view (profile) collection."
},
"username": {
"type": "string",
"description": "Email ID of the authenticated user"
},
"kind": {
"description": "Collection type.",
"type": "string",
"default": "analytics#profiles"
},
"itemsPerPage": {
"description": "The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.",
"type": "integer",
"format": "int32"
},
"items": {
"description": "A list of views (profiles).",
"type": "array",
"items": {
"$ref": "Profile"
}
}
}
},
"GaData": {
"description": "Analytics data for a given view (profile).",
"id": "GaData",
"properties": {
"profileInfo": {
"description": "Information for the view (profile), for which the Analytics data was requested.",
"type": "object",
"properties": {
"internalWebPropertyId": {
"type": "string",
"description": "Internal ID for the web property to which this view (profile) belongs."
},
"accountId": {
"type": "string",
"description": "Account ID to which this view (profile) belongs."
},
"profileId": {
"type": "string",
"description": "View (Profile) ID."
},
"profileName": {
"description": "View (Profile) name.",
"type": "string"
},
"webPropertyId": {
"type": "string",
"description": "Web Property ID to which this view (profile) belongs."
},
"tableId": {
"description": "Table ID for view (profile).",
"type": "string"
}
}
},
"dataLastRefreshed": {
"type": "string",
"description": "The last refreshed time in seconds for Analytics data.",
"format": "int64"
},
"dataTable": {
"type": "object",
"properties": {
"cols": {
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"label": {
"type": "string"
},
"id": {
"type": "string"
}
}
},
"type": "array"
},
"rows": {
"items": {
"type": "object",
"properties": {
"c": {
"items": {
"properties": {
"v": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
},
"type": "array"
}
}
},
"sampleSize": {
"description": "The number of samples used to calculate the result.",
"type": "string",
"format": "int64"
},
"query": {
"type": "object",
"properties": {
"start-index": {
"format": "int32",
"type": "integer",
"description": "Start index."
},
"start-date": {
"description": "Start date.",
"type": "string"
},
"sort": {
"items": {
"type": "string"
},
"description": "List of dimensions or metrics based on which Analytics data is sorted.",
"type": "array"
},
"max-results": {
"description": "Maximum results per page.",
"format": "int32",
"type": "integer"
},
"end-date": {
"description": "End date.",
"type": "string"
},
"filters": {
"description": "Comma-separated list of dimension or metric filters.",
"type": "string"
},
"dimensions": {
"description": "List of analytics dimensions.",
"type": "string"
},
"metrics": {
"type": "array",
"description": "List of analytics metrics.",
"items": {
"type": "string"
}
},
"samplingLevel": {
"type": "string",
"description": "Desired sampling level"
},
"segment": {
"type": "string",
"description": "Analytics advanced segment."
},
"ids": {
"description": "Unique table ID.",
"type": "string"
}
},
"description": "Analytics data request query parameters."
},
"columnHeaders": {
"type": "array",
"description": "Column headers that list dimension names followed by the metric names. The order of dimensions and metrics is same as specified in the request.",
"items": {
"type": "object",
"properties": {
"dataType": {
"type": "string",
"description": "Data type. Dimension column headers have only STRING as the data type. Metric column headers have data types for metric values such as INTEGER, DOUBLE, CURRENCY etc."
},
"name": {
"description": "Column name.",
"type": "string"
},
"columnType": {
"type": "string",
"description": "Column Type. Either DIMENSION or METRIC."
}
}
}
},
"id": {
"description": "Unique ID for this data response.",
"type": "string"
},
"selfLink": {
"type": "string",
"description": "Link to this page."
},
"totalsForAllResults": {
"additionalProperties": {
"type": "string",
"description": "Key-value pair for the total value of a metric. Key is the metric name and the value is the total value for that metric."
},
"description": "Total values for the requested metrics over all the results, not just the results returned in this response. The order of the metric totals is same as the metric order specified in the request.",
"type": "object"
},
"previousLink": {
"type": "string",
"description": "Link to previous page for this Analytics data query."
},
"totalResults": {
"type": "integer",
"description": "The total number of rows for the query, regardless of the number of rows in the response.",
"format": "int32"
},
"kind": {
"type": "string",
"default": "analytics#gaData",
"description": "Resource type."
},
"containsSampledData": {
"type": "boolean",
"description": "Determines if Analytics data contains samples."
},
"nextLink": {
"description": "Link to next page for this Analytics data query.",
"type": "string"
},
"itemsPerPage": {
"format": "int32",
"type": "integer",
"description": "The maximum number of rows the response can contain, regardless of the actual number of rows returned. Its value ranges from 1 to 10,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter."
},
"sampleSpace": {
"type": "string",
"format": "int64",
"description": "Total size of the sample space from which the samples were selected."
},
"rows": {
"items": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Analytics data rows, where each row contains a list of dimension values followed by the metric values. The order of dimensions and metrics is same as specified in the request.",
"type": "array"
}
},
"type": "object"
},
"WebPropertyRef": {
"properties": {
"name": {
"description": "Name of this web property.",
"type": "string"
},
"href": {
"type": "string",
"description": "Link for this web property."
},
"accountId": {
"type": "string",
"description": "Account ID to which this web property belongs."
},
"internalWebPropertyId": {
"type": "string",
"description": "Internal ID for this web property."
},
"kind": {
"default": "analytics#webPropertyRef",
"type": "string",
"description": "Analytics web property reference."
},
"id": {
"description": "Web property ID of the form UA-XXXXX-YY.",
"type": "string"
}
},
"id": "WebPropertyRef",
"type": "object",
"description": "JSON template for a web property reference."
},
"UnsampledReport": {
"type": "object",
"description": "JSON template for Analytics unsampled report resource.",
"id": "UnsampledReport",
"properties": {
"id": {
"type": "string",
"description": "Unsampled report ID."
},
"metrics": {
"annotations": {
"required": [
"analytics.management.filters.insert",
"analytics.management.unsampledReports.insert"
]
},
"description": "The metrics for the unsampled report.",
"type": "string"
},
"webPropertyId": {
"description": "Web property ID to which this unsampled report belongs. The web property ID is of the form UA-XXXXX-YY.",
"type": "string"
},
"segment": {
"description": "The segment for the unsampled report.",
"type": "string"
},
"dimensions": {
"type": "string",
"description": "The dimensions for the unsampled report."
},
"cloudStorageDownloadDetails": {
"type": "object",
"description": "Download details for a file stored in Google Cloud Storage.",
"properties": {
"objectId": {
"description": "Id of the file object containing the report data.",
"type": "string"
},
"bucketId": {
"description": "Id of the bucket the file object is stored in.",
"type": "string"
}
},
"readOnly": true
},
"profileId": {
"description": "View (Profile) ID to which this unsampled report belongs.",
"type": "string"
},
"created": {
"format": "date-time",
"description": "Time this unsampled report was created.",
"type": "string",
"readOnly": true
},
"end-date": {
"description": "The end date for the unsampled report.",
"annotations": {
"required": [
"analytics.management.filters.insert",
"analytics.management.unsampledReports.insert"
]
},
"type": "string"
},
"downloadType": {
"readOnly": true,
"type": "string",
"description": "The type of download you need to use for the report data file. Possible values include `GOOGLE_DRIVE` and `GOOGLE_CLOUD_STORAGE`. If the value is `GOOGLE_DRIVE`, see the `driveDownloadDetails` field. If the value is `GOOGLE_CLOUD_STORAGE`, see the `cloudStorageDownloadDetails` field."
},
"accountId": {
"description": "Account ID to which this unsampled report belongs.",
"type": "string"
},
"filters": {
"description": "The filters for the unsampled report.",
"type": "string"
},
"status": {
"description": "Status of this unsampled report. Possible values are PENDING, COMPLETED, or FAILED.",
"type": "string",
"readOnly": true
},
"kind": {
"description": "Resource type for an Analytics unsampled report.",
"default": "analytics#unsampledReport",
"type": "string",
"readOnly": true
},
"title": {
"annotations": {
"required": [
"analytics.management.filters.insert",
"analytics.management.unsampledReports.insert"
]
},
"type": "string",
"description": "Title of the unsampled report."
},
"driveDownloadDetails": {
"readOnly": true,
"properties": {
"documentId": {
"description": "Id of the document/file containing the report data.",
"type": "string"
}
},
"description": "Download details for a file stored in Google Drive.",
"type": "object"
},
"updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "Time this unsampled report was last modified."
},
"selfLink": {
"description": "Link for this unsampled report.",
"readOnly": true,
"type": "string"
},
"start-date": {
"type": "string",
"description": "The start date for the unsampled report.",
"annotations": {
"required": [
"analytics.management.filters.insert",
"analytics.management.unsampledReports.insert"
]
}
}
}
},
"McfData": {
"properties": {
"rows": {
"description": "Analytics data rows, where each row contains a list of dimension values followed by the metric values. The order of dimensions and metrics is same as specified in the request.",
"items": {
"items": {
"properties": {
"conversionPathValue": {
"type": "array",
"description": "A conversion path dimension value, containing a list of interactions with their attributes.",
"items": {
"properties": {
"nodeValue": {
"type": "string",
"description": "Node value of an interaction on conversion path. Such as source, medium etc."
},
"interactionType": {
"description": "Type of an interaction on conversion path. Such as CLICK, IMPRESSION etc.",
"type": "string"
}
},
"type": "object"
}
},
"primitiveValue": {
"description": "A primitive dimension value. A primitive metric value.",
"type": "string"
}
},
"type": "object",
"description": "A union object representing a dimension or metric value. Only one of \"primitiveValue\" or \"conversionPathValue\" attribute will be populated."
},
"type": "array"
},
"type": "array"
},
"nextLink": {
"type": "string",
"description": "Link to next page for this Analytics data query."
},
"profileInfo": {
"description": "Information for the view (profile), for which the Analytics data was requested.",
"properties": {
"profileName": {
"type": "string",
"description": "View (Profile) name."
},
"accountId": {
"type": "string",
"description": "Account ID to which this view (profile) belongs."
},
"tableId": {
"type": "string",
"description": "Table ID for view (profile)."
},
"webPropertyId": {
"description": "Web Property ID to which this view (profile) belongs.",
"type": "string"
},
"profileId": {
"type": "string",
"description": "View (Profile) ID."
},
"internalWebPropertyId": {
"description": "Internal ID for the web property to which this view (profile) belongs.",
"type": "string"
}
},
"type": "object"
},
"previousLink": {
"description": "Link to previous page for this Analytics data query.",
"type": "string"
},
"sampleSize": {
"description": "The number of samples used to calculate the result.",
"format": "int64",
"type": "string"
},
"sampleSpace": {
"format": "int64",
"description": "Total size of the sample space from which the samples were selected.",
"type": "string"
},
"id": {
"description": "Unique ID for this data response.",
"type": "string"
},
"itemsPerPage": {
"format": "int32",
"description": "The maximum number of rows the response can contain, regardless of the actual number of rows returned. Its value ranges from 1 to 10,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.",
"type": "integer"
},
"containsSampledData": {
"description": "Determines if the Analytics data contains sampled data.",
"type": "boolean"
},
"columnHeaders": {
"items": {
"properties": {
"columnType": {
"type": "string",
"description": "Column Type. Either DIMENSION or METRIC."
},
"dataType": {
"type": "string",
"description": "Data type. Dimension and metric values data types such as INTEGER, DOUBLE, CURRENCY, MCF_SEQUENCE etc."
},
"name": {
"type": "string",
"description": "Column name."
}
},
"type": "object"
},
"description": "Column headers that list dimension names followed by the metric names. The order of dimensions and metrics is same as specified in the request.",
"type": "array"
},
"kind": {
"description": "Resource type.",
"type": "string",
"default": "analytics#mcfData"
},
"selfLink": {
"type": "string",
"description": "Link to this page."
},
"totalsForAllResults": {
"description": "Total values for the requested metrics over all the results, not just the results returned in this response. The order of the metric totals is same as the metric order specified in the request.",
"additionalProperties": {
"description": "Key-value pair for the total value of a metric. Key is the metric name and the value is the total value for that metric.",
"type": "string"
},
"type": "object"
},
"totalResults": {
"description": "The total number of rows for the query, regardless of the number of rows in the response.",
"type": "integer",
"format": "int32"
},
"query": {
"properties": {
"dimensions": {
"type": "string",
"description": "List of analytics dimensions."
},
"start-index": {
"type": "integer",
"format": "int32",
"description": "Start index."
},
"filters": {
"type": "string",
"description": "Comma-separated list of dimension or metric filters."
},
"segment": {
"description": "Analytics advanced segment.",
"type": "string"
},
"samplingLevel": {
"description": "Desired sampling level",
"type": "string"
},
"max-results": {
"description": "Maximum results per page.",
"type": "integer",
"format": "int32"
},
"metrics": {
"items": {
"type": "string"
},
"description": "List of analytics metrics.",
"type": "array"
},
"sort": {
"description": "List of dimensions or metrics based on which Analytics data is sorted.",
"type": "array",
"items": {
"type": "string"
}
},
"end-date": {
"description": "End date.",
"type": "string"
},
"start-date": {
"description": "Start date.",
"type": "string"
},
"ids": {
"description": "Unique table ID.",
"type": "string"
}
},
"description": "Analytics data request query parameters.",
"type": "object"
}
},
"type": "object",
"description": "Multi-Channel Funnels data for a given view (profile).",
"id": "McfData"
},
"AccountTreeRequest": {
"type": "object",
"description": "JSON template for an Analytics account tree requests. The account tree request is used in the provisioning api to create an account, property, and view (profile). It contains the basic information required to make these fields.",
"id": "AccountTreeRequest",
"properties": {
"accountName": {
"type": "string",
"annotations": {
"required": [
"analytics.provisioning.createAccountTree"
]
}
},
"profileName": {
"annotations": {
"required": [
"analytics.provisioning.createAccountTree"
]
},
"type": "string"
},
"webpropertyName": {
"annotations": {
"required": [
"analytics.provisioning.createAccountTree"
]
},
"type": "string"
},
"kind": {
"default": "analytics#accountTreeRequest",
"type": "string",
"description": "Resource type for account ticket."
},
"websiteUrl": {
"type": "string",
"annotations": {
"required": [
"analytics.provisioning.createAccountTree"
]
}
},
"timezone": {
"annotations": {
"required": [
"analytics.provisioning.createAccountTree"
]
},
"type": "string"
}
}
}
},
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/analytics.user.deletion": {
"description": "Manage Google Analytics user deletion requests"
},
"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.provision": {
"description": "Create a new Google Analytics account along with its default property and view"
},
"https://www.googleapis.com/auth/analytics.manage.users.readonly": {
"description": "View Google Analytics user permissions"
},
"https://www.googleapis.com/auth/analytics.manage.users": {
"description": "Manage Google Analytics Account users by email address"
},
"https://www.googleapis.com/auth/analytics.readonly": {
"description": "View your Google Analytics data"
}
}
}
},
"batchPath": "batch/analytics/v3",
"description": "Views and manages your Google Analytics data.",
"kind": "discovery#restDescription",
"discoveryVersion": "v1",
"etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/o_TVyaWurnALX6ZIQ952-U5m22Y\"",
"name": "analytics",
"version": "v3",
"documentationLink": "https://developers.google.com/analytics/",
"servicePath": "analytics/v3/"
}
