Reference documentation and code samples for the Google Shopping Merchant Accounts V1 Client class Headers.
A non-empty list of row or column headers for a table.
Exactly one of prices, weights,
num_items, postal_code_group_names, or
location must be set.
Generated from protobuf message google.shopping.merchant.accounts.v1.Headers
Namespace
Google \ Shopping \ Merchant \ Accounts \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ prices |
array<Google\Shopping\Type\Price>
Required. A list of inclusive order price upper bounds. The last price's value can be infinity by setting price amount_micros = -1. For example |
↳ weights |
array<Google\Shopping\Type\Weight>
Required. A list of inclusive order weight upper bounds. The last weight's value can be infinity by setting price amount_micros = -1. For example |
↳ number_of_items |
array
Required. A list of inclusive number of items upper bounds. The last value can be |
↳ postal_code_group_names |
array
Required. A list of postal group names. The last value can be |
↳ locations |
array<LocationIdSet>
Required. A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set. |
getPrices
Required. A list of inclusive order price upper bounds. The last price's
value can be infinity by setting price amount_micros = -1. For example
[{"amount_micros": 10000000, "currency_code": "USD"},
{"amount_micros": 500000000, "currency_code": "USD"},
{"amount_micros": -1, "currency_code": "USD"}] represents the headers
"<= $10", "<= $500", and "> $500". All prices within a service must have
the same currency. Must be non-empty. Must be positive except -1. Can only
be set if all other fields are not set.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setPrices
Required. A list of inclusive order price upper bounds. The last price's
value can be infinity by setting price amount_micros = -1. For example
[{"amount_micros": 10000000, "currency_code": "USD"},
{"amount_micros": 500000000, "currency_code": "USD"},
{"amount_micros": -1, "currency_code": "USD"}] represents the headers
"<= $10", "<= $500", and "> $500". All prices within a service must have
the same currency. Must be non-empty. Must be positive except -1. Can only
be set if all other fields are not set.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Shopping\Type\Price>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getWeights
Required. A list of inclusive order weight upper bounds. The last weight's
value can be infinity by setting price amount_micros = -1. For example
[{"amount_micros": 10000000, "unit": "kg"}, {"amount_micros": 50000000,
"unit": "kg"},
{"amount_micros": -1, "unit": "kg"}] represents the headers
"<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have
the same unit. Must be non-empty. Must be positive except -1. Can only be
set if all other fields are not set.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setWeights
Required. A list of inclusive order weight upper bounds. The last weight's
value can be infinity by setting price amount_micros = -1. For example
[{"amount_micros": 10000000, "unit": "kg"}, {"amount_micros": 50000000,
"unit": "kg"},
{"amount_micros": -1, "unit": "kg"}] represents the headers
"<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have
the same unit. Must be non-empty. Must be positive except -1. Can only be
set if all other fields are not set.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Shopping\Type\Weight>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getNumberOfItems
Required. A list of inclusive number of items upper bounds. The last value
can be
"infinity". For example
["10", "50", "infinity"] represents the headers
"<= 10 items", "<= 50 items", and "> 50 items". Must be non-empty. Can
only be set if all other fields are not set.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setNumberOfItems
Required. A list of inclusive number of items upper bounds. The last value
can be
"infinity". For example
["10", "50", "infinity"] represents the headers
"<= 10 items", "<= 50 items", and "> 50 items". Must be non-empty. Can
only be set if all other fields are not set.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPostalCodeGroupNames
Required. A list of postal group names. The last value can be
"all other locations". Example:
["zone 1", "zone 2", "all other locations"]. The referred
postal code groups must match the delivery country of the service. Must
be non-empty. Can only be set if all other fields are not set.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setPostalCodeGroupNames
Required. A list of postal group names. The last value can be
"all other locations". Example:
["zone 1", "zone 2", "all other locations"]. The referred
postal code groups must match the delivery country of the service. Must
be non-empty. Can only be set if all other fields are not set.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLocations
Required. A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setLocations
Required. A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
| Parameter | |
|---|---|
| Name | Description |
var |
array<LocationIdSet>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|