Reference documentation and code samples for the Google Analytics Admin V1alpha Client class AuditUserLink.
Read-only resource used to summarize a principal's effective roles.
Generated from protobuf message google.analytics.admin.v1alpha.AuditUserLink
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Example format: properties/1234/userLinks/5678 |
↳ email_address |
string
Email address of the linked user |
↳ direct_roles |
array
Roles directly assigned to this user for this entity. Format: predefinedRoles/viewer Excludes roles that are inherited from an account (if this is for a property), group, or organization admin role. |
↳ effective_roles |
array
Union of all permissions a user has at this account or property (includes direct permissions, group-inherited permissions, etc.). Format: predefinedRoles/viewer |
getName
Example format: properties/1234/userLinks/5678
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Example format: properties/1234/userLinks/5678
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEmailAddress
Email address of the linked user
| Returns | |
|---|---|
| Type | Description |
string |
|
setEmailAddress
Email address of the linked user
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDirectRoles
Roles directly assigned to this user for this entity.
Format: predefinedRoles/viewer Excludes roles that are inherited from an account (if this is for a property), group, or organization admin role.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setDirectRoles
Roles directly assigned to this user for this entity.
Format: predefinedRoles/viewer Excludes roles that are inherited from an account (if this is for a property), group, or organization admin role.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEffectiveRoles
Union of all permissions a user has at this account or property (includes direct permissions, group-inherited permissions, etc.).
Format: predefinedRoles/viewer
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setEffectiveRoles
Union of all permissions a user has at this account or property (includes direct permissions, group-inherited permissions, etc.).
Format: predefinedRoles/viewer
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|