Reference documentation and code samples for the Google Cloud Channel V1 Client class Offer.
Represents an offer made to resellers for purchase.
An offer is associated with a Sku, has a plan for payment, a price, and defines the constraints for buying.
Generated from protobuf message google.cloud.channel.v1.Offer
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Resource Name of the Offer. Format: accounts/{account_id}/offers/{offer_id} |
↳ marketing_info |
Google\Cloud\Channel\V1\MarketingInfo
Marketing information for the Offer. |
↳ sku |
Google\Cloud\Channel\V1\Sku
SKU the offer is associated with. |
↳ plan |
Google\Cloud\Channel\V1\Plan
Describes the payment plan for the Offer. |
↳ constraints |
Google\Cloud\Channel\V1\Constraints
Constraints on transacting the Offer. |
↳ price_by_resources |
array<Google\Cloud\Channel\V1\PriceByResource>
Price for each monetizable resource type. |
↳ start_time |
Google\Protobuf\Timestamp
Start of the Offer validity time. |
↳ end_time |
Google\Protobuf\Timestamp
Output only. End of the Offer validity time. |
↳ parameter_definitions |
array<Google\Cloud\Channel\V1\ParameterDefinition>
Parameters required to use current Offer to purchase. |
getName
Resource Name of the Offer.
Format: accounts/{account_id}/offers/{offer_id}
Generated from protobuf field string name = 1;
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Resource Name of the Offer.
Format: accounts/{account_id}/offers/{offer_id}
Generated from protobuf field string name = 1;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMarketingInfo
Marketing information for the Offer.
Generated from protobuf field .google.cloud.channel.v1.MarketingInfo marketing_info = 2;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Channel\V1\MarketingInfo|null | |
hasMarketingInfo
clearMarketingInfo
setMarketingInfo
Marketing information for the Offer.
Generated from protobuf field .google.cloud.channel.v1.MarketingInfo marketing_info = 2;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Channel\V1\MarketingInfo
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSku
SKU the offer is associated with.
Generated from protobuf field .google.cloud.channel.v1.Sku sku = 3;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Channel\V1\Sku|null | |
hasSku
clearSku
setSku
SKU the offer is associated with.
Generated from protobuf field .google.cloud.channel.v1.Sku sku = 3;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Channel\V1\Sku
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPlan
Describes the payment plan for the Offer.
Generated from protobuf field .google.cloud.channel.v1.Plan plan = 4;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Channel\V1\Plan|null | |
hasPlan
clearPlan
setPlan
Describes the payment plan for the Offer.
Generated from protobuf field .google.cloud.channel.v1.Plan plan = 4;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Channel\V1\Plan
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getConstraints
Constraints on transacting the Offer.
Generated from protobuf field .google.cloud.channel.v1.Constraints constraints = 5;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Channel\V1\Constraints|null | |
hasConstraints
clearConstraints
setConstraints
Constraints on transacting the Offer.
Generated from protobuf field .google.cloud.channel.v1.Constraints constraints = 5;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Channel\V1\Constraints
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPriceByResources
Price for each monetizable resource type.
Generated from protobuf field repeated .google.cloud.channel.v1.PriceByResource price_by_resources = 6;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setPriceByResources
Price for each monetizable resource type.
Generated from protobuf field repeated .google.cloud.channel.v1.PriceByResource price_by_resources = 6;
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Channel\V1\PriceByResource>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStartTime
Start of the Offer validity time.
Generated from protobuf field .google.protobuf.Timestamp start_time = 7;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasStartTime
clearStartTime
setStartTime
Start of the Offer validity time.
Generated from protobuf field .google.protobuf.Timestamp start_time = 7;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEndTime
Output only. End of the Offer validity time.
Generated from protobuf field .google.protobuf.Timestamp end_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasEndTime
clearEndTime
setEndTime
Output only. End of the Offer validity time.
Generated from protobuf field .google.protobuf.Timestamp end_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getParameterDefinitions
Parameters required to use current Offer to purchase.
Generated from protobuf field repeated .google.cloud.channel.v1.ParameterDefinition parameter_definitions = 9;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setParameterDefinitions
Parameters required to use current Offer to purchase.
Generated from protobuf field repeated .google.cloud.channel.v1.ParameterDefinition parameter_definitions = 9;
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Channel\V1\ParameterDefinition>
|
| Returns | |
|---|---|
| Type | Description |
$this | |