Cloud Commerce Producer v1beta API - Class PrivateOffer (1.0.0-beta01)

public sealed class PrivateOffer : IMessage<PrivateOffer>, IEquatable<PrivateOffer>, IDeepCloneable<PrivateOffer>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud Commerce Producer v1beta API class PrivateOffer.

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.

Inheritance

object > PrivateOffer

Implements

IMessagePrivateOffer, IEquatablePrivateOffer, IDeepCloneablePrivateOffer, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.CommerceProducer.V1Beta

Assembly

Google.Cloud.CommerceProducer.V1Beta.dll

Constructors

PrivateOffer()

public PrivateOffer()

PrivateOffer(PrivateOffer)

public PrivateOffer(PrivateOffer other)

Parameter
Name	Description
other	PrivateOffer

Properties

AcceptDeadlineTime

public DateTime AcceptDeadlineTime { get; set; }

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.

Property Value
Type	Description
DateTime

AcceptTime

public Timestamp AcceptTime { get; set; }

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

Property Value
Type	Description
Timestamp

CancelTime

public Timestamp CancelTime { get; set; }

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

Property Value
Type	Description
Timestamp

CancellationNote

public string CancellationNote { get; set; }

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

Property Value
Type	Description
string

ContentCase

public PrivateOffer.ContentOneofCase ContentCase { get; }

Property Value
Type	Description
PrivateOfferContentOneofCase

CreateTime

public Timestamp CreateTime { get; set; }

Output only. The creation time.

Property Value
Type	Description
Timestamp

Customer

public PrivateOffer.Types.Customer Customer { get; set; }

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

Property Value
Type	Description
PrivateOfferTypesCustomer

CustomerNote

public string CustomerNote { get; set; }

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

Property Value
Type	Description
string

EndTime

public Timestamp EndTime { get; set; }

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

Property Value
Type	Description
Timestamp

InternalNote

public string InternalNote { get; set; }

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.

Property Value
Type	Description
string

Name

public string Name { get; set; }

Identifier. Name of the resource.

Property Value
Type	Description
string

OfferDealType

public PrivateOffer.Types.OfferDealType OfferDealType { get; set; }

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.

Property Value
Type	Description
PrivateOfferTypesOfferDealType

PartnerContact

public PrivateOffer.Types.PartnerContact PartnerContact { get; set; }

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

Property Value
Type	Description
PrivateOfferTypesPartnerContact

PrivateOfferName

public PrivateOfferName PrivateOfferName { get; set; }

PrivateOfferName-typed view over the Name resource name property.

Property Value
Type	Description
PrivateOfferName

PublishRequirementGoogleReview

public PrivateOffer.Types.PublishRequirementGoogleReview PublishRequirementGoogleReview { get; set; }

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

Property Value
Type	Description
PrivateOfferTypesPublishRequirementGoogleReview

PublishTime

public Timestamp PublishTime { get; set; }

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

Property Value
Type	Description
Timestamp

ResellerContact

public PrivateOffer.Types.ResellerContact ResellerContact { get; set; }

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

Property Value
Type	Description
PrivateOfferTypesResellerContact

SingleProductOffer

public PrivateOffer.Types.SingleProductOffer SingleProductOffer { get; set; }

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

Property Value
Type	Description
PrivateOfferTypesSingleProductOffer

State

public PrivateOffer.Types.State State { get; set; }

Output only. The state of the private offer.

Property Value
Type	Description
PrivateOfferTypesState

Term

public PrivateOffer.Types.Term Term { get; set; }

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

Property Value
Type	Description
PrivateOfferTypesTerm

Title

public string Title { get; set; }

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.

Property Value
Type	Description
string

UpdateTime

public Timestamp UpdateTime { get; set; }

Output only. The last update time.

Property Value
Type	Description
Timestamp