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

Reference documentation and code samples for the Google Ads Data Manager V1 Client class ListUserListGlobalLicenseCustomerInfosRequest.

Request to list all UserListGlobalLicenseCustomerInfo resources for a given user list global license.

Generated from protobuf message google.ads.datamanager.v1.ListUserListGlobalLicenseCustomerInfosRequest

Namespace

Google \ Ads \ DataManager \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ parent string

Required. The global license whose customer info are being queried. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}/userListGlobalLicenses/{USER_LIST_GLOBAL_LICENSE_ID}. To list all global license customer info under an account, replace the user list global license id with a '-' (for example, accountTypes/DATA_PARTNER/accounts/123/userListGlobalLicenses/-)
↳ filter string

Optional. Filters to apply to the list request. All fields need to be on the left hand side of each condition (for example: user_list_id = 123). Supported Operations: - AND - = - != - > - >= - < - <= Unsupported Fields: - name (use get method instead) - historical_pricings and all its subfields - pricing.start_time - pricing.end_time
↳ page_size int

Optional. The maximum number of licenses to return. The service may return fewer than this value. If unspecified, at most 50 licenses 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 ListUserListDirectLicense call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListUserListDirectLicense must match the call that provided the page token.

getParent

Required. The global license whose customer info are being queried. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}/userListGlobalLicenses/{USER_LIST_GLOBAL_LICENSE_ID}.

To list all global license customer info under an account, replace the user list global license id with a '-' (for example, accountTypes/DATA_PARTNER/accounts/123/userListGlobalLicenses/-)

Returns
Type Description
string

setParent

Required. The global license whose customer info are being queried. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}/userListGlobalLicenses/{USER_LIST_GLOBAL_LICENSE_ID}.

To list all global license customer info under an account, replace the user list global license id with a '-' (for example, accountTypes/DATA_PARTNER/accounts/123/userListGlobalLicenses/-)

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

Optional. Filters to apply to the list request. All fields need to be on the left hand side of each condition (for example: user_list_id = 123).

Supported Operations:

  • AND
  • =
  • !=
  • >
  • >=
  • <
  • <= Unsupported Fields:
  • name (use get method instead)
  • historical_pricings and all its subfields
  • pricing.start_time
  • pricing.end_time
Returns
Type Description
string

setFilter

Optional. Filters to apply to the list request. All fields need to be on the left hand side of each condition (for example: user_list_id = 123).

Supported Operations:

  • AND
  • =
  • !=
  • >
  • >=
  • <
  • <= Unsupported Fields:
  • name (use get method instead)
  • historical_pricings and all its subfields
  • pricing.start_time
  • pricing.end_time
Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

Optional. The maximum number of licenses to return. The service may return fewer than this value. If unspecified, at most 50 licenses 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 licenses to return. The service may return fewer than this value. If unspecified, at most 50 licenses 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 ListUserListDirectLicense call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListUserListDirectLicense must match the call that provided the page token.

Returns
Type Description
string

setPageToken

Optional. A page token, received from a previous ListUserListDirectLicense call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListUserListDirectLicense must match the call that provided the page token.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The global license whose customer info are being queried. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}/userListGlobalLicenses/{USER_LIST_GLOBAL_LICENSE_ID}. To list all global license customer info under an account, replace the user list global license id with a '-' (for example, accountTypes/DATA_PARTNER/accounts/123/userListGlobalLicenses/-) Please see UserListGlobalLicenseServiceClient::userListGlobalLicenseName() for help formatting this field.
Returns
Type Description
ListUserListGlobalLicenseCustomerInfosRequest