Reference documentation and code samples for the Google Analytics Admin V1alpha Client class UserLink.
A resource message representing a user's permissions on an Account or Property resource.
Generated from protobuf message google.analytics.admin.v1alpha.UserLink
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Output only. Example format: properties/1234/userLinks/5678 |
↳ email_address |
string
Immutable. Email address of the user to link |
↳ direct_roles |
array
Roles directly assigned to this user for this account or property. Valid values: predefinedRoles/viewer predefinedRoles/analyst predefinedRoles/editor predefinedRoles/admin predefinedRoles/no-cost-data predefinedRoles/no-revenue-data Excludes roles that are inherited from a higher-level entity, group, or organization admin role. A UserLink that is updated to have an empty list of direct_roles will be deleted. |
getName
Output only. Example format: properties/1234/userLinks/5678
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Output only. Example format: properties/1234/userLinks/5678
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEmailAddress
Immutable. Email address of the user to link
| Returns | |
|---|---|
| Type | Description |
string | |
setEmailAddress
Immutable. Email address of the user to link
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDirectRoles
Roles directly assigned to this user for this account or property.
Valid values: predefinedRoles/viewer predefinedRoles/analyst predefinedRoles/editor predefinedRoles/admin predefinedRoles/no-cost-data predefinedRoles/no-revenue-data Excludes roles that are inherited from a higher-level entity, group, or organization admin role. A UserLink that is updated to have an empty list of direct_roles will be deleted.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setDirectRoles
Roles directly assigned to this user for this account or property.
Valid values: predefinedRoles/viewer predefinedRoles/analyst predefinedRoles/editor predefinedRoles/admin predefinedRoles/no-cost-data predefinedRoles/no-revenue-data Excludes roles that are inherited from a higher-level entity, group, or organization admin role. A UserLink that is updated to have an empty list of direct_roles will be deleted.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |