Reference documentation and code samples for the Google Ads Ad Manager V1 Client class Role.
The Role resource.
Generated from protobuf message google.ads.admanager.v1.Role
Namespace
Google \ Ads \ AdManager \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Identifier. The resource name of the |
↳ role_id |
int|string
Output only. |
↳ display_name |
string
Required. The display name of the |
↳ description |
string
Optional. The description of the |
↳ built_in |
bool
Output only. Whether the |
↳ status |
int
Output only. The status of the |
getName
Identifier. The resource name of the Role.
Format: networks/{network_code}/roles/{role_id}
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. The resource name of the Role.
Format: networks/{network_code}/roles/{role_id}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRoleId
Output only. Role ID.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
setRoleId
Output only. Role ID.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
Required. The display name of the Role.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDisplayName
Required. The display name of the Role.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Optional. The description of the Role.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Optional. The description of the Role.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getBuiltIn
Output only. Whether the Role is a built-in or custom user role.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setBuiltIn
Output only. Whether the Role is a built-in or custom user role.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStatus
Output only. The status of the Role.
| Returns | |
|---|---|
| Type | Description |
int |
|
setStatus
Output only. The status of the Role.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|