프로그램 하위 API 개요

프로그램을 사용하면 다양한 Google 플랫폼에서 제품 홍보를 관리하고 계정의 기능을 개선할 수 있습니다.

그중 대표적인 예가 무료 제품 등록정보 프로그램으로, 이 프로그램을 사용하면 온라인 상점의 제품을 Google 서비스 전반에 무료로 표시할 수 있습니다.

Programs 하위 API를 사용하면 사용 가능한 모든 쇼핑 프로그램에 대한 참여를 검색하고 업데이트할 수 있습니다.

프로그램을 검색, 사용 설정, 사용 중지하려면 다음 메서드를 사용하세요.

모든 프로그램 나열

계정의 모든 프로그램을 검색하려면 accounts.programs.list 메서드를 사용하세요.

다음은 샘플 요청입니다.

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

다음은 성공적인 요청의 샘플 응답입니다.

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

단일 프로그램 검색

특정 프로그램을 가져오려면 accounts.programs.get 메서드를 사용합니다.

다음은 샘플 요청입니다.

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

다음은 성공적인 요청의 샘플 응답입니다.

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

프로그램 사용 설정

계정의 지정된 프로그램 참여를 사용 설정하려면 accounts.programs.enable 메서드를 사용합니다. 이 권한을 실행하려면 관리자 액세스 권한이 있어야 합니다.

다음은 샘플 요청입니다.

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

다음은 성공적인 요청의 샘플 응답입니다.

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

프로그램 사용 중지

계정의 지정된 프로그램 참여를 사용 중지하려면 accounts.programs.disable 메서드를 사용합니다. 이 권한을 실행하려면 관리자 액세스 권한이 있어야 합니다.

다음은 샘플 요청입니다.

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

다음은 성공적인 요청의 샘플 응답입니다.

{
  "name": "accounts/{ACCOUNT_ID}/programs/free-listings",
  "documentationUri": "{URI}",
  "state": "{ACCOUNT_STATE}"
}