Interface PrivateOfferOrBuilder (0.1.0) 

public interface PrivateOfferOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAcceptDeadlineTime()

public abstract DateTime getAcceptDeadlineTime()

Optional. Deadline for acceptance of published offers. A published offer not accepted by this time will expire. Only day boundaries in the America/Los_Angeles time zone are supported. Must be present to publish the offer.

When publishing an offer the deadline must be set to a time in the future not more than 3 months from the time of publishing. For example, if the offer is published on 03/05 at 1PM, then the deadline must be at or before 06/05 12AM America/Los_Angeles time.

The deadline must also be:

  • Before or equal to the scheduled start time of this offer (if term.scheduled_start_time is set and the term's start policy is SCHEDULED_START_TIME).
  • Before or equal to the scheduled end time of this offer, if term.scheduled_end_time is set and the term's end policy is SCHEDULED_END_TIME.
  • Before or equal to the upcoming installment start times on this offer.
  • Before or equal to the amended offer's end time, if the offer amends another private or standard offer.

  • Before or equal to the start time of the next pending installment of the amended offer, if amending a private offer with custom installments. For example, if the amended offer has installments on 01/01, 02/01, 03/01, 04/01, and today is 02/15, then this offer's accept_deadline_time must be at or before 03/01.

    In addition, if the offer amends another private offer, but there is already an accepted upcoming amendment against that private offer, then this deadline must be before or equal to the start time of the accepted upcoming offer. For example, today is 02/15, and this offer (offer C) amends private offer A, and private offer B has already been accepted which also amends private offer A. Private offer B has a start time of 03/01. Then this deadline must be at or before 03/01. Otherwise, on 03/01, private offer B would take effect, superseding offer A. This would mean offer C is no longer amending the currently active offer (Offer A), which is required for valid amendments.

    Once the offer is published, this field is still updatable to extend the deadline of the offer. However, the extension is still limited to be at most 3 months from the time of publishing.

.google.type.DateTime accept_deadline_time = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
com.google.type.DateTime

The acceptDeadlineTime.

getAcceptDeadlineTimeOrBuilder()

public abstract DateTimeOrBuilder getAcceptDeadlineTimeOrBuilder()

Optional. Deadline for acceptance of published offers. A published offer not accepted by this time will expire. Only day boundaries in the America/Los_Angeles time zone are supported. Must be present to publish the offer.

When publishing an offer the deadline must be set to a time in the future not more than 3 months from the time of publishing. For example, if the offer is published on 03/05 at 1PM, then the deadline must be at or before 06/05 12AM America/Los_Angeles time.

The deadline must also be:

  • Before or equal to the scheduled start time of this offer (if term.scheduled_start_time is set and the term's start policy is SCHEDULED_START_TIME).
  • Before or equal to the scheduled end time of this offer, if term.scheduled_end_time is set and the term's end policy is SCHEDULED_END_TIME.
  • Before or equal to the upcoming installment start times on this offer.
  • Before or equal to the amended offer's end time, if the offer amends another private or standard offer.

  • Before or equal to the start time of the next pending installment of the amended offer, if amending a private offer with custom installments. For example, if the amended offer has installments on 01/01, 02/01, 03/01, 04/01, and today is 02/15, then this offer's accept_deadline_time must be at or before 03/01.

    In addition, if the offer amends another private offer, but there is already an accepted upcoming amendment against that private offer, then this deadline must be before or equal to the start time of the accepted upcoming offer. For example, today is 02/15, and this offer (offer C) amends private offer A, and private offer B has already been accepted which also amends private offer A. Private offer B has a start time of 03/01. Then this deadline must be at or before 03/01. Otherwise, on 03/01, private offer B would take effect, superseding offer A. This would mean offer C is no longer amending the currently active offer (Offer A), which is required for valid amendments.

    Once the offer is published, this field is still updatable to extend the deadline of the offer. However, the extension is still limited to be at most 3 months from the time of publishing.

.google.type.DateTime accept_deadline_time = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
com.google.type.DateTimeOrBuilder

getAcceptTime()

public abstract Timestamp getAcceptTime()

Output only. The time the offer transitioned to ACCEPTED state.

.google.protobuf.Timestamp accept_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The acceptTime.

getAcceptTimeOrBuilder()

public abstract TimestampOrBuilder getAcceptTimeOrBuilder()

Output only. The time the offer transitioned to ACCEPTED state.

.google.protobuf.Timestamp accept_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getCancelTime()

public abstract Timestamp getCancelTime()

Output only. The time the offer transited to CANCELLED state.

.google.protobuf.Timestamp cancel_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The cancelTime.

getCancelTimeOrBuilder()

public abstract TimestampOrBuilder getCancelTimeOrBuilder()

Output only. The time the offer transited to CANCELLED state.

.google.protobuf.Timestamp cancel_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getCancellationNote()

public abstract String getCancellationNote()

Output only. Internal note supplied when the offer was cancelled. Present only for cancelled offers and only if a note was supplied.

string cancellation_note = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The cancellationNote.

getCancellationNoteBytes()

public abstract ByteString getCancellationNoteBytes()

Output only. Internal note supplied when the offer was cancelled. Present only for cancelled offers and only if a note was supplied.

string cancellation_note = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for cancellationNote.

getContentCase()

public abstract PrivateOffer.ContentCase getContentCase()
Returns
Type Description
PrivateOffer.ContentCase

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. The creation time.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The creation time.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getCustomer()

public abstract PrivateOffer.Customer getCustomer()

Optional. Information identifying the intended recipient of the offer. Must be provided when publishing the offer.

.google.cloud.commerceproducer.v1beta.PrivateOffer.Customer customer = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PrivateOffer.Customer

The customer.

getCustomerNote()

public abstract String getCustomerNote()

Optional. Unstructured text content that is visible to the customer. Maximum length: 120 characters.

string customer_note = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The customerNote.

getCustomerNoteBytes()

public abstract ByteString getCustomerNoteBytes()

Optional. Unstructured text content that is visible to the customer. Maximum length: 120 characters.

string customer_note = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for customerNote.

getCustomerOrBuilder()

public abstract PrivateOffer.CustomerOrBuilder getCustomerOrBuilder()

Optional. Information identifying the intended recipient of the offer. Must be provided when publishing the offer.

.google.cloud.commerceproducer.v1beta.PrivateOffer.Customer customer = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PrivateOffer.CustomerOrBuilder

getEndTime()

public abstract Timestamp getEndTime()

Output only. The time when the offer ended. This can only be set for offers with ENDED state.

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

Returns
Type Description
Timestamp

The endTime.

getEndTimeOrBuilder()

public abstract TimestampOrBuilder getEndTimeOrBuilder()

Output only. The time when the offer ended. This can only be set for offers with ENDED state.

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

Returns
Type Description
TimestampOrBuilder

getInternalNote()

public abstract String getInternalNote()

Optional. Unstructured text content that is not visible to the customer. Intended to be used by partners for storing notes about the private offer. Maximum length: 1500 characters.

string internal_note = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The internalNote.

getInternalNoteBytes()

public abstract ByteString getInternalNoteBytes()

Optional. Unstructured text content that is not visible to the customer. Intended to be used by partners for storing notes about the private offer. Maximum length: 1500 characters.

string internal_note = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for internalNote.

getName()

public abstract String getName()

Identifier. Name of the resource.

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

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Identifier. Name of the resource.

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

Returns
Type Description
ByteString

The bytes for name.

getOfferDealType()

public abstract PrivateOffer.OfferDealType getOfferDealType()

Optional. The type of the deal transacted with the offer.

The deal type is not visible to customers.

Must be present to publish the offer.

.google.cloud.commerceproducer.v1beta.PrivateOffer.OfferDealType offer_deal_type = 21 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PrivateOffer.OfferDealType

The offerDealType.

getOfferDealTypeValue()

public abstract int getOfferDealTypeValue()

Optional. The type of the deal transacted with the offer.

The deal type is not visible to customers.

Must be present to publish the offer.

.google.cloud.commerceproducer.v1beta.PrivateOffer.OfferDealType offer_deal_type = 21 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for offerDealType.

getPartnerContact()

public abstract PrivateOffer.PartnerContact getPartnerContact()

Optional. Information about the partner contact. Must be provided when publishing the offer.

.google.cloud.commerceproducer.v1beta.PrivateOffer.PartnerContact partner_contact = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PrivateOffer.PartnerContact

The partnerContact.

getPartnerContactOrBuilder()

public abstract PrivateOffer.PartnerContactOrBuilder getPartnerContactOrBuilder()

Optional. Information about the partner contact. Must be provided when publishing the offer.

.google.cloud.commerceproducer.v1beta.PrivateOffer.PartnerContact partner_contact = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PrivateOffer.PartnerContactOrBuilder

getPublishRequirementGoogleReview()

public abstract PrivateOffer.PublishRequirementGoogleReview getPublishRequirementGoogleReview()

Output only. Information about the Google review process. Present only when the offer is determined to require review by Google.

.google.cloud.commerceproducer.v1beta.PrivateOffer.PublishRequirementGoogleReview publish_requirement_google_review = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
PrivateOffer.PublishRequirementGoogleReview

The publishRequirementGoogleReview.

getPublishRequirementGoogleReviewOrBuilder()

public abstract PrivateOffer.PublishRequirementGoogleReviewOrBuilder getPublishRequirementGoogleReviewOrBuilder()

Output only. Information about the Google review process. Present only when the offer is determined to require review by Google.

.google.cloud.commerceproducer.v1beta.PrivateOffer.PublishRequirementGoogleReview publish_requirement_google_review = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
PrivateOffer.PublishRequirementGoogleReviewOrBuilder

getPublishTime()

public abstract Timestamp getPublishTime()

Output only. The time the offer transitioned to PUBLISHED state.

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

Returns
Type Description
Timestamp

The publishTime.

getPublishTimeOrBuilder()

public abstract TimestampOrBuilder getPublishTimeOrBuilder()

Output only. The time the offer transitioned to PUBLISHED state.

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

Returns
Type Description
TimestampOrBuilder

getResellerContact()

public abstract PrivateOffer.ResellerContact getResellerContact()

Output only. Information about the reseller contact. Present only for offers created by a reseller.

.google.cloud.commerceproducer.v1beta.PrivateOffer.ResellerContact reseller_contact = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
PrivateOffer.ResellerContact

The resellerContact.

getResellerContactOrBuilder()

public abstract PrivateOffer.ResellerContactOrBuilder getResellerContactOrBuilder()

Output only. Information about the reseller contact. Present only for offers created by a reseller.

.google.cloud.commerceproducer.v1beta.PrivateOffer.ResellerContact reseller_contact = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
PrivateOffer.ResellerContactOrBuilder

getSingleProductOffer()

public abstract PrivateOffer.SingleProductOffer getSingleProductOffer()

Optional. Configurations for the offer that is associated with a single product.

.google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer single_product_offer = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PrivateOffer.SingleProductOffer

The singleProductOffer.

getSingleProductOfferOrBuilder()

public abstract PrivateOffer.SingleProductOfferOrBuilder getSingleProductOfferOrBuilder()

Optional. Configurations for the offer that is associated with a single product.

.google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer single_product_offer = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PrivateOffer.SingleProductOfferOrBuilder

getState()

public abstract PrivateOffer.State getState()

Output only. The state of the private offer.

.google.cloud.commerceproducer.v1beta.PrivateOffer.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
PrivateOffer.State

The state.

getStateValue()

public abstract int getStateValue()

Output only. The state of the private offer.

.google.cloud.commerceproducer.v1beta.PrivateOffer.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getTerm()

public abstract PrivateOffer.Term getTerm()

Optional. Configuration for the offer term. Must be set when publishing the offer.

.google.cloud.commerceproducer.v1beta.PrivateOffer.Term term = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PrivateOffer.Term

The term.

getTermOrBuilder()

public abstract PrivateOffer.TermOrBuilder getTermOrBuilder()

Optional. Configuration for the offer term. Must be set when publishing the offer.

.google.cloud.commerceproducer.v1beta.PrivateOffer.Term term = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PrivateOffer.TermOrBuilder

getTitle()

public abstract String getTitle()

Optional. A title that describes the offer and helps your customers identify it. This title will be visible to the customer. Maximum length: 256 characters. Must be present to publish the offer.

string title = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The title.

getTitleBytes()

public abstract ByteString getTitleBytes()

Optional. A title that describes the offer and helps your customers identify it. This title will be visible to the customer. Maximum length: 256 characters. Must be present to publish the offer.

string title = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for title.

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. The last update time.

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

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The last update time.

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

Returns
Type Description
TimestampOrBuilder

hasAcceptDeadlineTime()

public abstract boolean hasAcceptDeadlineTime()

Optional. Deadline for acceptance of published offers. A published offer not accepted by this time will expire. Only day boundaries in the America/Los_Angeles time zone are supported. Must be present to publish the offer.

When publishing an offer the deadline must be set to a time in the future not more than 3 months from the time of publishing. For example, if the offer is published on 03/05 at 1PM, then the deadline must be at or before 06/05 12AM America/Los_Angeles time.

The deadline must also be:

  • Before or equal to the scheduled start time of this offer (if term.scheduled_start_time is set and the term's start policy is SCHEDULED_START_TIME).
  • Before or equal to the scheduled end time of this offer, if term.scheduled_end_time is set and the term's end policy is SCHEDULED_END_TIME.
  • Before or equal to the upcoming installment start times on this offer.
  • Before or equal to the amended offer's end time, if the offer amends another private or standard offer.

  • Before or equal to the start time of the next pending installment of the amended offer, if amending a private offer with custom installments. For example, if the amended offer has installments on 01/01, 02/01, 03/01, 04/01, and today is 02/15, then this offer's accept_deadline_time must be at or before 03/01.

    In addition, if the offer amends another private offer, but there is already an accepted upcoming amendment against that private offer, then this deadline must be before or equal to the start time of the accepted upcoming offer. For example, today is 02/15, and this offer (offer C) amends private offer A, and private offer B has already been accepted which also amends private offer A. Private offer B has a start time of 03/01. Then this deadline must be at or before 03/01. Otherwise, on 03/01, private offer B would take effect, superseding offer A. This would mean offer C is no longer amending the currently active offer (Offer A), which is required for valid amendments.

    Once the offer is published, this field is still updatable to extend the deadline of the offer. However, the extension is still limited to be at most 3 months from the time of publishing.

.google.type.DateTime accept_deadline_time = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the acceptDeadlineTime field is set.

hasAcceptTime()

public abstract boolean hasAcceptTime()

Output only. The time the offer transitioned to ACCEPTED state.

.google.protobuf.Timestamp accept_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the acceptTime field is set.

hasCancelTime()

public abstract boolean hasCancelTime()

Output only. The time the offer transited to CANCELLED state.

.google.protobuf.Timestamp cancel_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the cancelTime field is set.

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. The creation time.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasCustomer()

public abstract boolean hasCustomer()

Optional. Information identifying the intended recipient of the offer. Must be provided when publishing the offer.

.google.cloud.commerceproducer.v1beta.PrivateOffer.Customer customer = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the customer field is set.

hasEndTime()

public abstract boolean hasEndTime()

Output only. The time when the offer ended. This can only be set for offers with ENDED state.

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

Returns
Type Description
boolean

Whether the endTime field is set.

hasPartnerContact()

public abstract boolean hasPartnerContact()

Optional. Information about the partner contact. Must be provided when publishing the offer.

.google.cloud.commerceproducer.v1beta.PrivateOffer.PartnerContact partner_contact = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the partnerContact field is set.

hasPublishRequirementGoogleReview()

public abstract boolean hasPublishRequirementGoogleReview()

Output only. Information about the Google review process. Present only when the offer is determined to require review by Google.

.google.cloud.commerceproducer.v1beta.PrivateOffer.PublishRequirementGoogleReview publish_requirement_google_review = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the publishRequirementGoogleReview field is set.

hasPublishTime()

public abstract boolean hasPublishTime()

Output only. The time the offer transitioned to PUBLISHED state.

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

Returns
Type Description
boolean

Whether the publishTime field is set.

hasResellerContact()

public abstract boolean hasResellerContact()

Output only. Information about the reseller contact. Present only for offers created by a reseller.

.google.cloud.commerceproducer.v1beta.PrivateOffer.ResellerContact reseller_contact = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the resellerContact field is set.

hasSingleProductOffer()

public abstract boolean hasSingleProductOffer()

Optional. Configurations for the offer that is associated with a single product.

.google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer single_product_offer = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the singleProductOffer field is set.

hasTerm()

public abstract boolean hasTerm()

Optional. Configuration for the offer term. Must be set when publishing the offer.

.google.cloud.commerceproducer.v1beta.PrivateOffer.Term term = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the term field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. The last update time.

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

Returns
Type Description
boolean

Whether the updateTime field is set.