google-discovery-document

{ "kind": "discovery#restDescription", "etag": "\"FrPV2U6xXFUq8eRv_PO3IoAURkc/SYGRjopRmK4Bczs5VKxKJQKTU8s\"", "discoveryVersion": "v1", "id": "analytics:v3", "name": "analytics", "version": "v3", "revision": "20140723", "title": "Google Analytics API", "description": "View and manage your Google Analytics data", "ownerDomain": "google.com", "ownerName": "Google", "icons": { "x16": "http://www.google.com/images/icons/product/analytics-16.png", "x32": "http://www.google.com/images/icons/product/analytics-32.png" }, "documentationLink": "https://developers.google.com/analytics/", "protocol": "rest", "baseUrl": "https://www.googleapis.com/analytics/v3/", "basePath": "/analytics/v3/", "rootUrl": "https://www.googleapis.com/", "servicePath": "analytics/v3/", "batchPath": "batch", "parameters": { "alt": { "type": "string", "description": "Data format for the response.", "default": "json", "enum": [ "json" ], "enumDescriptions": [ "Responses with Content-Type of application/json" ], "location": "query" }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response.", "location": "query" }, "key": { "type": "string", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", "location": "query" }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user.", "location": "query" }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks.", "default": "false", "location": "query" }, "quotaUser": { "type": "string", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.", "location": "query" }, "userIp": { "type": "string", "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.", "location": "query" } }, "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/analytics": { "description": "View and manage your Google Analytics data" }, "https://www.googleapis.com/auth/analytics.edit": { "description": "Edit Google Analytics management entities" }, "https://www.googleapis.com/auth/analytics.manage.users": { "description": "Manage Google Analytics Account users by email address" }, "https://www.googleapis.com/auth/analytics.provision": { "description": "Create a new Google Analytics account along with its default property and view" }, "https://www.googleapis.com/auth/analytics.readonly": { "description": "View your Google Analytics data" } } } }, "schemas": { "Account": { "id": "Account", "type": "object", "description": "JSON template for Analytics account entry.", "properties": { "childLink": { "type": "object", "description": "Child link for an account entry. Points to the list of web properties for this account.", "properties": { "href": { "type": "string", "description": "Link to the list of web properties for this account." }, "type": { "type": "string", "description": "Type of the child link. Its value is \"analytics#webproperties\".", "default": "analytics#webproperties" } } }, "created": { "type": "string", "description": "Time the account was created.", "format": "date-time" }, "id": { "type": "string", "description": "Account ID." }, "kind": { "type": "string", "description": "Resource type for Analytics account.", "default": "analytics#account" }, "name": { "type": "string", "description": "Account name." }, "permissions": { "type": "object", "description": "Permissions the user has for this account.", "properties": { "effective": { "type": "array", "description": "All the permissions that the user has for this account. These include any implied permissions (e.g., EDIT implies VIEW).", "readOnly": true, "items": { "type": "string" } } } }, "selfLink": { "type": "string", "description": "Link for this account." }, "updated": { "type": "string", "description": "Time the account was last modified.", "format": "date-time" } } }, "AccountRef": { "id": "AccountRef", "type": "object", "description": "JSON template for a linked account.", "properties": { "href": { "type": "string", "description": "Link for this account." }, "id": { "type": "string", "description": "Account ID." }, "kind": { "type": "string", "description": "Analytics account reference.", "default": "analytics#accountRef" }, "name": { "type": "string", "description": "Account name." } } }, "AccountSummaries": { "id": "AccountSummaries", "type": "object", "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.", "properties": { "items": { "type": "array", "description": "A list of AccountSummaries.", "items": { "$ref": "AccountSummary" } }, "itemsPerPage": { "type": "integer", "description": "The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.", "format": "int32" }, "kind": { "type": "string", "description": "Collection type.", "default": "analytics#accountSummaries" }, "nextLink": { "type": "string", "description": "Link to next page for this AccountSummary collection." }, "previousLink": { "type": "string", "description": "Link to previous page for this AccountSummary collection." }, "startIndex": { "type": "integer", "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.", "format": "int32" }, "totalResults": { "type": "integer", "description": "The total number of results for the query, regardless of the number of results in the response.", "format": "int32" }, "username": { "type": "string", "description": "Email ID of the authenticated user" } } }, "AccountSummary": { "id": "AccountSummary", "type": "object", "description": "JSON template for an Analytics AccountSummary. An AccountSummary is a lightweight tree comprised of properties/profiles.", "properties": { "id": { "type": "string", "description": "Account ID." }, "kind": { "type": "string", "description": "Resource type for Analytics AccountSummary.", "default": "analytics#accountSummary" }, "name": { "type": "string", "description": "Account name." }, "webProperties": { "type": "array", "description": "List of web properties under this account.", "items": { "$ref": "WebPropertySummary" } } } }, "AccountTicket": { "id": "AccountTicket", "type": "object", "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.", "properties": { "account": { "$ref": "Account", "description": "Account for this ticket." }, "id": { "type": "string", "description": "Account ticket ID used to access the account ticket." }, "kind": { "type": "string", "description": "Resource type for account ticket.", "default": "analytics#accountTicket" }, "profile": { "$ref": "Profile", "description": "View (Profile) for the account." }, "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." }, "webproperty": { "$ref": "Webproperty", "description": "Web property for the account." } } }, "Accounts": { "id": "Accounts", "type": "object", "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.", "properties": { "items": { "type": "array", "description": "A list of accounts.", "items": { "$ref": "Account" } }, "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#accounts" }, "nextLink": { "type": "string", "description": "Next link for this account collection." }, "previousLink": { "type": "string", "description": "Previous link for this account collection." }, "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" }, "totalResults": { "type": "integer", "description": "The total number of results for the query, regardless of the number of results in the response.", "format": "int32" }, "username": { "type": "string", "description": "Email ID of the authenticated user" } } }, "AdWordsAccount": { "id": "AdWordsAccount", "type": "object", "description": "JSON template for an AdWords account.", "properties": { "autoTaggingEnabled": { "type": "boolean", "description": "True if auto-tagging is enabled on the AdWords account. Read-only after the insert operation." }, "customerId": { "type": "string", "description": "Customer ID. This field is required when creating an AdWords link.", "annotations": { "required": [ "analytics.management.webPropertyAdWordsLinks.insert", "analytics.management.webPropertyAdWordsLinks.update" ] } }, "kind": { "type": "string", "description": "Resource type for AdWords account.", "default": "analytics#adWordsAccount" } } }, "AnalyticsDataimportDeleteUploadDataRequest": { "id": "AnalyticsDataimportDeleteUploadDataRequest", "type": "object", "description": "Request template for the delete upload data request.", "properties": { "customDataImportUids": { "type": "array", "description": "A list of upload UIDs.", "items": { "type": "string" } } } }, "Column": { "id": "Column", "type": "object", "description": "JSON template for a metadata column.", "properties": { "attributes": { "type": "object", "description": "Map of attribute name and value for this column.", "additionalProperties": { "type": "string", "description": "The name of the attribute." } }, "id": { "type": "string", "description": "Column id." }, "kind": { "type": "string", "description": "Resource type for Analytics column.", "default": "analytics#column" } } }, "Columns": { "id": "Columns", "type": "object", "description": "Lists columns (dimensions and metrics) for a particular report type.", "properties": { "attributeNames": { "type": "array", "description": "List of attributes names returned by columns.", "items": { "type": "string" } }, "etag": { "type": "string", "description": "Etag of collection. This etag can be compared with the last response etag to check if response has changed." }, "items": { "type": "array", "description": "List of columns for a report type.", "items": { "$ref": "Column" } }, "kind": { "type": "string", "description": "Collection type.", "default": "analytics#columns" }, "totalResults": { "type": "integer", "description": "Total number of columns returned in the response.", "format": "int32" } } }, "CustomDataSource": { "id": "CustomDataSource", "type": "object", "description": "JSON template for an Analytics custom data source.", "properties": { "accountId": { "type": "string", "description": "Account ID to which this custom data source belongs." }, "childLink": { "type": "object", "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": { "type": "string", "description": "Value is \"analytics#dailyUploads\". Value is \"analytics#uploads\"." } } }, "created": { "type": "string", "description": "Time this custom data source was created.", "format": "date-time" }, "description": { "type": "string", "description": "Description of custom data source." }, "id": { "type": "string", "description": "Custom data source ID." }, "importBehavior": { "type": "string" }, "kind": { "type": "string", "description": "Resource type for Analytics custom data source.", "default": "analytics#customDataSource" }, "name": { "type": "string", "description": "Name of this custom data source." }, "parentLink": { "type": "object", "description": "Parent link for this custom data source. Points to the web property to which this custom data source belongs.", "properties": { "href": { "type": "string", "description": "Link to the web property to which this custom data source belongs." }, "type": { "type": "string", "description": "Value is \"analytics#webproperty\".", "default": "analytics#webproperty" } } }, "profilesLinked": { "type": "array", "description": "IDs of views (profiles) linked to the custom data source.", "items": { "type": "string" } }, "selfLink": { "type": "string", "description": "Link for this Analytics custom data source." }, "type": { "type": "string", "description": "Type of the custom data source." }, "updated": { "type": "string", "description": "Time this custom data source was last modified.", "format": "date-time" }, "uploadType": { "type": "string" }, "webPropertyId": { "type": "string", "description": "Web property ID of the form UA-XXXXX-YY to which this custom data source belongs." } } }, "CustomDataSources": { "id": "CustomDataSources", "type": "object", "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": { "items": { "type": "array", "description": "Collection of custom data sources.", "items": { "$ref": "CustomDataSource" } }, "itemsPerPage": { "type": "integer", "description": "The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.", "format": "int32" }, "kind": { "type": "string", "description": "Collection type.", "default": "analytics#customDataSources" }, "nextLink": { "type": "string", "description": "Link to next page for this custom data source collection." }, "previousLink": { "type": "string", "description": "Link to previous page for this custom data source collection." }, "startIndex": { "type": "integer", "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.", "format": "int32" }, "totalResults": { "type": "integer", "description": "The total number of results for the query, regardless of the number of results in the response.", "format": "int32" }, "username": { "type": "string", "description": "Email ID of the authenticated user" } } }, "DailyUpload": { "id": "DailyUpload", "type": "object", "description": "Metadata for daily upload entity.", "properties": { "accountId": { "type": "string", "description": "Account ID to which this daily upload belongs." }, "appendCount": { "type": "integer", "description": "Number of appends for this date.", "format": "int32" }, "createdTime": { "type": "string", "description": "Time this daily upload was created.", "format": "date-time" }, "customDataSourceId": { "type": "string", "description": "Custom data source ID to which this daily upload belongs." }, "date": { "type": "string", "description": "Date associated with daily upload." }, "kind": { "type": "string", "description": "Resource type for Analytics daily upload.", "default": "analytics#dailyUpload" }, "modifiedTime": { "type": "string", "description": "Time this daily upload was last modified.", "format": "date-time" }, "parentLink": { "type": "object", "description": "Parent link for a daily upload. Points to the custom data source to which this daily upload belongs.", "properties": { "href": { "type": "string", "description": "Link to the custom data source to which this daily upload belongs." }, "type": { "type": "string", "description": "Value is \"analytics#customDataSource\".", "default": "analytics#customDataSource" } } }, "recentChanges": { "type": "array", "description": "Change log for last 10 changes in chronological order.", "items": { "type": "object", "properties": { "change": { "type": "string", "description": "The type of change: APPEND, RESET, or DELETE." }, "time": { "type": "string", "description": "The time when the change occurred.", "format": "date-time" } } } }, "selfLink": { "type": "string", "description": "Link for this daily upload." }, "webPropertyId": { "type": "string", "description": "Web property ID of the form UA-XXXXX-YY to which this daily upload belongs." } } }, "DailyUploadAppend": { "id": "DailyUploadAppend", "type": "object", "description": "Metadata returned for a successful append operation.", "properties": { "accountId": { "type": "string", "description": "Account Id to which this daily upload append belongs." }, "appendNumber": { "type": "integer", "description": "Append number.", "format": "int32" }, "customDataSourceId": { "type": "string", "description": "Custom data source Id to which this daily upload append belongs." }, "date": { "type": "string", "description": "Date associated with daily upload append." }, "kind": { "type": "string", "description": "Resource type for Analytics daily upload append.", "default": "analytics#dailyUploadAppend" }, "nextAppendLink": { "type": "string" }, "webPropertyId": { "type": "string", "description": "Web property Id of the form UA-XXXXX-YY to which this daily upload append belongs." } } }, "DailyUploads": { "id": "DailyUploads", "type": "object", "description": "A daily upload collection lists Analytics daily uploads to which the user has access. Each resource in the collection corresponds to a single Analytics daily upload.", "properties": { "items": { "type": "array", "description": "A collection of daily uploads.", "items": { "$ref": "DailyUpload" } }, "itemsPerPage": { "type": "integer", "description": "The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.", "format": "int32" }, "kind": { "type": "string", "description": "Collection type. Value is analytics#dailyUploads.", "default": "analytics#dailyUploads" }, "nextLink": { "type": "string", "description": "Link to next page for this daily upload collection." }, "previousLink": { "type": "string", "description": "Link to previous page for this daily upload collection." }, "startIndex": { "type": "integer", "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.", "format": "int32" }, "totalResults": { "type": "integer", "description": "The total number of results for the query, regardless of the number of results in the response.", "format": "int32" }, "username": { "type": "string", "description": "Email ID of the authenticated user" } } }, "EntityAdWordsLink": { "id": "EntityAdWordsLink", "type": "object", "description": "JSON template for Analytics Entity AdWords Link.", "properties": { "adWordsAccounts": { "type": "array", "description": "A list of AdWords client accounts. These cannot be MCC accounts. This field is required when creating an AdWords link. It cannot be empty.", "items": { "$ref": "AdWordsAccount" }, "annotations": { "required": [ "analytics.management.webPropertyAdWordsLinks.insert", "analytics.management.webPropertyAdWordsLinks.update" ] } }, "entity": { "type": "object", "description": "Web property being linked.", "properties": { "webPropertyRef": { "$ref": "WebPropertyRef" } } }, "id": { "type": "string", "description": "Entity AdWords link ID" }, "kind": { "type": "string", "description": "Resource type for entity AdWords link.", "default": "analytics#entityAdWordsLink" }, "name": { "type": "string", "description": "Name of the link. This field is required when creating an AdWords link.", "annotations": { "required": [ "analytics.management.webPropertyAdWordsLinks.insert", "analytics.management.webPropertyAdWordsLinks.update" ] } }, "profileIds": { "type": "array", "description": "IDs of linked Views (Profiles) represented as strings.", "items": { "type": "string" } }, "selfLink": { "type": "string", "description": "URL link for this Google Analytics - Google AdWords link." } } }, "EntityAdWordsLinks": { "id": "EntityAdWordsLinks", "type": "object", "description": "An entity AdWords link collection provides a list of GA-AdWords links Each resource in this collection corresponds to a single link.", "properties": { "items": { "type": "array", "description": "A list of entity AdWords links.", "items": { "$ref": "EntityAdWordsLink" } }, "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": { "type": "string", "description": "Next link for this AdWords link collection." }, "previousLink": { "type": "string", "description": "Previous link for this AdWords link collection." }, "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" }, "totalResults": { "type": "integer", "description": "The total number of results for the query, regardless of the number of results in the response.", "format": "int32" } } }, "EntityUserLink": { "id": "EntityUserLink", "type": "object", "description": "JSON template for an Analytics Entity-User Link. Returns permissions that a user has for an entity.", "properties": { "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." } } }, "id": { "type": "string", "description": "Entity user link ID" }, "kind": { "type": "string", "description": "Resource type for entity user link.", "default": "analytics#entityUserLink" }, "permissions": { "type": "object", "description": "Permissions the user has for this entity.", "properties": { "effective": { "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, "items": { "type": "string" } }, "local": { "type": "array", "description": "Permissions that a user has been assigned at this very level. Does not include any implied or inherited permissions. Local permissions are modifiable.", "items": { "type": "string" } } } }, "selfLink": { "type": "string", "description": "Self link for this resource." }, "userRef": { "$ref": "UserRef", "description": "User reference." } } }, "EntityUserLinks": { "id": "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", "description": "A list of entity user links.", "items": { "$ref": "EntityUserLink" } }, "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#entityUserLinks" }, "nextLink": { "type": "string", "description": "Next link for this account collection." }, "previousLink": { "type": "string", "description": "Previous link for this account collection." }, "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" }, "totalResults": { "type": "integer", "description": "The total number of results for the query, regardless of the number of results in the response.", "format": "int32" } } }, "Experiment": { "id": "Experiment", "type": "object", "description": "JSON template for Analytics experiment resource.", "properties": { "accountId": { "type": "string", "description": "Account ID to which this experiment belongs. This field is read-only." }, "created": { "type": "string", "description": "Time the experiment was created. This field is read-only.", "format": "date-time" }, "description": { "type": "string", "description": "Notes about this experiment." }, "editableInGaUi": { "type": "boolean", "description": "If true, the end user will be able to edit the experiment via the Google Analytics user interface." }, "endTime": { "type": "string", "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.", "format": "date-time" }, "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." }, "id": { "type": "string", "description": "Experiment ID. Required for patch and update. Disallowed for create.", "annotations": { "required": [ "analytics.management.experiments.patch", "analytics.management.experiments.update" ] } }, "internalWebPropertyId": { "type": "string", "description": "Internal ID for the web property to which this experiment belongs. This field is read-only." }, "kind": { "type": "string", "description": "Resource type for an Analytics experiment. This field is read-only.", "default": "analytics#experiment" }, "minimumExperimentLengthInDays": { "type": "integer", "description": "An integer number in [3, 90]. Specifies the minimum length of the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.", "format": "int32" }, "name": { "type": "string", "description": "Experiment name. This field may not be changed for an experiment whose status is ENDED. This field is required when creating an experiment.", "annotations": { "required": [ "analytics.management.experiments.insert", "analytics.management.experiments.update" ] } }, "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\"." }, "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\"." }, "parentLink": { "type": "object", "description": "Parent link for an experiment. Points to the view (profile) to which this experiment belongs.", "properties": { "href": { "type": "string", "description": "Link to the view (profile) to which this experiment belongs. This field is read-only." }, "type": { "type": "string", "description": "Value is \"analytics#profile\". This field is read-only.", "default": "analytics#profile" } } }, "profileId": { "type": "string", "description": "View (Profile) ID to which this experiment belongs. This field is read-only." }, "reasonExperimentEnded": { "type": "string", "description": "Why the experiment ended. Possible values: \"STOPPED_BY_USER\", \"WINNER_FOUND\", \"EXPERIMENT_EXPIRED\", \"ENDED_WITH_NO_WINNER\", \"GOAL_OBJECTIVE_CHANGED\". \"ENDED_WITH_NO_WINNER\" means that the experiment didn't expire but no winner was projected to be found. If the experiment status is changed via the API to ENDED this field is set to STOPPED_BY_USER. This field is read-only." }, "rewriteVariationUrlsAsOriginal": { "type": "boolean", "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." }, "selfLink": { "type": "string", "description": "Link for this experiment. 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." }, "snippet": { "type": "string", "description": "The snippet of code to include on the control page(s). This field is read-only." }, "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" ] } }, "trafficCoverage": { "type": "number", "description": "A floating-point number between 0 and 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.", "format": "double" }, "updated": { "type": "string", "description": "Time the experiment was last modified. This field is read-only.", "format": "date-time" }, "variations": { "type": "array", "description": "Array of variations. The first variation in the array is the original. The number of variations may not change once an experiment is in the RUNNING state. At least two variations are required before status can be set to RUNNING.", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the variation. This field is required when creating an experiment. This field may not be changed for an experiment whose status is ENDED.", "annotations": { "required": [ "analytics.management.experiments.insert", "analytics.management.experiments.update" ] } }, "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." }, "url": { "type": "string", "description": "The URL of the variation. This field may not be changed for an experiment whose status is RUNNING or ENDED." }, "weight": { "type": "number", "description": "Weight that this variation should receive. Only present if the experiment is running. This field is read-only.", "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." } } } }, "webPropertyId": { "type": "string", "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." }, "winnerConfidenceLevel": { "type": "number", "description": "A floating-point number between 0 and 1. Specifies the necessary confidence level to choose a winner. This field may not be changed for an experiments whose status is ENDED.", "format": "double" }, "winnerFound": { "type": "boolean", "description": "Boolean specifying whether a winner has been found for this experiment. This field is read-only." } } }, "Experiments": { "id": "Experiments", "type": "object", "description": "An experiment collection lists Analytics experiments to which the user has access. Each view (profile) can have a set of experiments. Each resource in the Experiment collection corresponds to a single Analytics experiment.", "properties": { "items": { "type": "array", "description": "A list of experiments.", "items": { "$ref": "Experiment" } }, "itemsPerPage": { "type": "integer", "description": "The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.", "format": "int32" }, "kind": { "type": "string", "description": "Collection type.", "default": "analytics#experiments" }, "nextLink": { "type": "string", "description": "Link to next page for this experiment collection." }, "previousLink": { "type": "string", "description": "Link to previous page for this experiment collection." }, "startIndex": { "type": "integer", "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.", "format": "int32" }, "totalResults": { "type": "integer", "description": "The total number of results for the query, regardless of the number of resources in the result.", "format": "int32" }, "username": { "type": "string", "description": "Email ID of the authenticated user" } } }, "Filter": { "id": "Filter", "type": "object", "description": "JSON template for an Analytics account filter.", "properties": { "accountId": { "type": "string", "description": "Account ID to which this filter belongs." }, "advancedDetails": { "type": "object", "description": "Details for the filter of the type ADVANCED.", "properties": { "caseSensitive": { "type": "boolean", "description": "Indicates if the filter expressions are case sensitive." }, "extractA": { "type": "string", "description": "Expression to extract from field A." }, "extractB": { "type": "string", "description": "Expression to extract from field B." }, "fieldA": { "type": "string", "description": "Field A." }, "fieldARequired": { "type": "boolean", "description": "Indicates if field A is required to match." }, "fieldB": { "type": "string", "description": "Field B." }, "fieldBRequired": { "type": "boolean", "description": "Indicates if field B is required to match." }, "outputConstructor": { "type": "string", "description": "Expression used to construct the output value." }, "outputToField": { "type": "string", "description": "Output field." }, "overrideOutputField": { "type": "boolean", "description": "Indicates if the existing value of the output field, if any, should be overridden by the output expression." } } }, "created": { "type": "string", "description": "Time this filter was created.", "format": "date-time", "readOnly": true }, "excludeDetails": { "$ref": "FilterExpression", "description": "Details for the filter of the type EXCLUDE." }, "id": { "type": "string", "description": "Filter ID." }, "includeDetails": { "$ref": "FilterExpression", "description": "Details for the filter of the type INCLUDE." }, "kind": { "type": "string", "description": "Resource type for Analytics filter.", "default": "analytics#filter", "readOnly": true }, "lowercaseDetails": { "type": "object", "description": "Details for the filter of the type LOWER.", "properties": { "field": { "type": "string", "description": "Field to use in the filter." } } }, "name": { "type": "string", "description": "Name of this filter.", "annotations": { "required": [ "analytics.management.filters.insert", "analytics.management.filters.update" ] } }, "parentLink": { "type": "object", "description": "Parent link for this filter. Points to the account to which this filter belongs.", "properties": { "href": { "type": "string", "description": "Link to the account to which this filter belongs." }, "type": { "type": "string", "description": "Value is \"analytics#account\".", "default": "analytics#account" } } }, "searchAndReplaceDetails": { "type": "object", "description": "Details for the filter of the type SEARCH_AND_REPLACE.", "properties": { "caseSensitive": { "type": "boolean", "description": "Determines if the filter is case sensitive." }, "field": { "type": "string", "description": "Field to use in the filter." }, "replaceString": { "type": "string", "description": "Term to replace the search term with." }, "searchString": { "type": "string", "description": "Term to search." } } }, "selfLink": { "type": "string", "description": "Link for this filter.", "readOnly": true }, "type": { "type": "string", "description": "Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED.", "annotations": { "required": [ "analytics.management.filters.insert", "analytics.management.filters.update" ] } }, "updated": { "type": "string", "description": "Time this filter was last modified.", "format": "date-time", "readOnly": true }, "uppercaseDetails": { "type": "object", "description": "Details for the filter of the type UPPER.", "properties": { "field": { "type": "string", "description": "Field to use in the filter." } } } } }, "FilterExpression": { "id": "FilterExpression", "type": "object", "description": "JSON template for an Analytics filter expression.", "properties": { "caseSensitive": { "type": "boolean", "description": "Determines if the filter is case sensitive." }, "expressionValue": { "type": "string", "description": "Filter expression value" }, "field": { "type": "string", "description": "Field to filter. Possible values: \n- Reserved \n- UNUSED, \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, \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, \n- IS_FATAL_EXCEPTION, \n- EXCEPTION_DESCRIPTION, \n- Mobile device \n- IS_MOBILE, \n- IS_TABLET, \n- MOBILE_HAS_QWERTY_KEYBOARD, \n- MOBILE_HAS_NFC_SUPPORT, \n- MOBILE_HAS_CELLULAR_RADIO, \n- MOBILE_HAS_WIFI_SUPPORT, \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," }, "kind": { "type": "string", "description": "Kind value for filter expression", "default": "analytics#filterExpression" }, "matchType": { "type": "string", "description": "Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, MATCHES. Include and Exclude filters can use any match type. Match type is not applicable to Upper case and Lower case filters. Search and Replace expressions in the Search and Replace filter and all filter expressions in the Advanced filter default to MATCHES. User should not set match type for those filters." } } }, "FilterRef": { "id": "FilterRef", "type": "object", "description": "JSON template for a profile filter link.", "properties": { "accountId": { "type": "string", "description": "Account ID to which this filter belongs.", "readOnly": true }, "href": { "type": "string", "description": "Link for this filter." }, "id": { "type": "string", "description": "Filter ID.", "annotations": { "required": [ "analytics.management.profileFilterLinks.insert" ] } }, "kind": { "type": "string", "description": "Kind value for filter reference.", "default": "analytics#filterRef" }, "name": { "type": "string", "description": "Name of this filter.", "readOnly": true } } }, "Filters": { "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.", "properties": { "items": { "type": "array", "description": "A list of filters.", "items": { "$ref": "Filter" } }, "itemsPerPage": { "type": "integer", "description": "The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.", "format": "int32" }, "kind": { "type": "string", "description": "Collection type.", "default": "analytics#filters" }, "nextLink": { "type": "string", "description": "Link to next page for this filter collection." }, "previousLink": { "type": "string", "description": "Link to previous page for this filter collection." }, "startIndex": { "type": "integer", "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.", "format": "int32" }, "totalResults": { "type": "integer", "description": "The total number of results for the query, regardless of the number of results in the response.", "format": "int32" }, "username": { "type": "string", "description": "Email ID of the aut