Method: accounts.lfpStores.list
透過集合功能整理內容
你可以依據偏好儲存及分類內容。
列出目標商家的商店,由 ListLfpStoresRequest
中的篩選器指定。
HTTP 要求
GET https://merchantapi.googleapis.com/lfp/v1beta/{parent=accounts/*}/lfpStores
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 |
parent |
string
必要欄位。LFP 合作夥伴。格式:accounts/{account}
|
查詢參數
參數 |
targetAccount |
string (int64 format)
必要欄位。要列出商店的商家 Merchant Center ID。
|
pageSize |
integer
選用設定。指定帳戶可傳回的 LfpStore 資源數量上限。如果指定帳戶的商店數量少於 pageSize ,服務會傳回少於這個值的數量。預設值為 250。許可的最大值為 1000;如果指定的值高於上限,pageSize 預設值會設為上限。
|
pageToken |
string
選用設定。從先前 ListLfpStoresRequest 呼叫收到的網頁權杖。提供頁面符記即可擷取後續網頁。進行分頁時,提供至 ListLfpStoresRequest 的所有其他參數須與提供網頁權杖的呼叫相符。在先前要求的回應中,權杖會以 nextPageToken 的形式傳回。
|
回應主體
lfpStores.list 方法的回應訊息。
如果成功,回應主體會含有以下結構的資料:
JSON 表示法 |
{
"lfpStores": [
{
object (LfpStore )
}
],
"nextPageToken": string
} |
欄位 |
lfpStores[] |
object (LfpStore )
指定商家的商店。
|
nextPageToken |
string
可做為 pageToken 傳送的權杖,用於擷取後續網頁。如果省略這個欄位,就不會有後續頁面。
|
授權範圍
需要下列 OAuth 範圍:
https://www.googleapis.com/auth/content
詳情請參閱 OAuth 2.0 Overview。
除非另有註明,否則本頁面中的內容是採用創用 CC 姓名標示 4.0 授權,程式碼範例則為阿帕契 2.0 授權。詳情請參閱《Google Developers 網站政策》。Java 是 Oracle 和/或其關聯企業的註冊商標。
上次更新時間:2025-01-23 (世界標準時間)。
[null,null,["上次更新時間:2025-01-23 (世界標準時間)。"],[[["\u003cp\u003eLists stores for a target merchant using the \u003ccode\u003eListLfpStoresRequest\u003c/code\u003e filter.\u003c/p\u003e\n"],["\u003cp\u003eRequires specifying the LFP partner and Merchant Center ID in the request.\u003c/p\u003e\n"],["\u003cp\u003eSupports pagination to retrieve large lists of stores.\u003c/p\u003e\n"],["\u003cp\u003eReturns an array of \u003ccode\u003eLfpStore\u003c/code\u003e objects containing store information.\u003c/p\u003e\n"],["\u003cp\u003eRequires the \u003ccode\u003ehttps://www.googleapis.com/auth/content\u003c/code\u003e OAuth scope for authorization.\u003c/p\u003e\n"]]],["This describes how to list a merchant's stores using an HTTP GET request to `https://merchantapi.googleapis.com/lfp/v1beta/{parent=accounts/*}/lfpStores`. The `parent` path parameter specifies the account. Required query parameters include `targetAccount` for the merchant ID. Optional query parameters `pageSize` and `pageToken` control pagination. The empty request returns a JSON response with an array of `lfpStores` and an optional `nextPageToken` for pagination, all requiring OAuth scope `https://www.googleapis.com/auth/content`.\n"],null,["# Method: accounts.lfpStores.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListLfpStoresResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists the stores of the target merchant, specified by the filter in `ListLfpStoresRequest`.\n\n### HTTP request\n\n`GET https://merchantapi.googleapis.com/lfp/v1beta/{parent=accounts/*}/lfpStores`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|------------------------------------------------------------------|\n| `parent` | `string` Required. The LFP partner. Format: `accounts/{account}` |\n\n### Query parameters\n\n| Parameters ||\n|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `targetAccount` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Required. The Merchant Center id of the merchant to list stores for. |\n| `pageSize` | `integer` Optional. The maximum number of `LfpStore` resources for the given account to return. The service returns fewer than this value if the number of stores for the given account is less than the `pageSize`. The default value is 250. The maximum value is 1000; If a value higher than the maximum is specified, then the `pageSize` will default to the maximum. |\n| `pageToken` | `string` Optional. A page token, received from a previous `ListLfpStoresRequest` call. Provide the page token to retrieve the subsequent page. When paginating, all other parameters provided to `ListLfpStoresRequest` must match the call that provided the page token. The token returned as [nextPageToken](/merchant/api/reference/rest/lfp_v1beta/accounts.lfpStores/list#body.ListLfpStoresResponse.FIELDS.next_page_token) in the response to the previous request. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message for the lfpStores.list method.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"lfpStores\": [ { object (/merchant/api/reference/rest/lfp_v1beta/accounts.lfpStores#LfpStore) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|----------------------------------------------------------------------------------------------------------------------------------------|\n| `lfpStores[]` | `object (`[LfpStore](/merchant/api/reference/rest/lfp_v1beta/accounts.lfpStores#LfpStore)`)` The stores from the specified merchant. |\n| `nextPageToken` | `string` A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted, there are no subsequent pages. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/content`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2)."]]