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。
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2025-01-23。
[null,null,["最后更新时间 (UTC):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)."]]