Reference documentation and code samples for the Google Ads Data Manager V1 Client class ListUserListsRequest.
Request message for ListUserLists.
Generated from protobuf message google.ads.datamanager.v1.ListUserListsRequest
Namespace
Google \ Ads \ DataManager \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The parent account which owns this collection of user lists. Format: accountTypes/{account_type}/accounts/{account}
↳ page_size
int
Optional. The maximum number of user lists to return. The service may return fewer than this value. If unspecified, at most 50 user lists 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 ListUserLists
call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListUserLists
must match the call that provided the page token.
↳ filter
string
Optional. A filter string
. All fields need to be on the left hand side of each condition (for example: display_name = "list 1"
). Fields must be specified using either all camel case
or all snake case
. Don't use a combination of camel case and snake case. Supported operations: - AND
- =
- !=
- >
- >=
- <
- <=
- :
(has) Supported fields: - id
- display_name
- description
- membership_status
- integration_code
- access_reason
- ingested_user_list_info.upload_key_types
getParent
Required. The parent account which owns this collection of user lists.
Format: accountTypes/{account_type}/accounts/{account}
string
setParent
Required. The parent account which owns this collection of user lists.
Format: accountTypes/{account_type}/accounts/{account}
var
string
$this
getPageSize
Optional. The maximum number of user lists to return. The service may return fewer than this value. If unspecified, at most 50 user lists will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
int
setPageSize
Optional. The maximum number of user lists to return. The service may return fewer than this value. If unspecified, at most 50 user lists will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
var
int
$this
getPageToken
Optional. A page token, received from a previous ListUserLists
call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListUserLists
must
match the call that provided the page token.
string
setPageToken
Optional. A page token, received from a previous ListUserLists
call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListUserLists
must
match the call that provided the page token.
var
string
$this
getFilter
Optional. A filter string
. All fields need to
be on the left hand side of each condition (for example: display_name =
"list 1"
). Fields must be specified using either all camel
case
or all snake
case
. Don't use a combination of
camel case and snake case.
Supported operations:
-
AND -
= -
!= -
> -
>= -
< -
<= -
:(has) Supported fields: -
id -
display_name -
description -
membership_status -
integration_code -
access_reason -
ingested_user_list_info.upload_key_types
string
setFilter
Optional. A filter string
. All fields need to
be on the left hand side of each condition (for example: display_name =
"list 1"
). Fields must be specified using either all camel
case
or all snake
case
. Don't use a combination of
camel case and snake case.
Supported operations:
-
AND -
= -
!= -
> -
>= -
< -
<= -
:(has) Supported fields: -
id -
display_name -
description -
membership_status -
integration_code -
access_reason -
ingested_user_list_info.upload_key_types
var
string
$this
static::build
parent
string
Required. The parent account which owns this collection of user lists. Format: accountTypes/{account_type}/accounts/{account} Please see UserListServiceClient::accountName() for help formatting this field.
