연결된 계정의 등록 정보 가져오기

매개변수

본문

이름	유형	필수	설명
connectedAccountId	string	필수	UUID of the connected account whose listings to fetch. Send this in the JSON body: as a query parameter it is ignored.
page	integer	선택	Page number to fetch. Defaults to 1.
perPage	integer	선택	Records per page. Defaults to 500, which is also the maximum.
locationInfo	string	선택	Free-text search within the account's listings. Matches business name, address lines, locality, postal code, store code, and phone.

응답

200List of listings accessible to the account, with pagination metadata.

Response

{  "data": {    "connectedAccountListings": {      "pageInfo": {        "hasNextPage": false,        "hasPreviousPage": false,        "totalPages": 1,        "totalRecords": 60      },      "records": [        {          "accountTypeName": "Google",          "address": "123 William St, NY 10038, Manhattan, US",          "id": "R21iQnVsa0RhdGFMYWtlOjA2MDQ4NmExLTA0NzQtNDc4NS1iMjNhLTBkOGM4MzhmNGQ5OA==",          "liveLink": null,          "locationName": "Trial",          "phone": "(718) 667-7787"        }      ]    }  }}

401Unauthenticated, missing or invalid API key.

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

연결된 계정에서 액세스할 수 있는 Google Business Profile 또는 Facebook 등록 정보를 반환합니다. 각 레코드에는 등록 정보의 id(base64 ID), locationName, address, phone, liveLink가 포함됩니다. POST이지만 읽기 작업이며, 계정 및 페이지네이션 옵션은 반드시 JSON 본문으로 전송해야 합니다.

사용 사례: 등록 정보 선택기 만들기. 고객이 수십 개의 등록 정보를 소유한 Google 계정을 연결한 후 이 엔드포인트를 호출하여 검색 가능한 목록을 표시합니다. 고객이 입력한 검색어를 locationInfo에 넣으면 이름, 주소, 전화번호, 우편번호, 매장 코드 내에서 일치하는 항목을 검색하므로 고객이 원하는 매장을 빠르게 찾을 수 있습니다.

사용 사례: connect-listing에 입력값 제공하기. 각 레코드의 id는 connect-listing이 요구하는 connectedAccountListingId와 정확히 같습니다. 등록 정보를 가져와 고객 또는 매칭 로직이 하나를 선택하게 한 다음, 해당 등록 정보의 id와 대상 Listings API locationId를 connect-listing에 전달하여 연결합니다.

본문의 최상위 page 및 perPage 키로 페이지네이션을 적용하며, perPage의 기본값은 500이고 최댓값도 500입니다. 응답에서 pageInfo.hasNextPage와 pageInfo.totalPages를 읽어 전체 결과를 페이지별로 조회합니다. 이 엔드포인트 호출은 계정의 요청 빈도 제한에 포함되며, 429에는 Retry-After 헤더가 포함됩니다.

위 요청 구조는 실제 API를 대상으로 검증되었습니다. 샘플 응답은 설명을 위한 예시입니다.

curl -X POST 'https://listingsapi.com/api/v4/connected-accounts/connected-account-listings' \ -H "Authorization: API $LISTINGSAPI_KEY" \ -H 'Content-Type: application/json' \ -d '{ "connectedAccountId": "4f712c17-4f95-42dd-90f4-97171a2e67b5", "perPage": 50 }'

매개변수

본문

요청 예시

응답