Reference documentation and code samples for the Google Ads Data Manager V1 Client class UserListDirectLicense.
A user list direct license.
This feature is only available to data partners.
Generated from protobuf message google.ads.datamanager.v1.UserListDirectLicense
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 direct license. |
↳ user_list_id |
int|string
Immutable. ID of the user list being licensed. |
↳ user_list_display_name |
string
Output only. Name of the user list being licensed. This field is read-only. |
↳ client_account_type |
int
Immutable. Account type of client customer which the user list is being licensed to. |
↳ client_account_id |
int|string
Immutable. 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. This field is read-only. |
↳ status |
int
Optional. Status of UserListDirectLicense - ENABLED or DISABLED. |
↳ pricing |
UserListLicensePricing
Optional. UserListDirectLicense pricing. |
↳ historical_pricings |
array<UserListLicensePricing>
Output only. Pricing history of this user list license. This field is read-only. |
↳ metrics |
UserListLicenseMetrics
Output only. Metrics related to this license This field is read-only and only populated if the start and end dates are set in the ListUserListDirectLicenses call |
getName
Identifier. The resource name of the user list direct license.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. The resource name of the user list direct license.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUserListId
Immutable. ID of the user list being licensed.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
hasUserListId
clearUserListId
setUserListId
Immutable. 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.
This field is read-only.
| Returns | |
|---|---|
| Type | Description |
string |
|
setUserListDisplayName
Output only. Name of the user list being licensed.
This field is read-only.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getClientAccountType
Immutable. Account type of client customer which the user list is being licensed to.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasClientAccountType
clearClientAccountType
setClientAccountType
Immutable. Account type of client customer which the user list is being licensed to.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getClientAccountId
Immutable. ID of client customer which the user list is being licensed to.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
hasClientAccountId
clearClientAccountId
setClientAccountId
Immutable. 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.
This field is read-only.
| Returns | |
|---|---|
| Type | Description |
string |
|
setClientAccountDisplayName
Output only. Name of client customer which the user list is being licensed to.
This field is read-only.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStatus
Optional. Status of UserListDirectLicense - ENABLED or DISABLED.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasStatus
clearStatus
setStatus
Optional. Status of UserListDirectLicense - ENABLED or DISABLED.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPricing
Optional. UserListDirectLicense pricing.
| Returns | |
|---|---|
| Type | Description |
UserListLicensePricing|null |
|
hasPricing
clearPricing
setPricing
Optional. UserListDirectLicense pricing.
| Parameter | |
|---|---|
| Name | Description |
var |
UserListLicensePricing
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getHistoricalPricings
Output only. Pricing history of this user list license.
This field is read-only.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setHistoricalPricings
Output only. Pricing history of this user list license.
This field is read-only.
| Parameter | |
|---|---|
| Name | Description |
var |
array<UserListLicensePricing>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMetrics
Output only. Metrics related to this license This field is read-only and only populated if the start and end dates are set in the ListUserListDirectLicenses call
| Returns | |
|---|---|
| Type | Description |
UserListLicenseMetrics|null |
|
hasMetrics
clearMetrics
setMetrics
Output only. Metrics related to this license This field is read-only and only populated if the start and end dates are set in the ListUserListDirectLicenses call
| Parameter | |
|---|---|
| Name | Description |
var |
UserListLicenseMetrics
|
| Returns | |
|---|---|
| Type | Description |
$this |
|