REST Resource: accounts.programs.checkoutSettings

Resource: CheckoutSettings

CheckoutSettings for a specific merchant.

JSON representation 
{
  "name": string,
  "eligibleDestinations": [
    enum (DestinationEnum)
  ],
  "effectiveUriSettings": {
    object (UriSettings)
  },
  "uriSettings": {
    object (UriSettings)
  },
  "enrollmentState": enum (CheckoutEnrollmentState),
  "reviewState": enum (CheckoutReviewState),
  "effectiveEnrollmentState": enum (CheckoutEnrollmentState),
  "effectiveReviewState": enum (CheckoutReviewState)
}
Fields
name

string

Identifier. The resource name of the program configuration settings. Format: accounts/{account}/programs/{program}/checkoutSettings
eligibleDestinations[]

enum (DestinationEnum)

Optional. The destinations (also known as Marketing methods) to which the checkout program applies, valid destination values are SHOPPING_ADS, FREE_LISTINGS
effectiveUriSettings

object (UriSettings)

Output only. The effective value of uriSettings 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).
uriSettings

object (UriSettings)

URI settings for cart or checkout URL.
enrollmentState

enum (CheckoutEnrollmentState)

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

enum (CheckoutReviewState)

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 enrollmentState of ENROLLED before a review can begin for the merchant.For more details, check the help center doc.
effectiveEnrollmentState

enum (CheckoutEnrollmentState)

Output only. The effective value of enrollmentState 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).
effectiveReviewState

enum (CheckoutReviewState)

Output only. The effective value of reviewState 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).

UriSettings

URL settings for cart or checkout URL.

JSON representation 
{

  // Union field uri_template can be only one of the following:
  "checkoutUriTemplate": string,
  "cartUriTemplate": string
  // End of list of possible types for union field uri_template.
}
Fields
Union field uri_template. Specifications related to the Checkout URL. The UriTemplate is of the form https://www.mystore.com/checkout?item_id={id} where {id} will be automatically replaced with offer_id attribute from the merchant account uri_template can be only one of the following:
checkoutUriTemplate

string

Checkout URL template. When the placeholders are expanded will redirect the buyer to the merchant checkout page with the item in the cart. For more details, check the help center doc
cartUriTemplate

string

Cart URL template. When the placeholders are expanded will redirect the buyer to the cart page on the merchant website with the selected item in cart. For more details, check the help center doc

CheckoutEnrollmentState

Enum indicating the enrollment state of merchant in Checkout program.

Enums
CHECKOUT_ENROLLMENT_STATE_UNSPECIFIED Default enrollment state when enrollment state is not specified.
INACTIVE Merchant has not enrolled into the program.
ENROLLED Merchant has enrolled into the program by providing either an account level URL or checkout URLs as part of their feed.
OPTED_OUT Merchant has previously enrolled but opted out of the program.

CheckoutReviewState

Enum indicating the review state of merchant in Checkout program.

Enums
CHECKOUT_REVIEW_STATE_UNSPECIFIED Default review state when review state is not specified.
IN_REVIEW Merchant provided URLs are being reviewed for data quality issues.
APPROVED Merchant account has been approved. Indicates the data quality checks have passed.
DISAPPROVED Merchant account has been disapproved due to data quality issues.

Methods

create

 Creates CheckoutSettings for the given merchant.

deleteCheckoutSettings

 Deletes CheckoutSettings and unenrolls merchant from Checkout program.

getCheckoutSettings

 Gets CheckoutSettings for the given merchant.

updateCheckoutSettings

 Updates CheckoutSettings for the given merchant.