Class PrivateOffer.Builder (0.1.0)

public static final class PrivateOffer.Builder extends GeneratedMessage.Builder<PrivateOffer.Builder> implements PrivateOfferOrBuilder

Message describing PrivateOffer resource.

Note on OPTIONAL fields: To facilitate saving incomplete draft offers, most fields are categorized as OPTIONAL irrespective of whether they are necessary for a private offer to be valid. Many fields labeled OPTIONAL must be set to publish the offer.

Protobuf type google.cloud.commerceproducer.v1beta.PrivateOffer

Static Methods

getDescriptor()

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

Methods

build()

public PrivateOffer build()
Returns
Type Description
PrivateOffer

buildPartial()

public PrivateOffer buildPartial()
Returns
Type Description
PrivateOffer

clear()

public PrivateOffer.Builder clear()
Returns
Type Description
PrivateOffer.Builder
Overrides

clearAcceptDeadlineTime()

public PrivateOffer.Builder clearAcceptDeadlineTime()

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
PrivateOffer.Builder

clearAcceptTime()

public PrivateOffer.Builder clearAcceptTime()

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
PrivateOffer.Builder

clearCancelTime()

public PrivateOffer.Builder clearCancelTime()

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
PrivateOffer.Builder

clearCancellationNote()

public PrivateOffer.Builder clearCancellationNote()

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
PrivateOffer.Builder

This builder for chaining.

clearContent()

public PrivateOffer.Builder clearContent()
Returns
Type Description
PrivateOffer.Builder

clearCreateTime()

public PrivateOffer.Builder clearCreateTime()

Output only. The creation time.

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

Returns
Type Description
PrivateOffer.Builder

clearCustomer()

public PrivateOffer.Builder clearCustomer()

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.Builder

clearCustomerNote()

public PrivateOffer.Builder clearCustomerNote()

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
PrivateOffer.Builder

This builder for chaining.

clearEndTime()

public PrivateOffer.Builder clearEndTime()

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
PrivateOffer.Builder

clearInternalNote()

public PrivateOffer.Builder clearInternalNote()

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
PrivateOffer.Builder

This builder for chaining.

clearName()

public PrivateOffer.Builder clearName()

Identifier. Name of the resource.

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

Returns
Type Description
PrivateOffer.Builder

This builder for chaining.

clearOfferDealType()

public PrivateOffer.Builder clearOfferDealType()

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.Builder

This builder for chaining.

clearPartnerContact()

public PrivateOffer.Builder clearPartnerContact()

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.Builder

clearPublishRequirementGoogleReview()

public PrivateOffer.Builder clearPublishRequirementGoogleReview()

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.Builder

clearPublishTime()

public PrivateOffer.Builder clearPublishTime()

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
PrivateOffer.Builder

clearResellerContact()

public PrivateOffer.Builder clearResellerContact()

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.Builder

clearSingleProductOffer()

public PrivateOffer.Builder clearSingleProductOffer()

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.Builder

clearState()

public PrivateOffer.Builder clearState()

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.Builder

This builder for chaining.

clearTerm()

public PrivateOffer.Builder clearTerm()

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.Builder

clearTitle()

public PrivateOffer.Builder clearTitle()

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
PrivateOffer.Builder

This builder for chaining.

clearUpdateTime()

public PrivateOffer.Builder clearUpdateTime()

Output only. The last update time.

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

Returns
Type Description
PrivateOffer.Builder

getAcceptDeadlineTime()

public 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.

getAcceptDeadlineTimeBuilder()

public DateTime.Builder getAcceptDeadlineTimeBuilder()

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.Builder

getAcceptDeadlineTimeOrBuilder()

public 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 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.

getAcceptTimeBuilder()

public Timestamp.Builder getAcceptTimeBuilder()

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
Builder

getAcceptTimeOrBuilder()

public 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 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.

getCancelTimeBuilder()

public Timestamp.Builder getCancelTimeBuilder()

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
Builder

getCancelTimeOrBuilder()

public 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 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 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 PrivateOffer.ContentCase getContentCase()
Returns
Type Description
PrivateOffer.ContentCase

getCreateTime()

public 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.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. The creation time.

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

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public 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 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.

getCustomerBuilder()

public PrivateOffer.Customer.Builder getCustomerBuilder()

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.Builder

getCustomerNote()

public 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 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 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

getDefaultInstanceForType()

public PrivateOffer getDefaultInstanceForType()
Returns
Type Description
PrivateOffer

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEndTime()

public 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.

getEndTimeBuilder()

public Timestamp.Builder getEndTimeBuilder()

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
Builder

getEndTimeOrBuilder()

public 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 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 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 String getName()

Identifier. Name of the resource.

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

Returns
Type Description
String

The name.

getNameBytes()

public 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 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 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 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.

getPartnerContactBuilder()

public PrivateOffer.PartnerContact.Builder getPartnerContactBuilder()

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.Builder

getPartnerContactOrBuilder()

public 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 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.

getPublishRequirementGoogleReviewBuilder()

public PrivateOffer.PublishRequirementGoogleReview.Builder getPublishRequirementGoogleReviewBuilder()

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.Builder

getPublishRequirementGoogleReviewOrBuilder()

public 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 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.

getPublishTimeBuilder()

public Timestamp.Builder getPublishTimeBuilder()

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
Builder

getPublishTimeOrBuilder()

public 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 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.

getResellerContactBuilder()

public PrivateOffer.ResellerContact.Builder getResellerContactBuilder()

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.Builder

getResellerContactOrBuilder()

public 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 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.

getSingleProductOfferBuilder()

public PrivateOffer.SingleProductOffer.Builder getSingleProductOfferBuilder()

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.Builder

getSingleProductOfferOrBuilder()

public 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 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 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 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.

getTermBuilder()

public PrivateOffer.Term.Builder getTermBuilder()

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.Builder

getTermOrBuilder()

public 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 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 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 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.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. The last update time.

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

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public 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 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 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 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 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 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 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 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 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 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 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 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 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 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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeAcceptDeadlineTime(DateTime value)

public PrivateOffer.Builder mergeAcceptDeadlineTime(DateTime value)

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];

Parameter
Name Description
value com.google.type.DateTime
Returns
Type Description
PrivateOffer.Builder

mergeAcceptTime(Timestamp value)

public PrivateOffer.Builder mergeAcceptTime(Timestamp value)

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

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

Parameter
Name Description
value Timestamp
Returns
Type Description
PrivateOffer.Builder

mergeCancelTime(Timestamp value)

public PrivateOffer.Builder mergeCancelTime(Timestamp value)

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

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

Parameter
Name Description
value Timestamp
Returns
Type Description
PrivateOffer.Builder

mergeCreateTime(Timestamp value)

public PrivateOffer.Builder mergeCreateTime(Timestamp value)

Output only. The creation time.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
PrivateOffer.Builder

mergeCustomer(PrivateOffer.Customer value)

public PrivateOffer.Builder mergeCustomer(PrivateOffer.Customer value)

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];

Parameter
Name Description
value PrivateOffer.Customer
Returns
Type Description
PrivateOffer.Builder

mergeEndTime(Timestamp value)

public PrivateOffer.Builder mergeEndTime(Timestamp value)

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];

Parameter
Name Description
value Timestamp
Returns
Type Description
PrivateOffer.Builder

mergeFrom(PrivateOffer other)

public PrivateOffer.Builder mergeFrom(PrivateOffer other)
Parameter
Name Description
other PrivateOffer
Returns
Type Description
PrivateOffer.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PrivateOffer.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PrivateOffer.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public PrivateOffer.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
PrivateOffer.Builder
Overrides

mergePartnerContact(PrivateOffer.PartnerContact value)

public PrivateOffer.Builder mergePartnerContact(PrivateOffer.PartnerContact value)

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];

Parameter
Name Description
value PrivateOffer.PartnerContact
Returns
Type Description
PrivateOffer.Builder

mergePublishRequirementGoogleReview(PrivateOffer.PublishRequirementGoogleReview value)

public PrivateOffer.Builder mergePublishRequirementGoogleReview(PrivateOffer.PublishRequirementGoogleReview value)

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];

Parameter
Name Description
value PrivateOffer.PublishRequirementGoogleReview
Returns
Type Description
PrivateOffer.Builder

mergePublishTime(Timestamp value)

public PrivateOffer.Builder mergePublishTime(Timestamp value)

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

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

Parameter
Name Description
value Timestamp
Returns
Type Description
PrivateOffer.Builder

mergeResellerContact(PrivateOffer.ResellerContact value)

public PrivateOffer.Builder mergeResellerContact(PrivateOffer.ResellerContact value)

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];

Parameter
Name Description
value PrivateOffer.ResellerContact
Returns
Type Description
PrivateOffer.Builder

mergeSingleProductOffer(PrivateOffer.SingleProductOffer value)

public PrivateOffer.Builder mergeSingleProductOffer(PrivateOffer.SingleProductOffer value)

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];

Parameter
Name Description
value PrivateOffer.SingleProductOffer
Returns
Type Description
PrivateOffer.Builder

mergeTerm(PrivateOffer.Term value)

public PrivateOffer.Builder mergeTerm(PrivateOffer.Term value)

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];

Parameter
Name Description
value PrivateOffer.Term
Returns
Type Description
PrivateOffer.Builder

mergeUpdateTime(Timestamp value)

public PrivateOffer.Builder mergeUpdateTime(Timestamp value)

Output only. The last update time.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
PrivateOffer.Builder

setAcceptDeadlineTime(DateTime value)

public PrivateOffer.Builder setAcceptDeadlineTime(DateTime value)

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];

Parameter
Name Description
value com.google.type.DateTime
Returns
Type Description
PrivateOffer.Builder

setAcceptDeadlineTime(DateTime.Builder builderForValue)

public PrivateOffer.Builder setAcceptDeadlineTime(DateTime.Builder builderForValue)

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];

Parameter
Name Description
builderForValue com.google.type.DateTime.Builder
Returns
Type Description
PrivateOffer.Builder

setAcceptTime(Timestamp value)

public PrivateOffer.Builder setAcceptTime(Timestamp value)

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

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

Parameter
Name Description
value Timestamp
Returns
Type Description
PrivateOffer.Builder

setAcceptTime(Timestamp.Builder builderForValue)

public PrivateOffer.Builder setAcceptTime(Timestamp.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
PrivateOffer.Builder

setCancelTime(Timestamp value)

public PrivateOffer.Builder setCancelTime(Timestamp value)

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

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

Parameter
Name Description
value Timestamp
Returns
Type Description
PrivateOffer.Builder

setCancelTime(Timestamp.Builder builderForValue)

public PrivateOffer.Builder setCancelTime(Timestamp.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
PrivateOffer.Builder

setCancellationNote(String value)

public PrivateOffer.Builder setCancellationNote(String value)

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];

Parameter
Name Description
value String

The cancellationNote to set.

Returns
Type Description
PrivateOffer.Builder

This builder for chaining.

setCancellationNoteBytes(ByteString value)

public PrivateOffer.Builder setCancellationNoteBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for cancellationNote to set.

Returns
Type Description
PrivateOffer.Builder

This builder for chaining.

setCreateTime(Timestamp value)

public PrivateOffer.Builder setCreateTime(Timestamp value)

Output only. The creation time.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
PrivateOffer.Builder

setCreateTime(Timestamp.Builder builderForValue)

public PrivateOffer.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. The creation time.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
PrivateOffer.Builder

setCustomer(PrivateOffer.Customer value)

public PrivateOffer.Builder setCustomer(PrivateOffer.Customer value)

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];

Parameter
Name Description
value PrivateOffer.Customer
Returns
Type Description
PrivateOffer.Builder

setCustomer(PrivateOffer.Customer.Builder builderForValue)

public PrivateOffer.Builder setCustomer(PrivateOffer.Customer.Builder builderForValue)

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];

Parameter
Name Description
builderForValue PrivateOffer.Customer.Builder
Returns
Type Description
PrivateOffer.Builder

setCustomerNote(String value)

public PrivateOffer.Builder setCustomerNote(String value)

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

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

Parameter
Name Description
value String

The customerNote to set.

Returns
Type Description
PrivateOffer.Builder

This builder for chaining.

setCustomerNoteBytes(ByteString value)

public PrivateOffer.Builder setCustomerNoteBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for customerNote to set.

Returns
Type Description
PrivateOffer.Builder

This builder for chaining.

setEndTime(Timestamp value)

public PrivateOffer.Builder setEndTime(Timestamp value)

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];

Parameter
Name Description
value Timestamp
Returns
Type Description
PrivateOffer.Builder

setEndTime(Timestamp.Builder builderForValue)

public PrivateOffer.Builder setEndTime(Timestamp.Builder builderForValue)

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];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
PrivateOffer.Builder

setInternalNote(String value)

public PrivateOffer.Builder setInternalNote(String value)

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];

Parameter
Name Description
value String

The internalNote to set.

Returns
Type Description
PrivateOffer.Builder

This builder for chaining.

setInternalNoteBytes(ByteString value)

public PrivateOffer.Builder setInternalNoteBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for internalNote to set.

Returns
Type Description
PrivateOffer.Builder

This builder for chaining.

setName(String value)

public PrivateOffer.Builder setName(String value)

Identifier. Name of the resource.

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
PrivateOffer.Builder

This builder for chaining.

setNameBytes(ByteString value)

public PrivateOffer.Builder setNameBytes(ByteString value)

Identifier. Name of the resource.

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
PrivateOffer.Builder

This builder for chaining.

setOfferDealType(PrivateOffer.OfferDealType value)

public PrivateOffer.Builder setOfferDealType(PrivateOffer.OfferDealType value)

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];

Parameter
Name Description
value PrivateOffer.OfferDealType

The offerDealType to set.

Returns
Type Description
PrivateOffer.Builder

This builder for chaining.

setOfferDealTypeValue(int value)

public PrivateOffer.Builder setOfferDealTypeValue(int value)

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];

Parameter
Name Description
value int

The enum numeric value on the wire for offerDealType to set.

Returns
Type Description
PrivateOffer.Builder

This builder for chaining.

setPartnerContact(PrivateOffer.PartnerContact value)

public PrivateOffer.Builder setPartnerContact(PrivateOffer.PartnerContact value)

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];

Parameter
Name Description
value PrivateOffer.PartnerContact
Returns
Type Description
PrivateOffer.Builder

setPartnerContact(PrivateOffer.PartnerContact.Builder builderForValue)

public PrivateOffer.Builder setPartnerContact(PrivateOffer.PartnerContact.Builder builderForValue)

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];

Parameter
Name Description
builderForValue PrivateOffer.PartnerContact.Builder
Returns
Type Description
PrivateOffer.Builder

setPublishRequirementGoogleReview(PrivateOffer.PublishRequirementGoogleReview value)

public PrivateOffer.Builder setPublishRequirementGoogleReview(PrivateOffer.PublishRequirementGoogleReview value)

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];

Parameter
Name Description
value PrivateOffer.PublishRequirementGoogleReview
Returns
Type Description
PrivateOffer.Builder

setPublishRequirementGoogleReview(PrivateOffer.PublishRequirementGoogleReview.Builder builderForValue)

public PrivateOffer.Builder setPublishRequirementGoogleReview(PrivateOffer.PublishRequirementGoogleReview.Builder builderForValue)

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];

Parameter
Name Description
builderForValue PrivateOffer.PublishRequirementGoogleReview.Builder
Returns
Type Description
PrivateOffer.Builder

setPublishTime(Timestamp value)

public PrivateOffer.Builder setPublishTime(Timestamp value)

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

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

Parameter
Name Description
value Timestamp
Returns
Type Description
PrivateOffer.Builder

setPublishTime(Timestamp.Builder builderForValue)

public PrivateOffer.Builder setPublishTime(Timestamp.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
PrivateOffer.Builder

setResellerContact(PrivateOffer.ResellerContact value)

public PrivateOffer.Builder setResellerContact(PrivateOffer.ResellerContact value)

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];

Parameter
Name Description
value PrivateOffer.ResellerContact
Returns
Type Description
PrivateOffer.Builder

setResellerContact(PrivateOffer.ResellerContact.Builder builderForValue)

public PrivateOffer.Builder setResellerContact(PrivateOffer.ResellerContact.Builder builderForValue)

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];

Parameter
Name Description
builderForValue PrivateOffer.ResellerContact.Builder
Returns
Type Description
PrivateOffer.Builder

setSingleProductOffer(PrivateOffer.SingleProductOffer value)

public PrivateOffer.Builder setSingleProductOffer(PrivateOffer.SingleProductOffer value)

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];

Parameter
Name Description
value PrivateOffer.SingleProductOffer
Returns
Type Description
PrivateOffer.Builder

setSingleProductOffer(PrivateOffer.SingleProductOffer.Builder builderForValue)

public PrivateOffer.Builder setSingleProductOffer(PrivateOffer.SingleProductOffer.Builder builderForValue)

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];

Parameter
Name Description
builderForValue PrivateOffer.SingleProductOffer.Builder
Returns
Type Description
PrivateOffer.Builder

setState(PrivateOffer.State value)

public PrivateOffer.Builder setState(PrivateOffer.State value)

Output only. The state of the private offer.

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

Parameter
Name Description
value PrivateOffer.State

The state to set.

Returns
Type Description
PrivateOffer.Builder

This builder for chaining.

setStateValue(int value)

public PrivateOffer.Builder setStateValue(int value)

Output only. The state of the private offer.

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

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.

Returns
Type Description
PrivateOffer.Builder

This builder for chaining.

setTerm(PrivateOffer.Term value)

public PrivateOffer.Builder setTerm(PrivateOffer.Term value)

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];

Parameter
Name Description
value PrivateOffer.Term
Returns
Type Description
PrivateOffer.Builder

setTerm(PrivateOffer.Term.Builder builderForValue)

public PrivateOffer.Builder setTerm(PrivateOffer.Term.Builder builderForValue)

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];

Parameter
Name Description
builderForValue PrivateOffer.Term.Builder
Returns
Type Description
PrivateOffer.Builder

setTitle(String value)

public PrivateOffer.Builder setTitle(String value)

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];

Parameter
Name Description
value String

The title to set.

Returns
Type Description
PrivateOffer.Builder

This builder for chaining.

setTitleBytes(ByteString value)

public PrivateOffer.Builder setTitleBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for title to set.

Returns
Type Description
PrivateOffer.Builder

This builder for chaining.

setUpdateTime(Timestamp value)

public PrivateOffer.Builder setUpdateTime(Timestamp value)

Output only. The last update time.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
PrivateOffer.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public PrivateOffer.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. The last update time.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
PrivateOffer.Builder