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

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

Information about a customer of a user list global license. This will automatically be created by the system when a customer purchases a global license.

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

Namespace

Google \ Ads \ DataManager \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

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

Identifier. The resource name of the user list global license customer.
↳ user_list_id int|string

Output only. ID of the user list being licensed.
↳ user_list_display_name string

Output only. Name of the user list being licensed.
↳ license_type int

Output only. Product type of client customer which the user list is being licensed to.
↳ status int

Output only. Status of UserListDirectLicense - ENABLED or DISABLED.
↳ pricing UserListLicensePricing

Output only. UserListDirectLicense pricing.
↳ client_account_type int

Output only. Product type of client customer which the user list is being licensed to.
↳ client_account_id int|string

Output only. ID of client customer which the user list is being licensed to.
↳ client_account_display_name string

Output only. Name of client customer which the user list is being licensed to.
↳ historical_pricings array<UserListLicensePricing>

Output only. Pricing history of this user list license.
↳ metrics UserListLicenseMetrics

Output only. Metrics related to this license This field is only populated if the start and end dates are set in the ListUserListGlobalLicenseCustomerInfos call.

getName

Identifier. The resource name of the user list global license customer.

Returns
Type Description
string

setName

Identifier. The resource name of the user list global license customer.

Parameter
Name Description
var string
Returns
Type Description
$this

getUserListId

Output only. ID of the user list being licensed.

Returns
Type Description
int|string

setUserListId

Output only. ID of the user list being licensed.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getUserListDisplayName

Output only. Name of the user list being licensed.

Returns
Type Description
string

setUserListDisplayName

Output only. Name of the user list being licensed.

Parameter
Name Description
var string
Returns
Type Description
$this

getLicenseType

Output only. Product type of client customer which the user list is being licensed to.

Returns
Type Description
int Enum of type UserListGlobalLicenseType.

setLicenseType

Output only. Product type of client customer which the user list is being licensed to.

Parameter
Name Description
var int

Enum of type UserListGlobalLicenseType.

Returns
Type Description
$this

getStatus

Output only. Status of UserListDirectLicense - ENABLED or DISABLED.

Returns
Type Description
int Enum of type UserListLicenseStatus.

setStatus

Output only. Status of UserListDirectLicense - ENABLED or DISABLED.

Parameter
Name Description
var int

Enum of type UserListLicenseStatus.

Returns
Type Description
$this

getPricing

Output only. UserListDirectLicense pricing.

Returns
Type Description
UserListLicensePricing|null

hasPricing

clearPricing

setPricing

Output only. UserListDirectLicense pricing.

Parameter
Name Description
var UserListLicensePricing
Returns
Type Description
$this

getClientAccountType

Output only. Product type of client customer which the user list is being licensed to.

Returns
Type Description
int Enum of type UserListLicenseClientAccountType.

setClientAccountType

Output only. Product type of client customer which the user list is being licensed to.

Parameter
Name Description
var int

Enum of type UserListLicenseClientAccountType.

Returns
Type Description
$this

getClientAccountId

Output only. ID of client customer which the user list is being licensed to.

Returns
Type Description
int|string

setClientAccountId

Output only. ID of client customer which the user list is being licensed to.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getClientAccountDisplayName

Output only. Name of client customer which the user list is being licensed to.

Returns
Type Description
string

setClientAccountDisplayName

Output only. Name of client customer which the user list is being licensed to.

Parameter
Name Description
var string
Returns
Type Description
$this

getHistoricalPricings

Output only. Pricing history of this user list license.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setHistoricalPricings

Output only. Pricing history of this user list license.

Parameter
Name Description
var array<UserListLicensePricing>
Returns
Type Description
$this

getMetrics

Output only. Metrics related to this license This field is only populated if the start and end dates are set in the ListUserListGlobalLicenseCustomerInfos call.

Returns
Type Description
UserListLicenseMetrics|null

hasMetrics

clearMetrics

setMetrics

Output only. Metrics related to this license This field is only populated if the start and end dates are set in the ListUserListGlobalLicenseCustomerInfos call.

Parameter
Name Description
var UserListLicenseMetrics
Returns
Type Description
$this