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

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

Message describing the StandardOffer resource.

Generated from protobuf message google.cloud.commerceproducer.v1beta.StandardOffer

Namespace

Google \ Cloud \ CommerceProducer \ V1beta

Methods

__construct

Constructor.

Parameters
Name Description
data array

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

Output only. Term duration of the offer in months. Applicable only to offers with a subscription price model. Additional forms of offer term may be added in the future.
↳ name string

Identifier. Name of resource.
↳ create_time Google\Protobuf\Timestamp

Output only. Creation time of the offer.
↳ update_time Google\Protobuf\Timestamp

Output only. Last update time of the offer.
↳ effective_time Google\Protobuf\Timestamp

Output only. Effective time of the offer. Prior to this time, the offer cannot be purchased or used as the base standard offer of a private offer.
↳ expire_time Google\Protobuf\Timestamp

Output only. Expire time of the offer. An offer is expired if its expire time is in the past. An expired standard offer cannot be purchased or used as the base standard offer of a private offer.
↳ service_level string

Output only. Identifier that distinguishes between different service levels of the same product that constitute distinct offerings to customers with different pricing. The service levels of a product are also referred to in some cases as the product's 'plans', and the service_level value is referred to in some cases as the "plan ID". Multiple non-expired standard offers can share the same service level when they are subscription offers for different term durations.
↳ service_level_title string

Output only. Title of the service level. Not included for STANDARD_OFFER_VIEW_BASIC.
↳ price_model StandardOffer\PriceModel

Output only. Price model of the offer.

getTermDurationMonths

Output only. Term duration of the offer in months.

Applicable only to offers with a subscription price model. Additional forms of offer term may be added in the future.

Returns
Type Description
int

hasTermDurationMonths

setTermDurationMonths

Output only. Term duration of the offer in months.

Applicable only to offers with a subscription price model. Additional forms of offer term may be added in the future.

Parameter
Name Description
var int
Returns
Type Description
$this

getName

Identifier. Name of resource.

Returns
Type Description
string

setName

Identifier. Name of resource.

Parameter
Name Description
var string
Returns
Type Description
$this

getCreateTime

Output only. Creation time of the offer.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Creation time of the offer.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUpdateTime

Output only. Last update time of the offer.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Last update time of the offer.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getEffectiveTime

Output only. Effective time of the offer.

Prior to this time, the offer cannot be purchased or used as the base standard offer of a private offer.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasEffectiveTime

clearEffectiveTime

setEffectiveTime

Output only. Effective time of the offer.

Prior to this time, the offer cannot be purchased or used as the base standard offer of a private offer.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getExpireTime

Output only. Expire time of the offer.

An offer is expired if its expire time is in the past. An expired standard offer cannot be purchased or used as the base standard offer of a private offer.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasExpireTime

clearExpireTime

setExpireTime

Output only. Expire time of the offer.

An offer is expired if its expire time is in the past. An expired standard offer cannot be purchased or used as the base standard offer of a private offer.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getServiceLevel

Output only. Identifier that distinguishes between different service levels of the same product that constitute distinct offerings to customers with different pricing.

The service levels of a product are also referred to in some cases as the product's 'plans', and the service_level value is referred to in some cases as the "plan ID". Multiple non-expired standard offers can share the same service level when they are subscription offers for different term durations.

Returns
Type Description
string

setServiceLevel

Output only. Identifier that distinguishes between different service levels of the same product that constitute distinct offerings to customers with different pricing.

The service levels of a product are also referred to in some cases as the product's 'plans', and the service_level value is referred to in some cases as the "plan ID". Multiple non-expired standard offers can share the same service level when they are subscription offers for different term durations.

Parameter
Name Description
var string
Returns
Type Description
$this

getServiceLevelTitle

Output only. Title of the service level.

Not included for STANDARD_OFFER_VIEW_BASIC.

Returns
Type Description
string

setServiceLevelTitle

Output only. Title of the service level.

Not included for STANDARD_OFFER_VIEW_BASIC.

Parameter
Name Description
var string
Returns
Type Description
$this

getPriceModel

Output only. Price model of the offer.

Returns
Type Description
StandardOffer\PriceModel|null

hasPriceModel

clearPriceModel

setPriceModel

Output only. Price model of the offer.

Parameter
Name Description
var StandardOffer\PriceModel
Returns
Type Description
$this

getTerm

Returns
Type Description
string