Content API for Shopping . freelistingsprogram . checkoutsettings

close()

Close httplib2 connections.

delete(merchantId, x__xgafv=None)

Deletes `Checkout` settings and unenrolls merchant from `Checkout` program.

Args:
  merchantId: string, Required. The ID of the account. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

get(merchantId, x__xgafv=None)

Gets Checkout settings for the given merchant. This includes information about review state, enrollment state and URL settings.

Args:
  merchantId: string, Required. The ID of the account. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # `CheckoutSettings` for a specific merchant ID.
  "effectiveEnrollmentState": "A String", # 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.
  "effectiveReviewState": "A String", # 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.
  "effectiveUriSettings": { # 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 data from the merchant account with this attribute [offer_id](https://developers.google.com/shopping-content/reference/rest/v2.1/products#Product.FIELDS.offer_id) # The effective value of `url_settings` 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.
    "cartUriTemplate": "A String", # 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.
    "checkoutUriTemplate": "A String", # URL template when the placeholders are expanded will redirect the buyer to the merchant checkout page with the item in the cart.
  },
  "enrollmentState": "A String", # Output only. Reflects the merchant enrollment state in `Checkout` feature.
  "merchantId": "A String", # Required. The ID of the account.
  "reviewState": "A String", # Output only. Reflects the merchant review state in `Checkout` feature. 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.
  "uriSettings": { # 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 data from the merchant account with this attribute [offer_id](https://developers.google.com/shopping-content/reference/rest/v2.1/products#Product.FIELDS.offer_id) # URL settings for cart or checkout URL.
    "cartUriTemplate": "A String", # 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.
    "checkoutUriTemplate": "A String", # URL template when the placeholders are expanded will redirect the buyer to the merchant checkout page with the item in the cart.
  },
}

insert(merchantId, body=None, x__xgafv=None)

Enrolls merchant in `Checkout` program.

Args:
  merchantId: string, Required. The ID of the account. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for the `InsertCheckoutSettings` method.
  "uriSettings": { # 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 data from the merchant account with this attribute [offer_id](https://developers.google.com/shopping-content/reference/rest/v2.1/products#Product.FIELDS.offer_id) # Required. The `UrlSettings` for the request. The presence of URL settings indicates `Checkout` enrollment.
    "cartUriTemplate": "A String", # 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.
    "checkoutUriTemplate": "A String", # URL template when the placeholders are expanded will redirect the buyer to the merchant checkout page with the item in the cart.
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # `CheckoutSettings` for a specific merchant ID.
  "effectiveEnrollmentState": "A String", # 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.
  "effectiveReviewState": "A String", # 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.
  "effectiveUriSettings": { # 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 data from the merchant account with this attribute [offer_id](https://developers.google.com/shopping-content/reference/rest/v2.1/products#Product.FIELDS.offer_id) # The effective value of `url_settings` 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.
    "cartUriTemplate": "A String", # 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.
    "checkoutUriTemplate": "A String", # URL template when the placeholders are expanded will redirect the buyer to the merchant checkout page with the item in the cart.
  },
  "enrollmentState": "A String", # Output only. Reflects the merchant enrollment state in `Checkout` feature.
  "merchantId": "A String", # Required. The ID of the account.
  "reviewState": "A String", # Output only. Reflects the merchant review state in `Checkout` feature. 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.
  "uriSettings": { # 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 data from the merchant account with this attribute [offer_id](https://developers.google.com/shopping-content/reference/rest/v2.1/products#Product.FIELDS.offer_id) # URL settings for cart or checkout URL.
    "cartUriTemplate": "A String", # 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.
    "checkoutUriTemplate": "A String", # URL template when the placeholders are expanded will redirect the buyer to the merchant checkout page with the item in the cart.
  },
}