Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Cloud Commerce Producer V1BETA API - Class Google::Cloud::CommerceProducer::V1beta::PrivateOffer (v0.1.0)

Reference documentation and code samples for the Cloud Commerce Producer V1BETA API class Google::Cloud::CommerceProducer::V1beta::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.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#accept_deadline_time

def accept_deadline_time() -> ::Google::Type::DateTime

Returns

(::Google::Type::DateTime) — 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.

#accept_deadline_time=

def accept_deadline_time=(value) -> ::Google::Type::DateTime

Parameter

value (::Google::Type::DateTime) — 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.

Returns

(::Google::Type::DateTime) — 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.

#accept_time

def accept_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. The time the offer transitioned to ACCEPTED state.

#cancel_time

def cancel_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. The time the offer transited to CANCELLED state.

#cancellation_note

def cancellation_note() -> ::String

Returns

(::String) — Output only. Internal note supplied when the offer was cancelled. Present only for cancelled offers and only if a note was supplied.

#create_time

def create_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. The creation time.

#customer

def customer() -> ::Google::Cloud::CommerceProducer::V1beta::PrivateOffer::Customer

Returns

(::Google::Cloud::CommerceProducer::V1beta::PrivateOffer::Customer) — Optional. Information identifying the intended recipient of the offer. Must be provided when publishing the offer.

#customer=

def customer=(value) -> ::Google::Cloud::CommerceProducer::V1beta::PrivateOffer::Customer

Parameter

value (::Google::Cloud::CommerceProducer::V1beta::PrivateOffer::Customer) — Optional. Information identifying the intended recipient of the offer. Must be provided when publishing the offer.

Returns

(::Google::Cloud::CommerceProducer::V1beta::PrivateOffer::Customer) — Optional. Information identifying the intended recipient of the offer. Must be provided when publishing the offer.

#customer_note

def customer_note() -> ::String

Returns

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

#customer_note=

def customer_note=(value) -> ::String

Parameter

value (::String) — Optional. Unstructured text content that is visible to the customer. Maximum length: 120 characters.

Returns

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

#end_time

def end_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. The time when the offer ended. This can only be set for offers with ENDED state.

#internal_note

def internal_note() -> ::String

Returns

(::String) — 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.

#internal_note=

def internal_note=(value) -> ::String

Parameter

value (::String) — 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.

Returns

(::String) — 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.

#name

def name() -> ::String

Returns

(::String) — Identifier. Name of the resource.

#name=

def name=(value) -> ::String

Parameter

value (::String) — Identifier. Name of the resource.

Returns

(::String) — Identifier. Name of the resource.

#offer_deal_type

def offer_deal_type() -> ::Google::Cloud::CommerceProducer::V1beta::PrivateOffer::OfferDealType

Returns

(::Google::Cloud::CommerceProducer::V1beta::PrivateOffer::OfferDealType) — 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.

#offer_deal_type=

def offer_deal_type=(value) -> ::Google::Cloud::CommerceProducer::V1beta::PrivateOffer::OfferDealType

Parameter

value (::Google::Cloud::CommerceProducer::V1beta::PrivateOffer::OfferDealType) — 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.

Returns

(::Google::Cloud::CommerceProducer::V1beta::PrivateOffer::OfferDealType) — 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.

#partner_contact

def partner_contact() -> ::Google::Cloud::CommerceProducer::V1beta::PrivateOffer::PartnerContact

Returns

(::Google::Cloud::CommerceProducer::V1beta::PrivateOffer::PartnerContact) — Optional. Information about the partner contact. Must be provided when publishing the offer.

#partner_contact=

def partner_contact=(value) -> ::Google::Cloud::CommerceProducer::V1beta::PrivateOffer::PartnerContact

Parameter

value (::Google::Cloud::CommerceProducer::V1beta::PrivateOffer::PartnerContact) — Optional. Information about the partner contact. Must be provided when publishing the offer.

Returns

(::Google::Cloud::CommerceProducer::V1beta::PrivateOffer::PartnerContact) — Optional. Information about the partner contact. Must be provided when publishing the offer.

#publish_requirement_google_review

def publish_requirement_google_review() -> ::Google::Cloud::CommerceProducer::V1beta::PrivateOffer::PublishRequirementGoogleReview

Returns

(::Google::Cloud::CommerceProducer::V1beta::PrivateOffer::PublishRequirementGoogleReview) — Output only. Information about the Google review process. Present only when the offer is determined to require review by Google.

#publish_time

def publish_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. The time the offer transitioned to PUBLISHED state.

#reseller_contact

def reseller_contact() -> ::Google::Cloud::CommerceProducer::V1beta::PrivateOffer::ResellerContact

Returns

(::Google::Cloud::CommerceProducer::V1beta::PrivateOffer::ResellerContact) — Output only. Information about the reseller contact. Present only for offers created by a reseller.

#single_product_offer

def single_product_offer() -> ::Google::Cloud::CommerceProducer::V1beta::PrivateOffer::SingleProductOffer

Returns

(::Google::Cloud::CommerceProducer::V1beta::PrivateOffer::SingleProductOffer) — Optional. Configurations for the offer that is associated with a single product.

#single_product_offer=

def single_product_offer=(value) -> ::Google::Cloud::CommerceProducer::V1beta::PrivateOffer::SingleProductOffer

Parameter

value (::Google::Cloud::CommerceProducer::V1beta::PrivateOffer::SingleProductOffer) — Optional. Configurations for the offer that is associated with a single product.

Returns

(::Google::Cloud::CommerceProducer::V1beta::PrivateOffer::SingleProductOffer) — Optional. Configurations for the offer that is associated with a single product.

#state

def state() -> ::Google::Cloud::CommerceProducer::V1beta::PrivateOffer::State

Returns

(::Google::Cloud::CommerceProducer::V1beta::PrivateOffer::State) — Output only. The state of the private offer.

#term

def term() -> ::Google::Cloud::CommerceProducer::V1beta::PrivateOffer::Term

Returns

(::Google::Cloud::CommerceProducer::V1beta::PrivateOffer::Term) — Optional. Configuration for the offer term. Must be set when publishing the offer.

#term=

def term=(value) -> ::Google::Cloud::CommerceProducer::V1beta::PrivateOffer::Term

Parameter

value (::Google::Cloud::CommerceProducer::V1beta::PrivateOffer::Term) — Optional. Configuration for the offer term. Must be set when publishing the offer.

Returns

(::Google::Cloud::CommerceProducer::V1beta::PrivateOffer::Term) — Optional. Configuration for the offer term. Must be set when publishing the offer.

#title

def title() -> ::String

Returns

(::String) — 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.

#title=

def title=(value) -> ::String

Parameter

value (::String) — 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.

Returns

(::String) — 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.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. The last update time.