Reference documentation and code samples for the Google Shopping Merchant Accounts V1beta Client class Program.
Defines participation in a given program for the specified account.
Programs provide a mechanism for adding functionality to merchant accounts. A typical example of this is the Free product listings program, which enables products from a merchant's store to be shown across Google for free.
Generated from protobuf message google.shopping.merchant.accounts.v1beta.Program
Namespace
Google \ Shopping \ Merchant \ Accounts \ V1betaMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Identifier. The resource name of the program. Format: |
↳ documentation_uri |
string
Output only. The URL of a Merchant Center help page describing the program. |
↳ state |
int
Output only. The participation state of the account in the program. |
↳ active_region_codes |
array
Output only. The regions in which the account is actively participating in the program. Active regions are defined as those where all program requirements affecting the regions have been met. Region codes are defined by CLDR. This is either a country where the program applies specifically to that country or |
↳ unmet_requirements |
array<Program\Requirement>
Output only. The requirements that the account has not yet satisfied that are affecting participation in the program. |
getName
Identifier. The resource name of the program.
Format: accounts/{account}/programs/{program}
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. The resource name of the program.
Format: accounts/{account}/programs/{program}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDocumentationUri
Output only. The URL of a Merchant Center help page describing the program.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDocumentationUri
Output only. The URL of a Merchant Center help page describing the program.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getState
Output only. The participation state of the account in the program.
| Returns | |
|---|---|
| Type | Description |
int |
|
setState
Output only. The participation state of the account in the program.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getActiveRegionCodes
Output only. The regions in which the account is actively participating in the program. Active regions are defined as those where all program requirements affecting the regions have been met.
Region codes are defined by CLDR. This is
either a country where the program applies specifically to that country or
001 when the program applies globally.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setActiveRegionCodes
Output only. The regions in which the account is actively participating in the program. Active regions are defined as those where all program requirements affecting the regions have been met.
Region codes are defined by CLDR. This is
either a country where the program applies specifically to that country or
001 when the program applies globally.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUnmetRequirements
Output only. The requirements that the account has not yet satisfied that are affecting participation in the program.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setUnmetRequirements
Output only. The requirements that the account has not yet satisfied that are affecting participation in the program.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Program\Requirement>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|