Class ProgrammaticBuyer (0.27.0)

public final class ProgrammaticBuyer extends GeneratedMessageV3 implements ProgrammaticBuyerOrBuilder

Represents a programmatic buyer.

Protobuf type google.ads.admanager.v1.ProgrammaticBuyer

Static Fields

AGENCY_FIELD_NUMBER

public static final int AGENCY_FIELD_NUMBER
Field Value
Type Description
int

BUYER_ACCOUNT_ID_FIELD_NUMBER

public static final int BUYER_ACCOUNT_ID_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PARENT_ACCOUNT_ID_FIELD_NUMBER

public static final int PARENT_ACCOUNT_ID_FIELD_NUMBER
Field Value
Type Description
int

PARTNER_CLIENT_ID_FIELD_NUMBER

public static final int PARTNER_CLIENT_ID_FIELD_NUMBER
Field Value
Type Description
int

PREFERRED_DEALS_ENABLED_FIELD_NUMBER

public static final int PREFERRED_DEALS_ENABLED_FIELD_NUMBER
Field Value
Type Description
int

PROGRAMMATIC_GUARANTEED_ENABLED_FIELD_NUMBER

public static final int PROGRAMMATIC_GUARANTEED_ENABLED_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ProgrammaticBuyer getDefaultInstance()
Returns
Type Description
ProgrammaticBuyer

getDescriptor()

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

newBuilder()

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

newBuilder(ProgrammaticBuyer prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAgency()

public boolean getAgency()

Output only. Whether the buyer is an advertising agency.

optional bool agency = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The agency.

getBuyerAccountId()

public long getBuyerAccountId()

Output only. The buyer account ID of the buyer.

optional int64 buyer_account_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The buyerAccountId.

getDefaultInstanceForType()

public ProgrammaticBuyer getDefaultInstanceForType()
Returns
Type Description
ProgrammaticBuyer

getDisplayName()

public String getDisplayName()

Output only. The display name of the buyer.

optional string display_name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Output only. The display name of the buyer.

optional string display_name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for displayName.

getName()

public String getName()

Identifier. The resource name of the ProgrammaticBuyer. Format: networks/{network_code}/programmaticBuyers/{buyer_account_id}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The resource name of the ProgrammaticBuyer. Format: networks/{network_code}/programmaticBuyers/{buyer_account_id}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getParentAccountId()

public long getParentAccountId()

Output only. The ID of the programmatic buyer's sponsor. If the buyer has no sponsor, this field will be -1.

optional int64 parent_account_id = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The parentAccountId.

getParserForType()

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

getPartnerClientId()

public String getPartnerClientId()

Output only. ID of the Display & Video 360 client buyer partner ID (if Display & Video 360) or Authorized Buyers client buyer account ID.

optional string partner_client_id = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The partnerClientId.

getPartnerClientIdBytes()

public ByteString getPartnerClientIdBytes()

Output only. ID of the Display & Video 360 client buyer partner ID (if Display & Video 360) or Authorized Buyers client buyer account ID.

optional string partner_client_id = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for partnerClientId.

getPreferredDealsEnabled()

public boolean getPreferredDealsEnabled()

Output only. Whether the buyer is enabled for preferred deals.

optional bool preferred_deals_enabled = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The preferredDealsEnabled.

getProgrammaticGuaranteedEnabled()

public boolean getProgrammaticGuaranteedEnabled()

Output only. Whether the buyer is enabled for programmatic guaranteed deals.

optional bool programmatic_guaranteed_enabled = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The programmaticGuaranteedEnabled.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasAgency()

public boolean hasAgency()

Output only. Whether the buyer is an advertising agency.

optional bool agency = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the agency field is set.

hasBuyerAccountId()

public boolean hasBuyerAccountId()

Output only. The buyer account ID of the buyer.

optional int64 buyer_account_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the buyerAccountId field is set.

hasDisplayName()

public boolean hasDisplayName()

Output only. The display name of the buyer.

optional string display_name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the displayName field is set.

hasParentAccountId()

public boolean hasParentAccountId()

Output only. The ID of the programmatic buyer's sponsor. If the buyer has no sponsor, this field will be -1.

optional int64 parent_account_id = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the parentAccountId field is set.

hasPartnerClientId()

public boolean hasPartnerClientId()

Output only. ID of the Display & Video 360 client buyer partner ID (if Display & Video 360) or Authorized Buyers client buyer account ID.

optional string partner_client_id = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the partnerClientId field is set.

hasPreferredDealsEnabled()

public boolean hasPreferredDealsEnabled()

Output only. Whether the buyer is enabled for preferred deals.

optional bool preferred_deals_enabled = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the preferredDealsEnabled field is set.

hasProgrammaticGuaranteedEnabled()

public boolean hasProgrammaticGuaranteedEnabled()

Output only. Whether the buyer is enabled for programmatic guaranteed deals.

optional bool programmatic_guaranteed_enabled = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the programmaticGuaranteedEnabled field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ProgrammaticBuyer.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ProgrammaticBuyer.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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