요금제 사이트 목록 조회

응답

200Array of plan site objects. Country arrays are truncated below for brevity; the live response lists every supported country.

Response

{  "data": {    "planSites": [      {        "hideAddressSupportedCountries": ["US", "CA", "AU", "IN", "GB"],        "id": 1,        "name": "Google Maps",        "supportedCountries": ["US", "CA", "IN", "GB", "DE"],        "url": "maps.google.com"      },      {        "hideAddressSupportedCountries": ["US", "CA", "AU", "IN", "GB"],        "id": 184,        "name": "Facebook",        "supportedCountries": ["US", "CA", "IN", "GB", "DE"],        "url": "facebook.com"      },      {        "hideAddressSupportedCountries": ["US", "CA", "AU", "GB"],        "id": 2,        "name": "Yelp",        "supportedCountries": ["US", "CA", "GB", "DE", "FR"],        "url": "yelp.com"      }    ]  }}

401Unauthenticated, missing or invalid API key.

429Rate limit exceeded. Retry after the `Retry-After` header value.

현재 계정에 연결된 요금제에 포함된 모든 게시 플랫폼 디렉터리 사이트를 반환합니다. 각 항목에는 정수형 id, 표시용 name, 사이트의 url, 사이트에서 허용하는 ISO 국가 코드 목록(supportedCountries), 주소 숨김 / 서비스 지역 플래그가 적용되는 국가 목록(hideAddressSupportedCountries)이 포함됩니다.

사용 사례: 유효한 사이트 ID 선택기 구현. 사업장에서 게시 플랫폼을 활성화하거나 비활성화하기 전에 이 엔드포인트를 호출하여 해당 요금제에 어떤 숫자형 사이트 ID가 있는지 확인합니다. 여기서 반환된 ID만 API의 다른 곳에 전달할 수 있습니다. id를 name/url에 매핑하여 사람이 읽기 쉬운 제출 설정 화면을 표시합니다.

사용 사례: 사업장의 국가 사전 확인. 응답에서 supportedCountries에 사업장의 countryIso가 포함된 사이트만 필터링하여 실제로 등록 정보를 허용하는 게시 플랫폼만 선택할 수 있도록 합니다. 서비스 지역 기반 업체의 경우 hideAddressSupportedCountries를 대조하여 어느 국가에서 주소를 숨길 수 있는지 확인합니다.

주의 사항.

이 목록은 요금제 범위로 제한되며 페이지로 나누지 않습니다. 요금제의 전체 사이트 카탈로그를 한 번의 응답으로 반환하므로 커서가 없습니다. 항목이 수십 개에 이를 수 있으므로 요청할 때마다 호출하지 말고 결과를 캐시합니다.
supportedCountries와 hideAddressSupportedCountries에는 각각 50개 이상의 ISO 코드가 포함될 수 있으며, 위 예시에서는 일부가 생략되어 있습니다.
계정의 요청 빈도 제한을 공유하며, 429가 반환되면 Retry-After 헤더를 따릅니다.

매개변수

응답