{ "name": "analytics", "documentationLink": "https://developers.google.com/analytics/", "batchPath": "batch/analytics/v3", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/analytics": { "description": "View and manage your Google Analytics data" }, "https://www.googleapis.com/auth/analytics.manage.users": { "description": "Manage Google Analytics Account users by email address" }, "https://www.googleapis.com/auth/analytics.user.deletion": { "description": "Manage Google Analytics user deletion requests" }, "https://www.googleapis.com/auth/analytics.readonly": { "description": "View your Google Analytics data" }, "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.edit": { "description": "Edit Google Analytics management entities" }, "https://www.googleapis.com/auth/analytics.manage.users.readonly": { "description": "View Google Analytics user permissions" } } } }, "ownerName": "Google", "baseUrl": "https://www.googleapis.com/analytics/v3/", "description": "Views and manages your Google Analytics data.", "icons": { "x32": "https://www.google.com/images/icons/product/analytics-32.png", "x16": "https://www.google.com/images/icons/product/analytics-16.png" }, "version": "v3", "schemas": { "AccountSummary": { "type": "object", "properties": { "name": { "description": "Account name.", "type": "string" }, "kind": { "description": "Resource type for Analytics AccountSummary.", "type": "string", "default": "analytics#accountSummary" }, "id": { "description": "Account ID.", "type": "string" }, "webProperties": { "type": "array", "description": "List of web properties under this account.", "items": { "$ref": "WebPropertySummary" } }, "starred": { "description": "Indicates whether this account is starred or not.", "type": "boolean" } }, "id": "AccountSummary", "description": "JSON template for an Analytics AccountSummary. An AccountSummary is a lightweight tree comprised of properties/profiles." }, "EntityUserLink": { "properties": { "permissions": { "description": "Permissions the user has for this entity.", "properties": { "effective": { "items": { "type": "string" }, "type": "array", "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.", "readOnly": true }, "local": { "items": { "type": "string" }, "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." } }, "type": "object" }, "id": { "description": "Entity user link ID", "type": "string" }, "entity": { "type": "object", "description": "Entity for this link. It can be an account, a web property, or a view (profile).", "properties": { "accountRef": { "$ref": "AccountRef", "description": "Account for this link." }, "profileRef": { "$ref": "ProfileRef", "description": "View (Profile) for this link." }, "webPropertyRef": { "$ref": "WebPropertyRef", "description": "Web property for this link." } } }, "userRef": { "description": "User reference.", "$ref": "UserRef" }, "selfLink": { "type": "string", "description": "Self link for this resource." }, "kind": { "description": "Resource type for entity user link.", "type": "string", "default": "analytics#entityUserLink" } }, "type": "object", "description": "JSON template for an Analytics Entity-User Link. Returns permissions that a user has for an entity.", "id": "EntityUserLink" }, "AccountRef": { "properties": { "name": { "type": "string", "description": "Account name." }, "kind": { "default": "analytics#accountRef", "type": "string", "description": "Analytics account reference." }, "href": { "type": "string", "description": "Link for this account." }, "id": { "description": "Account ID.", "type": "string" } }, "description": "JSON template for a linked account.", "type": "object", "id": "AccountRef" }, "CustomMetric": { "properties": { "id": { "type": "string", "description": "Custom metric ID." }, "max_value": { "description": "Max value of custom metric.", "type": "string" }, "created": { "readOnly": true, "type": "string", "format": "date-time", "description": "Time the custom metric was created." }, "kind": { "readOnly": true, "type": "string", "default": "analytics#customMetric", "description": "Kind value for a custom metric. Set to \"analytics#customMetric\". It is a read-only field." }, "type": { "description": "Data type of custom metric.", "type": "string" }, "scope": { "description": "Scope of the custom metric: HIT or PRODUCT.", "type": "string" }, "index": { "readOnly": true, "format": "int32", "description": "Index of the custom metric.", "type": "integer" }, "min_value": { "type": "string", "description": "Min value of custom metric." }, "name": { "description": "Name of the custom metric.", "type": "string" }, "updated": { "readOnly": true, "type": "string", "format": "date-time", "description": "Time the custom metric was last modified." }, "selfLink": { "description": "Link for the custom metric", "type": "string", "readOnly": true }, "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\".", "default": "analytics#webproperty", "type": "string" } }, "description": "Parent link for the custom metric. Points to the property to which the custom metric belongs.", "type": "object" }, "active": { "type": "boolean", "description": "Boolean indicating whether the custom metric is active." }, "webPropertyId": { "description": "Property ID.", "type": "string" }, "accountId": { "type": "string", "description": "Account ID." } }, "id": "CustomMetric", "description": "JSON template for Analytics Custom Metric.", "type": "object" }, "CustomDimensions": { "properties": { "previousLink": { "type": "string", "description": "Link to previous page for this custom dimension collection." }, "kind": { "default": "analytics#customDimensions", "description": "Collection type.", "type": "string" }, "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": { "type": "string", "description": "Link to next page for this custom dimension collection." }, "totalResults": { "description": "The total number of results for the query, regardless of the number of results in the response.", "type": "integer", "format": "int32" }, "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" }, "username": { "type": "string", "description": "Email ID of the authenticated user" }, "items": { "type": "array", "description": "Collection of custom dimensions.", "items": { "$ref": "CustomDimension" } } }, "id": "CustomDimensions", "type": "object", "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." }, "AnalyticsDataimportDeleteUploadDataRequest": { "type": "object", "properties": { "customDataImportUids": { "description": "A list of upload UIDs.", "type": "array", "items": { "type": "string" } } }, "id": "AnalyticsDataimportDeleteUploadDataRequest", "description": "Request template for the delete upload data request." }, "EntityUserLinks": { "type": "object", "description": "An entity user link collection provides a list of Analytics ACL links Each resource in this collection corresponds to a single link.", "properties": { "items": { "type": "array", "items": { "$ref": "EntityUserLink" }, "description": "A list of entity user links." }, "previousLink": { "description": "Previous link for this account collection.", "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" }, "kind": { "description": "Collection type.", "default": "analytics#entityUserLinks", "type": "string" }, "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" }, "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" }, "nextLink": { "description": "Next link for this account collection.", "type": "string" } }, "id": "EntityUserLinks" }, "RealtimeData": { "type": "object", "properties": { "columnHeaders": { "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", "items": { "type": "object", "properties": { "columnType": { "description": "Column Type. Either DIMENSION or METRIC.", "type": "string" }, "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" } } } }, "id": { "description": "Unique ID for this data response.", "type": "string" }, "kind": { "default": "analytics#realtimeData", "type": "string", "description": "Resource type." }, "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.", "type": "array", "items": { "items": { "type": "string" }, "type": "array" } }, "selfLink": { "description": "Link to this page.", "type": "string" }, "profileInfo": { "description": "Information for the view (profile), for which the real time data was requested.", "type": "object", "properties": { "webPropertyId": { "type": "string", "description": "Web Property ID to which this view (profile) belongs." }, "profileName": { "description": "View (Profile) name.", "type": "string" }, "profileId": { "description": "View (Profile) ID.", "type": "string" }, "internalWebPropertyId": { "description": "Internal ID for the web property to which this view (profile) belongs.", "type": "string" }, "tableId": { "description": "Table ID for view (profile).", "type": "string" }, "accountId": { "type": "string", "description": "Account ID to which this view (profile) belongs." } } }, "query": { "description": "Real time data request query parameters.", "properties": { "metrics": { "type": "array", "items": { "type": "string" }, "description": "List of real time metrics." }, "ids": { "description": "Unique table ID.", "type": "string" }, "sort": { "type": "array", "items": { "type": "string" }, "description": "List of dimensions or metrics based on which real time data is sorted." }, "filters": { "description": "Comma-separated list of dimension or metric filters.", "type": "string" }, "dimensions": { "type": "string", "description": "List of real time dimensions." }, "max-results": { "type": "integer", "description": "Maximum results per page.", "format": "int32" } }, "type": "object" }, "totalResults": { "format": "int32", "description": "The total number of rows for the query, regardless of the number of rows in the response.", "type": "integer" }, "totalsForAllResults": { "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", "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." } }, "id": "RealtimeData", "description": "Real time data for a given view (profile)." }, "Webproperty": { "properties": { "parentLink": { "type": "object", "description": "Parent link for this web property. Points to the account to which this web property belongs.", "properties": { "type": { "description": "Type of the parent link. Its value is \"analytics#account\".", "default": "analytics#account", "type": "string" }, "href": { "type": "string", "description": "Link to the account for this web property." } } }, "created": { "readOnly": true, "format": "date-time", "description": "Time this web property was created.", "type": "string" }, "dataRetentionResetOnNewActivity": { "type": "boolean", "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." }, "updated": { "description": "Time this web property was last modified.", "readOnly": true, "format": "date-time", "type": "string" }, "profileCount": { "type": "integer", "format": "int32", "description": "View (Profile) count for this web property.", "readOnly": true }, "name": { "type": "string", "description": "Name of this web property." }, "starred": { "description": "Indicates whether this web property is starred or not.", "type": "boolean" }, "websiteUrl": { "description": "Website url for this web property.", "type": "string" }, "level": { "type": "string", "description": "Level for this web property. Possible values are STANDARD or PREMIUM.", "readOnly": true }, "defaultProfileId": { "format": "int64", "description": "Default view (profile) ID.", "type": "string" }, "dataRetentionTtl": { "type": "string", "description": "The length of time for which user and event data is retained.\nThis property cannot be set on insert." }, "accountId": { "description": "Account ID to which this web property belongs.", "type": "string" }, "selfLink": { "description": "Link for this web property.", "readOnly": true, "type": "string" }, "childLink": { "properties": { "href": { "description": "Link to the list of views (profiles) for this web property.", "type": "string" }, "type": { "type": "string", "default": "analytics#profiles", "description": "Type of the parent link. Its value is \"analytics#profiles\"." } }, "type": "object", "description": "Child link for this web property. Points to the list of views (profiles) for this web property." }, "internalWebPropertyId": { "type": "string", "readOnly": true, "description": "Internal ID for this web property." }, "industryVertical": { "description": "The industry vertical/category selected for this web property.", "type": "string" }, "permissions": { "type": "object", "properties": { "effective": { "type": "array", "readOnly": true, "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" } } }, "description": "Permissions the user has for this web property." }, "kind": { "description": "Resource type for Analytics WebProperty.", "type": "string", "readOnly": true, "default": "analytics#webproperty" }, "id": { "type": "string", "description": "Web property ID of the form UA-XXXXX-YY." } }, "type": "object", "description": "JSON template for an Analytics web property.", "id": "Webproperty" }, "CustomDimension": { "properties": { "id": { "description": "Custom dimension ID.", "type": "string" }, "selfLink": { "description": "Link for the custom dimension", "readOnly": true, "type": "string" }, "parentLink": { "properties": { "href": { "description": "Link to the property to which the custom dimension belongs.", "type": "string" }, "type": { "default": "analytics#webproperty", "type": "string", "description": "Type of the parent link. Set to \"analytics#webproperty\"." } }, "type": "object", "description": "Parent link for the custom dimension. Points to the property to which the custom dimension belongs." }, "scope": { "type": "string", "description": "Scope of the custom dimension: HIT, SESSION, USER or PRODUCT." }, "name": { "type": "string", "description": "Name of the custom dimension." }, "webPropertyId": { "type": "string", "description": "Property ID." }, "created": { "readOnly": true, "format": "date-time", "type": "string", "description": "Time the custom dimension was created." }, "accountId": { "description": "Account ID.", "type": "string" }, "kind": { "default": "analytics#customDimension", "type": "string", "description": "Kind value for a custom dimension. Set to \"analytics#customDimension\". It is a read-only field.", "readOnly": true }, "active": { "type": "boolean", "description": "Boolean indicating whether the custom dimension is active." }, "index": { "description": "Index of the custom dimension.", "format": "int32", "readOnly": true, "type": "integer" }, "updated": { "description": "Time the custom dimension was last modified.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "id": "CustomDimension", "description": "JSON template for Analytics Custom Dimension." }, "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.", "id": "Experiments", "type": "object", "properties": { "previousLink": { "type": "string", "description": "Link to previous page for this experiment collection." }, "nextLink": { "type": "string", "description": "Link to next page for this experiment collection." }, "username": { "description": "Email ID of the authenticated user", "type": "string" }, "kind": { "description": "Collection type.", "default": "analytics#experiments", "type": "string" }, "items": { "items": { "$ref": "Experiment" }, "description": "A list of experiments.", "type": "array" }, "totalResults": { "format": "int32", "description": "The total number of results for the query, regardless of the number of resources in the result.", "type": "integer" }, "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." }, "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." } } }, "IncludeConditions": { "description": "JSON template for an Analytics Remarketing Include Conditions.", "id": "IncludeConditions", "properties": { "kind": { "default": "analytics#includeConditions", "description": "Resource type for include conditions.", "type": "string" }, "membershipDurationDays": { "type": "integer", "description": "Number of days (in the range 1 to 540) a user remains in the audience.", "format": "int32" }, "segment": { "description": "The segment condition that will cause a user to be added to an audience.", "type": "string" }, "isSmartList": { "type": "boolean", "description": "Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577" }, "daysToLookBack": { "format": "int32", "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.", "type": "integer" } }, "type": "object" }, "RemarketingAudiences": { "type": "object", "id": "RemarketingAudiences", "properties": { "items": { "items": { "$ref": "RemarketingAudience" }, "description": "A list of remarketing audiences.", "type": "array" }, "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." }, "previousLink": { "type": "string", "description": "Link to previous page for this view (profile) collection." }, "nextLink": { "description": "Link to next page for this remarketing audience collection.", "type": "string" }, "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" }, "kind": { "type": "string", "default": "analytics#remarketingAudiences", "description": "Collection type." }, "username": { "type": "string", "description": "Email ID of the authenticated user" }, "totalResults": { "type": "integer", "description": "The total number of results for the query, regardless of the number of results in the response.", "format": "int32" } }, "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." }, "Profiles": { "type": "object", "properties": { "nextLink": { "description": "Link to next page for this view (profile) collection.", "type": "string" }, "kind": { "description": "Collection type.", "type": "string", "default": "analytics#profiles" }, "username": { "type": "string", "description": "Email ID of the authenticated user" }, "totalResults": { "type": "integer", "format": "int32", "description": "The total number of results for the query, regardless of the number of results in the response." }, "items": { "items": { "$ref": "Profile" }, "description": "A list of views (profiles).", "type": "array" }, "previousLink": { "description": "Link to previous page for this view (profile) collection.", "type": "string" }, "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." }, "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." } }, "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).", "id": "Profiles" }, "UnsampledReport": { "properties": { "webPropertyId": { "description": "Web property ID to which this unsampled report belongs. The web property ID is of the form UA-XXXXX-YY.", "type": "string" }, "dimensions": { "type": "string", "description": "The dimensions for the unsampled report." }, "filters": { "description": "The filters for the unsampled report.", "type": "string" }, "status": { "type": "string", "readOnly": true, "description": "Status of this unsampled report. Possible values are PENDING, COMPLETED, or FAILED." }, "accountId": { "description": "Account ID to which this unsampled report belongs.", "type": "string" }, "end-date": { "type": "string", "annotations": { "required": [ "analytics.management.filters.insert", "analytics.management.unsampledReports.insert" ] }, "description": "The end date for the unsampled report." }, "selfLink": { "description": "Link for this unsampled report.", "type": "string", "readOnly": true }, "profileId": { "type": "string", "description": "View (Profile) ID to which this unsampled report belongs." }, "downloadType": { "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.", "readOnly": true, "type": "string" }, "driveDownloadDetails": { "description": "Download details for a file stored in Google Drive.", "properties": { "documentId": { "description": "Id of the document/file containing the report data.", "type": "string" } }, "type": "object", "readOnly": true }, "updated": { "type": "string", "format": "date-time", "readOnly": true, "description": "Time this unsampled report was last modified." }, "title": { "description": "Title of the unsampled report.", "annotations": { "required": [ "analytics.management.filters.insert", "analytics.management.unsampledReports.insert" ] }, "type": "string" }, "metrics": { "annotations": { "required": [ "analytics.management.filters.insert", "analytics.management.unsampledReports.insert" ] }, "type": "string", "description": "The metrics for the unsampled report." }, "start-date": { "annotations": { "required": [ "analytics.management.filters.insert", "analytics.management.unsampledReports.insert" ] }, "type": "string", "description": "The start date for the unsampled report." }, "cloudStorageDownloadDetails": { "properties": { "objectId": { "type": "string", "description": "Id of the file object containing the report data." }, "bucketId": { "description": "Id of the bucket the file object is stored in.", "type": "string" } }, "description": "Download details for a file stored in Google Cloud Storage.", "type": "object", "readOnly": true }, "segment": { "type": "string", "description": "The segment for the unsampled report." }, "created": { "description": "Time this unsampled report was created.", "type": "string", "format": "date-time", "readOnly": true }, "id": { "description": "Unsampled report ID.", "type": "string" }, "kind": { "default": "analytics#unsampledReport", "readOnly": true, "type": "string", "description": "Resource type for an Analytics unsampled report." } }, "description": "JSON template for Analytics unsampled report resource.", "id": "UnsampledReport", "type": "object" }, "WebPropertyRef": { "id": "WebPropertyRef", "properties": { "href": { "description": "Link for this web property.", "type": "string" }, "internalWebPropertyId": { "type": "string", "description": "Internal ID for this web property." }, "name": { "description": "Name of this web property.", "type": "string" }, "accountId": { "description": "Account ID to which this web property belongs.", "type": "string" }, "kind": { "type": "string", "default": "analytics#webPropertyRef", "description": "Analytics web property reference." }, "id": { "type": "string", "description": "Web property ID of the form UA-XXXXX-YY." } }, "type": "object", "description": "JSON template for a web property reference." }, "EntityAdWordsLink": { "properties": { "selfLink": { "description": "URL link for this Google Analytics - Google Ads link.", "type": "string" }, "kind": { "default": "analytics#entityAdWordsLink", "description": "Resource type for entity Google Ads link.", "type": "string" }, "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" }, "entity": { "description": "Web property being linked.", "type": "object", "properties": { "webPropertyRef": { "$ref": "WebPropertyRef" } } }, "name": { "description": "Name of the link. This field is required when creating a Google Ads link.", "annotations": { "required": [ "analytics.management.webPropertyAdWordsLinks.insert", "analytics.management.webPropertyAdWordsLinks.update" ] }, "type": "string" }, "profileIds": { "description": "IDs of linked Views (Profiles) represented as strings.", "items": { "type": "string" }, "type": "array" }, "id": { "type": "string", "description": "Entity Google Ads link ID" } }, "type": "object", "description": "JSON template for Analytics Entity Google Ads Link.", "id": "EntityAdWordsLink" }, "AdWordsAccount": { "description": "JSON template for an Google Ads account.", "properties": { "autoTaggingEnabled": { "type": "boolean", "description": "True if auto-tagging is enabled on the Google Ads account. Read-only after the insert operation." }, "customerId": { "type": "string", "annotations": { "required": [ "analytics.management.webPropertyAdWordsLinks.insert", "analytics.management.webPropertyAdWordsLinks.update" ] }, "description": "Customer ID. This field is required when creating a Google Ads link." }, "kind": { "type": "string", "default": "analytics#adWordsAccount", "description": "Resource type for Google Ads account." } }, "id": "AdWordsAccount", "type": "object" }, "AccountSummaries": { "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", "properties": { "previousLink": { "type": "string", "description": "Link to previous page for this AccountSummary collection." }, "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": { "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." }, "username": { "type": "string", "description": "Email ID of the authenticated user" }, "totalResults": { "format": "int32", "type": "integer", "description": "The total number of results for the query, regardless of the number of results in the response." }, "nextLink": { "type": "string", "description": "Link to next page for this AccountSummary collection." }, "items": { "type": "array", "description": "A list of AccountSummaries.", "items": { "$ref": "AccountSummary" } }, "kind": { "default": "analytics#accountSummaries", "type": "string", "description": "Collection type." } } }, "Filter": { "description": "JSON template for an Analytics account filter.", "properties": { "searchAndReplaceDetails": { "type": "object", "description": "Details for the filter of the type SEARCH_AND_REPLACE.", "properties": { "replaceString": { "description": "Term to replace the search term with.", "type": "string" }, "searchString": { "type": "string", "description": "Term to search." }, "caseSensitive": { "type": "boolean", "description": "Determines if the filter is case sensitive." }, "fieldIndex": { "format": "int32", "description": "The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.", "type": "integer" }, "field": { "type": "string", "description": "Field to use in the filter." } } }, "parentLink": { "properties": { "type": { "description": "Value is \"analytics#account\".", "default": "analytics#account", "type": "string" }, "href": { "description": "Link to the account to which this filter belongs.", "type": "string" } }, "description": "Parent link for this filter. Points to the account to which this filter belongs.", "type": "object" }, "updated": { "format": "date-time", "readOnly": true, "type": "string", "description": "Time this filter was last modified." }, "accountId": { "type": "string", "description": "Account ID to which this filter belongs." }, "kind": { "description": "Resource type for Analytics filter.", "type": "string", "readOnly": true, "default": "analytics#filter" }, "advancedDetails": { "type": "object", "properties": { "fieldAIndex": { "type": "integer", "format": "int32", "description": "The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION." }, "fieldARequired": { "description": "Indicates if field A is required to match.", "type": "boolean" }, "caseSensitive": { "type": "boolean", "description": "Indicates if the filter expressions are case sensitive." }, "extractA": { "description": "Expression to extract from field A.", "type": "string" }, "fieldB": { "type": "string", "description": "Field B." }, "extractB": { "description": "Expression to extract from field B.", "type": "string" }, "outputToFieldIndex": { "format": "int32", "type": "integer", "description": "The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION." }, "outputConstructor": { "type": "string", "description": "Expression used to construct the output value." }, "fieldBRequired": { "description": "Indicates if field B is required to match.", "type": "boolean" }, "outputToField": { "type": "string", "description": "Output field." }, "fieldA": { "type": "string", "description": "Field A." }, "fieldBIndex": { "format": "int32", "description": "The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.", "type": "integer" }, "overrideOutputField": { "type": "boolean", "description": "Indicates if the existing value of the output field, if any, should be overridden by the output expression." } }, "description": "Details for the filter of the type ADVANCED." }, "selfLink": { "description": "Link for this filter.", "type": "string", "readOnly": true }, "excludeDetails": { "description": "Details for the filter of the type EXCLUDE.", "$ref": "FilterExpression" }, "created": { "format": "date-time", "description": "Time this filter was created.", "type": "string", "readOnly": true }, "includeDetails": { "$ref": "FilterExpression", "description": "Details for the filter of the type INCLUDE." }, "name": { "annotations": { "required": [ "analytics.management.filters.insert", "analytics.management.filters.update" ] }, "type": "string", "description": "Name of this filter." }, "uppercaseDetails": { "description": "Details for the filter of the type UPPER.", "type": "object", "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.", "format": "int32", "type": "integer" } } }, "type": { "annotations": { "required": [ "analytics.management.filters.insert", "analytics.management.filters.update" ] }, "type": "string", "description": "Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED." }, "lowercaseDetails": { "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" } }, "type": "object", "description": "Details for the filter of the type LOWER." }, "id": { "type": "string", "description": "Filter ID." } }, "type": "object", "id": "Filter" }, "Column": { "properties": { "kind": { "type": "string", "default": "analytics#column", "description": "Resource type for Analytics column." }, "attributes": { "description": "Map of attribute name and value for this column.", "type": "object", "additionalProperties": { "type": "string", "description": "The name of the attribute." } }, "id": { "description": "Column id.", "type": "string" } }, "type": "object", "description": "JSON template for a metadata column.", "id": "Column" }, "CustomMetrics": { "type": "object", "id": "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.", "properties": { "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" }, "previousLink": { "description": "Link to previous page for this custom metric collection.", "type": "string" }, "items": { "description": "Collection of custom metrics.", "items": { "$ref": "CustomMetric" }, "type": "array" }, "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" }, "nextLink": { "type": "string", "description": "Link to next page for this custom metric collection." }, "username": { "type": "string", "description": "Email ID of the authenticated user" }, "totalResults": { "description": "The total number of results for the query, regardless of the number of results in the response.", "type": "integer", "format": "int32" }, "kind": { "default": "analytics#customMetrics", "type": "string", "description": "Collection type." } } }, "Account": { "type": "object", "description": "JSON template for Analytics account entry.", "id": "Account", "properties": { "updated": { "description": "Time the account was last modified.", "type": "string", "format": "date-time" }, "id": { "type": "string", "description": "Account ID." }, "childLink": { "properties": { "type": { "type": "string", "default": "analytics#webproperties", "description": "Type of the child link. Its value is \"analytics#webproperties\"." }, "href": { "description": "Link to the list of web properties for this account.", "type": "string" } }, "type": "object", "description": "Child link for an account entry. Points to the list of web properties for this account." }, "created": { "format": "date-time", "type": "string", "description": "Time the account was created." }, "selfLink": { "type": "string", "description": "Link for this account." }, "starred": { "description": "Indicates whether this account is starred or not.", "type": "boolean" }, "name": { "description": "Account name.", "type": "string" }, "permissions": { "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" } } }, "description": "Permissions the user has for this account.", "type": "object" }, "kind": { "default": "analytics#account", "type": "string", "description": "Resource type for Analytics account." } } }, "ProfileFilterLink": { "id": "ProfileFilterLink", "description": "JSON template for an Analytics profile filter link.", "type": "object", "properties": { "filterRef": { "description": "Filter for this link.", "$ref": "FilterRef" }, "profileRef": { "description": "View (Profile) for this link.", "$ref": "ProfileRef" }, "rank": { "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.", "format": "int32", "type": "integer" }, "kind": { "description": "Resource type for Analytics filter.", "readOnly": true, "default": "analytics#profileFilterLink", "type": "string" }, "id": { "description": "Profile filter link ID.", "type": "string" }, "selfLink": { "description": "Link for this profile filter link.", "readOnly": true, "type": "string" } } }, "AccountTreeRequest": { "properties": { "webpropertyName": { "annotations": { "required": [ "analytics.provisioning.createAccountTree" ] }, "type": "string" }, "websiteUrl": { "annotations": { "required": [ "analytics.provisioning.createAccountTree" ] }, "type": "string" }, "profileName": { "annotations": { "required": [ "analytics.provisioning.createAccountTree" ] }, "type": "string" }, "kind": { "type": "string", "description": "Resource type for account ticket.", "default": "analytics#accountTreeRequest" }, "timezone": { "type": "string", "annotations": { "required": [ "analytics.provisioning.createAccountTree" ] } }, "accountName": { "annotations": { "required": [ "analytics.provisioning.createAccountTree" ] }, "type": "string" } }, "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" }, "WebPropertySummary": { "description": "JSON template for an Analytics WebPropertySummary. WebPropertySummary returns basic information (i.e., summary) for a web property.", "type": "object", "properties": { "internalWebPropertyId": { "type": "string", "description": "Internal ID for this web property." }, "starred": { "type": "boolean", "description": "Indicates whether this web property is starred or not." }, "id": { "description": "Web property ID of the form UA-XXXXX-YY.", "type": "string" }, "kind": { "default": "analytics#webPropertySummary", "description": "Resource type for Analytics WebPropertySummary.", "type": "string" }, "profiles": { "items": { "$ref": "ProfileSummary" }, "type": "array", "description": "List of profiles under this web property." }, "name": { "type": "string", "description": "Web property name." }, "level": { "description": "Level for this web property. Possible values are STANDARD or PREMIUM.", "type": "string" }, "websiteUrl": { "description": "Website url for this web property.", "type": "string" } }, "id": "WebPropertySummary" }, "RemarketingAudience": { "description": "JSON template for an Analytics remarketing audience.", "type": "object", "properties": { "audienceType": { "description": "The type of audience, either SIMPLE or STATE_BASED.", "type": "string" }, "id": { "type": "string", "description": "Remarketing Audience ID." }, "kind": { "default": "analytics#remarketingAudience", "description": "Collection type.", "type": "string" }, "stateBasedAudienceDefinition": { "description": "A state based audience definition that will cause a user to be added or removed from an audience.", "type": "object", "properties": { "includeConditions": { "$ref": "IncludeConditions", "description": "Defines the conditions to include users to the audience." }, "excludeConditions": { "properties": { "segment": { "type": "string", "description": "The segment condition that will cause a user to be removed from an audience." }, "exclusionDuration": { "description": "Whether to make the exclusion TEMPORARY or PERMANENT.", "type": "string" } }, "description": "Defines the conditions to exclude users from the audience.", "type": "object" } } }, "name": { "type": "string", "description": "The name of this remarketing audience." }, "internalWebPropertyId": { "type": "string", "readOnly": true, "description": "Internal ID for the web property to which this remarketing audience belongs." }, "audienceDefinition": { "type": "object", "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." }, "created": { "type": "string", "readOnly": true, "description": "Time this remarketing audience was created.", "format": "date-time" }, "accountId": { "description": "Account ID to which this remarketing audience belongs.", "type": "string" }, "linkedViews": { "items": { "type": "string" }, "type": "array", "description": "The views (profiles) that this remarketing audience is linked to." }, "webPropertyId": { "type": "string", "description": "Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs." }, "updated": { "description": "Time this remarketing audience was last modified.", "format": "date-time", "readOnly": true, "type": "string" }, "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." }, "description": { "type": "string", "readOnly": true, "description": "The description of this remarketing audience." } }, "id": "RemarketingAudience" }, "Segments": { "type": "object", "properties": { "username": { "description": "Email ID of the authenticated user", "type": "string" }, "kind": { "default": "analytics#segments", "description": "Collection type for segments.", "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" }, "previousLink": { "type": "string", "description": "Link to previous page for this segment collection." }, "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" }, "nextLink": { "type": "string", "description": "Link to next page for this segment collection." }, "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" }, "items": { "type": "array", "items": { "$ref": "Segment" }, "description": "A list of 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.", "id": "Segments" }, "EntityAdWordsLinks": { "type": "object", "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.", "properties": { "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" }, "kind": { "type": "string", "description": "Collection type.", "default": "analytics#entityAdWordsLinks" }, "nextLink": { "description": "Next link for this Google Ads link collection.", "type": "string" }, "previousLink": { "description": "Previous link for this Google Ads link 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" }, "items": { "type": "array", "items": { "$ref": "EntityAdWordsLink" }, "description": "A list of entity Google Ads links." }, "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" } } }, "FilterRef": { "properties": { "kind": { "description": "Kind value for filter reference.", "default": "analytics#filterRef", "type": "string" }, "accountId": { "type": "string", "readOnly": true, "description": "Account ID to which this filter belongs." }, "id": { "annotations": { "required": [ "analytics.management.profileFilterLinks.insert" ] }, "description": "Filter ID.", "type": "string" }, "href": { "type": "string", "description": "Link for this filter." }, "name": { "type": "string", "description": "Name of this filter.", "readOnly": true } }, "type": "object", "id": "FilterRef", "description": "JSON template for a profile filter link." }, "GaData": { "id": "GaData", "type": "object", "description": "Analytics data for a given view (profile).", "properties": { "selfLink": { "type": "string", "description": "Link to this page." }, "sampleSpace": { "format": "int64", "description": "Total size of the sample space from which the samples were selected.", "type": "string" }, "id": { "type": "string", "description": "Unique ID for this data response." }, "totalResults": { "type": "integer", "description": "The total number of rows for the query, regardless of the number of rows in the response.", "format": "int32" }, "itemsPerPage": { "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", "format": "int32" }, "columnHeaders": { "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": { "columnType": { "type": "string", "description": "Column Type. Either DIMENSION or METRIC." }, "name": { "type": "string", "description": "Column name." }, "dataType": { "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": "string" } } }, "type": "array" }, "totalsForAllResults": { "type": "object", "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" }, "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." }, "rows": { "items": { "items": { "type": "string" }, "type": "array" }, "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" }, "nextLink": { "type": "string", "description": "Link to next page for this Analytics data query." }, "containsSampledData": { "description": "Determines if Analytics data contains samples.", "type": "boolean" }, "previousLink": { "description": "Link to previous page for this Analytics data query.", "type": "string" }, "profileInfo": { "description": "Information for the view (profile), for which the Analytics data was requested.", "type": "object", "properties": { "profileId": { "type": "string", "description": "View (Profile) ID." }, "internalWebPropertyId": { "description": "Internal ID for the web property to which this view (profile) belongs.", "type": "string" }, "tableId": { "description": "Table ID for view (profile).", "type": "string" }, "webPropertyId": { "description": "Web Property ID to which this view (profile) belongs.", "type": "string" }, "profileName": { "type": "string", "description": "View (Profile) name." }, "accountId": { "description": "Account ID to which this view (profile) belongs.", "type": "string" } } }, "query": { "properties": { "filters": { "type": "string", "description": "Comma-separated list of dimension or metric filters." }, "start-index": { "type": "integer", "description": "Start index.", "format": "int32" }, "metrics": { "description": "List of analytics metrics.", "items": { "type": "string" }, "type": "array" }, "end-date": { "description": "End date.", "type": "string" }, "max-results": { "description": "Maximum results per page.", "format": "int32", "type": "integer" }, "dimensions": { "description": "List of analytics dimensions.", "type": "string" }, "sort": { "description": "List of dimensions or metrics based on which Analytics data is sorted.", "type": "array", "items": { "type": "string" } }, "samplingLevel": { "type": "string", "description": "Desired sampling level" }, "segment": { "type": "string", "description": "Analytics advanced segment." }, "ids": { "type": "string", "description": "Unique table ID." }, "start-date": { "type": "string", "description": "Start date." } }, "type": "object", "description": "Analytics data request query parameters." }, "dataLastRefreshed": { "type": "string", "description": "The last refreshed time in seconds for Analytics data.", "format": "int64" }, "kind": { "description": "Resource type.", "default": "analytics#gaData", "type": "string" }, "dataTable": { "type": "object", "properties": { "rows": { "type": "array", "items": { "properties": { "c": { "type": "array", "items": { "type": "object", "properties": { "v": { "type": "string" } } } } }, "type": "object" } }, "cols": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "id": { "type": "string" }, "label": { "type": "string" } } } } } }, "sampleSize": { "type": "string", "format": "int64", "description": "The number of samples used to calculate the result." } } }, "ProfileSummary": { "id": "ProfileSummary", "description": "JSON template for an Analytics ProfileSummary. ProfileSummary returns basic information (i.e., summary) for a profile.", "type": "object", "properties": { "starred": { "type": "boolean", "description": "Indicates whether this view (profile) is starred or not." }, "id": { "type": "string", "description": "View (profile) ID." }, "name": { "description": "View (profile) name.", "type": "string" }, "type": { "description": "View (Profile) type. Supported types: WEB or APP.", "type": "string" }, "kind": { "description": "Resource type for Analytics ProfileSummary.", "default": "analytics#profileSummary", "type": "string" } } }, "HashClientIdResponse": { "id": "HashClientIdResponse", "description": "JSON template for a hash Client Id response resource.", "properties": { "kind": { "type": "string", "default": "analytics#hashClientIdResponse" }, "clientId": { "type": "string" }, "webPropertyId": { "type": "string" }, "hashedClientId": { "type": "string" } }, "type": "object" }, "ProfileRef": { "properties": { "kind": { "default": "analytics#profileRef", "type": "string", "description": "Analytics view (profile) reference." }, "accountId": { "type": "string", "description": "Account ID to which this view (profile) belongs." }, "name": { "type": "string", "description": "Name of this view (profile)." }, "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" }, "id": { "type": "string", "description": "View (Profile) ID." }, "href": { "type": "string", "description": "Link for this view (profile)." } }, "type": "object", "id": "ProfileRef", "description": "JSON template for a linked view (profile)." }, "AccountTicket": { "type": "object", "properties": { "profile": { "description": "View (Profile) for the account.", "$ref": "Profile" }, "account": { "$ref": "Account", "description": "Account for this ticket." }, "kind": { "type": "string", "description": "Resource type for account ticket.", "default": "analytics#accountTicket" }, "redirectUri": { "type": "string", "description": "Redirect URI where the user will be sent after accepting Terms of Service. Must be configured in APIs console as a callback URL." }, "id": { "description": "Account ticket ID used to access the account ticket.", "type": "string" }, "webproperty": { "description": "Web property for the account.", "$ref": "Webproperty" } }, "id": "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." }, "Filters": { "properties": { "username": { "description": "Email ID of the authenticated user", "type": "string" }, "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 1,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.", "type": "integer" }, "nextLink": { "description": "Link to next page for this filter collection.", "type": "string" }, "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" }, "items": { "items": { "$ref": "Filter" }, "description": "A list of filters.", "type": "array" }, "kind": { "default": "analytics#filters", "type": "string", "description": "Collection type." }, "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": "Link to previous page for this filter collection.", "type": "string" } }, "id": "Filters", "type": "object", "description": "A filter collection lists filters created by users in an Analytics account. Each resource in the collection corresponds to a filter." }, "Columns": { "type": "object", "properties": { "items": { "type": "array", "description": "List of columns for a report type.", "items": { "$ref": "Column" } }, "etag": { "description": "Etag of collection. This etag can be compared with the last response etag to check if response has changed.", "type": "string" }, "kind": { "description": "Collection type.", "default": "analytics#columns", "type": "string" }, "attributeNames": { "description": "List of attributes names returned by columns.", "items": { "type": "string" }, "type": "array" }, "totalResults": { "format": "int32", "description": "Total number of columns returned in the response.", "type": "integer" } }, "id": "Columns", "description": "Lists columns (dimensions and metrics) for a particular report type." }, "Upload": { "id": "Upload", "properties": { "uploadTime": { "format": "date-time", "type": "string", "description": "Time this file is uploaded." }, "customDataSourceId": { "type": "string", "description": "Custom data source Id to which this data import belongs." }, "accountId": { "type": "string", "description": "Account Id to which this upload belongs.", "format": "int64" }, "kind": { "default": "analytics#upload", "description": "Resource type for Analytics upload.", "type": "string" }, "status": { "type": "string", "description": "Upload status. Possible values: PENDING, COMPLETED, FAILED, DELETING, DELETED." }, "id": { "description": "A unique ID for this upload.", "type": "string" }, "errors": { "items": { "type": "string" }, "type": "array", "description": "Data import errors collection." } }, "description": "Metadata returned for an upload operation.", "type": "object" }, "UserRef": { "id": "UserRef", "description": "JSON template for a user reference.", "properties": { "email": { "type": "string", "description": "Email ID of this user." }, "id": { "type": "string", "description": "User ID." }, "kind": { "type": "string", "default": "analytics#userRef" } }, "type": "object" }, "Goals": { "id": "Goals", "properties": { "nextLink": { "description": "Link to next page for this goal 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.", "format": "int32", "type": "integer" }, "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" }, "previousLink": { "description": "Link to previous page for this goal collection.", "type": "string" }, "items": { "description": "A list of goals.", "type": "array", "items": { "$ref": "Goal" } }, "totalResults": { "type": "integer", "description": "The total number of results for the query, regardless of the number of resources in the result.", "format": "int32" }, "username": { "description": "Email ID of the authenticated user", "type": "string" }, "kind": { "default": "analytics#goals", "type": "string", "description": "Collection type." } }, "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" }, "LinkedForeignAccount": { "description": "JSON template for an Analytics Remarketing Audience Foreign Link.", "properties": { "linkedAccountId": { "type": "string", "description": "The foreign account ID. For example the an Google Ads `linkedAccountId` has the following format XXX-XXX-XXXX." }, "internalWebPropertyId": { "description": "Internal ID for the web property to which this linked foreign account belongs.", "type": "string", "readOnly": true }, "kind": { "type": "string", "default": "analytics#linkedForeignAccount", "description": "Resource type for linked foreign account." }, "id": { "description": "Entity ad account link ID.", "type": "string" }, "webPropertyId": { "description": "Web property ID of the form UA-XXXXX-YY to which this linked foreign account belongs.", "type": "string" }, "eligibleForSearch": { "description": "Boolean indicating whether this is eligible for search.", "readOnly": true, "type": "boolean" }, "status": { "type": "string", "description": "The status of this foreign account link." }, "accountId": { "type": "string", "description": "Account ID to which this linked foreign account belongs." }, "remarketingAudienceId": { "type": "string", "description": "Remarketing audience ID to which this linked foreign account belongs." }, "type": { "description": "The type of the foreign account. For example, `ADWORDS_LINKS`, `DBM_LINKS`, `MCC_LINKS` or `OPTIMIZE`.", "type": "string" } }, "type": "object", "id": "LinkedForeignAccount" }, "Profile": { "properties": { "timezone": { "description": "Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database.", "type": "string" }, "childLink": { "type": "object", "properties": { "href": { "description": "Link to the list of goals for this view (profile).", "type": "string" }, "type": { "description": "Value is \"analytics#goals\".", "default": "analytics#goals", "type": "string" } }, "description": "Child link for this view (profile). Points to the list of goals for this view (profile)." }, "eCommerceTracking": { "type": "boolean", "description": "Indicates whether ecommerce tracking is enabled for this view (profile)." }, "stripSiteSearchQueryParameters": { "description": "Whether or not Analytics will strip search query parameters from the URLs in your reports.", "type": "boolean" }, "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" }, "defaultPage": { "description": "Default page for this view (profile).", "type": "string" }, "kind": { "readOnly": true, "type": "string", "default": "analytics#profile", "description": "Resource type for Analytics view (profile)." }, "name": { "type": "string", "description": "Name of this view (profile)." }, "siteSearchCategoryParameters": { "type": "string", "description": "Site search category parameters for this view (profile)." }, "internalWebPropertyId": { "description": "Internal ID for the web property to which this view (profile) belongs.", "type": "string", "readOnly": true }, "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" }, "parentLink": { "type": "object", "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" } } }, "id": { "description": "View (Profile) ID.", "type": "string" }, "selfLink": { "type": "string", "readOnly": true, "description": "Link for this view (profile)." }, "excludeQueryParameters": { "type": "string", "description": "The query parameters that are excluded from this view (profile)." }, "starred": { "description": "Indicates whether this view (profile) is starred or not.", "type": "boolean" }, "siteSearchQueryParameters": { "description": "The site search query parameters for this view (profile).", "type": "string" }, "created": { "format": "date-time", "readOnly": true, "type": "string", "description": "Time this view (profile) was created." }, "accountId": { "type": "string", "description": "Account ID to which this view (profile) belongs." }, "websiteUrl": { "description": "Website URL for this view (profile).", "type": "string" }, "stripSiteSearchCategoryParameters": { "type": "boolean", "description": "Whether or not Analytics will strip search category parameters from the URLs in your reports." }, "webPropertyId": { "description": "Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.", "readOnly": true, "type": "string" }, "type": { "type": "string", "description": "View (Profile) type. Supported types: WEB or APP." }, "permissions": { "description": "Permissions the user has for this view (profile).", "type": "object", "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." } } }, "updated": { "readOnly": true, "format": "date-time", "description": "Time this view (profile) was last modified.", "type": "string" }, "botFilteringEnabled": { "description": "Indicates whether bot filtering is enabled for this view (profile).", "type": "boolean" } }, "type": "object", "description": "JSON template for an Analytics view (profile).", "id": "Profile" }, "CustomDataSource": { "description": "JSON template for an Analytics custom data source.", "properties": { "uploadType": { "description": "Upload type of the custom data source.", "type": "string" }, "selfLink": { "type": "string", "description": "Link for this Analytics custom data source." }, "created": { "description": "Time this custom data source was created.", "format": "date-time", "type": "string" }, "type": { "description": "Type of the custom data source.", "type": "string" }, "webPropertyId": { "type": "string", "description": "Web property ID of the form UA-XXXXX-YY to which this custom data source belongs." }, "importBehavior": { "type": "string" }, "kind": { "default": "analytics#customDataSource", "type": "string", "description": "Resource type for Analytics custom data source." }, "description": { "type": "string", "description": "Description of custom data source." }, "schema": { "items": { "type": "string" }, "type": "array", "description": "Collection of schema headers of the custom data source." }, "parentLink": { "properties": { "href": { "description": "Link to the web property to which this custom data source belongs.", "type": "string" }, "type": { "description": "Value is \"analytics#webproperty\".", "type": "string", "default": "analytics#webproperty" } }, "type": "object", "description": "Parent link for this custom data source. Points to the web property to which this custom data source belongs." }, "accountId": { "type": "string", "description": "Account ID to which this custom data source belongs." }, "childLink": { "properties": { "href": { "type": "string", "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": { "description": "Value is \"analytics#dailyUploads\". Value is \"analytics#uploads\".", "type": "string" } }, "type": "object" }, "profilesLinked": { "description": "IDs of views (profiles) linked to the custom data source.", "type": "array", "items": { "type": "string" } }, "name": { "description": "Name of this custom data source.", "type": "string" }, "updated": { "format": "date-time", "type": "string", "description": "Time this custom data source was last modified." }, "id": { "description": "Custom data source ID.", "type": "string" } }, "id": "CustomDataSource", "type": "object" }, "AccountTreeResponse": { "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).", "id": "AccountTreeResponse", "type": "object", "properties": { "webproperty": { "$ref": "Webproperty", "description": "Web property for the account." }, "account": { "description": "The account created.", "$ref": "Account" }, "profile": { "$ref": "Profile", "description": "View (Profile) for the account." }, "kind": { "default": "analytics#accountTreeResponse", "description": "Resource type for account ticket.", "type": "string" } } }, "Webproperties": { "id": "Webproperties", "type": "object", "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": { "items": { "type": "array", "items": { "$ref": "Webproperty" }, "description": "A list of web properties." }, "totalResults": { "description": "The total number of results for the query, regardless of the number of results in the response.", "type": "integer", "format": "int32" }, "nextLink": { "description": "Link to next page for this web property collection.", "type": "string" }, "kind": { "default": "analytics#webproperties", "type": "string", "description": "Collection type." }, "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." }, "previousLink": { "description": "Link to previous page for this web property collection.", "type": "string" }, "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" }, "username": { "description": "Email ID of the authenticated user", "type": "string" } } }, "Accounts": { "type": "object", "id": "Accounts", "properties": { "items": { "type": "array", "items": { "$ref": "Account" }, "description": "A list of accounts." }, "previousLink": { "type": "string", "description": "Previous link for this account collection." }, "nextLink": { "type": "string", "description": "Next link for this account collection." }, "itemsPerPage": { "format": "int32", "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." }, "kind": { "description": "Collection type.", "default": "analytics#accounts", "type": "string" }, "startIndex": { "format": "int32", "type": "integer", "description": "The starting index of the entries, which is 1 by default or otherwise specified by the start-index query parameter." }, "totalResults": { "type": "integer", "format": "int32", "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": "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." }, "Experiment": { "type": "object", "description": "JSON template for Analytics experiment resource.", "id": "Experiment", "properties": { "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" }, "startTime": { "type": "string", "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.", "format": "date-time" }, "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" ] } }, "winnerFound": { "type": "boolean", "description": "Boolean specifying whether a winner has been found for this experiment. This field is read-only." }, "description": { "type": "string", "description": "Notes about this experiment." }, "profileId": { "type": "string", "description": "View (Profile) ID to which this experiment belongs. This field is read-only." }, "snippet": { "type": "string", "description": "The snippet of code to include on the control page(s). This field is read-only." }, "parentLink": { "type": "object", "description": "Parent link for an experiment. Points to the view (profile) to which this experiment belongs.", "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" } } }, "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\"." }, "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" }, "updated": { "format": "date-time", "description": "Time the experiment was last modified. This field is read-only.", "type": "string" }, "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." }, "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" }, "id": { "description": "Experiment ID. Required for patch and update. Disallowed for create.", "annotations": { "required": [ "analytics.management.experiments.patch", "analytics.management.experiments.update" ] }, "type": "string" }, "endTime": { "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.", "type": "string", "format": "date-time" }, "accountId": { "description": "Account ID to which this experiment belongs. This field is read-only.", "type": "string" }, "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." }, "minimumExperimentLengthInDays": { "format": "int32", "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.", "type": "integer" }, "winnerConfidenceLevel": { "format": "double", "type": "number", "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." }, "variations": { "type": "array", "items": { "type": "object", "properties": { "weight": { "description": "Weight that this variation should receive. Only present if the experiment is running. This field is read-only.", "type": "number", "format": "double" }, "won": { "type": "boolean", "description": "True if the experiment has ended and this variation performed (statistically) significantly better than the original. This field is read-only." }, "status": { "type": "string", "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." }, "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.", "type": "string", "annotations": { "required": [ "analytics.management.experiments.insert", "analytics.management.experiments.update" ] } }, "url": { "type": "string", "description": "The URL of the variation. This field may not be changed for an experiment whose status is RUNNING or ENDED." } } }, "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." }, "selfLink": { "type": "string", "description": "Link for this experiment. This field is read-only." }, "name": { "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" ] }, "type": "string" }, "editableInGaUi": { "description": "If true, the end user will be able to edit the experiment via the Google Analytics user interface.", "type": "boolean" }, "kind": { "description": "Resource type for an Analytics experiment. This field is read-only.", "type": "string", "default": "analytics#experiment" }, "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\"." }, "created": { "format": "date-time", "type": "string", "description": "Time the experiment was created. This field is read-only." }, "servingFramework": { "type": "string", "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." }, "internalWebPropertyId": { "type": "string", "description": "Internal ID for the web property to which this experiment belongs. This field is read-only." } } }, "HashClientIdRequest": { "type": "object", "description": "JSON template for a hash Client Id request resource.", "id": "HashClientIdRequest", "properties": { "kind": { "type": "string", "default": "analytics#hashClientIdRequest" }, "clientId": { "type": "string" }, "webPropertyId": { "type": "string" } } }, "UnsampledReports": { "type": "object", "id": "UnsampledReports", "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.", "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." }, "kind": { "default": "analytics#unsampledReports", "type": "string", "description": "Collection type." }, "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" }, "items": { "items": { "$ref": "UnsampledReport" }, "type": "array", "description": "A list of unsampled reports." }, "username": { "type": "string", "description": "Email ID of the authenticated user" }, "previousLink": { "type": "string", "description": "Link to previous page for this unsampled report collection." }, "nextLink": { "type": "string", "description": "Link to next page for this unsampled report collection." }, "totalResults": { "type": "integer", "format": "int32", "description": "The total number of results for the query, regardless of the number of resources in the result." } } }, "Goal": { "description": "JSON template for Analytics goal resource.", "id": "Goal", "type": "object", "properties": { "profileId": { "type": "string", "description": "View (Profile) ID to which this goal belongs." }, "active": { "type": "boolean", "description": "Determines whether this goal is active." }, "id": { "description": "Goal ID.", "type": "string" }, "selfLink": { "description": "Link for this goal.", "type": "string" }, "kind": { "description": "Resource type for an Analytics goal.", "default": "analytics#goal", "type": "string" }, "urlDestinationDetails": { "type": "object", "properties": { "url": { "type": "string", "description": "URL for this goal." }, "matchType": { "type": "string", "description": "Match type for the goal URL. Possible values are HEAD, EXACT, or REGEX." }, "steps": { "description": "List of steps configured for this goal funnel.", "type": "array", "items": { "properties": { "number": { "type": "integer", "format": "int32", "description": "Step number." }, "name": { "type": "string", "description": "Step name." }, "url": { "type": "string", "description": "URL for this step." } }, "type": "object" } }, "firstStepRequired": { "type": "boolean", "description": "Determines if the first step in this goal is required." }, "caseSensitive": { "type": "boolean", "description": "Determines if the goal URL must exactly match the capitalization of visited URLs." } }, "description": "Details for the goal of the type URL_DESTINATION." }, "parentLink": { "description": "Parent link for a goal. Points to the view (profile) to which this goal belongs.", "properties": { "href": { "type": "string", "description": "Link to the view (profile) to which this goal belongs." }, "type": { "default": "analytics#profile", "type": "string", "description": "Value is \"analytics#profile\"." } }, "type": "object" }, "internalWebPropertyId": { "description": "Internal ID for the web property to which this goal belongs.", "type": "string" }, "visitTimeOnSiteDetails": { "properties": { "comparisonValue": { "format": "int64", "description": "Value used for this comparison.", "type": "string" }, "comparisonType": { "description": "Type of comparison. Possible values are LESS_THAN or GREATER_THAN.", "type": "string" } }, "description": "Details for the goal of the type VISIT_TIME_ON_SITE.", "type": "object" }, "name": { "type": "string", "description": "Goal name." }, "updated": { "description": "Time this goal was last modified.", "format": "date-time", "type": "string" }, "value": { "description": "Goal value.", "format": "float", "type": "number" }, "webPropertyId": { "description": "Web property ID to which this goal belongs. The web property ID is of the form UA-XXXXX-YY.", "type": "string" }, "accountId": { "description": "Account ID to which this goal belongs.", "type": "string" }, "visitNumPagesDetails": { "description": "Details for the goal of the type VISIT_NUM_PAGES.", "type": "object", "properties": { "comparisonType": { "type": "string", "description": "Type of comparison. Possible values are LESS_THAN, GREATER_THAN, or EQUAL." }, "comparisonValue": { "description": "Value used for this comparison.", "type": "string", "format": "int64" } } }, "created": { "format": "date-time", "description": "Time this goal was created.", "type": "string" }, "eventDetails": { "properties": { "eventConditions": { "type": "array", "description": "List of event conditions.", "items": { "type": "object", "properties": { "comparisonType": { "type": "string", "description": "Type of comparison. Possible values are LESS_THAN, GREATER_THAN or EQUAL." }, "type": { "description": "Type of this event condition. Possible values are CATEGORY, ACTION, LABEL, or VALUE.", "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.", "type": "string", "format": "int64" }, "expression": { "type": "string", "description": "Expression used for this match." } } } }, "useEventValue": { "type": "boolean", "description": "Determines if the event value should be used as the value for this goal." } }, "description": "Details for the goal of the type EVENT.", "type": "object" }, "type": { "type": "string", "description": "Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT." } } }, "FilterExpression": { "type": "object", "description": "JSON template for an Analytics filter expression.", "id": "FilterExpression", "properties": { "fieldIndex": { "format": "int32", "type": "integer", "description": "The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION." }, "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": { "type": "boolean", "description": "Determines if the filter is case sensitive." }, "kind": { "description": "Kind value for filter expression", "default": "analytics#filterExpression", "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)," }, "expressionValue": { "type": "string", "description": "Filter expression value" } } }, "CustomDataSources": { "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.", "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" }, "previousLink": { "type": "string", "description": "Link to previous page for this custom data source collection." }, "totalResults": { "format": "int32", "description": "The total number of results for the query, regardless of the number of results in the response.", "type": "integer" }, "kind": { "type": "string", "default": "analytics#customDataSources", "description": "Collection type." }, "username": { "description": "Email ID of the authenticated user", "type": "string" }, "nextLink": { "description": "Link to next page for this custom data source 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" }, "items": { "description": "Collection of custom data sources.", "type": "array", "items": { "$ref": "CustomDataSource" } } } }, "ProfileFilterLinks": { "properties": { "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 1,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.", "format": "int32", "type": "integer" }, "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" }, "nextLink": { "description": "Link to next page for this profile filter link collection.", "type": "string" }, "items": { "description": "A list of profile filter links.", "items": { "$ref": "ProfileFilterLink" }, "type": "array" }, "kind": { "default": "analytics#profileFilterLinks", "type": "string", "description": "Collection type." }, "previousLink": { "description": "Link to previous page for this profile filter link collection.", "type": "string" }, "username": { "description": "Email ID of the authenticated user", "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" } }, "type": "object", "id": "ProfileFilterLinks", "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." }, "Segment": { "type": "object", "id": "Segment", "properties": { "type": { "description": "Type for a segment. Possible values are \"BUILT_IN\" or \"CUSTOM\".", "type": "string" }, "name": { "type": "string", "description": "Segment name." }, "definition": { "description": "Segment definition.", "type": "string" }, "updated": { "description": "Time the segment was last modified.", "type": "string", "format": "date-time" }, "selfLink": { "description": "Link for this segment.", "type": "string" }, "created": { "type": "string", "format": "date-time", "description": "Time the segment was created." }, "segmentId": { "description": "Segment ID. Can be used with the 'segment' parameter in Core Reporting API.", "type": "string" }, "kind": { "description": "Resource type for Analytics segment.", "type": "string", "default": "analytics#segment" }, "id": { "description": "Segment ID.", "type": "string" } }, "description": "JSON template for an Analytics segment." }, "UserDeletionRequest": { "description": "JSON template for a user deletion request resource.", "id": "UserDeletionRequest", "properties": { "id": { "description": "User ID.", "type": "object", "properties": { "type": { "description": "Type of user", "type": "string" }, "userId": { "type": "string", "description": "The User's id" } } }, "webPropertyId": { "type": "string", "description": "Web property ID of the form UA-XXXXX-YY." }, "propertyId": { "description": "Property ID", "type": "string" }, "firebaseProjectId": { "type": "string", "description": "Firebase Project Id" }, "kind": { "description": "Value is \"analytics#userDeletionRequest\".", "type": "string", "default": "analytics#userDeletionRequest" }, "deletionRequestTime": { "readOnly": true, "type": "string", "format": "date-time", "description": "This marks the point in time for which all user data before should be deleted" } }, "type": "object" }, "McfData": { "type": "object", "description": "Multi-Channel Funnels data for a given view (profile).", "id": "McfData", "properties": { "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" }, "profileInfo": { "properties": { "tableId": { "type": "string", "description": "Table ID for view (profile)." }, "accountId": { "description": "Account ID to which this view (profile) belongs.", "type": "string" }, "profileName": { "type": "string", "description": "View (Profile) name." }, "profileId": { "description": "View (Profile) ID.", "type": "string" }, "internalWebPropertyId": { "description": "Internal ID for the web property to which this view (profile) belongs.", "type": "string" }, "webPropertyId": { "description": "Web Property ID to which this view (profile) belongs.", "type": "string" } }, "description": "Information for the view (profile), for which the Analytics data was requested.", "type": "object" }, "containsSampledData": { "description": "Determines if the Analytics data contains sampled data.", "type": "boolean" }, "selfLink": { "type": "string", "description": "Link to this page." }, "totalResults": { "description": "The total number of rows for the query, regardless of the number of rows in the response.", "format": "int32", "type": "integer" }, "sampleSize": { "type": "string", "description": "The number of samples used to calculate the result.", "format": "int64" }, "query": { "type": "object", "properties": { "ids": { "type": "string", "description": "Unique table ID." }, "end-date": { "type": "string", "description": "End date." }, "start-date": { "description": "Start date.", "type": "string" }, "filters": { "type": "string", "description": "Comma-separated list of dimension or metric filters." }, "sort": { "description": "List of dimensions or metrics based on which Analytics data is sorted.", "items": { "type": "string" }, "type": "array" }, "dimensions": { "type": "string", "description": "List of analytics dimensions." }, "segment": { "description": "Analytics advanced segment.", "type": "string" }, "metrics": { "items": { "type": "string" }, "type": "array", "description": "List of analytics metrics." }, "start-index": { "description": "Start index.", "format": "int32", "type": "integer" }, "max-results": { "description": "Maximum results per page.", "format": "int32", "type": "integer" }, "samplingLevel": { "type": "string", "description": "Desired sampling level" } }, "description": "Analytics data request query parameters." }, "totalsForAllResults": { "type": "object", "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" } }, "kind": { "description": "Resource type.", "type": "string", "default": "analytics#mcfData" }, "columnHeaders": { "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": { "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": { "description": "Column name.", "type": "string" } }, "type": "object" }, "type": "array" }, "nextLink": { "type": "string", "description": "Link to next page for this Analytics data query." }, "rows": { "items": { "type": "array", "items": { "type": "object", "properties": { "primitiveValue": { "type": "string", "description": "A primitive dimension value. A primitive metric value." }, "conversionPathValue": { "items": { "properties": { "interactionType": { "type": "string", "description": "Type of an interaction on conversion path. Such as CLICK, IMPRESSION etc." }, "nodeValue": { "description": "Node value of an interaction on conversion path. Such as source, medium etc.", "type": "string" } }, "type": "object" }, "description": "A conversion path dimension value, containing a list of interactions with their attributes.", "type": "array" } }, "description": "A union object representing a dimension or metric value. Only one of \"primitiveValue\" or \"conversionPathValue\" attribute will be populated." } }, "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" }, "sampleSpace": { "format": "int64", "description": "Total size of the sample space from which the samples were selected.", "type": "string" }, "previousLink": { "description": "Link to previous page for this Analytics data query.", "type": "string" }, "id": { "type": "string", "description": "Unique ID for this data response." } } }, "Uploads": { "type": "object", "properties": { "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": { "description": "Collection type.", "type": "string", "default": "analytics#uploads" }, "nextLink": { "description": "Link to next page for this upload 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.", "format": "int32", "type": "integer" }, "items": { "items": { "$ref": "Upload" }, "type": "array", "description": "A list of uploads." }, "totalResults": { "type": "integer", "format": "int32", "description": "The total number of results for the query, regardless of the number of resources in the result." }, "previousLink": { "type": "string", "description": "Link to previous page for this upload collection." } }, "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.", "id": "Uploads" } }, "basePath": "/analytics/v3/", "etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/o_TVyaWurnALX6ZIQ952-U5m22Y\"", "parameters": { "quotaUser": { "type": "string", "location": "query", "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters." }, "alt": { "type": "string", "description": "Data format for the response.", "enumDescriptions": [ "Responses with Content-Type of application/json" ], "default": "json", "location": "query", "enum": [ "json" ] }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response.", "location": "query" }, "key": { "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", "type": "string", "location": "query" }, "prettyPrint": { "default": "false", "description": "Returns response with indentations and line breaks.", "type": "boolean", "location": "query" }, "userIp": { "description": "Deprecated. Please use quotaUser instead.", "type": "string", "location": "query" }, "oauth_token": { "description": "OAuth 2.0 token for the current user.", "type": "string", "location": "query" } }, "rootUrl": "https://analytics.googleapis.com/", "servicePath": "analytics/v3/", "revision": "20190807", "ownerDomain": "google.com", "discoveryVersion": "v1", "title": "Google Analytics API", "kind": "discovery#restDescription", "id": "analytics:v3", "resources": { "userDeletion": { "resources": { "userDeletionRequest": { "methods": { "upsert": { "path": "userDeletion/userDeletionRequests:upsert", "scopes": [ "https://www.googleapis.com/auth/analytics.user.deletion" ], "response": { "$ref": "UserDeletionRequest" }, "id": "analytics.userDeletion.userDeletionRequest.upsert", "request": { "$ref": "UserDeletionRequest" }, "description": "Insert or update a user deletion requests.", "httpMethod": "POST" } } } } }, "metadata": { "resources": { "columns": { "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": "Columns" }, "parameters": { "reportType": { "location": "path", "required": true, "pattern": "ga", "type": "string", "description": "Report type. Allowed Values: 'ga'. Where 'ga' corresponds to the Core Reporting API" } }, "httpMethod": "GET", "id": "analytics.metadata.columns.list", "parameterOrder": [ "reportType" ], "description": "Lists all columns for a report type", "path": "metadata/{reportType}/columns" } } } } }, "provisioning": { "methods": { "createAccountTree": { "path": "provisioning/createAccountTree", "response": { "$ref": "AccountTreeResponse" }, "scopes": [ "https://www.googleapis.com/auth/analytics.provision" ], "request": { "$ref": "AccountTreeRequest" }, "httpMethod": "POST", "id": "analytics.provisioning.createAccountTree", "description": "Provision account." }, "createAccountTicket": { "request": { "$ref": "AccountTicket" }, "id": "analytics.provisioning.createAccountTicket", "response": { "$ref": "AccountTicket" }, "path": "provisioning/createAccountTicket", "httpMethod": "POST", "description": "Creates an account ticket.", "scopes": [ "https://www.googleapis.com/auth/analytics.provision" ] } } }, "data": { "resources": { "realtime": { "methods": { "get": { "scopes": [ "https://www.googleapis.com/auth/analytics", "https://www.googleapis.com/auth/analytics.readonly" ], "description": "Returns real time data for a view (profile).", "response": { "$ref": "RealtimeData" }, "path": "data/realtime", "id": "analytics.data.realtime.get", "httpMethod": "GET", "parameterOrder": [ "ids", "metrics" ], "parameters": { "sort": { "type": "string", "description": "A comma-separated list of dimensions or metrics that determine the sort order for real time data.", "location": "query", "pattern": "(-)?((ga:.+)|(rt:.+))" }, "metrics": { "type": "string", "pattern": "(ga:.+)|(rt:.+)", "required": true, "description": "A comma-separated list of real time metrics. E.g., 'rt:activeUsers'. At least one metric must be specified.", "location": "query" }, "ids": { "required": true, "pattern": "ga:[0-9]+", "description": "Unique table ID for retrieving real time data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.", "location": "query", "type": "string" }, "dimensions": { "type": "string", "pattern": "(ga:.+)|(rt:.+)", "location": "query", "description": "A comma-separated list of real time dimensions. E.g., 'rt:medium,rt:city'." }, "max-results": { "description": "The maximum number of entries to include in this feed.", "format": "int32", "type": "integer", "location": "query" }, "filters": { "pattern": "(ga:.+)|(rt:.+)", "type": "string", "description": "A comma-separated list of dimension or metric filters to be applied to real time data.", "location": "query" } } } } }, "ga": { "methods": { "get": { "scopes": [ "https://www.googleapis.com/auth/analytics", "https://www.googleapis.com/auth/analytics.readonly" ], "path": "data/ga", "httpMethod": "GET", "parameters": { "start-date": { "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}|today|yesterday|[0-9]+(daysAgo)", "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.", "required": true, "type": "string" }, "sort": { "description": "A comma-separated list of dimensions or metrics that determine the sort order for Analytics data.", "location": "query", "type": "string", "pattern": "(-)?ga:.+" }, "include-empty-rows": { "location": "query", "type": "boolean", "description": "The response will include empty rows if this parameter is set to true, the default is true" }, "output": { "enum": [ "dataTable", "json" ], "enumDescriptions": [ "Returns the response in Google Charts Data Table format. This is useful in creating visualization using Google Charts.", "Returns the response in standard JSON format." ], "location": "query", "type": "string", "description": "The selected format for the response. Default format is JSON." }, "filters": { "description": "A comma-separated list of dimension or metric filters to be applied to Analytics data.", "location": "query", "type": "string", "pattern": "ga:.+" }, "end-date": { "description": "End date for fetching Analytics data. Request can should specify an end date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is yesterday.", "location": "query", "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}|today|yesterday|[0-9]+(daysAgo)", "required": true, "type": "string" }, "segment": { "location": "query", "description": "An Analytics segment to be applied to data.", "type": "string" }, "metrics": { "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", "pattern": "ga:.+", "location": "query" }, "max-results": { "format": "int32", "description": "The maximum number of entries to include in this feed.", "location": "query", "type": "integer" }, "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" }, "dimensions": { "type": "string", "description": "A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'.", "location": "query", "pattern": "(ga:.+)?" }, "ids": { "description": "Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.", "required": true, "location": "query", "type": "string", "pattern": "ga:[0-9]+" }, "samplingLevel": { "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." ], "description": "The desired sampling level.", "enum": [ "DEFAULT", "FASTER", "HIGHER_PRECISION" ], "type": "string" } }, "parameterOrder": [ "ids", "start-date", "end-date", "metrics" ], "id": "analytics.data.ga.get", "response": { "$ref": "GaData" }, "description": "Returns Analytics data for a view (profile)." } } }, "mcf": { "methods": { "get": { "parameterOrder": [ "ids", "start-date", "end-date", "metrics" ], "path": "data/mcf", "scopes": [ "https://www.googleapis.com/auth/analytics", "https://www.googleapis.com/auth/analytics.readonly" ], "id": "analytics.data.mcf.get", "parameters": { "max-results": { "description": "The maximum number of entries to include in this feed.", "format": "int32", "location": "query", "type": "integer" }, "dimensions": { "location": "query", "description": "A comma-separated list of Multi-Channel Funnels dimensions. E.g., 'mcf:source,mcf:medium'.", "pattern": "(mcf:.+)?", "type": "string" }, "sort": { "type": "string", "description": "A comma-separated list of dimensions or metrics that determine the sort order for the Analytics data.", "location": "query", "pattern": "(-)?mcf:.+" }, "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.", "type": "string", "location": "query", "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}|today|yesterday|[0-9]+(daysAgo)", "required": true }, "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." ], "location": "query", "type": "string", "enum": [ "DEFAULT", "FASTER", "HIGHER_PRECISION" ], "description": "The desired sampling level." }, "filters": { "location": "query", "description": "A comma-separated list of dimension or metric filters to be applied to the Analytics data.", "type": "string", "pattern": "mcf:.+" }, "start-index": { "type": "integer", "location": "query", "minimum": "1", "format": "int32", "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter." }, "ids": { "description": "Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.", "type": "string", "location": "query", "pattern": "ga:[0-9]+", "required": true }, "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.", "required": true, "type": "string", "location": "query" }, "metrics": { "location": "query", "pattern": "mcf:.+", "type": "string", "description": "A comma-separated list of Multi-Channel Funnels metrics. E.g., 'mcf:totalConversions,mcf:totalConversionValue'. At least one metric must be specified.", "required": true } }, "response": { "$ref": "McfData" }, "httpMethod": "GET", "description": "Returns Analytics Multi-Channel Funnels data for a view (profile)." } } } } }, "management": { "resources": { "webproperties": { "methods": { "get": { "scopes": [ "https://www.googleapis.com/auth/analytics.edit", "https://www.googleapis.com/auth/analytics.readonly" ], "response": { "$ref": "Webproperty" }, "parameters": { "accountId": { "type": "string", "required": true, "description": "Account ID to retrieve the web property for.", "pattern": "[0-9]+", "location": "path" }, "webPropertyId": { "description": "ID to retrieve the web property for.", "type": "string", "pattern": "UA-[0-9]+-[0-9]+", "required": true, "location": "path" } }, "httpMethod": "GET", "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" }, "insert": { "parameters": { "accountId": { "type": "string", "required": true, "location": "path", "description": "Account ID to create the web property for." } }, "id": "analytics.management.webproperties.insert", "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.", "httpMethod": "POST", "request": { "$ref": "Webproperty" }, "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "parameterOrder": [ "accountId" ], "path": "management/accounts/{accountId}/webproperties" }, "patch": { "parameterOrder": [ "accountId", "webPropertyId" ], "httpMethod": "PATCH", "id": "analytics.management.webproperties.patch", "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "request": { "$ref": "Webproperty" }, "response": { "$ref": "Webproperty" }, "parameters": { "accountId": { "required": true, "location": "path", "type": "string", "description": "Account ID to which the web property belongs" }, "webPropertyId": { "location": "path", "required": true, "type": "string", "description": "Web property ID" } }, "description": "Updates an existing web property. This method supports patch semantics.", "path": "management/accounts/{accountId}/webproperties/{webPropertyId}" }, "list": { "description": "Lists web properties to which the user has access.", "path": "management/accounts/{accountId}/webproperties", "response": { "$ref": "Webproperties" }, "id": "analytics.management.webproperties.list", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/analytics", "https://www.googleapis.com/auth/analytics.edit", "https://www.googleapis.com/auth/analytics.readonly" ], "parameterOrder": [ "accountId" ], "parameters": { "max-results": { "format": "int32", "type": "integer", "location": "query", "description": "The maximum number of web properties to include in this response." }, "accountId": { "type": "string", "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.", "required": true }, "start-index": { "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.", "type": "integer", "minimum": "1", "location": "query", "format": "int32" } } }, "update": { "response": { "$ref": "Webproperty" }, "path": "management/accounts/{accountId}/webproperties/{webPropertyId}", "parameters": { "accountId": { "description": "Account ID to which the web property belongs", "location": "path", "type": "string", "required": true }, "webPropertyId": { "required": true, "location": "path", "type": "string", "description": "Web property ID" } }, "description": "Updates an existing web property.", "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "httpMethod": "PUT", "request": { "$ref": "Webproperty" }, "parameterOrder": [ "accountId", "webPropertyId" ], "id": "analytics.management.webproperties.update" } } }, "customDataSources": { "methods": { "list": { "description": "List custom data sources to which the user has access.", "id": "analytics.management.customDataSources.list", "response": { "$ref": "CustomDataSources" }, "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources", "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 custom data sources to retrieve.", "pattern": "\\d+", "required": true, "type": "string", "location": "path" }, "webPropertyId": { "location": "path", "type": "string", "description": "Web property Id for the custom data sources to retrieve.", "required": true, "pattern": "UA-(\\d+)-(\\d+)" }, "max-results": { "description": "The maximum number of custom data sources to include in this response.", "type": "integer", "location": "query", "format": "int32", "minimum": "1" }, "start-index": { "minimum": "1", "description": "A 1-based index of the first custom data source to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.", "format": "int32", "type": "integer", "location": "query" } }, "parameterOrder": [ "accountId", "webPropertyId" ] } } }, "customMetrics": { "methods": { "update": { "parameters": { "webPropertyId": { "description": "Web property ID for the custom metric to update.", "location": "path", "required": true, "type": "string" }, "customMetricId": { "type": "string", "description": "Custom metric ID for the custom metric to update.", "required": true, "location": "path" }, "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", "type": "boolean", "location": "query" }, "accountId": { "type": "string", "required": true, "description": "Account ID for the custom metric to update.", "location": "path" } }, "description": "Updates an existing custom metric.", "response": { "$ref": "CustomMetric" }, "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics/{customMetricId}", "httpMethod": "PUT", "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "parameterOrder": [ "accountId", "webPropertyId", "customMetricId" ], "id": "analytics.management.customMetrics.update", "request": { "$ref": "CustomMetric" } }, "patch": { "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics/{customMetricId}", "id": "analytics.management.customMetrics.patch", "httpMethod": "PATCH", "parameterOrder": [ "accountId", "webPropertyId", "customMetricId" ], "parameters": { "customMetricId": { "description": "Custom metric ID for the custom metric to update.", "required": true, "location": "path", "type": "string" }, "webPropertyId": { "location": "path", "required": true, "type": "string", "description": "Web property ID for the custom metric to update." }, "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.", "default": "false", "type": "boolean" }, "accountId": { "location": "path", "type": "string", "description": "Account ID for the custom metric to update.", "required": true } }, "response": { "$ref": "CustomMetric" }, "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "description": "Updates an existing custom metric. This method supports patch semantics.", "request": { "$ref": "CustomMetric" } }, "list": { "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics", "response": { "$ref": "CustomMetrics" }, "parameterOrder": [ "accountId", "webPropertyId" ], "id": "analytics.management.customMetrics.list", "httpMethod": "GET", "parameters": { "start-index": { "minimum": "1", "location": "query", "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" }, "max-results": { "type": "integer", "format": "int32", "description": "The maximum number of custom metrics to include in this response.", "location": "query" }, "webPropertyId": { "description": "Web property ID for the custom metrics to retrieve.", "location": "path", "required": true, "type": "string" }, "accountId": { "description": "Account ID for the custom metrics to retrieve.", "location": "path", "type": "string", "required": true } }, "description": "Lists custom metrics to which the user has access.", "scopes": [ "https://www.googleapis.com/auth/analytics", "https://www.googleapis.com/auth/analytics.readonly" ] }, "insert": { "httpMethod": "POST", "request": { "$ref": "CustomMetric" }, "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics", "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "id": "analytics.management.customMetrics.insert", "response": { "$ref": "CustomMetric" }, "parameters": { "webPropertyId": { "type": "string", "location": "path", "description": "Web property ID for the custom dimension to create.", "required": true }, "accountId": { "location": "path", "required": true, "type": "string", "description": "Account ID for the custom metric to create." } }, "description": "Create a new custom metric.", "parameterOrder": [ "accountId", "webPropertyId" ] }, "get": { "description": "Get a custom metric to which the user has access.", "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics/{customMetricId}", "id": "analytics.management.customMetrics.get", "httpMethod": "GET", "parameterOrder": [ "accountId", "webPropertyId", "customMetricId" ], "parameters": { "customMetricId": { "description": "The ID of the custom metric to retrieve.", "type": "string", "required": true, "location": "path" }, "webPropertyId": { "required": true, "location": "path", "type": "string", "description": "Web property ID for the custom metric to retrieve." }, "accountId": { "location": "path", "required": true, "description": "Account ID for the custom metric to retrieve.", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/analytics.edit", "https://www.googleapis.com/auth/analytics.readonly" ], "response": { "$ref": "CustomMetric" } } } }, "accountUserLinks": { "methods": { "update": { "response": { "$ref": "EntityUserLink" }, "scopes": [ "https://www.googleapis.com/auth/analytics.manage.users" ], "parameters": { "accountId": { "location": "path", "description": "Account ID to update the account-user link for.", "type": "string", "required": true }, "linkId": { "description": "Link ID to update the account-user link for.", "location": "path", "type": "string", "required": true } }, "id": "analytics.management.accountUserLinks.update", "path": "management/accounts/{accountId}/entityUserLinks/{linkId}", "description": "Updates permissions for an existing user on the given account.", "parameterOrder": [ "accountId", "linkId" ], "httpMethod": "PUT", "request": { "$ref": "EntityUserLink" } }, "delete": { "httpMethod": "DELETE", "parameters": { "linkId": { "type": "string", "required": true, "description": "Link ID to delete the user link for.", "location": "path" }, "accountId": { "type": "string", "location": "path", "description": "Account ID to delete the user link for.", "required": true } }, "id": "analytics.management.accountUserLinks.delete", "path": "management/accounts/{accountId}/entityUserLinks/{linkId}", "parameterOrder": [ "accountId", "linkId" ], "description": "Removes a user from the given account.", "scopes": [ "https://www.googleapis.com/auth/analytics.manage.users" ] }, "list": { "httpMethod": "GET", "id": "analytics.management.accountUserLinks.list", "response": { "$ref": "EntityUserLinks" }, "parameterOrder": [ "accountId" ], "parameters": { "accountId": { "description": "Account ID to retrieve the user links for.", "type": "string", "required": true, "location": "path" }, "max-results": { "type": "integer", "description": "The maximum number of account-user links to include in this response.", "format": "int32", "location": "query" }, "start-index": { "type": "integer", "format": "int32", "minimum": "1", "location": "query", "description": "An index of the first account-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter." } }, "scopes": [ "https://www.googleapis.com/auth/analytics.manage.users", "https://www.googleapis.com/auth/analytics.manage.users.readonly" ], "path": "management/accounts/{accountId}/entityUserLinks", "description": "Lists account-user links for a given account." }, "insert": { "request": { "$ref": "EntityUserLink" }, "scopes": [ "https://www.googleapis.com/auth/analytics.manage.users" ], "id": "analytics.management.accountUserLinks.insert", "path": "management/accounts/{accountId}/entityUserLinks", "response": { "$ref": "EntityUserLink" }, "parameters": { "accountId": { "location": "path", "required": true, "type": "string", "description": "Account ID to create the user link for." } }, "parameterOrder": [ "accountId" ], "httpMethod": "POST", "description": "Adds a new user to the given account." } } }, "profiles": { "methods": { "patch": { "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "httpMethod": "PATCH", "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}", "parameters": { "accountId": { "location": "path", "description": "Account ID to which the view (profile) belongs", "type": "string", "required": true }, "profileId": { "description": "ID of the view (profile) to be updated.", "required": true, "location": "path", "type": "string" }, "webPropertyId": { "description": "Web property ID to which the view (profile) belongs", "required": true, "type": "string", "location": "path" } }, "id": "analytics.management.profiles.patch", "response": { "$ref": "Profile" }, "parameterOrder": [ "accountId", "webPropertyId", "profileId" ], "description": "Updates an existing view (profile). This method supports patch semantics.", "request": { "$ref": "Profile" } }, "get": { "scopes": [ "https://www.googleapis.com/auth/analytics.edit", "https://www.googleapis.com/auth/analytics.readonly" ], "httpMethod": "GET", "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}", "id": "analytics.management.profiles.get", "parameters": { "accountId": { "description": "Account ID to retrieve the view (profile) for.", "location": "path", "type": "string", "required": true, "pattern": "[0-9]+" }, "webPropertyId": { "location": "path", "required": true, "pattern": "UA-[0-9]+-[0-9]+", "type": "string", "description": "Web property ID to retrieve the view (profile) for." }, "profileId": { "location": "path", "required": true, "type": "string", "description": "View (Profile) ID to retrieve the view (profile) for.", "pattern": "[0-9]+" } }, "response": { "$ref": "Profile" }, "parameterOrder": [ "accountId", "webPropertyId", "profileId" ], "description": "Gets a view (profile) to which the user has access." }, "insert": { "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "httpMethod": "POST", "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles", "description": "Create a new view (profile).", "id": "analytics.management.profiles.insert", "request": { "$ref": "Profile" }, "response": { "$ref": "Profile" }, "parameters": { "accountId": { "location": "path", "description": "Account ID to create the view (profile) for.", "required": true, "type": "string" }, "webPropertyId": { "location": "path", "type": "string", "description": "Web property ID to create the view (profile) for.", "required": true } }, "parameterOrder": [ "accountId", "webPropertyId" ] }, "delete": { "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "id": "analytics.management.profiles.delete", "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}", "description": "Deletes a view (profile).", "parameterOrder": [ "accountId", "webPropertyId", "profileId" ], "parameters": { "profileId": { "location": "path", "type": "string", "required": true, "description": "ID of the view (profile) to be deleted." }, "accountId": { "location": "path", "required": true, "description": "Account ID to delete the view (profile) for.", "type": "string" }, "webPropertyId": { "location": "path", "type": "string", "required": true, "description": "Web property ID to delete the view (profile) for." } } }, "update": { "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "id": "analytics.management.profiles.update", "description": "Updates an existing view (profile).", "parameterOrder": [ "accountId", "webPropertyId", "profileId" ], "request": { "$ref": "Profile" }, "response": { "$ref": "Profile" }, "parameters": { "webPropertyId": { "required": true, "type": "string", "location": "path", "description": "Web property ID to which the view (profile) belongs" }, "profileId": { "location": "path", "required": true, "type": "string", "description": "ID of the view (profile) to be updated." }, "accountId": { "location": "path", "type": "string", "description": "Account ID to which the view (profile) belongs", "required": true } }, "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}", "httpMethod": "PUT" }, "list": { "parameterOrder": [ "accountId", "webPropertyId" ], "response": { "$ref": "Profiles" }, "httpMethod": "GET", "id": "analytics.management.profiles.list", "parameters": { "webPropertyId": { "location": "path", "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.", "type": "string", "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.", "type": "integer", "location": "query", "minimum": "1" }, "accountId": { "type": "string", "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 }, "max-results": { "format": "int32", "location": "query", "type": "integer", "description": "The maximum number of views (profiles) to include in this response." } }, "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}/profiles", "description": "Lists views (profiles) to which the user has access." } } }, "accountSummaries": { "methods": { "list": { "id": "analytics.management.accountSummaries.list", "parameters": { "start-index": { "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", "minimum": "1", "type": "integer" }, "max-results": { "format": "int32", "type": "integer", "location": "query", "description": "The maximum number of account summaries to include in this response, where the largest acceptable value is 1000." } }, "path": "management/accountSummaries", "response": { "$ref": "AccountSummaries" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/analytics.edit", "https://www.googleapis.com/auth/analytics.readonly" ], "description": "Lists account summaries (lightweight tree comprised of accounts/properties/profiles) to which the user has access." } } }, "accounts": { "methods": { "list": { "id": "analytics.management.accounts.list", "description": "Lists all accounts to which the user has access.", "response": { "$ref": "Accounts" }, "path": "management/accounts", "parameters": { "max-results": { "description": "The maximum number of accounts to include in this response.", "format": "int32", "type": "integer", "location": "query" }, "start-index": { "format": "int32", "location": "query", "type": "integer", "description": "An index of the first account to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.", "minimum": "1" } }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/analytics", "https://www.googleapis.com/auth/analytics.edit", "https://www.googleapis.com/auth/analytics.readonly" ] } } }, "segments": { "methods": { "list": { "description": "Lists segments to which the user has access.", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/analytics", "https://www.googleapis.com/auth/analytics.edit", "https://www.googleapis.com/auth/analytics.readonly" ], "path": "management/segments", "parameters": { "start-index": { "location": "query", "format": "int32", "minimum": "1", "type": "integer", "description": "An index of the first segment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter." }, "max-results": { "type": "integer", "location": "query", "format": "int32", "description": "The maximum number of segments to include in this response." } }, "response": { "$ref": "Segments" }, "id": "analytics.management.segments.list" } } }, "customDimensions": { "methods": { "insert": { "parameters": { "accountId": { "location": "path", "required": true, "description": "Account ID for the custom dimension to create.", "type": "string" }, "webPropertyId": { "location": "path", "description": "Web property ID for the custom dimension to create.", "required": true, "type": "string" } }, "httpMethod": "POST", "parameterOrder": [ "accountId", "webPropertyId" ], "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "description": "Create a new custom dimension.", "response": { "$ref": "CustomDimension" }, "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions", "request": { "$ref": "CustomDimension" }, "id": "analytics.management.customDimensions.insert" }, "patch": { "response": { "$ref": "CustomDimension" }, "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions/{customDimensionId}", "parameterOrder": [ "accountId", "webPropertyId", "customDimensionId" ], "parameters": { "customDimensionId": { "type": "string", "location": "path", "required": true, "description": "Custom dimension ID for the custom dimension to update." }, "webPropertyId": { "type": "string", "description": "Web property ID for the custom dimension to update.", "location": "path", "required": true }, "accountId": { "description": "Account ID for the custom dimension to update.", "required": true, "type": "string", "location": "path" }, "ignoreCustomDataSourceLinks": { "description": "Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set.", "default": "false", "location": "query", "type": "boolean" } }, "request": { "$ref": "CustomDimension" }, "id": "analytics.management.customDimensions.patch", "description": "Updates an existing custom dimension. This method supports patch semantics.", "httpMethod": "PATCH" }, "list": { "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions", "id": "analytics.management.customDimensions.list", "parameters": { "start-index": { "minimum": "1", "format": "int32", "location": "query", "type": "integer", "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter." }, "accountId": { "location": "path", "required": true, "description": "Account ID for the custom dimensions to retrieve.", "type": "string" }, "webPropertyId": { "type": "string", "location": "path", "description": "Web property ID for the custom dimensions to retrieve.", "required": true }, "max-results": { "description": "The maximum number of custom dimensions to include in this response.", "format": "int32", "type": "integer", "location": "query" } }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/analytics", "https://www.googleapis.com/auth/analytics.readonly" ], "description": "Lists custom dimensions to which the user has access.", "parameterOrder": [ "accountId", "webPropertyId" ], "response": { "$ref": "CustomDimensions" } }, "get": { "response": { "$ref": "CustomDimension" }, "description": "Get a custom dimension to which the user has access.", "httpMethod": "GET", "id": "analytics.management.customDimensions.get", "parameterOrder": [ "accountId", "webPropertyId", "customDimensionId" ], "scopes": [ "https://www.googleapis.com/auth/analytics.edit", "https://www.googleapis.com/auth/analytics.readonly" ], "parameters": { "accountId": { "description": "Account ID for the custom dimension to retrieve.", "location": "path", "type": "string", "required": true }, "webPropertyId": { "description": "Web property ID for the custom dimension to retrieve.", "required": true, "type": "string", "location": "path" }, "customDimensionId": { "description": "The ID of the custom dimension to retrieve.", "required": true, "location": "path", "type": "string" } }, "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions/{customDimensionId}" }, "update": { "httpMethod": "PUT", "description": "Updates an existing custom dimension.", "request": { "$ref": "CustomDimension" }, "id": "analytics.management.customDimensions.update", "parameterOrder": [ "accountId", "webPropertyId", "customDimensionId" ], "parameters": { "customDimensionId": { "location": "path", "description": "Custom dimension ID for the custom dimension to update.", "required": true, "type": "string" }, "webPropertyId": { "location": "path", "type": "string", "required": true, "description": "Web property ID for the custom dimension to update." }, "accountId": { "location": "path", "required": true, "description": "Account ID for the custom dimension to update.", "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." } }, "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions/{customDimensionId}", "response": { "$ref": "CustomDimension" } } } }, "webpropertyUserLinks": { "methods": { "insert": { "description": "Adds a new user to the given web property.", "response": { "$ref": "EntityUserLink" }, "id": "analytics.management.webpropertyUserLinks.insert", "request": { "$ref": "EntityUserLink" }, "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks", "parameters": { "accountId": { "location": "path", "required": true, "type": "string", "description": "Account ID to create the user link for." }, "webPropertyId": { "location": "path", "required": true, "type": "string", "description": "Web Property ID to create the user link for." } }, "parameterOrder": [ "accountId", "webPropertyId" ], "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/analytics.manage.users" ] }, "list": { "scopes": [ "https://www.googleapis.com/auth/analytics.manage.users", "https://www.googleapis.com/auth/analytics.manage.users.readonly" ], "response": { "$ref": "EntityUserLinks" }, "parameters": { "accountId": { "type": "string", "description": "Account ID which the given web property belongs to.", "location": "path", "required": true }, "webPropertyId": { "type": "string", "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.", "required": true, "location": "path" }, "start-index": { "description": "An index of the first webProperty-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.", "minimum": "1", "location": "query", "format": "int32", "type": "integer" }, "max-results": { "location": "query", "format": "int32", "description": "The maximum number of webProperty-user Links to include in this response.", "type": "integer" } }, "description": "Lists webProperty-user links for a given web property.", "id": "analytics.management.webpropertyUserLinks.list", "httpMethod": "GET", "parameterOrder": [ "accountId", "webPropertyId" ], "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks" }, "update": { "description": "Updates permissions for an existing user on the given web property.", "parameterOrder": [ "accountId", "webPropertyId", "linkId" ], "id": "analytics.management.webpropertyUserLinks.update", "request": { "$ref": "EntityUserLink" }, "response": { "$ref": "EntityUserLink" }, "httpMethod": "PUT", "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks/{linkId}", "parameters": { "webPropertyId": { "required": true, "type": "string", "location": "path", "description": "Web property ID to update the account-user link for." }, "accountId": { "required": true, "type": "string", "description": "Account ID to update the account-user link for.", "location": "path" }, "linkId": { "location": "path", "description": "Link ID to update the account-user link for.", "required": true, "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/analytics.manage.users" ] }, "delete": { "scopes": [ "https://www.googleapis.com/auth/analytics.manage.users" ], "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks/{linkId}", "httpMethod": "DELETE", "parameterOrder": [ "accountId", "webPropertyId", "linkId" ], "id": "analytics.management.webpropertyUserLinks.delete", "description": "Removes a user from the given web property.", "parameters": { "webPropertyId": { "required": true, "type": "string", "description": "Web Property ID to delete the user link for.", "location": "path" }, "linkId": { "required": true, "description": "Link ID to delete the user link for.", "location": "path", "type": "string" }, "accountId": { "type": "string", "description": "Account ID to delete the user link for.", "required": true, "location": "path" } } } } }, "filters": { "methods": { "list": { "parameters": { "accountId": { "type": "string", "required": true, "pattern": "\\d+", "location": "path", "description": "Account ID to retrieve filters for." }, "max-results": { "type": "integer", "format": "int32", "location": "query", "description": "The maximum number of filters to include in this response." }, "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.", "type": "integer", "location": "query", "minimum": "1" } }, "id": "analytics.management.filters.list", "description": "Lists all filters for an account", "parameterOrder": [ "accountId" ], "scopes": [ "https://www.googleapis.com/auth/analytics.edit", "https://www.googleapis.com/auth/analytics.readonly" ], "httpMethod": "GET", "path": "management/accounts/{accountId}/filters", "response": { "$ref": "Filters" } }, "get": { "description": "Returns filters to which the user has access.", "scopes": [ "https://www.googleapis.com/auth/analytics.edit", "https://www.googleapis.com/auth/analytics.readonly" ], "httpMethod": "GET", "id": "analytics.management.filters.get", "parameters": { "accountId": { "type": "string", "location": "path", "required": true, "description": "Account ID to retrieve filters for." }, "filterId": { "description": "Filter ID to retrieve filters for.", "type": "string", "required": true, "location": "path" } }, "response": { "$ref": "Filter" }, "parameterOrder": [ "accountId", "filterId" ], "path": "management/accounts/{accountId}/filters/{filterId}" }, "patch": { "parameters": { "accountId": { "location": "path", "description": "Account ID to which the filter belongs.", "required": true, "type": "string" }, "filterId": { "description": "ID of the filter to be updated.", "location": "path", "type": "string", "required": true } }, "path": "management/accounts/{accountId}/filters/{filterId}", "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "httpMethod": "PATCH", "request": { "$ref": "Filter" }, "response": { "$ref": "Filter" }, "parameterOrder": [ "accountId", "filterId" ], "description": "Updates an existing filter. This method supports patch semantics.", "id": "analytics.management.filters.patch" }, "delete": { "id": "analytics.management.filters.delete", "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "description": "Delete a filter.", "response": { "$ref": "Filter" }, "parameters": { "filterId": { "required": true, "type": "string", "description": "ID of the filter to be deleted.", "location": "path" }, "accountId": { "type": "string", "location": "path", "required": true, "description": "Account ID to delete the filter for." } }, "parameterOrder": [ "accountId", "filterId" ], "path": "management/accounts/{accountId}/filters/{filterId}" }, "update": { "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "path": "management/accounts/{accountId}/filters/{filterId}", "httpMethod": "PUT", "description": "Updates an existing filter.", "request": { "$ref": "Filter" }, "parameterOrder": [ "accountId", "filterId" ], "id": "analytics.management.filters.update", "parameters": { "accountId": { "type": "string", "required": true, "description": "Account ID to which the filter belongs.", "location": "path" }, "filterId": { "location": "path", "required": true, "description": "ID of the filter to be updated.", "type": "string" } }, "response": { "$ref": "Filter" } }, "insert": { "parameters": { "accountId": { "description": "Account ID to create filter for.", "required": true, "type": "string", "location": "path" } }, "response": { "$ref": "Filter" }, "parameterOrder": [ "accountId" ], "httpMethod": "POST", "path": "management/accounts/{accountId}/filters", "description": "Create a new filter.", "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "request": { "$ref": "Filter" }, "id": "analytics.management.filters.insert" } } }, "unsampledReports": { "methods": { "get": { "parameterOrder": [ "accountId", "webPropertyId", "profileId", "unsampledReportId" ], "id": "analytics.management.unsampledReports.get", "scopes": [ "https://www.googleapis.com/auth/analytics", "https://www.googleapis.com/auth/analytics.edit", "https://www.googleapis.com/auth/analytics.readonly" ], "response": { "$ref": "UnsampledReport" }, "httpMethod": "GET", "parameters": { "unsampledReportId": { "type": "string", "description": "ID of the unsampled report to retrieve.", "required": true, "location": "path" }, "accountId": { "type": "string", "required": true, "description": "Account ID to retrieve unsampled report for.", "location": "path" }, "webPropertyId": { "description": "Web property ID to retrieve unsampled reports for.", "location": "path", "required": true, "type": "string" }, "profileId": { "required": true, "location": "path", "description": "View (Profile) ID to retrieve unsampled report for.", "type": "string" } }, "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports/{unsampledReportId}", "description": "Returns a single unsampled report." }, "insert": { "description": "Create a new unsampled report.", "parameterOrder": [ "accountId", "webPropertyId", "profileId" ], "request": { "$ref": "UnsampledReport" }, "parameters": { "accountId": { "location": "path", "description": "Account ID to create the unsampled report for.", "type": "string", "required": true }, "profileId": { "location": "path", "type": "string", "required": true, "description": "View (Profile) ID to create the unsampled report for." }, "webPropertyId": { "description": "Web property ID to create the unsampled report for.", "type": "string", "required": true, "location": "path" } }, "httpMethod": "POST", "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports", "id": "analytics.management.unsampledReports.insert", "response": { "$ref": "UnsampledReport" }, "scopes": [ "https://www.googleapis.com/auth/analytics", "https://www.googleapis.com/auth/analytics.edit" ] }, "delete": { "id": "analytics.management.unsampledReports.delete", "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "parameterOrder": [ "accountId", "webPropertyId", "profileId", "unsampledReportId" ], "parameters": { "accountId": { "type": "string", "required": true, "description": "Account ID to delete the unsampled report for.", "location": "path" }, "webPropertyId": { "required": true, "description": "Web property ID to delete the unsampled reports for.", "location": "path", "type": "string" }, "unsampledReportId": { "required": true, "description": "ID of the unsampled report to be deleted.", "type": "string", "location": "path" }, "profileId": { "description": "View (Profile) ID to delete the unsampled report for.", "location": "path", "type": "string", "required": true } }, "httpMethod": "DELETE", "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports/{unsampledReportId}", "description": "Deletes an unsampled report." }, "list": { "id": "analytics.management.unsampledReports.list", "httpMethod": "GET", "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" ], "parameters": { "max-results": { "type": "integer", "description": "The maximum number of unsampled reports to include in this response.", "location": "query", "format": "int32" }, "webPropertyId": { "location": "path", "description": "Web property ID to retrieve unsampled reports for. Must be a specific web property ID, ~all is not supported.", "type": "string", "required": true }, "start-index": { "description": "An index of the first unsampled report to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.", "minimum": "1", "location": "query", "format": "int32", "type": "integer" }, "profileId": { "required": true, "type": "string", "description": "View (Profile) ID to retrieve unsampled reports for. Must be a specific view (profile) ID, ~all is not supported.", "location": "path" }, "accountId": { "description": "Account ID to retrieve unsampled reports for. Must be a specific account ID, ~all is not supported.", "type": "string", "required": true, "location": "path" } }, "description": "Lists unsampled reports to which the user has access.", "response": { "$ref": "UnsampledReports" }, "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports" } } }, "remarketingAudience": { "methods": { "patch": { "response": { "$ref": "RemarketingAudience" }, "parameterOrder": [ "accountId", "webPropertyId", "remarketingAudienceId" ], "description": "Updates an existing remarketing audience. This method supports patch semantics.", "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences/{remarketingAudienceId}", "parameters": { "webPropertyId": { "required": true, "type": "string", "location": "path", "description": "The web property ID of the remarketing audience to update." }, "accountId": { "type": "string", "description": "The account ID of the remarketing audience to update.", "location": "path", "required": true }, "remarketingAudienceId": { "type": "string", "location": "path", "description": "The ID of the remarketing audience to update.", "required": true } }, "id": "analytics.management.remarketingAudience.patch", "request": { "$ref": "RemarketingAudience" } }, "delete": { "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "id": "analytics.management.remarketingAudience.delete", "description": "Delete a remarketing audience.", "parameterOrder": [ "accountId", "webPropertyId", "remarketingAudienceId" ], "parameters": { "remarketingAudienceId": { "required": true, "location": "path", "type": "string", "description": "The ID of the remarketing audience to delete." }, "accountId": { "required": true, "type": "string", "description": "Account ID to which the remarketing audience belongs.", "location": "path" }, "webPropertyId": { "description": "Web property ID to which the remarketing audience belongs.", "required": true, "location": "path", "type": "string" } }, "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences/{remarketingAudienceId}" }, "insert": { "parameterOrder": [ "accountId", "webPropertyId" ], "description": "Creates a new remarketing audience.", "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "httpMethod": "POST", "request": { "$ref": "RemarketingAudience" }, "response": { "$ref": "RemarketingAudience" }, "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences", "parameters": { "webPropertyId": { "location": "path", "type": "string", "required": true, "description": "Web property ID for which to create the remarketing audience." }, "accountId": { "type": "string", "required": true, "description": "The account ID for which to create the remarketing audience.", "location": "path" } }, "id": "analytics.management.remarketingAudience.insert" }, "get": { "httpMethod": "GET", "response": { "$ref": "RemarketingAudience" }, "description": "Gets a remarketing audience to which the user has access.", "parameters": { "accountId": { "type": "string", "required": true, "location": "path", "description": "The account ID of the remarketing audience to retrieve." }, "remarketingAudienceId": { "description": "The ID of the remarketing audience to retrieve.", "type": "string", "location": "path", "required": true }, "webPropertyId": { "required": true, "description": "The web property ID of the remarketing audience to retrieve.", "type": "string", "location": "path" } }, "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences/{remarketingAudienceId}", "id": "analytics.management.remarketingAudience.get", "parameterOrder": [ "accountId", "webPropertyId", "remarketingAudienceId" ], "scopes": [ "https://www.googleapis.com/auth/analytics.edit", "https://www.googleapis.com/auth/analytics.readonly" ] }, "update": { "parameterOrder": [ "accountId", "webPropertyId", "remarketingAudienceId" ], "response": { "$ref": "RemarketingAudience" }, "request": { "$ref": "RemarketingAudience" }, "description": "Updates an existing remarketing audience.", "httpMethod": "PUT", "parameters": { "webPropertyId": { "location": "path", "required": true, "type": "string", "description": "The web property ID of the remarketing audience to update." }, "remarketingAudienceId": { "location": "path", "description": "The ID of the remarketing audience to update.", "required": true, "type": "string" }, "accountId": { "required": true, "location": "path", "type": "string", "description": "The account ID of the remarketing audience to update." } }, "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "id": "analytics.management.remarketingAudience.update", "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences/{remarketingAudienceId}" }, "list": { "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences", "description": "Lists remarketing audiences to which the user has access.", "response": { "$ref": "RemarketingAudiences" }, "parameters": { "accountId": { "required": true, "location": "path", "description": "The account ID of the remarketing audiences to retrieve.", "type": "string" }, "type": { "type": "string", "default": "all", "location": "query" }, "webPropertyId": { "location": "path", "required": true, "type": "string", "description": "The web property ID of the remarketing audiences to retrieve." }, "max-results": { "type": "integer", "location": "query", "format": "int32", "description": "The maximum number of remarketing audiences to include in this response." }, "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", "type": "integer", "minimum": "1" } }, "id": "analytics.management.remarketingAudience.list", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/analytics.edit", "https://www.googleapis.com/auth/analytics.readonly" ], "parameterOrder": [ "accountId", "webPropertyId" ] } } }, "experiments": { "methods": { "update": { "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}", "request": { "$ref": "Experiment" }, "response": { "$ref": "Experiment" }, "parameterOrder": [ "accountId", "webPropertyId", "profileId", "experimentId" ], "parameters": { "profileId": { "required": true, "description": "View (Profile) ID of the experiment to update.", "type": "string", "location": "path" }, "experimentId": { "description": "Experiment ID of the experiment to update.", "type": "string", "location": "path", "required": true }, "accountId": { "type": "string", "location": "path", "description": "Account ID of the experiment to update.", "required": true }, "webPropertyId": { "required": true, "description": "Web property ID of the experiment to update.", "location": "path", "type": "string" } }, "httpMethod": "PUT", "id": "analytics.management.experiments.update", "scopes": [ "https://www.googleapis.com/auth/analytics", "https://www.googleapis.com/auth/analytics.edit" ], "description": "Update an existing experiment." }, "get": { "parameters": { "profileId": { "required": true, "type": "string", "description": "View (Profile) ID to retrieve the experiment for.", "location": "path" }, "accountId": { "type": "string", "location": "path", "description": "Account ID to retrieve the experiment for.", "required": true }, "experimentId": { "description": "Experiment ID to retrieve the experiment for.", "location": "path", "type": "string", "required": true }, "webPropertyId": { "description": "Web property ID to retrieve the experiment for.", "location": "path", "type": "string", "required": true } }, "parameterOrder": [ "accountId", "webPropertyId", "profileId", "experimentId" ], "response": { "$ref": "Experiment" }, "description": "Returns an experiment to which the user has access.", "id": "analytics.management.experiments.get", "httpMethod": "GET", "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}/profiles/{profileId}/experiments/{experimentId}" }, "delete": { "parameters": { "accountId": { "required": true, "description": "Account ID to which the experiment belongs", "type": "string", "location": "path" }, "webPropertyId": { "type": "string", "location": "path", "required": true, "description": "Web property ID to which the experiment belongs" }, "experimentId": { "type": "string", "description": "ID of the experiment to delete", "location": "path", "required": true }, "profileId": { "description": "View (Profile) ID to which the experiment belongs", "type": "string", "location": "path", "required": true } }, "id": "analytics.management.experiments.delete", "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/analytics", "https://www.googleapis.com/auth/analytics.edit" ], "parameterOrder": [ "accountId", "webPropertyId", "profileId", "experimentId" ], "description": "Delete an experiment.", "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}" }, "insert": { "description": "Create a new experiment.", "parameters": { "webPropertyId": { "type": "string", "location": "path", "description": "Web property ID to create the experiment for.", "required": true }, "accountId": { "type": "string", "description": "Account ID to create the experiment for.", "location": "path", "required": true }, "profileId": { "location": "path", "required": true, "description": "View (Profile) ID to create the experiment for.", "type": "string" } }, "request": { "$ref": "Experiment" }, "httpMethod": "POST", "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments", "parameterOrder": [ "accountId", "webPropertyId", "profileId" ], "id": "analytics.management.experiments.insert", "scopes": [ "https://www.googleapis.com/auth/analytics", "https://www.googleapis.com/auth/analytics.edit" ], "response": { "$ref": "Experiment" } }, "patch": { "parameters": { "experimentId": { "required": true, "location": "path", "description": "Experiment ID of the experiment to update.", "type": "string" }, "accountId": { "type": "string", "location": "path", "required": true, "description": "Account ID of the experiment to update." }, "webPropertyId": { "description": "Web property ID of the experiment to update.", "type": "string", "location": "path", "required": true }, "profileId": { "required": true, "description": "View (Profile) ID of the experiment to update.", "type": "string", "location": "path" } }, "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}", "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/analytics", "https://www.googleapis.com/auth/analytics.edit" ], "request": { "$ref": "Experiment" }, "parameterOrder": [ "accountId", "webPropertyId", "profileId", "experimentId" ], "description": "Update an existing experiment. This method supports patch semantics.", "id": "analytics.management.experiments.patch", "response": { "$ref": "Experiment" } }, "list": { "description": "Lists experiments to which the user has access.", "id": "analytics.management.experiments.list", "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/{profileId}/experiments", "parameterOrder": [ "accountId", "webPropertyId", "profileId" ], "response": { "$ref": "Experiments" }, "parameters": { "accountId": { "pattern": "\\d+", "location": "path", "description": "Account ID to retrieve experiments for.", "required": true, "type": "string" }, "max-results": { "type": "integer", "location": "query", "format": "int32", "description": "The maximum number of experiments to include in this response." }, "start-index": { "type": "integer", "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" }, "webPropertyId": { "location": "path", "description": "Web property ID to retrieve experiments for.", "type": "string", "pattern": "UA-(\\d+)-(\\d+)", "required": true }, "profileId": { "pattern": "\\d+", "required": true, "description": "View (Profile) ID to retrieve experiments for.", "type": "string", "location": "path" } } } } }, "clientId": { "methods": { "hashClientId": { "description": "Hashes the given Client ID.", "request": { "$ref": "HashClientIdRequest" }, "scopes": [ "https://www.googleapis.com/auth/analytics.edit", "https://www.googleapis.com/auth/analytics.readonly" ], "response": { "$ref": "HashClientIdResponse" }, "id": "analytics.management.clientId.hashClientId", "path": "management/clientId:hashClientId", "httpMethod": "POST" } } }, "uploads": { "methods": { "list": { "scopes": [ "https://www.googleapis.com/auth/analytics", "https://www.googleapis.com/auth/analytics.edit", "https://www.googleapis.com/auth/analytics.readonly" ], "parameters": { "customDataSourceId": { "location": "path", "type": "string", "required": true, "pattern": ".{22}", "description": "Custom data source Id for uploads to retrieve." }, "start-index": { "minimum": "1", "description": "A 1-based index of the first upload to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.", "location": "query", "type": "integer", "format": "int32" }, "accountId": { "type": "string", "required": true, "description": "Account Id for the uploads to retrieve.", "location": "path", "pattern": "\\d+" }, "webPropertyId": { "required": true, "description": "Web property Id for the uploads to retrieve.", "location": "path", "pattern": "UA-(\\d+)-(\\d+)", "type": "string" }, "max-results": { "type": "integer", "description": "The maximum number of uploads to include in this response.", "format": "int32", "location": "query", "minimum": "1" } }, "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads", "response": { "$ref": "Uploads" }, "httpMethod": "GET", "description": "List uploads to which the user has access.", "id": "analytics.management.uploads.list", "parameterOrder": [ "accountId", "webPropertyId", "customDataSourceId" ] }, "uploadData": { "parameters": { "webPropertyId": { "location": "path", "description": "Web property UA-string associated with the upload.", "type": "string", "required": true, "pattern": "UA-\\d+-\\d+" }, "customDataSourceId": { "description": "Custom data source Id to which the data being uploaded belongs.", "required": true, "location": "path", "type": "string" }, "accountId": { "type": "string", "location": "path", "required": true, "pattern": "\\d+", "description": "Account Id associated with the upload." } }, "scopes": [ "https://www.googleapis.com/auth/analytics", "https://www.googleapis.com/auth/analytics.edit" ], "description": "Upload data for a custom data source.", "parameterOrder": [ "accountId", "webPropertyId", "customDataSourceId" ], "id": "analytics.management.uploads.uploadData", "supportsMediaUpload": true, "mediaUpload": { "maxSize": "1GB", "accept": [ "application/octet-stream" ], "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 } } }, "httpMethod": "POST", "response": { "$ref": "Upload" }, "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads" }, "get": { "description": "List uploads to which the user has access.", "scopes": [ "https://www.googleapis.com/auth/analytics", "https://www.googleapis.com/auth/analytics.edit", "https://www.googleapis.com/auth/analytics.readonly" ], "httpMethod": "GET", "parameters": { "customDataSourceId": { "description": "Custom data source Id for upload to retrieve.", "location": "path", "pattern": ".{22}", "required": true, "type": "string" }, "uploadId": { "location": "path", "type": "string", "pattern": ".{22}", "required": true, "description": "Upload Id to retrieve." }, "accountId": { "required": true, "description": "Account Id for the upload to retrieve.", "pattern": "\\d+", "location": "path", "type": "string" }, "webPropertyId": { "type": "string", "description": "Web property Id for the upload to retrieve.", "location": "path", "required": true, "pattern": "UA-(\\d+)-(\\d+)" } }, "parameterOrder": [ "accountId", "webPropertyId", "customDataSourceId", "uploadId" ], "response": { "$ref": "Upload" }, "id": "analytics.management.uploads.get", "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads/{uploadId}" }, "deleteUploadData": { "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/deleteUploadData", "parameterOrder": [ "accountId", "webPropertyId", "customDataSourceId" ], "description": "Delete data associated with a previous upload.", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/analytics", "https://www.googleapis.com/auth/analytics.edit" ], "id": "analytics.management.uploads.deleteUploadData", "request": { "$ref": "AnalyticsDataimportDeleteUploadDataRequest" }, "parameters": { "customDataSourceId": { "location": "path", "required": true, "type": "string", "description": "Custom data source Id for the uploads to be deleted.", "pattern": ".{22}" }, "webPropertyId": { "location": "path", "description": "Web property Id for the uploads to be deleted.", "required": true, "type": "string", "pattern": "UA-(\\d+)-(\\d+)" }, "accountId": { "pattern": "\\d+", "required": true, "location": "path", "type": "string", "description": "Account Id for the uploads to be deleted." } } } } }, "profileFilterLinks": { "methods": { "delete": { "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "httpMethod": "DELETE", "parameters": { "webPropertyId": { "pattern": "UA-(\\d+)-(\\d+)", "location": "path", "required": true, "type": "string", "description": "Web property Id to which the profile filter link belongs." }, "linkId": { "type": "string", "pattern": "\\d+:\\d+", "location": "path", "description": "ID of the profile filter link to delete.", "required": true }, "accountId": { "description": "Account ID to which the profile filter link belongs.", "pattern": "\\d+", "location": "path", "type": "string", "required": true }, "profileId": { "location": "path", "type": "string", "description": "Profile ID to which the filter link belongs.", "required": true, "pattern": "\\d+" } }, "id": "analytics.management.profileFilterLinks.delete", "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}", "description": "Delete a profile filter link.", "parameterOrder": [ "accountId", "webPropertyId", "profileId", "linkId" ] }, "patch": { "id": "analytics.management.profileFilterLinks.patch", "parameterOrder": [ "accountId", "webPropertyId", "profileId", "linkId" ], "response": { "$ref": "ProfileFilterLink" }, "parameters": { "accountId": { "required": true, "description": "Account ID to which profile filter link belongs.", "type": "string", "location": "path", "pattern": "\\d+" }, "linkId": { "required": true, "location": "path", "description": "ID of the profile filter link to be updated.", "type": "string", "pattern": "\\d+:\\d+" }, "webPropertyId": { "location": "path", "type": "string", "pattern": "UA-(\\d+)-(\\d+)", "description": "Web property Id to which profile filter link belongs", "required": true }, "profileId": { "pattern": "\\d+", "description": "Profile ID to which filter link belongs", "location": "path", "required": true, "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}", "request": { "$ref": "ProfileFilterLink" }, "description": "Update an existing profile filter link. This method supports patch semantics.", "httpMethod": "PATCH" }, "insert": { "httpMethod": "POST", "parameters": { "accountId": { "pattern": "\\d+", "type": "string", "location": "path", "description": "Account ID to create profile filter link for.", "required": true }, "webPropertyId": { "pattern": "UA-(\\d+)-(\\d+)", "required": true, "type": "string", "location": "path", "description": "Web property Id to create profile filter link for." }, "profileId": { "type": "string", "required": true, "pattern": "\\d+", "location": "path", "description": "Profile ID to create filter link for." } }, "request": { "$ref": "ProfileFilterLink" }, "response": { "$ref": "ProfileFilterLink" }, "id": "analytics.management.profileFilterLinks.insert", "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "parameterOrder": [ "accountId", "webPropertyId", "profileId" ], "description": "Create a new profile filter link.", "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks" }, "update": { "description": "Update an existing profile filter link.", "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}", "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "parameters": { "linkId": { "pattern": "\\d+:\\d+", "required": true, "description": "ID of the profile filter link to be updated.", "type": "string", "location": "path" }, "webPropertyId": { "description": "Web property Id to which profile filter link belongs", "required": true, "pattern": "UA-(\\d+)-(\\d+)", "type": "string", "location": "path" }, "profileId": { "pattern": "\\d+", "description": "Profile ID to which filter link belongs", "required": true, "location": "path", "type": "string" }, "accountId": { "required": true, "description": "Account ID to which profile filter link belongs.", "location": "path", "type": "string", "pattern": "\\d+" } }, "request": { "$ref": "ProfileFilterLink" }, "id": "analytics.management.profileFilterLinks.update", "httpMethod": "PUT", "response": { "$ref": "ProfileFilterLink" }, "parameterOrder": [ "accountId", "webPropertyId", "profileId", "linkId" ] }, "get": { "id": "analytics.management.profileFilterLinks.get", "response": { "$ref": "ProfileFilterLink" }, "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}", "parameters": { "profileId": { "type": "string", "pattern": "\\d+", "location": "path", "description": "Profile ID to retrieve filter link for.", "required": true }, "accountId": { "pattern": "\\d+", "description": "Account ID to retrieve profile filter link for.", "location": "path", "required": true, "type": "string" }, "webPropertyId": { "pattern": "UA-(\\d+)-(\\d+)", "location": "path", "description": "Web property Id to retrieve profile filter link for.", "required": true, "type": "string" }, "linkId": { "pattern": "\\d+:\\d+", "location": "path", "description": "ID of the profile filter link.", "required": true, "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/analytics.edit", "https://www.googleapis.com/auth/analytics.readonly" ], "httpMethod": "GET", "description": "Returns a single profile filter link.", "parameterOrder": [ "accountId", "webPropertyId", "profileId", "linkId" ] }, "list": { "parameters": { "profileId": { "description": "Profile ID to retrieve filter links for. Can either be a specific profile ID or '~all', which refers to all the profiles that user has access to.", "required": true, "type": "string", "location": "path" }, "start-index": { "format": "int32", "type": "integer", "location": "query", "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": { "description": "The maximum number of profile filter links to include in this response.", "type": "integer", "format": "int32", "location": "query" }, "accountId": { "description": "Account ID to retrieve profile filter links for.", "required": true, "pattern": "\\d+", "location": "path", "type": "string" }, "webPropertyId": { "required": true, "location": "path", "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.", "type": "string" } }, "response": { "$ref": "ProfileFilterLinks" }, "httpMethod": "GET", "description": "Lists all profile filter links for a profile.", "id": "analytics.management.profileFilterLinks.list", "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks", "scopes": [ "https://www.googleapis.com/auth/analytics.edit", "https://www.googleapis.com/auth/analytics.readonly" ], "parameterOrder": [ "accountId", "webPropertyId", "profileId" ] } } }, "profileUserLinks": { "methods": { "insert": { "parameterOrder": [ "accountId", "webPropertyId", "profileId" ], "scopes": [ "https://www.googleapis.com/auth/analytics.manage.users" ], "parameters": { "profileId": { "location": "path", "type": "string", "description": "View (Profile) ID to create the user link for.", "required": true }, "webPropertyId": { "location": "path", "required": true, "type": "string", "description": "Web Property ID to create the user link for." }, "accountId": { "description": "Account ID to create the user link for.", "type": "string", "location": "path", "required": true } }, "response": { "$ref": "EntityUserLink" }, "httpMethod": "POST", "description": "Adds a new user to the given view (profile).", "request": { "$ref": "EntityUserLink" }, "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks", "id": "analytics.management.profileUserLinks.insert" }, "list": { "parameters": { "webPropertyId": { "type": "string", "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.", "required": true, "location": "path" }, "accountId": { "required": true, "location": "path", "type": "string", "description": "Account ID which the given view (profile) belongs to." }, "max-results": { "type": "integer", "location": "query", "description": "The maximum number of profile-user links to include in this response.", "format": "int32" }, "start-index": { "location": "query", "type": "integer", "format": "int32", "minimum": "1", "description": "An index of the first profile-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter." }, "profileId": { "type": "string", "location": "path", "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.", "required": true } }, "id": "analytics.management.profileUserLinks.list", "description": "Lists profile-user links for a given view (profile).", "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks", "httpMethod": "GET", "parameterOrder": [ "accountId", "webPropertyId", "profileId" ], "scopes": [ "https://www.googleapis.com/auth/analytics.manage.users", "https://www.googleapis.com/auth/analytics.manage.users.readonly" ], "response": { "$ref": "EntityUserLinks" } }, "update": { "parameters": { "webPropertyId": { "location": "path", "type": "string", "description": "Web Property ID to update the user link for.", "required": true }, "accountId": { "type": "string", "location": "path", "required": true, "description": "Account ID to update the user link for." }, "linkId": { "type": "string", "required": true, "description": "Link ID to update the user link for.", "location": "path" }, "profileId": { "description": "View (Profile ID) to update the user link for.", "location": "path", "required": true, "type": "string" } }, "description": "Updates permissions for an existing user on the given view (profile).", "response": { "$ref": "EntityUserLink" }, "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks/{linkId}", "id": "analytics.management.profileUserLinks.update", "httpMethod": "PUT", "scopes": [ "https://www.googleapis.com/auth/analytics.manage.users" ], "parameterOrder": [ "accountId", "webPropertyId", "profileId", "linkId" ], "request": { "$ref": "EntityUserLink" } }, "delete": { "scopes": [ "https://www.googleapis.com/auth/analytics.manage.users" ], "description": "Removes a user from the given view (profile).", "id": "analytics.management.profileUserLinks.delete", "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks/{linkId}", "parameterOrder": [ "accountId", "webPropertyId", "profileId", "linkId" ], "httpMethod": "DELETE", "parameters": { "linkId": { "required": true, "location": "path", "description": "Link ID to delete the user link for.", "type": "string" }, "accountId": { "required": true, "location": "path", "type": "string", "description": "Account ID to delete the user link for." }, "profileId": { "location": "path", "required": true, "type": "string", "description": "View (Profile) ID to delete the user link for." }, "webPropertyId": { "required": true, "location": "path", "type": "string", "description": "Web Property ID to delete the user link for." } } } } }, "goals": { "methods": { "patch": { "parameterOrder": [ "accountId", "webPropertyId", "profileId", "goalId" ], "request": { "$ref": "Goal" }, "httpMethod": "PATCH", "parameters": { "accountId": { "type": "string", "description": "Account ID to update the goal.", "location": "path", "required": true }, "webPropertyId": { "description": "Web property ID to update the goal.", "location": "path", "required": true, "type": "string" }, "profileId": { "description": "View (Profile) ID to update the goal.", "required": true, "location": "path", "type": "string" }, "goalId": { "location": "path", "type": "string", "description": "Index of the goal to be updated.", "required": true } }, "response": { "$ref": "Goal" }, "id": "analytics.management.goals.patch", "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals/{goalId}", "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "description": "Updates an existing goal. This method supports patch semantics." }, "update": { "id": "analytics.management.goals.update", "parameterOrder": [ "accountId", "webPropertyId", "profileId", "goalId" ], "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals/{goalId}", "request": { "$ref": "Goal" }, "httpMethod": "PUT", "parameters": { "accountId": { "type": "string", "required": true, "location": "path", "description": "Account ID to update the goal." }, "webPropertyId": { "location": "path", "description": "Web property ID to update the goal.", "required": true, "type": "string" }, "profileId": { "required": true, "type": "string", "description": "View (Profile) ID to update the goal.", "location": "path" }, "goalId": { "description": "Index of the goal to be updated.", "required": true, "location": "path", "type": "string" } }, "response": { "$ref": "Goal" }, "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "description": "Updates an existing goal." }, "insert": { "response": { "$ref": "Goal" }, "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "parameterOrder": [ "accountId", "webPropertyId", "profileId" ], "parameters": { "profileId": { "required": true, "description": "View (Profile) ID to create the goal for.", "type": "string", "location": "path" }, "webPropertyId": { "type": "string", "description": "Web property ID to create the goal for.", "location": "path", "required": true }, "accountId": { "location": "path", "type": "string", "description": "Account ID to create the goal for.", "required": true } }, "description": "Create a new goal.", "id": "analytics.management.goals.insert", "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals", "request": { "$ref": "Goal" }, "httpMethod": "POST" }, "list": { "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals", "description": "Lists goals to which the user has access.", "response": { "$ref": "Goals" }, "httpMethod": "GET", "parameters": { "start-index": { "format": "int32", "location": "query", "minimum": "1", "description": "An index of the first goal to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.", "type": "integer" }, "max-results": { "type": "integer", "description": "The maximum number of goals to include in this response.", "format": "int32", "location": "query" }, "webPropertyId": { "type": "string", "required": true, "location": "path", "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." }, "profileId": { "required": true, "type": "string", "location": "path", "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." }, "accountId": { "location": "path", "required": true, "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.", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/analytics", "https://www.googleapis.com/auth/analytics.edit", "https://www.googleapis.com/auth/analytics.readonly" ], "id": "analytics.management.goals.list", "parameterOrder": [ "accountId", "webPropertyId", "profileId" ] }, "get": { "parameterOrder": [ "accountId", "webPropertyId", "profileId", "goalId" ], "parameters": { "goalId": { "type": "string", "location": "path", "description": "Goal ID to retrieve the goal for.", "required": true }, "webPropertyId": { "required": true, "type": "string", "description": "Web property ID to retrieve the goal for.", "location": "path" }, "profileId": { "required": true, "location": "path", "type": "string", "description": "View (Profile) ID to retrieve the goal for." }, "accountId": { "description": "Account ID to retrieve the goal for.", "required": true, "type": "string", "location": "path" } }, "description": "Gets a goal to which the user has access.", "httpMethod": "GET", "response": { "$ref": "Goal" }, "scopes": [ "https://www.googleapis.com/auth/analytics.edit", "https://www.googleapis.com/auth/analytics.readonly" ], "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals/{goalId}", "id": "analytics.management.goals.get" } } }, "webPropertyAdWordsLinks": { "methods": { "insert": { "httpMethod": "POST", "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks", "id": "analytics.management.webPropertyAdWordsLinks.insert", "request": { "$ref": "EntityAdWordsLink" }, "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "parameters": { "accountId": { "required": true, "description": "ID of the Google Analytics account to create the link for.", "type": "string", "location": "path" }, "webPropertyId": { "location": "path", "required": true, "description": "Web property ID to create the link for.", "type": "string" } }, "parameterOrder": [ "accountId", "webPropertyId" ], "response": { "$ref": "EntityAdWordsLink" }, "description": "Creates a webProperty-Google Ads link." }, "patch": { "parameters": { "webPropertyAdWordsLinkId": { "type": "string", "location": "path", "required": true, "description": "Web property-Google Ads link ID." }, "accountId": { "type": "string", "required": true, "location": "path", "description": "ID of the account which the given web property belongs to." }, "webPropertyId": { "description": "Web property ID to retrieve the Google Ads link for.", "type": "string", "required": true, "location": "path" } }, "id": "analytics.management.webPropertyAdWordsLinks.patch", "description": "Updates an existing webProperty-Google Ads link. This method supports patch semantics.", "httpMethod": "PATCH", "response": { "$ref": "EntityAdWordsLink" }, "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "parameterOrder": [ "accountId", "webPropertyId", "webPropertyAdWordsLinkId" ], "request": { "$ref": "EntityAdWordsLink" }, "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}" }, "get": { "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}", "parameterOrder": [ "accountId", "webPropertyId", "webPropertyAdWordsLinkId" ], "httpMethod": "GET", "parameters": { "webPropertyAdWordsLinkId": { "description": "Web property-Google Ads link ID.", "required": true, "location": "path", "type": "string" }, "accountId": { "required": true, "description": "ID of the account which the given web property belongs to.", "location": "path", "type": "string" }, "webPropertyId": { "type": "string", "description": "Web property ID to retrieve the Google Ads link for.", "location": "path", "required": true } }, "response": { "$ref": "EntityAdWordsLink" }, "description": "Returns a web property-Google Ads link to which the user has access.", "id": "analytics.management.webPropertyAdWordsLinks.get", "scopes": [ "https://www.googleapis.com/auth/analytics.edit", "https://www.googleapis.com/auth/analytics.readonly" ] }, "delete": { "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "description": "Deletes a web property-Google Ads link.", "id": "analytics.management.webPropertyAdWordsLinks.delete", "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}", "httpMethod": "DELETE", "parameters": { "webPropertyAdWordsLinkId": { "required": true, "type": "string", "location": "path", "description": "Web property Google Ads link ID." }, "webPropertyId": { "type": "string", "required": true, "location": "path", "description": "Web property ID to delete the Google Ads link for." }, "accountId": { "location": "path", "type": "string", "required": true, "description": "ID of the account which the given web property belongs to." } }, "parameterOrder": [ "accountId", "webPropertyId", "webPropertyAdWordsLinkId" ] }, "update": { "httpMethod": "PUT", "parameterOrder": [ "accountId", "webPropertyId", "webPropertyAdWordsLinkId" ], "request": { "$ref": "EntityAdWordsLink" }, "parameters": { "webPropertyId": { "type": "string", "location": "path", "required": true, "description": "Web property ID to retrieve the Google Ads link for." }, "webPropertyAdWordsLinkId": { "description": "Web property-Google Ads link ID.", "required": true, "location": "path", "type": "string" }, "accountId": { "type": "string", "required": true, "location": "path", "description": "ID of the account which the given web property belongs to." } }, "id": "analytics.management.webPropertyAdWordsLinks.update", "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}", "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "description": "Updates an existing webProperty-Google Ads link.", "response": { "$ref": "EntityAdWordsLink" } }, "list": { "id": "analytics.management.webPropertyAdWordsLinks.list", "httpMethod": "GET", "parameterOrder": [ "accountId", "webPropertyId" ], "scopes": [ "https://www.googleapis.com/auth/analytics.edit", "https://www.googleapis.com/auth/analytics.readonly" ], "description": "Lists webProperty-Google Ads links for a given web property.", "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks", "response": { "$ref": "EntityAdWordsLinks" }, "parameters": { "max-results": { "description": "The maximum number of webProperty-Google Ads links to include in this response.", "type": "integer", "location": "query", "format": "int32" }, "accountId": { "pattern": "\\d+", "type": "string", "required": true, "description": "ID of the account which the given web property belongs to.", "location": "path" }, "start-index": { "location": "query", "minimum": "1", "format": "int32", "type": "integer", "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." }, "webPropertyId": { "type": "string", "description": "Web property ID to retrieve the Google Ads links for.", "location": "path", "required": true } } } } } } } }, "protocol": "rest" }