Reference documentation and code samples for the Google Ads Marketing Platform Admin V1alpha Client class ListUserGroupMembersRequest.
Request message for ListUserGroupMembers RPC.
Generated from protobuf message google.marketingplatform.admin.v1alpha.ListUserGroupMembersRequest
Namespace
Google \ Ads \ MarketingPlatform \ Admin \ V1alphaMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The parent user group where this UserGroupMember will be listed. Format: organizations/{org_id}/userGroups/{user_group_id} |
↳ page_size |
int
Optional. The maximum number of user group members to return in one call. The service may return fewer than this value. If unspecified, at most 50 user group members will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
↳ page_token |
string
Optional. A page token, received from a previous ListUserGroupMembers call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to |
getParent
Required. The parent user group where this UserGroupMember will be listed.
Format: organizations/{org_id}/userGroups/{user_group_id}
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
Required. The parent user group where this UserGroupMember will be listed.
Format: organizations/{org_id}/userGroups/{user_group_id}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageSize
Optional. The maximum number of user group members to return in one call.
The service may return fewer than this value. If unspecified, at most 50 user group members will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
| Returns | |
|---|---|
| Type | Description |
int |
|
setPageSize
Optional. The maximum number of user group members to return in one call.
The service may return fewer than this value. If unspecified, at most 50 user group members will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageToken
Optional. A page token, received from a previous ListUserGroupMembers call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to
ListUserGroupMembers must match the call that provided the page token.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPageToken
Optional. A page token, received from a previous ListUserGroupMembers call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to
ListUserGroupMembers must match the call that provided the page token.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameter | |
|---|---|
| Name | Description |
parent |
string
Required. The parent user group where this UserGroupMember will be listed. Format: organizations/{org_id}/userGroups/{user_group_id} Please see MarketingplatformAdminServiceClient::userGroupName() for help formatting this field. |
| Returns | |
|---|---|
| Type | Description |
ListUserGroupMembersRequest |
|