Reference documentation and code samples for the Google Ads Data Manager V1 Client class PairIdInfo.
Additional information when PAIR_ID is one of the upload_key_types.
This feature is only available to data partners.
Generated from protobuf message google.ads.datamanager.v1.PairIdInfo
Namespace
Google \ Ads \ DataManager \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ publisher_id |
int|string
Required. Immutable. Identifies the publisher that the Publisher Advertiser Identity Reconciliation user list is reconciled with. This field is provided by the cleanroom provider and is only unique in the scope of that cleanroom. This cannot be used as a global identifier across multiple cleanrooms. |
↳ publisher_name |
string
Required. Descriptive name of the publisher to be displayed in the UI for a better targeting experience. |
↳ match_rate_percentage |
int
Required. This field denotes the percentage of membership match of this user list with the corresponding publisher's first party data. Must be between 0 and 100 inclusive. |
↳ advertiser_identifier_count |
int|string
Optional. The count of the advertiser's first party data records that have been uploaded to a clean room provider. This does not signify the size of a PAIR user list. |
↳ clean_room_identifier |
string
Required. Immutable. Identifies a unique advertiser to publisher relationship with one clean room provider or across multiple clean room providers. |
getPublisherId
Required. Immutable. Identifies the publisher that the Publisher Advertiser Identity Reconciliation user list is reconciled with. This field is provided by the cleanroom provider and is only unique in the scope of that cleanroom. This cannot be used as a global identifier across multiple cleanrooms.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
hasPublisherId
clearPublisherId
setPublisherId
Required. Immutable. Identifies the publisher that the Publisher Advertiser Identity Reconciliation user list is reconciled with. This field is provided by the cleanroom provider and is only unique in the scope of that cleanroom. This cannot be used as a global identifier across multiple cleanrooms.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPublisherName
Required. Descriptive name of the publisher to be displayed in the UI for a better targeting experience.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasPublisherName
clearPublisherName
setPublisherName
Required. Descriptive name of the publisher to be displayed in the UI for a better targeting experience.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMatchRatePercentage
Required. This field denotes the percentage of membership match of this user list with the corresponding publisher's first party data. Must be between 0 and 100 inclusive.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasMatchRatePercentage
clearMatchRatePercentage
setMatchRatePercentage
Required. This field denotes the percentage of membership match of this user list with the corresponding publisher's first party data. Must be between 0 and 100 inclusive.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAdvertiserIdentifierCount
Optional. The count of the advertiser's first party data records that have been uploaded to a clean room provider. This does not signify the size of a PAIR user list.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
hasAdvertiserIdentifierCount
clearAdvertiserIdentifierCount
setAdvertiserIdentifierCount
Optional. The count of the advertiser's first party data records that have been uploaded to a clean room provider. This does not signify the size of a PAIR user list.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCleanRoomIdentifier
Required. Immutable. Identifies a unique advertiser to publisher relationship with one clean room provider or across multiple clean room providers.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasCleanRoomIdentifier
clearCleanRoomIdentifier
setCleanRoomIdentifier
Required. Immutable. Identifies a unique advertiser to publisher relationship with one clean room provider or across multiple clean room providers.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|