The Profiles collection is a set of Profile resources, each of which describes the profile of an authenticated user.
For a list of methods for this resource, see the end of this page.
Resource representations
JSON template for an Analytics view (profile).
{ "id": string, "kind": "analytics#profile", "selfLink": string, "accountId": string, "webPropertyId": string, "internalWebPropertyId": string, "name": string, "currency": string, "timezone": string, "websiteUrl": string, "defaultPage": string, "excludeQueryParameters": string, "siteSearchQueryParameters": string, "stripSiteSearchQueryParameters": boolean, "siteSearchCategoryParameters": string, "stripSiteSearchCategoryParameters": boolean, "type": string, "permissions": { "effective": [ string ] }, "created": datetime, "updated": datetime, "eCommerceTracking": boolean, "enhancedECommerceTracking": boolean, "botFilteringEnabled": boolean, "starred": boolean, "parentLink": { "type": "analytics#webproperty", "href": string }, "childLink": { "type": "analytics#goals", "href": string } }
Property name | Value | Description | Notes |
---|---|---|---|
accountId |
string |
Account ID to which this view (profile) belongs. | |
botFilteringEnabled |
boolean |
Indicates whether bot filtering is enabled for this view (profile). | |
childLink |
object |
Child link for this view (profile). Points to the list of goals for this view (profile). | |
childLink.href |
string |
Link to the list of goals for this view (profile). | |
childLink.type |
string |
Value is "analytics#goals ". |
|
created |
datetime |
Time this view (profile) was created. | |
currency |
string |
The currency type associated with this view (profile), defaults to USD. The supported values are: USD, 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 |
|
defaultPage |
string |
Default page for this view (profile). | |
eCommerceTracking |
boolean |
Indicates whether ecommerce tracking is enabled for this view (profile). | |
enhancedECommerceTracking |
boolean |
Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled. This property cannot be set on insert. | |
excludeQueryParameters |
string |
The query parameters that are excluded from this view (profile). | |
id |
string |
View (Profile) ID. | |
internalWebPropertyId |
string |
Internal ID for the web property to which this view (profile) belongs. | |
kind |
string |
Resource type for Analytics view (profile). | |
name |
string |
Name of this view (profile). | |
parentLink |
object |
Parent link for this view (profile). Points to the web property to which this view (profile) belongs. | |
parentLink.href |
string |
Link to the web property to which this view (profile) belongs. | |
parentLink.type |
string |
Value is "analytics#webproperty ". |
|
permissions |
object |
Permissions the user has for this view (profile). | |
permissions.effective[] |
list |
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. | |
selfLink |
string |
Link for this view (profile). | |
siteSearchCategoryParameters |
string |
Site search category parameters for this view (profile). | |
siteSearchQueryParameters |
string |
The site search query parameters for this view (profile). | |
starred |
boolean |
Indicates whether this view (profile) is starred or not. | |
stripSiteSearchCategoryParameters |
boolean |
Whether or not Analytics will strip search category parameters from the URLs in your reports. | |
stripSiteSearchQueryParameters |
boolean |
Whether or not Analytics will strip search query parameters from the URLs in your reports. | |
timezone |
string |
Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database. | |
type |
string |
View (Profile) type. Supported types: WEB or APP. | |
updated |
datetime |
Time this view (profile) was last modified. | |
webPropertyId |
string |
Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs. | |
websiteUrl |
string |
Website URL for this view (profile). |
Methods
- delete
- Deletes a view (profile).
- get
- Gets a view (profile) to which the user has access.
- insert
- Create a new view (profile).
- list
- Lists views (profiles) to which the user has access.
- patch
- Updates an existing view (profile). This method supports patch semantics.
- update
- Updates an existing view (profile).