Tổng quan về API phụ của Chương trình

Các chương trình giúp bạn kiểm soát việc quảng bá sản phẩm và cải thiện các tính năng của tài khoản trên nhiều nền tảng của Google.

Một ví dụ điển hình là chương trình trang thông tin miễn phí về sản phẩm, giúp sản phẩm trong cửa hàng trực tuyến của bạn xuất hiện trên Google mà không mất phí.

API phụ Programs cho phép bạn truy xuất và cập nhật thông tin về việc tham gia của bạn trong tất cả các chương trình mua sắm hiện có.

Để truy xuất, bật và tắt chương trình, bạn có thể sử dụng các phương thức sau:

Liệt kê tất cả chương trình

Để truy xuất tất cả chương trình cho tài khoản, hãy sử dụng phương thức accounts.programs.list.

Sau đây là một yêu cầu mẫu:

HTTP

GET https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/programs

cURL

  curl \
  'https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/programs?key={YOUR_API_KEY}' \
  --header 'Authorization: Bearer {YOUR_ACCESS_TOKEN}' \
  --header 'Accept: application/json' \
  --compressed

Sau đây là phản hồi mẫu cho một yêu cầu thành công:

{
  "programs": [
    {
      "name": "accounts/{ACCOUNT_ID}/programs/free-listings",
      "documentationUri": "{URI}",
      "state": "{ACCOUNT_STATE}",
      "unmetRequirements": [
        {
          "title": "{TITLE}",
          "documentationUri": "{URI}",
          "affectedRegionCodes": [
            "{REGION_CODE}"
          ]
        }
      ]
    }
  ]
}

Truy xuất một chương trình

Để truy xuất một chương trình cụ thể, hãy sử dụng phương thức accounts.programs.get.

Sau đây là một yêu cầu mẫu:

HTTP

GET https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/programs/free-listings

cURL

  curl \
  'https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/programs/free-listing?key={YOUR_API_KEY}' \
  --header 'Authorization: Bearer {YOUR_ACCESS_TOKEN}' \
  --header 'Accept: application/json' \
  --compressed

Sau đây là phản hồi mẫu cho một yêu cầu thành công:

{
  "name": "accounts/{ACCOUNT_ID}/programs/free-listings",
  "documentationUri": "{URI}",
  "state": "{ACCOUNT_STATE}",
  "unmetRequirements": [
    {
      "title": "{TITLE}",
      "documentationUri": "{URI}",
      "affectedRegionCodes": [
        "{REGION_CODE}"
      ]
    }
  ]
}

Bật một chương trình

Để cho phép tài khoản tham gia chương trình đã chỉ định, hãy sử dụng phương thức accounts.programs.enable. Bạn phải có quyền quản trị để chạy quyền này.

Sau đây là một yêu cầu mẫu:

HTTP

POST https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/programs/free-listings:enable

cURL

  curl --request POST \
  'https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/programs/free-listing:enable?key={YOUR_API_KEY}' \
  --header 'Authorization: Bearer {YOUR_ACCESS_TOKEN}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{}' \
  --compressed

Sau đây là phản hồi mẫu cho một yêu cầu thành công:

{
  "name": "accounts/{ACCOUNT_ID}/programs/free-listings",
  "documentationUri": "{URI}",
  "state": "{ACCOUNT_STATE}",
  "unmetRequirements": [
    {
      "title": "{TITLE}",
      "documentationUri": "{URI}",
      "affectedRegionCodes": [
        "{REGION_CODE}"
      ]
    }
  ]
}

Tắt chương trình

Để tắt tính năng tham gia chương trình được chỉ định cho tài khoản, hãy sử dụng phương thức accounts.programs.disable. Bạn phải có quyền quản trị để chạy quyền này.

Sau đây là một yêu cầu mẫu:

HTTP

POST https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/programs/free-listings:disable

cURL

  curl --request POST \
  'https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/programs/free-listing:disable?key={YOUR_API_KEY}' \
  --header 'Authorization: Bearer {YOUR_ACCESS_TOKEN}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{}' \
  --compressed

Sau đây là phản hồi mẫu cho một yêu cầu thành công:

{
  "name": "accounts/{ACCOUNT_ID}/programs/free-listings",
  "documentationUri": "{URI}",
  "state": "{ACCOUNT_STATE}"
}
Tiếp
Manage loyalty programs