Reference documentation and code samples for the Google Ads Marketing Platform Admin V1alpha Client class UserGroup.
A resource message representing a user group in a GMP organization.
Generated from protobuf message google.marketingplatform.admin.v1alpha.UserGroup
Namespace
Google \ Ads \ MarketingPlatform \ Admin \ V1alphaMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Identifier. Resource name of this UserGroup. Format: organizations/{org_id}/userGroups/{user_group_id} Example: "organizations/123abc/userGroups/456def" |
↳ display_name |
string
Optional. The human-readable name for the user group. |
↳ description |
string
Optional. The description of the user group. |
getName
Identifier. Resource name of this UserGroup.
Format: organizations/{org_id}/userGroups/{user_group_id} Example: "organizations/123abc/userGroups/456def"
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. Resource name of this UserGroup.
Format: organizations/{org_id}/userGroups/{user_group_id} Example: "organizations/123abc/userGroups/456def"
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
Optional. The human-readable name for the user group.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDisplayName
Optional. The human-readable name for the user group.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Optional. The description of the user group.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Optional. The description of the user group.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|