Reference documentation and code samples for the Google Shopping Merchant Accounts V1 Client class CheckoutSettings.
CheckoutSettings for a specific merchant.
Generated from protobuf message google.shopping.merchant.accounts.v1.CheckoutSettings
Namespace
Google \ Shopping \ Merchant \ Accounts \ V1Methods
__construct
Constructor.
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
↳ eligible_destinations
array
Optional. The destinations (also known as Marketing methods
) 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
string
setName
Identifier. The resource name of the program configuration settings.
Format: accounts/{account}/programs/{program}/checkoutSettings
var
string
$this
getUriSettings
URI settings for cart or checkout URL.
hasUriSettings
clearUriSettings
setUriSettings
URI settings for cart or checkout URL.
$this
getEligibleDestinations
Optional. The destinations (also known as Marketing
methods
) to which
the checkout program applies, valid destination values are SHOPPING_ADS
, FREE_LISTINGS
setEligibleDestinations
Optional. The destinations (also known as Marketing
methods
) to which
the checkout program applies, valid destination values are SHOPPING_ADS
, FREE_LISTINGS
var
int[]
$this
getEnrollmentState
Output only. Reflects the merchant enrollment state in Checkout
program.
int
hasEnrollmentState
clearEnrollmentState
setEnrollmentState
Output only. Reflects the merchant enrollment state in Checkout
program.
var
int
$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.
int
hasReviewState
clearReviewState
setReviewState
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.
var
int
$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).
hasEffectiveUriSettings
clearEffectiveUriSettings
setEffectiveUriSettings
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).
$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).
int
hasEffectiveEnrollmentState
clearEffectiveEnrollmentState
setEffectiveEnrollmentState
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).
var
int
$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).
int
hasEffectiveReviewState
clearEffectiveReviewState
setEffectiveReviewState
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).
var
int
$this
