店舗コードによる拠点の取得

名前	型	必須	説明	デフォルト
storeCodes	string	必須	JSON-encoded array of store code strings, e.g. `["ACME01","jio678"]`. URL-encode the value.	—

名前

型

必須

説明

デフォルト

storeCodes

string

必須

JSON-encoded array of store code strings, e.g. `["ACME01","jio678"]`. URL-encode the value.

—

レスポンス

200Array of full location objects matching the provided store codes. Returns `null` when no store codes match.

Response

{  "data": {    "getLocationsByStoreCodes": [      {        "id": "TG9jYXRpb246MTgwMDI4OQ==",        "databaseId": 1800289,        "accountId": 12345,        "storeId": "ACME01",        "name": "Jenny Home",        "archived": false,        "street": "600 Congress Ave, Suite 200",        "city": "Austin",        "stateIso": "TX",        "postalCode": "78701",        "countryIso": "US",        "phone": "5125550142",        "categoryId": 15,        "subCategoryId": 1432,        "subCategoryName": "Restaurants",        "package": "PREMIUM",        "planId": 3797,        "planName": "Launch",        "placeActionLinks": [          {            "placeActionType": "FOOD_ORDERING",            "uri": "https://order.example.com",            "isPreferred": true,            "name": "locations/1944.../placeActionLinks/54ada85bc246058a",            "submissionStatus": "success"          }        ],        "discoveredPlaceActionLinks": []      }    ]  }}

401Unauthenticated, missing or invalid API key.

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

店舗コードから拠点の完全なレコードを取得します。これは、Listings APIの内部IDで拠点を追跡する操作の逆にあたります。自社のシステム（POS、フランチャイズ加盟店名簿、PIM）で店舗コードを拠点のキーとして使用しており、対応するListings APIの拠点を取得または照合する必要がある場合に使用します。コードをJSON形式の配列にエンコードし、さらにURLエンコードして、storeCodesクエリパラメーターに渡します。

ユースケース：フランチャイズ加盟店名簿の照合。 マスターリストの店舗コードを使用して?storeCodes=["ACME01","ACME02","ACME03"]を呼び出し、返された各オブジェクトのstoreIdを自社のレコードと照合することで、Listings APIにすでに登録されている店舗を確認します。一致する拠点がないコードは、返される配列に含まれません。

注意点：空の場合と値がない場合の違い。 指定したコードのいずれもアカウント内の拠点に一致しない場合、getLocationsByStoreCodesは空の配列ではなくnullになるため、反復処理の前にnullかどうかを確認してください。拠点が店舗コードを持つのは、作成時または更新によってstoreIdが設定された場合のみであり、店舗コードのない拠点はIDでのみ取得できます。レート制限を超えないように複数のコードを1回の呼び出しにまとめ、429が返された場合はRetry-Afterヘッダーに従ってください。

各拠点について、placeActionLinks（Listings APIが管理するGoogleアクションリンク）とdiscoveredPlaceActionLinks（ビジネスのGoogleプロフィール上で直接見つかった、まだ管理されていないリンク）が返されます。Place Action Linksガイドを参照してください。