Reference documentation and code samples for the Google Shopping Merchant Products V1 Client class LoyaltyPoints.
A message that represents loyalty points.
Generated from protobuf message google.shopping.merchant.products.v1.LoyaltyPoints
Namespace
Google \ Shopping \ Merchant \ Products \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Name of loyalty points program. It is recommended to limit the name to 12 full-width characters or 24 Roman characters. |
↳ points_value |
int|string
The retailer's loyalty points in absolute value. |
↳ ratio |
float
The ratio of a point when converted to currency. Google assumes currency based on Merchant Center settings. If ratio is left out, it defaults to 1.0. |
getName
Name of loyalty points program. It is recommended to limit the name to 12 full-width characters or 24 Roman characters.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Name of loyalty points program. It is recommended to limit the name to 12 full-width characters or 24 Roman characters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPointsValue
The retailer's loyalty points in absolute value.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
setPointsValue
The retailer's loyalty points in absolute value.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRatio
The ratio of a point when converted to currency. Google assumes currency based on Merchant Center settings. If ratio is left out, it defaults to 1.0.
| Returns | |
|---|---|
| Type | Description |
float |
|
setRatio
The ratio of a point when converted to currency. Google assumes currency based on Merchant Center settings. If ratio is left out, it defaults to 1.0.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this |
|