GET/api/v4/locations/{locationId}/listings/premium

获取某个地点的高级商家信息

返回某个地点的套餐中每个发布平台目录的同步状态。

需要 API 密钥。请求头格式和密钥轮换请参阅身份验证。

参数

路径

名称类型必填描述
locationIdstring必填Location to read. Accepts a base64-encoded Relay ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`) or a raw numeric location ID.

响应

200Array of listings with per-directory sync status.
Response
{  "data": {    "listingsForLocation": [      {        "id": "TGlzdGluZzoxMDQ0Njg3MjM=",        "databaseId": "104468723",        "site": { "id": "U2l0ZTox", "databaseId": "1", "name": "Google Maps", "url": "maps.google.com", "syScore": "100" },        "syncStatus": "REQUIRING_ACTION",        "displayStatus": "Connect your account to sync the listing",        "actionRequired": true,        "listingUrl": null,        "connectedAccountId": null,        "lastUpdate": "2026-07-06T18:33:28Z",        "indexStatus": false,        "syncIssue": null,        "verified": false      },      {        "id": "TGlzdGluZzoxMDQ0Njg3MTQ=",        "databaseId": "104468714",        "site": { "id": "U2l0ZToxODA=", "databaseId": "180", "name": "Bing", "url": "www.bing.com", "syScore": "97" },        "syncStatus": "IN_PROGRESS",        "displayStatus": "Information submitted to partner; awaiting response",        "actionRequired": false,        "listingUrl": null,        "connectedAccountId": null,        "lastUpdate": "2026-07-06T18:33:35Z",        "indexStatus": false,        "syncIssue": null,        "verified": false      },      {        "id": "TGlzdGluZzoxMDQ0Njg3Mjc=",        "databaseId": "104468727",        "site": { "id": "U2l0ZTozODc=", "databaseId": "387", "name": "BeLocalFocussed", "url": "belocalfocussed.com", "syScore": "80" },        "syncStatus": "SYNCED",        "displayStatus": "Synced",        "actionRequired": false,        "listingUrl": "https://belocalfocussed.com/jenny-home-26x0ffkd0e",        "connectedAccountId": null,        "lastUpdate": "2026-07-06T18:33:30Z",        "indexStatus": false,        "syncIssue": null,        "verified": false      },      {        "id": "TGlzdGluZzoxMDQ0Njg3MDk=",        "databaseId": "104468709",        "site": { "id": "U2l0ZTozMDE=", "databaseId": "301", "name": "Local Mint", "url": "localmint.com", "syScore": "69" },        "syncStatus": "FAILED",        "displayStatus": "Partner experiencing issues; awaiting response",        "actionRequired": false,        "listingUrl": null,        "connectedAccountId": null,        "lastUpdate": "2026-07-06T18:34:03Z",        "indexStatus": false,        "syncIssue": "Publisher requires website URL",        "verified": false      }    ]  }}
401Unauthenticated, missing or invalid API key.
429Rate limit exceeded. Retry after the `Retry-After` header value.

返回某个地点的套餐所包含的每个发布平台目录的同步状态。每条记录都将一个 site(目录元数据)与一个 syncStatus 及一个便于阅读的 displayStatus 配对。上面的示例从 Jenny Home 的实时响应(返回超过 30 个目录)中截取,展示了每种常见状态下的一条记录。

商家信息层级是路径的一部分:/listings/premium 返回套餐中的高级目录(此处所示),/listings/additional 返回附加/免费商家信息。没有 listingType 查询参数;通过该参数传入的值会被忽略。

使用场景:商家信息健康状况控制台

获取某个地点的高级商家信息,并按 syncStatus 分组,以便一目了然地展示覆盖情况,包括已上线、处理中或受阻的目录数量。为 SYNCED 行显示 listingUrl,以便用户点击访问已上线的商家信息,并读取所有未同步条目的 displayStatus/syncIssue(例如 Publisher requires website URL)。

使用场景:列出需要“连接您的账号”的阻塞项

筛选出 actionRequired: true,以构建所有者的待办事项列表。在实时数据中,Google Maps、Facebook 和 Waze 返回 REQUIRING_ACTION,同时带有 displayStatus: "Connect your account to sync the listing",这些发布平台需要先建立 OAuth 连接才能同步。引导所有者进入相应的连接流程,然后重新轮询此端点以观察状态变化。

syncStatus 的值: AVAILABLE(已准备好同步,尚未开始),IN_PROGRESS(已提交给合作伙伴,等待响应),PENDING_APPROVAL(等待合作伙伴批准),SYNCED/COMPLETED(已上线;listingUrl 已填充),REQUIRING_ACTION(需要所有者处理,参见 displayStatus),FAILED(同步失败;参见 syncIssue),CANNOT_SUBMIT(无法提交)。

这是按地点返回的列表,受账户速率限制约束;遇到 429 时,请等待 Retry-After 响应头指定的时间后重试,而不要立即重新轮询。

Request
curl -X GET 'https://listingsapi.com/api/v4/locations/<locationId>/listings/premium' \  -H "Authorization: API $LISTINGSAPI_KEY"