Google Ads Marketing Platform Admin V1alpha Client - Class UserGroupMember (0.6.0)

Reference documentation and code samples for the Google Ads Marketing Platform Admin V1alpha Client class UserGroupMember.

A resource message representing a member of a user group.

Generated from protobuf message google.marketingplatform.admin.v1alpha.UserGroupMember

Namespace

Google \ Ads \ MarketingPlatform \ Admin \ V1alpha

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ user_email string

Email address of the user member.

↳ user_group string

User group resource name of the group member.

↳ name string

Identifier. The resource name of this UserGroupMember. Format: organizations/{org_id}/userGroups/{user_group_id}/members/{member_id} Example: "organizations/123abc/userGroups/456def/members/789ghi"

↳ membership_role int

Optional. The role of the member in the user group.

getUserEmail

Email address of the user member.

Returns
Type Description
string

hasUserEmail

setUserEmail

Email address of the user member.

Parameter
Name Description
var string
Returns
Type Description
$this

getUserGroup

User group resource name of the group member.

Returns
Type Description
string

hasUserGroup

setUserGroup

User group resource name of the group member.

Parameter
Name Description
var string
Returns
Type Description
$this

getName

Identifier. The resource name of this UserGroupMember.

Format: organizations/{org_id}/userGroups/{user_group_id}/members/{member_id} Example: "organizations/123abc/userGroups/456def/members/789ghi"

Returns
Type Description
string

setName

Identifier. The resource name of this UserGroupMember.

Format: organizations/{org_id}/userGroups/{user_group_id}/members/{member_id} Example: "organizations/123abc/userGroups/456def/members/789ghi"

Parameter
Name Description
var string
Returns
Type Description
$this

getMembershipRole

Optional. The role of the member in the user group.

Returns
Type Description
int Enum of type MembershipRole.

setMembershipRole

Optional. The role of the member in the user group.

Parameter
Name Description
var int

Enum of type MembershipRole.

Returns
Type Description
$this

getMember

Returns
Type Description
string