Reference documentation and code samples for the Google Ads Data Manager V1 Client class UserList.
A user list resource.
Generated from protobuf message google.ads.datamanager.v1.UserList
Namespace
Google \ Ads \ DataManager \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Identifier. The resource name of the user list. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}
↳ id
int|string
Output only. The unique ID of the user list.
↳ read_only
bool
Output only. An option that indicates if a user may edit a list.
↳ display_name
string
Required. The display name of the user list.
↳ description
string
Optional. A description of the user list.
↳ membership_status
int
Optional. Membership status of this user list.
↳ integration_code
string
Optional. An ID from external system. It is used by user list sellers to correlate IDs on their systems.
↳ membership_duration
Google\Protobuf\Duration
Optional. The duration a user remains in the user list. Valid durations are exact multiples of 24 hours (86400 seconds). Providing a value that is not an exact multiple of 24 hours will result in an INVALID_ARGUMENT error.
↳ closing_reason
int
Output only. The reason why this user list membership status is closed.
↳ access_reason
int
Output only. The reason this account has been granted access to the list.
↳ account_access_status
int
Optional. Indicates if this share is still enabled. When a user list is shared with the account this field is set to ENABLED
. Later the user list owner can decide to revoke the share and make it DISABLED
.
↳ size_info
↳ target_network_info
↳ ingested_user_list_info
getName
Identifier. The resource name of the user list.
Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}
string
setName
Identifier. The resource name of the user list.
Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}
var
string
$this
getId
Output only. The unique ID of the user list.
int|string
setId
Output only. The unique ID of the user list.
var
int|string
$this
getReadOnly
Output only. An option that indicates if a user may edit a list.
bool
setReadOnly
Output only. An option that indicates if a user may edit a list.
var
bool
$this
getDisplayName
Required. The display name of the user list.
string
hasDisplayName
clearDisplayName
setDisplayName
Required. The display name of the user list.
var
string
$this
getDescription
Optional. A description of the user list.
string
hasDescription
clearDescription
setDescription
Optional. A description of the user list.
var
string
$this
getMembershipStatus
Optional. Membership status of this user list.
int
hasMembershipStatus
clearMembershipStatus
setMembershipStatus
Optional. Membership status of this user list.
var
int
$this
getIntegrationCode
Optional. An ID from external system. It is used by user list sellers to correlate IDs on their systems.
string
hasIntegrationCode
clearIntegrationCode
setIntegrationCode
Optional. An ID from external system. It is used by user list sellers to correlate IDs on their systems.
var
string
$this
getMembershipDuration
Optional. The duration a user remains in the user list.
Valid durations are exact multiples of 24 hours (86400 seconds). Providing a value that is not an exact multiple of 24 hours will result in an INVALID_ARGUMENT error.
hasMembershipDuration
clearMembershipDuration
setMembershipDuration
Optional. The duration a user remains in the user list.
Valid durations are exact multiples of 24 hours (86400 seconds). Providing a value that is not an exact multiple of 24 hours will result in an INVALID_ARGUMENT error.
$this
getClosingReason
Output only. The reason why this user list membership status is closed.
int
hasClosingReason
clearClosingReason
setClosingReason
Output only. The reason why this user list membership status is closed.
var
int
$this
getAccessReason
Output only. The reason this account has been granted access to the list.
setAccessReason
Output only. The reason this account has been granted access to the list.
$this
getAccountAccessStatus
Optional. Indicates if this share is still enabled. When a user list is
shared with the account this field is set to ENABLED
. Later the user list
owner can decide to revoke the share and make it DISABLED
.
int
hasAccountAccessStatus
clearAccountAccessStatus
setAccountAccessStatus
Optional. Indicates if this share is still enabled. When a user list is
shared with the account this field is set to ENABLED
. Later the user list
owner can decide to revoke the share and make it DISABLED
.
var
int
$this
getSizeInfo
Output only. Estimated number of members in this user list in different target networks.
hasSizeInfo
clearSizeInfo
setSizeInfo
Output only. Estimated number of members in this user list in different target networks.
$this
getTargetNetworkInfo
Optional. Eligibility information for different target networks.
hasTargetNetworkInfo
clearTargetNetworkInfo
setTargetNetworkInfo
Optional. Eligibility information for different target networks.
$this
getIngestedUserListInfo
Optional. Represents a user list that is populated by user ingested data.
hasIngestedUserListInfo
setIngestedUserListInfo
Optional. Represents a user list that is populated by user ingested data.
$this
getUserListInfo
string
