/management/accounts/{accountId}/webproperties

POST

management

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.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://analytics.googleapis.com/analytics/v3/management/accounts//webproperties' \
--header 'Content-Type: application/json' \
--data-raw ''

Response Example

{
  "accountId": "string",
  "childLink": {
    "href": "string",
    "type": "analytics#profiles"
  },
  "created": "2019-08-24T14:15:22Z",
  "dataRetentionResetOnNewActivity": true,
  "dataRetentionTtl": "string",
  "defaultProfileId": "string",
  "id": "string",
  "industryVertical": "string",
  "internalWebPropertyId": "string",
  "kind": "analytics#webproperty",
  "level": "string",
  "name": "string",
  "parentLink": {
    "href": "string",
    "type": "analytics#account"
  },
  "permissions": {
    "effective": [
      "string"
    ]
  },
  "profileCount": 0,
  "selfLink": "string",
  "starred": true,
  "updated": "2019-08-24T14:15:22Z",
  "websiteUrl": "string"
}

Request

Path Params

accountId

string

required

Account ID to create the web property for.

Body Params application/json

JSON template for an Analytics web property.

accountId

string

optional

Account ID to which this web property belongs.

childLink

object

optional

Child link for this web property. Points to the list of views (profiles) for this web property.

href

string

optional

Link to the list of views (profiles) for this web property.

type

string

optional

Type of the parent link. Its value is "analytics#profiles".

Default:

analytics#profiles

dataRetentionResetOnNewActivity

boolean

optional

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 data associated with the user identifier automatically after the rentention period.
This property cannot be set on insert.

dataRetentionTtl

string

optional

The length of time for which user and event data is retained.
This property cannot be set on insert.

defaultProfileId

string <int64>

optional

Default view (profile) ID.

string

optional

Web property ID of the form UA-XXXXX-YY.

industryVertical

string

optional

The industry vertical/category selected for this web property.

name

string

optional

Name of this web property.

parentLink

object

optional

Parent link for this web property. Points to the account to which this web property belongs.

href

string

optional

Link to the account for this web property.

type

string

optional

Type of the parent link. Its value is "analytics#account".

Default:

analytics#account

permissions

object

optional

Permissions the user has for this web property.

starred

boolean

optional

Indicates whether this web property is starred or not.

websiteUrl

string

optional

Website url for this web property.

Examples

Responses

🟢200Successful response

application/json

Body

JSON template for an Analytics web property.

accountId

string

optional

Account ID to which this web property belongs.

childLink

object

optional

Child link for this web property. Points to the list of views (profiles) for this web property.

href

string

optional

Link to the list of views (profiles) for this web property.

type

string

optional

Type of the parent link. Its value is "analytics#profiles".

Default:

analytics#profiles

created

string <date-time>

read-onlyoptional

Time this web property was created.

dataRetentionResetOnNewActivity

boolean

optional

dataRetentionTtl

string

optional

The length of time for which user and event data is retained.
This property cannot be set on insert.

defaultProfileId

string <int64>

optional

Default view (profile) ID.

string

optional

Web property ID of the form UA-XXXXX-YY.

industryVertical

string

optional

The industry vertical/category selected for this web property.

internalWebPropertyId

string

read-onlyoptional

Internal ID for this web property.

kind

string

read-onlyoptional

Resource type for Analytics WebProperty.

Default:

analytics#webproperty

level

string

read-onlyoptional

Level for this web property. Possible values are STANDARD or PREMIUM.

name

string

optional

Name of this web property.

parentLink

object

optional

Parent link for this web property. Points to the account to which this web property belongs.

href

string

optional

Link to the account for this web property.

type

string

optional

Type of the parent link. Its value is "analytics#account".

Default:

analytics#account

permissions

object

optional

Permissions the user has for this web property.

effective

array[string]

read-onlyoptional

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 <int32>

read-onlyoptional

View (Profile) count for this web property.

selfLink

string

read-onlyoptional

Link for this web property.

starred

boolean

optional

Indicates whether this web property is starred or not.

updated

string <date-time>

read-onlyoptional

Time this web property was last modified.

websiteUrl

string

optional

Website url for this web property.

Modified at 2023-08-15 05:39:07

/management/accounts/{accountId}/webproperties

/management/accounts/{accountId}/webproperties/{webPropertyId}