public final class PrivateOffer extends GeneratedMessage implements PrivateOfferOrBuilderMessage 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
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > PrivateOfferImplements
PrivateOfferOrBuilderStatic Fields
ACCEPT_DEADLINE_TIME_FIELD_NUMBER
public static final int ACCEPT_DEADLINE_TIME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
ACCEPT_TIME_FIELD_NUMBER
public static final int ACCEPT_TIME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
CANCELLATION_NOTE_FIELD_NUMBER
public static final int CANCELLATION_NOTE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
CANCEL_TIME_FIELD_NUMBER
public static final int CANCEL_TIME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
CUSTOMER_FIELD_NUMBER
public static final int CUSTOMER_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
CUSTOMER_NOTE_FIELD_NUMBER
public static final int CUSTOMER_NOTE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
END_TIME_FIELD_NUMBER
public static final int END_TIME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
INTERNAL_NOTE_FIELD_NUMBER
public static final int INTERNAL_NOTE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
OFFER_DEAL_TYPE_FIELD_NUMBER
public static final int OFFER_DEAL_TYPE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
PARTNER_CONTACT_FIELD_NUMBER
public static final int PARTNER_CONTACT_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
PUBLISH_REQUIREMENT_GOOGLE_REVIEW_FIELD_NUMBER
public static final int PUBLISH_REQUIREMENT_GOOGLE_REVIEW_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
PUBLISH_TIME_FIELD_NUMBER
public static final int PUBLISH_TIME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
RESELLER_CONTACT_FIELD_NUMBER
public static final int RESELLER_CONTACT_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
SINGLE_PRODUCT_OFFER_FIELD_NUMBER
public static final int SINGLE_PRODUCT_OFFER_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
TERM_FIELD_NUMBER
public static final int TERM_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
TITLE_FIELD_NUMBER
public static final int TITLE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
Static Methods
getDefaultInstance()
public static PrivateOffer getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
PrivateOffer |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
newBuilder()
public static PrivateOffer.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
PrivateOffer.Builder |
|
newBuilder(PrivateOffer prototype)
public static PrivateOffer.Builder newBuilder(PrivateOffer prototype)| Parameter | |
|---|---|
| Name | Description |
prototype |
PrivateOffer |
| Returns | |
|---|---|
| Type | Description |
PrivateOffer.Builder |
|
parseDelimitedFrom(InputStream input)
public static PrivateOffer parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
PrivateOffer |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static PrivateOffer parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
PrivateOffer |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(byte[] data)
public static PrivateOffer parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data |
byte[] |
| Returns | |
|---|---|
| Type | Description |
PrivateOffer |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PrivateOffer parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
PrivateOffer |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data)
public static PrivateOffer parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteString |
| Returns | |
|---|---|
| Type | Description |
PrivateOffer |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PrivateOffer parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
PrivateOffer |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(CodedInputStream input)
public static PrivateOffer parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
PrivateOffer |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static PrivateOffer parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
PrivateOffer |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input)
public static PrivateOffer parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
PrivateOffer |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static PrivateOffer parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
PrivateOffer |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(ByteBuffer data)
public static PrivateOffer parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
PrivateOffer |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static PrivateOffer parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
PrivateOffer |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parser()
public static Parser<PrivateOffer> parser()| Returns | |
|---|---|
| Type | Description |
Parser<PrivateOffer> |
|
Methods
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj |
Object |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
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_timeis set and the term's start policy isSCHEDULED_START_TIME). - Before or equal to the scheduled end time of this offer, if
term.scheduled_end_timeis set and the term's end policy isSCHEDULED_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_timemust 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 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_timeis set and the term's start policy isSCHEDULED_START_TIME). - Before or equal to the scheduled end time of this offer, if
term.scheduled_end_timeis set and the term's end policy isSCHEDULED_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_timemust 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. |
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. |
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. |
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. |
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 |
|
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. |
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. |
getParserForType()
public Parser<PrivateOffer> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<PrivateOffer> |
|
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. |
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. |
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. |
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. |
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 |
|
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
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. |
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. |
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. |
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_timeis set and the term's start policy isSCHEDULED_START_TIME). - Before or equal to the scheduled end time of this offer, if
term.scheduled_end_timeis set and the term's end policy isSCHEDULED_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_timemust 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. |
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
newBuilderForType()
public PrivateOffer.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
PrivateOffer.Builder |
|
newBuilderForType(AbstractMessage.BuilderParent parent)
protected PrivateOffer.Builder newBuilderForType(AbstractMessage.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
PrivateOffer.Builder |
|
toBuilder()
public PrivateOffer.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
PrivateOffer.Builder |
|
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|