public static final class PairIdInfo.Builder extends GeneratedMessage.Builder<PairIdInfo.Builder> implements PairIdInfoOrBuilder Additional information when PAIR_ID is one of the upload_key_types.
This feature is only available to data partners.
Protobuf type google.ads.datamanager.v1.PairIdInfo
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > PairIdInfo.BuilderImplements
PairIdInfoOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
build()
public PairIdInfo build()| Returns | |
|---|---|
| Type | Description |
PairIdInfo |
|
buildPartial()
public PairIdInfo buildPartial()| Returns | |
|---|---|
| Type | Description |
PairIdInfo |
|
clear()
public PairIdInfo.Builder clear()| Returns | |
|---|---|
| Type | Description |
PairIdInfo.Builder |
|
clearAdvertiserIdentifierCount()
public PairIdInfo.Builder clearAdvertiserIdentifierCount()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.
optional int64 advertiser_identifier_count = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
PairIdInfo.Builder |
This builder for chaining. |
clearCleanRoomIdentifier()
public PairIdInfo.Builder clearCleanRoomIdentifier()Required. Immutable. Identifies a unique advertiser to publisher relationship with one clean room provider or across multiple clean room providers.
optional string clean_room_identifier = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
PairIdInfo.Builder |
This builder for chaining. |
clearMatchRatePercentage()
public PairIdInfo.Builder clearMatchRatePercentage()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.
optional int32 match_rate_percentage = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
PairIdInfo.Builder |
This builder for chaining. |
clearPublisherId()
public PairIdInfo.Builder clearPublisherId()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.
optional int64 publisher_id = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
PairIdInfo.Builder |
This builder for chaining. |
clearPublisherName()
public PairIdInfo.Builder clearPublisherName()Required. Descriptive name of the publisher to be displayed in the UI for a better targeting experience.
optional string publisher_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
PairIdInfo.Builder |
This builder for chaining. |
getAdvertiserIdentifierCount()
public long 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.
optional int64 advertiser_identifier_count = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
long |
The advertiserIdentifierCount. |
getCleanRoomIdentifier()
public String getCleanRoomIdentifier()Required. Immutable. Identifies a unique advertiser to publisher relationship with one clean room provider or across multiple clean room providers.
optional string clean_room_identifier = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
String |
The cleanRoomIdentifier. |
getCleanRoomIdentifierBytes()
public ByteString getCleanRoomIdentifierBytes()Required. Immutable. Identifies a unique advertiser to publisher relationship with one clean room provider or across multiple clean room providers.
optional string clean_room_identifier = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for cleanRoomIdentifier. |
getDefaultInstanceForType()
public PairIdInfo getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
PairIdInfo |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getMatchRatePercentage()
public int 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.
optional int32 match_rate_percentage = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
int |
The matchRatePercentage. |
getPublisherId()
public long 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.
optional int64 publisher_id = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
long |
The publisherId. |
getPublisherName()
public String getPublisherName()Required. Descriptive name of the publisher to be displayed in the UI for a better targeting experience.
optional string publisher_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String |
The publisherName. |
getPublisherNameBytes()
public ByteString getPublisherNameBytes()Required. Descriptive name of the publisher to be displayed in the UI for a better targeting experience.
optional string publisher_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for publisherName. |
hasAdvertiserIdentifierCount()
public boolean hasAdvertiserIdentifierCount()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.
optional int64 advertiser_identifier_count = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the advertiserIdentifierCount field is set. |
hasCleanRoomIdentifier()
public boolean hasCleanRoomIdentifier()Required. Immutable. Identifies a unique advertiser to publisher relationship with one clean room provider or across multiple clean room providers.
optional string clean_room_identifier = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the cleanRoomIdentifier field is set. |
hasMatchRatePercentage()
public boolean hasMatchRatePercentage()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.
optional int32 match_rate_percentage = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the matchRatePercentage field is set. |
hasPublisherId()
public boolean hasPublisherId()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.
optional int64 publisher_id = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the publisherId field is set. |
hasPublisherName()
public boolean hasPublisherName()Required. Descriptive name of the publisher to be displayed in the UI for a better targeting experience.
optional string publisher_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the publisherName field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(PairIdInfo other)
public PairIdInfo.Builder mergeFrom(PairIdInfo other)| Parameter | |
|---|---|
| Name | Description |
other |
PairIdInfo |
| Returns | |
|---|---|
| Type | Description |
PairIdInfo.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public PairIdInfo.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
PairIdInfo.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public PairIdInfo.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
PairIdInfo.Builder |
|
setAdvertiserIdentifierCount(long value)
public PairIdInfo.Builder setAdvertiserIdentifierCount(long value)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.
optional int64 advertiser_identifier_count = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
longThe advertiserIdentifierCount to set. |
| Returns | |
|---|---|
| Type | Description |
PairIdInfo.Builder |
This builder for chaining. |
setCleanRoomIdentifier(String value)
public PairIdInfo.Builder setCleanRoomIdentifier(String value)Required. Immutable. Identifies a unique advertiser to publisher relationship with one clean room provider or across multiple clean room providers.
optional string clean_room_identifier = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe cleanRoomIdentifier to set. |
| Returns | |
|---|---|
| Type | Description |
PairIdInfo.Builder |
This builder for chaining. |
setCleanRoomIdentifierBytes(ByteString value)
public PairIdInfo.Builder setCleanRoomIdentifierBytes(ByteString value)Required. Immutable. Identifies a unique advertiser to publisher relationship with one clean room provider or across multiple clean room providers.
optional string clean_room_identifier = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for cleanRoomIdentifier to set. |
| Returns | |
|---|---|
| Type | Description |
PairIdInfo.Builder |
This builder for chaining. |
setMatchRatePercentage(int value)
public PairIdInfo.Builder setMatchRatePercentage(int value)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.
optional int32 match_rate_percentage = 3 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe matchRatePercentage to set. |
| Returns | |
|---|---|
| Type | Description |
PairIdInfo.Builder |
This builder for chaining. |
setPublisherId(long value)
public PairIdInfo.Builder setPublisherId(long value)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.
optional int64 publisher_id = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
| Parameter | |
|---|---|
| Name | Description |
value |
longThe publisherId to set. |
| Returns | |
|---|---|
| Type | Description |
PairIdInfo.Builder |
This builder for chaining. |
setPublisherName(String value)
public PairIdInfo.Builder setPublisherName(String value)Required. Descriptive name of the publisher to be displayed in the UI for a better targeting experience.
optional string publisher_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe publisherName to set. |
| Returns | |
|---|---|
| Type | Description |
PairIdInfo.Builder |
This builder for chaining. |
setPublisherNameBytes(ByteString value)
public PairIdInfo.Builder setPublisherNameBytes(ByteString value)Required. Descriptive name of the publisher to be displayed in the UI for a better targeting experience.
optional string publisher_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for publisherName to set. |
| Returns | |
|---|---|
| Type | Description |
PairIdInfo.Builder |
This builder for chaining. |