Class BuyerRfp (0.62.0)

public final class BuyerRfp extends GeneratedMessage implements BuyerRfpOrBuilder

Represents the buyer RFP information associated with a Proposal describing the requirements from the buyer.

Protobuf type google.ads.admanager.v1.BuyerRfp

Implements

BuyerRfpOrBuilder

Static Fields

ADDITIONAL_TERMS_FIELD_NUMBER

public static final int ADDITIONAL_TERMS_FIELD_NUMBER
Field Value
Type Description
int

AD_EXCHANGE_ENVIRONMENT_FIELD_NUMBER

public static final int AD_EXCHANGE_ENVIRONMENT_FIELD_NUMBER
Field Value
Type Description
int

BUDGET_FIELD_NUMBER

public static final int BUDGET_FIELD_NUMBER
Field Value
Type Description
int

COST_PER_UNIT_FIELD_NUMBER

public static final int COST_PER_UNIT_FIELD_NUMBER
Field Value
Type Description
int

CREATIVE_PLACEHOLDERS_FIELD_NUMBER

public static final int CREATIVE_PLACEHOLDERS_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER
Field Value
Type Description
int

RFP_TYPE_FIELD_NUMBER

public static final int RFP_TYPE_FIELD_NUMBER
Field Value
Type Description
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER
Field Value
Type Description
int

TARGETING_FIELD_NUMBER

public static final int TARGETING_FIELD_NUMBER
Field Value
Type Description
int

UNITS_FIELD_NUMBER

public static final int UNITS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static BuyerRfp getDefaultInstance()
Returns
Type Description
BuyerRfp

getDescriptor()

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

newBuilder()

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

newBuilder(BuyerRfp prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAdExchangeEnvironment()

public ProposalEnvironmentTypeEnum.ProposalEnvironmentType getAdExchangeEnvironment()

Output only. Identifies the format of the inventory or "channel" through which the ad serves. Environments currently supported include DISPLAY, VIDEO, and MOBILE.

optional .google.ads.admanager.v1.ProposalEnvironmentTypeEnum.ProposalEnvironmentType ad_exchange_environment = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ProposalEnvironmentTypeEnum.ProposalEnvironmentType

The adExchangeEnvironment.

getAdExchangeEnvironmentValue()

public int getAdExchangeEnvironmentValue()

Output only. Identifies the format of the inventory or "channel" through which the ad serves. Environments currently supported include DISPLAY, VIDEO, and MOBILE.

optional .google.ads.admanager.v1.ProposalEnvironmentTypeEnum.ProposalEnvironmentType ad_exchange_environment = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for adExchangeEnvironment.

getAdditionalTerms()

public String getAdditionalTerms()

Output only. Additional terms of the deal in question. This field can be used to state more specific targeting information for the deal, as well as any additional information regarding this deal. Given that this field belongs to a request for proposal (for which initially a Proposal does not yet exist), this field can be populated by buyers to specify additional information that they wish publishers to incorporate into the Proposal derived from this request for proposal.

optional string additional_terms = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The additionalTerms.

getAdditionalTermsBytes()

public ByteString getAdditionalTermsBytes()

Output only. Additional terms of the deal in question. This field can be used to state more specific targeting information for the deal, as well as any additional information regarding this deal. Given that this field belongs to a request for proposal (for which initially a Proposal does not yet exist), this field can be populated by buyers to specify additional information that they wish publishers to incorporate into the Proposal derived from this request for proposal.

optional string additional_terms = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for additionalTerms.

getBudget()

public Money getBudget()

Output only. Total amount of money available to spend on this deal. In the case of a Preferred Deal, the budget is equal to the maximum amount of money a buyer is willing to spend on a given Proposal, even though the budget might not be spent entirely, as impressions are not guaranteed.

.google.type.Money budget = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.type.Money

The budget.

getBudgetOrBuilder()

public MoneyOrBuilder getBudgetOrBuilder()

Output only. Total amount of money available to spend on this deal. In the case of a Preferred Deal, the budget is equal to the maximum amount of money a buyer is willing to spend on a given Proposal, even though the budget might not be spent entirely, as impressions are not guaranteed.

.google.type.Money budget = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.type.MoneyOrBuilder

getCostPerUnit()

public Money getCostPerUnit()

Output only. CPM for the Proposal in question. Given that this field belongs to a request for proposal (for which initially a Proposal does not yet exist), this field should serve as guidance for publishers to create a Proposal with LineItems reflecting this CPM.

.google.type.Money cost_per_unit = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.type.Money

The costPerUnit.

getCostPerUnitOrBuilder()

public MoneyOrBuilder getCostPerUnitOrBuilder()

Output only. CPM for the Proposal in question. Given that this field belongs to a request for proposal (for which initially a Proposal does not yet exist), this field should serve as guidance for publishers to create a Proposal with LineItems reflecting this CPM.

.google.type.Money cost_per_unit = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.type.MoneyOrBuilder

getCreativePlaceholders(int index)

public CreativePlaceholder getCreativePlaceholders(int index)

Output only. A list of inventory sizes in which creatives will eventually be served.

repeated .google.ads.admanager.v1.CreativePlaceholder creative_placeholders = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
CreativePlaceholder

getCreativePlaceholdersCount()

public int getCreativePlaceholdersCount()

Output only. A list of inventory sizes in which creatives will eventually be served.

repeated .google.ads.admanager.v1.CreativePlaceholder creative_placeholders = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getCreativePlaceholdersList()

public List<CreativePlaceholder> getCreativePlaceholdersList()

Output only. A list of inventory sizes in which creatives will eventually be served.

repeated .google.ads.admanager.v1.CreativePlaceholder creative_placeholders = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<CreativePlaceholder>

getCreativePlaceholdersOrBuilder(int index)

public CreativePlaceholderOrBuilder getCreativePlaceholdersOrBuilder(int index)

Output only. A list of inventory sizes in which creatives will eventually be served.

repeated .google.ads.admanager.v1.CreativePlaceholder creative_placeholders = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
CreativePlaceholderOrBuilder

getCreativePlaceholdersOrBuilderList()

public List<? extends CreativePlaceholderOrBuilder> getCreativePlaceholdersOrBuilderList()

Output only. A list of inventory sizes in which creatives will eventually be served.

repeated .google.ads.admanager.v1.CreativePlaceholder creative_placeholders = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.ads.admanager.v1.CreativePlaceholderOrBuilder>

getDefaultInstanceForType()

public BuyerRfp getDefaultInstanceForType()
Returns
Type Description
BuyerRfp

getDescription()

public String getDescription()

Output only. A description of the proposed deal. This can be used for the buyer to tell the publisher more detailed information about the deal in question.

optional string description = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Output only. A description of the proposed deal. This can be used for the buyer to tell the publisher more detailed information about the deal in question.

optional string description = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for description.

getEndTime()

public Timestamp getEndTime()

Output only. The time at which the proposed deal should end serving.

.google.protobuf.Timestamp end_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The endTime.

getEndTimeOrBuilder()

public TimestampOrBuilder getEndTimeOrBuilder()

Output only. The time at which the proposed deal should end serving.

.google.protobuf.Timestamp end_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getParserForType()

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

getRfpType()

public BuyerRfpTypeEnum.BuyerRfpType getRfpType()

Output only. Deal type; either Programmatic Guaranteed or Preferred Deal. This field corresponds to the type of Proposal that a buyer wishes to negotiate with a seller.

optional .google.ads.admanager.v1.BuyerRfpTypeEnum.BuyerRfpType rfp_type = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
BuyerRfpTypeEnum.BuyerRfpType

The rfpType.

getRfpTypeValue()

public int getRfpTypeValue()

Output only. Deal type; either Programmatic Guaranteed or Preferred Deal. This field corresponds to the type of Proposal that a buyer wishes to negotiate with a seller.

optional .google.ads.admanager.v1.BuyerRfpTypeEnum.BuyerRfpType rfp_type = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for rfpType.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStartTime()

public Timestamp getStartTime()

Output only. The time at which the proposed deal should start serving.

.google.protobuf.Timestamp start_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The startTime.

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

Output only. The time at which the proposed deal should start serving.

.google.protobuf.Timestamp start_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getTargeting()

public Targeting getTargeting()

Output only. Targeting information for the proposal in question. Currently this field only contains GeoTargeting information.

.google.ads.admanager.v1.Targeting targeting = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Targeting

The targeting.

getTargetingOrBuilder()

public TargetingOrBuilder getTargetingOrBuilder()

Output only. Targeting information for the proposal in question. Currently this field only contains GeoTargeting information.

.google.ads.admanager.v1.Targeting targeting = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TargetingOrBuilder

getUnits()

public long getUnits()

Output only. The number of impressions per day that a buyer wishes to see in the Proposal derived from the request for proposal in question.

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

Returns
Type Description
long

The units.

hasAdExchangeEnvironment()

public boolean hasAdExchangeEnvironment()

Output only. Identifies the format of the inventory or "channel" through which the ad serves. Environments currently supported include DISPLAY, VIDEO, and MOBILE.

optional .google.ads.admanager.v1.ProposalEnvironmentTypeEnum.ProposalEnvironmentType ad_exchange_environment = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the adExchangeEnvironment field is set.

hasAdditionalTerms()

public boolean hasAdditionalTerms()

Output only. Additional terms of the deal in question. This field can be used to state more specific targeting information for the deal, as well as any additional information regarding this deal. Given that this field belongs to a request for proposal (for which initially a Proposal does not yet exist), this field can be populated by buyers to specify additional information that they wish publishers to incorporate into the Proposal derived from this request for proposal.

optional string additional_terms = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the additionalTerms field is set.

hasBudget()

public boolean hasBudget()

Output only. Total amount of money available to spend on this deal. In the case of a Preferred Deal, the budget is equal to the maximum amount of money a buyer is willing to spend on a given Proposal, even though the budget might not be spent entirely, as impressions are not guaranteed.

.google.type.Money budget = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the budget field is set.

hasCostPerUnit()

public boolean hasCostPerUnit()

Output only. CPM for the Proposal in question. Given that this field belongs to a request for proposal (for which initially a Proposal does not yet exist), this field should serve as guidance for publishers to create a Proposal with LineItems reflecting this CPM.

.google.type.Money cost_per_unit = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the costPerUnit field is set.

hasDescription()

public boolean hasDescription()

Output only. A description of the proposed deal. This can be used for the buyer to tell the publisher more detailed information about the deal in question.

optional string description = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the description field is set.

hasEndTime()

public boolean hasEndTime()

Output only. The time at which the proposed deal should end serving.

.google.protobuf.Timestamp end_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the endTime field is set.

hasRfpType()

public boolean hasRfpType()

Output only. Deal type; either Programmatic Guaranteed or Preferred Deal. This field corresponds to the type of Proposal that a buyer wishes to negotiate with a seller.

optional .google.ads.admanager.v1.BuyerRfpTypeEnum.BuyerRfpType rfp_type = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the rfpType field is set.

hasStartTime()

public boolean hasStartTime()

Output only. The time at which the proposed deal should start serving.

.google.protobuf.Timestamp start_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the startTime field is set.

hasTargeting()

public boolean hasTargeting()

Output only. Targeting information for the proposal in question. Currently this field only contains GeoTargeting information.

.google.ads.admanager.v1.Targeting targeting = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the targeting field is set.

hasUnits()

public boolean hasUnits()

Output only. The number of impressions per day that a buyer wishes to see in the Proposal derived from the request for proposal in question.

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

Returns
Type Description
boolean

Whether the units 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 BuyerRfp.Builder newBuilderForType()
Returns
Type Description
BuyerRfp.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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