Google Analytics · Schema

Webproperty

JSON template for an Analytics web property.

AnalyticsDataGoogleMetricsReportingWeb AnalyticsMachine LearningAttribution

Properties

Name Type Description
accountId string Account ID to which this web property belongs.
childLink object Child link for this web property. Points to the list of views (profiles) for this web property.
created string 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). Set to false to delete dat
dataRetentionTtl string The length of time for which user and event data is retained. This property cannot be set on insert.
defaultProfileId string 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.
internalWebPropertyId string Internal ID for this web property.
kind string Resource type for Analytics WebProperty.
level string Level for this web property. Possible values are STANDARD or PREMIUM.
name string Name of this web property.
parentLink object Parent link for this web property. Points to the account to which this web property belongs.
permissions object Permissions the user has for this web property.
profileCount integer View (Profile) count for this web property.
selfLink string Link for this web property.
starred boolean Indicates whether this web property is starred or not.
updated string Time this web property was last modified.
websiteUrl string Website url for this web property.
View JSON Schema on GitHub

JSON Schema

google-analytics-webproperty-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Webproperty",
  "title": "Webproperty",
  "description": "JSON template for an Analytics web property.",
  "properties": {
    "accountId": {
      "description": "Account ID to which this web property belongs.",
      "type": "string"
    },
    "childLink": {
      "description": "Child link for this web property. Points to the list of views (profiles) for this web property.",
      "properties": {
        "href": {
          "description": "Link to the list of views (profiles) for this web property.",
          "type": "string"
        },
        "type": {
          "default": "analytics#profiles",
          "description": "Type of the parent link. Its value is \"analytics#profiles\".",
          "type": "string"
        }
      },
      "type": "object"
    },
    "created": {
      "description": "Time this web property was created.",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "dataRetentionResetOnNewActivity": {
      "description": "Set to true to reset the retention period of the user identifier with each new event from that user (thus setting the expiration date to current time plus retention period).\nSet to false to delete data associated with the user identifier automatically after the rentention period.\nThis property cannot be set on insert.",
      "type": "boolean"
    },
    "dataRetentionTtl": {
      "description": "The length of time for which user and event data is retained.\nThis property cannot be set on insert.",
      "type": "string"
    },
    "defaultProfileId": {
      "description": "Default view (profile) ID.",
      "format": "int64",
      "type": "string"
    },
    "id": {
      "description": "Web property ID of the form UA-XXXXX-YY.",
      "type": "string"
    },
    "industryVertical": {
      "description": "The industry vertical/category selected for this web property.",
      "type": "string"
    },
    "internalWebPropertyId": {
      "description": "Internal ID for this web property.",
      "readOnly": true,
      "type": "string"
    },
    "kind": {
      "default": "analytics#webproperty",
      "description": "Resource type for Analytics WebProperty.",
      "readOnly": true,
      "type": "string"
    },
    "level": {
      "description": "Level for this web property. Possible values are STANDARD or PREMIUM.",
      "readOnly": true,
      "type": "string"
    },
    "name": {
      "description": "Name of this web property.",
      "type": "string"
    },
    "parentLink": {
      "description": "Parent link for this web property. Points to the account to which this web property belongs.",
      "properties": {
        "href": {
          "description": "Link to the account for this web property.",
          "type": "string"
        },
        "type": {
          "default": "analytics#account",
          "description": "Type of the parent link. Its value is \"analytics#account\".",
          "type": "string"
        }
      },
      "type": "object"
    },
    "permissions": {
      "description": "Permissions the user has for this web property.",
      "properties": {
        "effective": {
          "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"
          },
          "readOnly": true,
          "type": "array"
        }
      },
      "type": "object"
    },
    "profileCount": {
      "description": "View (Profile) count for this web property.",
      "format": "int32",
      "readOnly": true,
      "type": "integer"
    },
    "selfLink": {
      "description": "Link for this web property.",
      "readOnly": true,
      "type": "string"
    },
    "starred": {
      "description": "Indicates whether this web property is starred or not.",
      "type": "boolean"
    },
    "updated": {
      "description": "Time this web property was last modified.",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "websiteUrl": {
      "description": "Website url for this web property.",
      "type": "string"
    }
  },
  "type": "object"
}