Web Properties

The Webproperties collection is a set of Webproperty resources, each of which describes a web property available to an authenticated user. 

For a list of methods for this resource, see the end of this page.

Resource representations

JSON template for an Analytics web property.

{
  "id": string,
  "kind": "analytics#webproperty",
  "selfLink": string,
  "accountId": string,
  "internalWebPropertyId": string,
  "name": string,
  "websiteUrl": string,
  "level": string,
  "profileCount": integer,
  "industryVertical": string,
  "defaultProfileId": long,
  "dataRetentionTtl": string,
  "dataRetentionResetOnNewActivity": boolean,
  "permissions": {
    "effective": [
      string
    ]
  },
  "created": datetime,
  "updated": datetime,
  "starred": boolean,
  "parentLink": {
    "type": "analytics#account",
    "href": string
  },
  "childLink": {
    "type": "analytics#profiles",
    "href": string
  }
}
Property name Value Description Notes
accountId string Account ID to which this web property belongs.
childLink.href string Link to the list of views (profiles) for this web property.
childLink.type string Type of the parent link. Its value is "analytics#profiles".
created datetime Time this web property was created.
dataRetentionResetOnNewActivity boolean 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). True is the default setting for this field.

Set to false to delete data associated with the user identifer automatically after the rentention period.

This property cannot be set on insert.

dataRetentionTtl string The length of time for which user and event data is retained. If this field is set, the correct values are:
  • INDEFINITE
  • MONTHS_14
  • MONTHS_26
  • MONTHS_38
  • MONTHS_50

This property cannot be set on insert.

defaultProfileId long Default view (profile) ID.
id string Web property ID of the form UA-XXXXX-YY.
industryVertical string The industry vertical/category selected for this web property. If this field is set, the correct values are:
  • UNSPECIFIED
  • ARTS_AND_ENTERTAINMENT
  • AUTOMOTIVE
  • BEAUTY_AND_FITNESS
  • BOOKS_AND_LITERATURE
  • BUSINESS_AND_INDUSTRIAL_MARKETS
  • COMPUTERS_AND_ELECTRONICS
  • FINANCE
  • FOOD_AND_DRINK
  • GAMES
  • HEALTHCARE
  • HOBBIES_AND_LEISURE
  • HOME_AND_GARDEN
  • INTERNET_AND_TELECOM
  • JOBS_AND_EDUCATION
  • LAW_AND_GOVERNMENT
  • NEWS
  • ONLINE_COMMUNITIES
  • OTHER
  • PEOPLE_AND_SOCIETY
  • PETS_AND_ANIMALS
  • REAL_ESTATE
  • REFERENCE
  • SCIENCE
  • SHOPPING
  • SPORTS
  • TRAVEL
internalWebPropertyId string Internal ID for this web property.
kind string Resource type for Analytics WebProperty.
level string Level for this web property.
name string Name of this web property.
parentLink.href string Link to the account for this web property.
parentLink.type string Type of the parent link. Its value is "analytics#account".
permissions object Permissions the user has for this web property.
permissions.effective[] list 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.
profileCount integer View (Profile) count for this web property.
starred boolean Indicates whether this web property is starred or not.
updated datetime Time this web property was last modified.
websiteUrl string Website url for this web property.

Methods

get
Gets a property to which the user has access.
insert
Creates a new property.
list
Lists properties to which the user has access.
patch
Updates an existing property. This method supports patch semantics.
update
Updates an existing property.