Google Ads Data Manager V1 Client - Class ListUserListsRequest (0.2.0)

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 \ V1

Methods

__construct

Constructor.

Parameters
Name Description
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"). 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}

Returns
Type Description
string

setParent

Required. The parent account which owns this collection of user lists.

Format: accountTypes/{account_type}/accounts/{account}

Parameter
Name Description
var string
Returns
Type Description
$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.

Returns
Type Description
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.

Parameter
Name Description
var int
Returns
Type Description
$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.

Returns
Type Description
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.

Parameter
Name Description
var string
Returns
Type Description
$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").

Supported operations:

  • AND
  • =
  • !=
  • >
  • >=
  • <
  • <=
  • : (has) Supported fields:
  • id
  • display_name
  • description
  • membership_status
  • integration_code
  • access_reason
  • ingested_user_list_info.upload_key_types
Returns
Type Description
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").

Supported operations:

  • AND
  • =
  • !=
  • >
  • >=
  • <
  • <=
  • : (has) Supported fields:
  • id
  • display_name
  • description
  • membership_status
  • integration_code
  • access_reason
  • ingested_user_list_info.upload_key_types
Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
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.
Returns
Type Description
ListUserListsRequest