Class PairIdInfo (0.8.0)

public final class PairIdInfo extends GeneratedMessage 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

Implements

PairIdInfoOrBuilder

Static Fields

ADVERTISER_IDENTIFIER_COUNT_FIELD_NUMBER

public static final int ADVERTISER_IDENTIFIER_COUNT_FIELD_NUMBER
Field Value
Type Description
int

CLEAN_ROOM_IDENTIFIER_FIELD_NUMBER

public static final int CLEAN_ROOM_IDENTIFIER_FIELD_NUMBER
Field Value
Type Description
int

MATCH_RATE_PERCENTAGE_FIELD_NUMBER

public static final int MATCH_RATE_PERCENTAGE_FIELD_NUMBER
Field Value
Type Description
int

PUBLISHER_ID_FIELD_NUMBER

public static final int PUBLISHER_ID_FIELD_NUMBER
Field Value
Type Description
int

PUBLISHER_NAME_FIELD_NUMBER

public static final int PUBLISHER_NAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PairIdInfo getDefaultInstance()
Returns
Type Description
PairIdInfo

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static PairIdInfo.Builder newBuilder()
Returns
Type Description
PairIdInfo.Builder

newBuilder(PairIdInfo prototype)

public static PairIdInfo.Builder newBuilder(PairIdInfo prototype)
Parameter
Name Description
prototype PairIdInfo
Returns
Type Description
PairIdInfo.Builder

parseDelimitedFrom(InputStream input)

public static PairIdInfo parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PairIdInfo
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PairIdInfo parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PairIdInfo
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static PairIdInfo parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
PairIdInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PairIdInfo parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PairIdInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PairIdInfo parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
PairIdInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PairIdInfo parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PairIdInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PairIdInfo parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
PairIdInfo
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PairIdInfo parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PairIdInfo
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static PairIdInfo parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PairIdInfo
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PairIdInfo parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PairIdInfo
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static PairIdInfo parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
PairIdInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PairIdInfo parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PairIdInfo
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<PairIdInfo> parser()
Returns
Type Description
Parser<PairIdInfo>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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

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.

getParserForType()

public Parser<PairIdInfo> getParserForType()
Returns
Type Description
Parser<PairIdInfo>
Overrides

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public PairIdInfo.Builder newBuilderForType()
Returns
Type Description
PairIdInfo.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected PairIdInfo.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
PairIdInfo.Builder
Overrides

toBuilder()

public PairIdInfo.Builder toBuilder()
Returns
Type Description
PairIdInfo.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException