Reference documentation and code samples for the Google Shopping Merchant Products V1beta Client class LoyaltyProgram.
A message that represents loyalty program.
Generated from protobuf message google.shopping.merchant.products.v1beta.LoyaltyProgram
Namespace
Google \ Shopping \ Merchant \ Products \ V1betaMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ program_label |
string
The label of the loyalty program. This is an internal label that uniquely identifies the relationship between a merchant entity and a loyalty program entity. The label must be provided so that the system can associate the assets below (for example, price and points) with a merchant. The corresponding program must be linked to the merchant account. |
↳ tier_label |
string
The label of the tier within the loyalty program. Must match one of the labels within the program. |
↳ price |
Google\Shopping\Type\Price
The price for members of the given tier, that is, the instant discount price. Must be smaller or equal to the regular price. |
↳ cashback_for_future_use |
Google\Shopping\Type\Price
The cashback that can be used for future purchases. |
↳ loyalty_points |
int|string
The amount of loyalty points earned on a purchase. |
getProgramLabel
The label of the loyalty program. This is an internal label that uniquely identifies the relationship between a merchant entity and a loyalty program entity. The label must be provided so that the system can associate the assets below (for example, price and points) with a merchant. The corresponding program must be linked to the merchant account.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasProgramLabel
clearProgramLabel
setProgramLabel
The label of the loyalty program. This is an internal label that uniquely identifies the relationship between a merchant entity and a loyalty program entity. The label must be provided so that the system can associate the assets below (for example, price and points) with a merchant. The corresponding program must be linked to the merchant account.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTierLabel
The label of the tier within the loyalty program.
Must match one of the labels within the program.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasTierLabel
clearTierLabel
setTierLabel
The label of the tier within the loyalty program.
Must match one of the labels within the program.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPrice
The price for members of the given tier, that is, the instant discount price. Must be smaller or equal to the regular price.
| Returns | |
|---|---|
| Type | Description |
Google\Shopping\Type\Price|null |
|
hasPrice
clearPrice
setPrice
The price for members of the given tier, that is, the instant discount price. Must be smaller or equal to the regular price.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Shopping\Type\Price
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCashbackForFutureUse
The cashback that can be used for future purchases.
| Returns | |
|---|---|
| Type | Description |
Google\Shopping\Type\Price|null |
|
hasCashbackForFutureUse
clearCashbackForFutureUse
setCashbackForFutureUse
The cashback that can be used for future purchases.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Shopping\Type\Price
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLoyaltyPoints
The amount of loyalty points earned on a purchase.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
hasLoyaltyPoints
clearLoyaltyPoints
setLoyaltyPoints
The amount of loyalty points earned on a purchase.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|