Google Shopping Merchant Accounts V1beta Client - Class CheckoutSettings (0.9.0)

Reference documentation and code samples for the Google Shopping Merchant Accounts V1beta Client class CheckoutSettings.

CheckoutSettings for a specific merchant.

Generated from protobuf message google.shopping.merchant.accounts.v1beta.CheckoutSettings

Namespace

Google \ Shopping \ Merchant \ Accounts \ V1beta

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Identifier. The resource name of the program configuration settings. Format: `accounts/{account}/programs/{program}/checkoutSettings`
`↳ uri_settings`	`UriSettings` URI settings for cart or checkout URL.
`↳ eligible_destinations`	`array` Optional. The destinations to which the checkout program applies, valid destination values are `SHOPPING_ADS`, `FREE_LISTINGS`
`↳ enrollment_state`	`int` Output only. Reflects the merchant enrollment state in `Checkout` program.
`↳ review_state`	`int` Output only. Reflects the merchant review state in `Checkout` program. This is set based on the data quality reviews of the URL provided by the merchant. A merchant with enrollment state as `ENROLLED` can be in the following review states: `IN_REVIEW`, `APPROVED` or `DISAPPROVED`. A merchant must be in an `enrollment_state` of `ENROLLED` before a review can begin for the merchant.For more details, check the help center doc.
`↳ effective_uri_settings`	`UriSettings` Output only. The effective value of `uri_settings` for a given merchant. If account level settings are present then this value will be a copy of url settings. Otherwise, it will have the value of the parent account (for only marketplace sellers).
`↳ effective_enrollment_state`	`int` Output only. The effective value of enrollment_state for a given merchant ID. If account level settings are present then this value will be a copy of the account level settings. Otherwise, it will have the value of the parent account (for only marketplace sellers).
`↳ effective_review_state`	`int` Output only. The effective value of `review_state` for a given merchant ID. If account level settings are present then this value will be a copy of the account level settings. Otherwise, it will have the value of the parent account (for only marketplace sellers).

getName

Identifier. The resource name of the program configuration settings.

Format: accounts/{account}/programs/{program}/checkoutSettings

Returns
Type	Description
`string`

setName

Identifier. The resource name of the program configuration settings.

Format: accounts/{account}/programs/{program}/checkoutSettings

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getUriSettings

URI settings for cart or checkout URL.

Returns
Type	Description
`UriSettings\|null`

hasUriSettings

clearUriSettings

setUriSettings

URI settings for cart or checkout URL.

Parameter
Name	Description
`var`	`UriSettings`

Returns
Type	Description
`$this`

getEligibleDestinations

Optional. The destinations to which the checkout program applies, valid destination values are SHOPPING_ADS, FREE_LISTINGS

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setEligibleDestinations

Optional. The destinations to which the checkout program applies, valid destination values are SHOPPING_ADS, FREE_LISTINGS

Parameter
Name	Description
`var`	`int[]`

Returns
Type	Description
`$this`

getEnrollmentState

Output only. Reflects the merchant enrollment state in Checkout program.

Returns
Type	Description
`int`

hasEnrollmentState

clearEnrollmentState

setEnrollmentState

Output only. Reflects the merchant enrollment state in Checkout program.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getReviewState

Output only. Reflects the merchant review state in Checkout program.

This is set based on the data quality reviews of the URL provided by the merchant. A merchant with enrollment state as ENROLLED can be in the following review states: IN_REVIEW, APPROVED or DISAPPROVED. A merchant must be in an enrollment_state of ENROLLED before a review can begin for the merchant.For more details, check the help center doc.

Returns
Type	Description
`int`

hasReviewState

clearReviewState

setReviewState

Output only. Reflects the merchant review state in Checkout program.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getEffectiveUriSettings

Output only. The effective value of uri_settings for a given merchant. If account level settings are present then this value will be a copy of url settings. Otherwise, it will have the value of the parent account (for only marketplace sellers).

Returns
Type	Description
`UriSettings\|null`

hasEffectiveUriSettings

clearEffectiveUriSettings

setEffectiveUriSettings

Parameter
Name	Description
`var`	`UriSettings`

Returns
Type	Description
`$this`

getEffectiveEnrollmentState

Output only. The effective value of enrollment_state for a given merchant ID. If account level settings are present then this value will be a copy of the account level settings. Otherwise, it will have the value of the parent account (for only marketplace sellers).

Returns
Type	Description
`int`

hasEffectiveEnrollmentState

clearEffectiveEnrollmentState

setEffectiveEnrollmentState

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getEffectiveReviewState

Output only. The effective value of review_state for a given merchant ID.

If account level settings are present then this value will be a copy of the account level settings. Otherwise, it will have the value of the parent account (for only marketplace sellers).

Returns
Type	Description
`int`

hasEffectiveReviewState

clearEffectiveReviewState

setEffectiveReviewState