PrivateOffer(mapping=None, *, ignore_unknown_fields=False, **kwargs)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.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes |
|
|---|---|
| Name | Description |
single_product_offer |
google.cloud.commerceproducer_v1beta.types.PrivateOffer.SingleProductOffer
Optional. Configurations for the offer that is associated with a single product. This field is a member of oneof_ content.
|
name |
str
Identifier. Name of the resource. |
state |
google.cloud.commerceproducer_v1beta.types.PrivateOffer.State
Output only. The state of the private offer. |
publish_requirement_google_review |
google.cloud.commerceproducer_v1beta.types.PrivateOffer.PublishRequirementGoogleReview
Output only. Information about the Google review process. Present only when the offer is determined to require review by Google. |
create_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. The creation time. |
update_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. The last update time. |
publish_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. The time the offer transitioned to PUBLISHED state. |
accept_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. The time the offer transitioned to ACCEPTED state. |
cancel_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. The time the offer transited to CANCELLED state. |
end_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. The time when the offer ended. This can only be set for offers with ENDED state.
|
cancellation_note |
str
Output only. Internal note supplied when the offer was cancelled. Present only for cancelled offers and only if a note was supplied. |
reseller_contact |
google.cloud.commerceproducer_v1beta.types.PrivateOffer.ResellerContact
Output only. Information about the reseller contact. Present only for offers created by a reseller. |
internal_note |
str
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. |
offer_deal_type |
google.cloud.commerceproducer_v1beta.types.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. |
title |
str
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. |
customer_note |
str
Optional. Unstructured text content that is visible to the customer. Maximum length: 120 characters. |
partner_contact |
google.cloud.commerceproducer_v1beta.types.PrivateOffer.PartnerContact
Optional. Information about the partner contact. Must be provided when publishing the offer. |
customer |
google.cloud.commerceproducer_v1beta.types.PrivateOffer.Customer
Optional. Information identifying the intended recipient of the offer. Must be provided when publishing the offer. |
accept_deadline_time |
google.type.datetime_pb2.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.
|
term |
google.cloud.commerceproducer_v1beta.types.PrivateOffer.Term
Optional. Configuration for the offer term. Must be set when publishing the offer. |
Classes
Customer
Customer(mapping=None, *, ignore_unknown_fields=False, **kwargs)Information about the customer.
OfferDealType
OfferDealType(value)The type of the deal transacted with the offer. The deal type of an offer is a factor in determining the offer's revenue share.
This value is not allowed if the offer amends another
private offer where the term has not ended, and the amended
private offer has a deal type of `MIGRATION`,
`CHANNEL_SHIFT` or `NATIVE_RENEWAL`.
PartnerContact
PartnerContact(mapping=None, *, ignore_unknown_fields=False, **kwargs)Contact information for the partner representative.
PublishRequirementGoogleReview
PublishRequirementGoogleReview(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)Information about the Google review process.
ResellerContact
ResellerContact(mapping=None, *, ignore_unknown_fields=False, **kwargs)Contact information for a reseller.
SingleProductOffer
SingleProductOffer(mapping=None, *, ignore_unknown_fields=False, **kwargs)Configurations for the offer that is associated with a single product.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
State
State(value)State of an offer.
Ended offers were accepted and active in the
past, but have now reached the end of their term
or have been terminated.
Term
Term(mapping=None, *, ignore_unknown_fields=False, **kwargs)Configurations for the offer term and renewal options. Extending a private offer to a customer that covers a given term constitutes a guarantee to the customer that the product will remain available to them for the duration of the term.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields