Insert
|
|||||
|
|
Adds a new user to the given view (profile)
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- Manage Google Analytics Account users by email address
Input
This building block consumes 34 input parameters
Name | Format | Description |
---|---|---|
accountId Required |
STRING |
Account ID to create the user link for |
webPropertyId Required |
STRING |
Web Property ID to create the user link for |
profileId Required |
STRING |
View (Profile) ID to create the user link for |
entity |
OBJECT |
Entity for this link. It can be an account, a web property, or a view (profile) |
entity.accountRef |
OBJECT |
JSON template for a linked account |
entity.accountRef.href |
STRING |
Link for this account |
entity.accountRef.id |
STRING |
Account ID |
entity.accountRef.kind |
STRING |
Analytics account reference |
entity.accountRef.name |
STRING |
Account name |
entity.profileRef |
OBJECT |
JSON template for a linked view (profile) |
entity.profileRef.accountId |
STRING |
Account ID to which this view (profile) belongs |
entity.profileRef.href |
STRING |
Link for this view (profile) |
entity.profileRef.id |
STRING |
View (Profile) ID |
entity.profileRef.internalWebPropertyId |
STRING |
Internal ID for the web property to which this view (profile) belongs |
entity.profileRef.kind |
STRING |
Analytics view (profile) reference |
entity.profileRef.name |
STRING |
Name of this view (profile) |
entity.profileRef.webPropertyId |
STRING |
Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs |
entity.webPropertyRef |
OBJECT |
JSON template for a web property reference |
entity.webPropertyRef.accountId |
STRING |
Account ID to which this web property belongs |
entity.webPropertyRef.href |
STRING |
Link for this web property |
entity.webPropertyRef.id |
STRING |
Web property ID of the form UA-XXXXX-YY |
entity.webPropertyRef.internalWebPropertyId |
STRING |
Internal ID for this web property |
entity.webPropertyRef.kind |
STRING |
Analytics web property reference |
entity.webPropertyRef.name |
STRING |
Name of this web property |
id |
STRING |
Entity user link ID |
kind |
STRING |
Resource type for entity user link |
permissions |
OBJECT |
Permissions the user has for this entity |
permissions.effective[] |
STRING |
|
permissions.local[] |
STRING |
|
selfLink |
STRING |
Self link for this resource |
userRef |
OBJECT |
JSON template for a user reference |
userRef.email |
STRING |
Email ID of this user |
userRef.id |
STRING |
User ID |
userRef.kind |
STRING |
= Parameter name
= Format
accountId STRING Required Account ID to create the user link for |
webPropertyId STRING Required Web Property ID to create the user link for |
profileId STRING Required View (Profile) ID to create the user link for |
entity OBJECT Entity for this link. It can be an account, a web property, or a view (profile) |
entity.accountRef OBJECT JSON template for a linked account |
entity.accountRef.href STRING Link for this account |
entity.accountRef.id STRING Account ID |
entity.accountRef.kind STRING Analytics account reference |
entity.accountRef.name STRING Account name |
entity.profileRef OBJECT JSON template for a linked view (profile) |
entity.profileRef.accountId STRING Account ID to which this view (profile) belongs |
entity.profileRef.href STRING Link for this view (profile) |
entity.profileRef.id STRING View (Profile) ID |
entity.profileRef.internalWebPropertyId STRING Internal ID for the web property to which this view (profile) belongs |
entity.profileRef.kind STRING Analytics view (profile) reference |
entity.profileRef.name STRING Name of this view (profile) |
entity.profileRef.webPropertyId STRING Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs |
entity.webPropertyRef OBJECT JSON template for a web property reference |
entity.webPropertyRef.accountId STRING Account ID to which this web property belongs |
entity.webPropertyRef.href STRING Link for this web property |
entity.webPropertyRef.id STRING Web property ID of the form UA-XXXXX-YY |
entity.webPropertyRef.internalWebPropertyId STRING Internal ID for this web property |
entity.webPropertyRef.kind STRING Analytics web property reference |
entity.webPropertyRef.name STRING Name of this web property |
id STRING Entity user link ID |
kind STRING Resource type for entity user link |
permissions OBJECT Permissions the user has for this entity |
permissions.effective[] STRING |
permissions.local[] STRING |
selfLink STRING Self link for this resource |
userRef OBJECT JSON template for a user reference |
userRef.email STRING Email ID of this user |
userRef.id STRING User ID |
userRef.kind STRING |
Output
This building block provides 31 output parameters
Name | Format | Description |
---|---|---|
entity |
OBJECT |
Entity for this link. It can be an account, a web property, or a view (profile) |
entity.accountRef |
OBJECT |
JSON template for a linked account |
entity.accountRef.href |
STRING |
Link for this account |
entity.accountRef.id |
STRING |
Account ID |
entity.accountRef.kind |
STRING |
Analytics account reference |
entity.accountRef.name |
STRING |
Account name |
entity.profileRef |
OBJECT |
JSON template for a linked view (profile) |
entity.profileRef.accountId |
STRING |
Account ID to which this view (profile) belongs |
entity.profileRef.href |
STRING |
Link for this view (profile) |
entity.profileRef.id |
STRING |
View (Profile) ID |
entity.profileRef.internalWebPropertyId |
STRING |
Internal ID for the web property to which this view (profile) belongs |
entity.profileRef.kind |
STRING |
Analytics view (profile) reference |
entity.profileRef.name |
STRING |
Name of this view (profile) |
entity.profileRef.webPropertyId |
STRING |
Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs |
entity.webPropertyRef |
OBJECT |
JSON template for a web property reference |
entity.webPropertyRef.accountId |
STRING |
Account ID to which this web property belongs |
entity.webPropertyRef.href |
STRING |
Link for this web property |
entity.webPropertyRef.id |
STRING |
Web property ID of the form UA-XXXXX-YY |
entity.webPropertyRef.internalWebPropertyId |
STRING |
Internal ID for this web property |
entity.webPropertyRef.kind |
STRING |
Analytics web property reference |
entity.webPropertyRef.name |
STRING |
Name of this web property |
id |
STRING |
Entity user link ID |
kind |
STRING |
Resource type for entity user link |
permissions |
OBJECT |
Permissions the user has for this entity |
permissions.effective[] |
STRING |
|
permissions.local[] |
STRING |
|
selfLink |
STRING |
Self link for this resource |
userRef |
OBJECT |
JSON template for a user reference |
userRef.email |
STRING |
Email ID of this user |
userRef.id |
STRING |
User ID |
userRef.kind |
STRING |
= Parameter name
= Format
entity OBJECT Entity for this link. It can be an account, a web property, or a view (profile) |
entity.accountRef OBJECT JSON template for a linked account |
entity.accountRef.href STRING Link for this account |
entity.accountRef.id STRING Account ID |
entity.accountRef.kind STRING Analytics account reference |
entity.accountRef.name STRING Account name |
entity.profileRef OBJECT JSON template for a linked view (profile) |
entity.profileRef.accountId STRING Account ID to which this view (profile) belongs |
entity.profileRef.href STRING Link for this view (profile) |
entity.profileRef.id STRING View (Profile) ID |
entity.profileRef.internalWebPropertyId STRING Internal ID for the web property to which this view (profile) belongs |
entity.profileRef.kind STRING Analytics view (profile) reference |
entity.profileRef.name STRING Name of this view (profile) |
entity.profileRef.webPropertyId STRING Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs |
entity.webPropertyRef OBJECT JSON template for a web property reference |
entity.webPropertyRef.accountId STRING Account ID to which this web property belongs |
entity.webPropertyRef.href STRING Link for this web property |
entity.webPropertyRef.id STRING Web property ID of the form UA-XXXXX-YY |
entity.webPropertyRef.internalWebPropertyId STRING Internal ID for this web property |
entity.webPropertyRef.kind STRING Analytics web property reference |
entity.webPropertyRef.name STRING Name of this web property |
id STRING Entity user link ID |
kind STRING Resource type for entity user link |
permissions OBJECT Permissions the user has for this entity |
permissions.effective[] STRING |
permissions.local[] STRING |
selfLink STRING Self link for this resource |
userRef OBJECT JSON template for a user reference |
userRef.email STRING Email ID of this user |
userRef.id STRING User ID |
userRef.kind STRING |