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.
| Parameters | |
|---|---|
| Name | Description |
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 |
↳ size_info |
SizeInfo
Output only. Estimated number of members in this user list in different target networks. |
↳ target_network_info |
TargetNetworkInfo
Optional. Eligibility information for different target networks. |
↳ ingested_user_list_info |
IngestedUserListInfo
Optional. Represents a user list that is populated by user ingested data. |
getName
Identifier. The resource name of the user list.
Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. The resource name of the user list.
Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getId
Output only. The unique ID of the user list.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
setId
Output only. The unique ID of the user list.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getReadOnly
Output only. An option that indicates if a user may edit a list.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setReadOnly
Output only. An option that indicates if a user may edit a list.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
Required. The display name of the user list.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasDisplayName
clearDisplayName
setDisplayName
Required. The display name of the user list.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Optional. A description of the user list.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasDescription
clearDescription
setDescription
Optional. A description of the user list.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMembershipStatus
Optional. Membership status of this user list.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasMembershipStatus
clearMembershipStatus
setMembershipStatus
Optional. Membership status of this user list.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getIntegrationCode
Optional. An ID from external system. It is used by user list sellers to correlate IDs on their systems.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasIntegrationCode
clearIntegrationCode
setIntegrationCode
Optional. An ID from external system. It is used by user list sellers to correlate IDs on their systems.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null |
|
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getClosingReason
Output only. The reason why this user list membership status is closed.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasClosingReason
clearClosingReason
setClosingReason
Output only. The reason why this user list membership status is closed.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAccessReason
Output only. The reason this account has been granted access to the list.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type AccessReason. |
setAccessReason
Output only. The reason this account has been granted access to the list.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type AccessReason. |
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSizeInfo
Output only. Estimated number of members in this user list in different target networks.
| Returns | |
|---|---|
| Type | Description |
SizeInfo|null |
|
hasSizeInfo
clearSizeInfo
setSizeInfo
Output only. Estimated number of members in this user list in different target networks.
| Parameter | |
|---|---|
| Name | Description |
var |
SizeInfo
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTargetNetworkInfo
Optional. Eligibility information for different target networks.
| Returns | |
|---|---|
| Type | Description |
TargetNetworkInfo|null |
|
hasTargetNetworkInfo
clearTargetNetworkInfo
setTargetNetworkInfo
Optional. Eligibility information for different target networks.
| Parameter | |
|---|---|
| Name | Description |
var |
TargetNetworkInfo
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getIngestedUserListInfo
Optional. Represents a user list that is populated by user ingested data.
| Returns | |
|---|---|
| Type | Description |
IngestedUserListInfo|null |
|
hasIngestedUserListInfo
setIngestedUserListInfo
Optional. Represents a user list that is populated by user ingested data.
| Parameter | |
|---|---|
| Name | Description |
var |
IngestedUserListInfo
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUserListInfo
| Returns | |
|---|---|
| Type | Description |
string |
|