Google Cloud Commerce Producer V1beta Client - Class Term (0.2.0)

Reference documentation and code samples for the Google Cloud Commerce Producer V1beta Client class Term.

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.

Generated from protobuf message google.cloud.commerceproducer.v1beta.PrivateOffer.Term

Namespace

Google \ Cloud \ CommerceProducer \ V1beta \ PrivateOffer

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ duration_months int

Optional. Duration in months of the offer term. The offer will end on the same day of the month after this duration. If that date is not available, the offer will end on the last day of the month. For example, if the offer starts on 01/31/2024 and the duration is 13 months, the offer will end on 02/28/2025. Must be set to publish the offer if the end policy is AFTER_DURATION or MATCH_AMENDED_OFFER, and must be a positive value. The maximum possible offer duration, including all renewal terms, cannot exceed 7 years. For example, if duration_months is 9 and term.max_renewal_count is 9, then the maximum possible offer duration is 90 months and exceeds the 7 year limit.
↳ scheduled_end_time Google\Type\DateTime

Optional. Specified end time of the offer. Must be set to publish the offer if the end policy is SCHEDULED_END_TIME. When set, the time must be in the future and at a day boundary in the America/Los_Angeles time zone, and must be after term.scheduled_start_time if applicable.
↳ max_renewal_count int

Optional. The max number of renewals allowed, after the initial term ends. This field is only relevant to standard interval offers with interval of 'MONTHLY_PRORATED', 'MONTHLY_NOT_PRORATED', 'QUARTERLY_NOT_PRORATED' or 'YEARLY_NOT_PRORATED'. Other types of offers cannot be renewed. For example, if the initial term is 1 year and the max renewals is 3, the customer can renew the offer for up to 3 additional years after the initial term ends. Customers control whether they renew the offer. Allowing a customer to renew an offer does not constitute a guarantee to the customer that the offered product will still be available to be renewed at the renewal date. An offer with a max renewal count of 0 cannot be renewed. Must be non-negative.
↳ unlimited_renewal bool

Output only. Deprecated: This field can only be true on existing offers with standard interval of 'MONTHLY_POSTPAY'. As of May 2024, we no longer allow unlimited renewals.
↳ start_policy int

Optional. Defines when the resulting order should start. Must be set when publishing the offer.
↳ scheduled_start_time Google\Type\DateTime

Optional. The scheduled start time of the offer. Cannot exceed one year from the time of publish. If the start policy is SCHEDULED_START_TIME, a future time at a day boundary in the America/Los_Angeles time zone must be provided when publishing the offer. If the offer amends another private or standard offer, then the scheduled start time must be: * * Before or equal to the amended offer's end time if the offer's end policy is not MATCH_AMENDED_OFFER. Otherwise, it has to be strictly before the amended offer's end time. * * 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 the new offer's scheduled_start_time must be at or before 03/01.
↳ end_policy int

Optional. Defines when an offer should end. Must be set when publishing the offer.
↳ effective_term_end_time Google\Type\DateTime

Output only. The expected end time of the current offer term. At the end of each offer term, an offer associated with an active order will either renew or end. When an offer renews, a new term begins and this value changes to reflect the end time of the new term. When an offer ends this value is no longer set and instead end_time is set. When the term of an offer ends and the offer does not renew, the associated order also ends if the base standard offer has a subscription price model. Otherwise, the associated order does not end and remains active. Not included for PRIVATE_OFFER_VIEW_BASIC. Included for PRIVATE_OFFER_VIEW_FULL when the offer has not ended and either the offer has started or the value can be derived from other fields. For offers that have not started, this field is set when one of the following conditions is true. * * The offer sets term.scheduled_end_time. * * The offer sets term.scheduled_start_time and term.duration_months, the offer's term.end_policy is not MATCH_AMENDED_OFFER, and the offer does not have standard_interval set to MONTHLY_POSTPAY.

getDurationMonths

Optional. Duration in months of the offer term.

The offer will end on the same day of the month after this duration. If that date is not available, the offer will end on the last day of the month. For example, if the offer starts on 01/31/2024 and the duration is 13 months, the offer will end on 02/28/2025. Must be set to publish the offer if the end policy is AFTER_DURATION or MATCH_AMENDED_OFFER, and must be a positive value. The maximum possible offer duration, including all renewal terms, cannot exceed 7 years. For example, if duration_months is 9 and term.max_renewal_count is 9, then the maximum possible offer duration is 90 months and exceeds the 7 year limit.

Returns
Type Description
int

hasDurationMonths

setDurationMonths

Optional. Duration in months of the offer term.

The offer will end on the same day of the month after this duration. If that date is not available, the offer will end on the last day of the month. For example, if the offer starts on 01/31/2024 and the duration is 13 months, the offer will end on 02/28/2025. Must be set to publish the offer if the end policy is AFTER_DURATION or MATCH_AMENDED_OFFER, and must be a positive value. The maximum possible offer duration, including all renewal terms, cannot exceed 7 years. For example, if duration_months is 9 and term.max_renewal_count is 9, then the maximum possible offer duration is 90 months and exceeds the 7 year limit.

Parameter
Name Description
var int
Returns
Type Description
$this

getScheduledEndTime

Optional. Specified end time of the offer.

Must be set to publish the offer if the end policy is SCHEDULED_END_TIME. When set, the time must be in the future and at a day boundary in the America/Los_Angeles time zone, and must be after term.scheduled_start_time if applicable.

Returns
Type Description
Google\Type\DateTime|null

hasScheduledEndTime

setScheduledEndTime

Optional. Specified end time of the offer.

Must be set to publish the offer if the end policy is SCHEDULED_END_TIME. When set, the time must be in the future and at a day boundary in the America/Los_Angeles time zone, and must be after term.scheduled_start_time if applicable.

Parameter
Name Description
var Google\Type\DateTime
Returns
Type Description
$this

getMaxRenewalCount

Optional. The max number of renewals allowed, after the initial term ends. This field is only relevant to standard interval offers with interval of 'MONTHLY_PRORATED', 'MONTHLY_NOT_PRORATED', 'QUARTERLY_NOT_PRORATED' or 'YEARLY_NOT_PRORATED'. Other types of offers cannot be renewed.

For example, if the initial term is 1 year and the max renewals is 3, the customer can renew the offer for up to 3 additional years after the initial term ends. Customers control whether they renew the offer. Allowing a customer to renew an offer does not constitute a guarantee to the customer that the offered product will still be available to be renewed at the renewal date. An offer with a max renewal count of 0 cannot be renewed. Must be non-negative.

Returns
Type Description
int

hasMaxRenewalCount

setMaxRenewalCount

Optional. The max number of renewals allowed, after the initial term ends. This field is only relevant to standard interval offers with interval of 'MONTHLY_PRORATED', 'MONTHLY_NOT_PRORATED', 'QUARTERLY_NOT_PRORATED' or 'YEARLY_NOT_PRORATED'. Other types of offers cannot be renewed.

For example, if the initial term is 1 year and the max renewals is 3, the customer can renew the offer for up to 3 additional years after the initial term ends. Customers control whether they renew the offer. Allowing a customer to renew an offer does not constitute a guarantee to the customer that the offered product will still be available to be renewed at the renewal date. An offer with a max renewal count of 0 cannot be renewed. Must be non-negative.

Parameter
Name Description
var int
Returns
Type Description
$this

getUnlimitedRenewal

Output only. Deprecated: This field can only be true on existing offers with standard interval of 'MONTHLY_POSTPAY'. As of May 2024, we no longer allow unlimited renewals.

Returns
Type Description
bool

hasUnlimitedRenewal

setUnlimitedRenewal

Output only. Deprecated: This field can only be true on existing offers with standard interval of 'MONTHLY_POSTPAY'. As of May 2024, we no longer allow unlimited renewals.

Parameter
Name Description
var bool
Returns
Type Description
$this

getStartPolicy

Optional. Defines when the resulting order should start.

Must be set when publishing the offer.

Returns
Type Description
int Enum of type StartPolicy.

setStartPolicy

Optional. Defines when the resulting order should start.

Must be set when publishing the offer.

Parameter
Name Description
var int

Enum of type StartPolicy.

Returns
Type Description
$this

getScheduledStartTime

Optional. The scheduled start time of the offer. Cannot exceed one year from the time of publish.

If the start policy is SCHEDULED_START_TIME, a future time at a day boundary in the America/Los_Angeles time zone must be provided when publishing the offer. If the offer amends another private or standard offer, then the scheduled start time must be:

  • Before or equal to the amended offer's end time if the offer's end policy is not MATCH_AMENDED_OFFER. Otherwise, it has to be strictly before the amended offer's end time.
  • 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 the new offer's scheduled_start_time must be at or before 03/01.
Returns
Type Description
Google\Type\DateTime|null

hasScheduledStartTime

clearScheduledStartTime

setScheduledStartTime

Optional. The scheduled start time of the offer. Cannot exceed one year from the time of publish.

If the start policy is SCHEDULED_START_TIME, a future time at a day boundary in the America/Los_Angeles time zone must be provided when publishing the offer. If the offer amends another private or standard offer, then the scheduled start time must be:

  • Before or equal to the amended offer's end time if the offer's end policy is not MATCH_AMENDED_OFFER. Otherwise, it has to be strictly before the amended offer's end time.
  • 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 the new offer's scheduled_start_time must be at or before 03/01.
Parameter
Name Description
var Google\Type\DateTime
Returns
Type Description
$this

getEndPolicy

Optional. Defines when an offer should end.

Must be set when publishing the offer.

Returns
Type Description
int Enum of type EndPolicy.

setEndPolicy

Optional. Defines when an offer should end.

Must be set when publishing the offer.

Parameter
Name Description
var int

Enum of type EndPolicy.

Returns
Type Description
$this

getEffectiveTermEndTime

Output only. The expected end time of the current offer term.

At the end of each offer term, an offer associated with an active order will either renew or end. When an offer renews, a new term begins and this value changes to reflect the end time of the new term. When an offer ends this value is no longer set and instead end_time is set. When the term of an offer ends and the offer does not renew, the associated order also ends if the base standard offer has a subscription price model. Otherwise, the associated order does not end and remains active. Not included for PRIVATE_OFFER_VIEW_BASIC. Included for PRIVATE_OFFER_VIEW_FULL when the offer has not ended and either the offer has started or the value can be derived from other fields. For offers that have not started, this field is set when one of the following conditions is true.

  • The offer sets term.scheduled_end_time.
  • The offer sets term.scheduled_start_time and term.duration_months, the offer's term.end_policy is not MATCH_AMENDED_OFFER, and the offer does not have standard_interval set to MONTHLY_POSTPAY.
Returns
Type Description
Google\Type\DateTime|null

hasEffectiveTermEndTime

clearEffectiveTermEndTime

setEffectiveTermEndTime

Output only. The expected end time of the current offer term.

At the end of each offer term, an offer associated with an active order will either renew or end. When an offer renews, a new term begins and this value changes to reflect the end time of the new term. When an offer ends this value is no longer set and instead end_time is set. When the term of an offer ends and the offer does not renew, the associated order also ends if the base standard offer has a subscription price model. Otherwise, the associated order does not end and remains active. Not included for PRIVATE_OFFER_VIEW_BASIC. Included for PRIVATE_OFFER_VIEW_FULL when the offer has not ended and either the offer has started or the value can be derived from other fields. For offers that have not started, this field is set when one of the following conditions is true.

  • The offer sets term.scheduled_end_time.
  • The offer sets term.scheduled_start_time and term.duration_months, the offer's term.end_policy is not MATCH_AMENDED_OFFER, and the offer does not have standard_interval set to MONTHLY_POSTPAY.
Parameter
Name Description
var Google\Type\DateTime
Returns
Type Description
$this

getEndPolicyData

Returns
Type Description
string

getRenewal

Returns
Type Description
string