Method: chains.search
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
בקשת HTTP
GET https://mybusiness.googleapis.com/v4/chains:search
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
פרמטרים של שאילתה
פרמטרים |
chainDisplayName |
string
מחפשים רשת לפי השם שלה. יש תמיכה בשאילתות מדויקות/חלקיות/מטושטשות או קשורות. דוגמאות: "walmart" , "wal-mart" , "walmmmart" , "沃尔玛"
|
resultCount |
integer
המספר המקסימלי של שרשראות תואמות שצריך להחזיר מהשאילתה הזו. ערך ברירת המחדל הוא 10. הערך המקסימלי האפשרי הוא 500.
|
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התשובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:
הודעת תגובה ל-Locations.SearchChains.
ייצוג JSON |
{
"chains": [
{
object (Chain )
}
]
} |
שדות |
chains[] |
object (Chain )
רשתות שתואמות ל-שרשרתDisplayName שהשאילתה מבקשת ב-SearchChainsRequest. אם אין התאמות, השדה הזה יהיה ריק. התוצאות מוצגות לפי סדר הרלוונטיות שלהן.
|
היקפי הרשאות
נדרש אחד מהיקפי ההרשאות הבאים של OAuth:
https://www.googleapis.com/auth/plus.business.manage
https://www.googleapis.com/auth/business.manage
למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-07-25 (שעון UTC).
[null,null,["עדכון אחרון: 2025-07-25 (שעון UTC)."],[[["\u003cp\u003eThis document details how to search for a business chain using the \u003ccode\u003esearch\u003c/code\u003e endpoint and the \u003ccode\u003echainDisplayName\u003c/code\u003e query parameter.\u003c/p\u003e\n"],["\u003cp\u003eThe request body should be empty, and the response will include a list of chains matching the query, ranked by relevance.\u003c/p\u003e\n"],["\u003cp\u003eThe maximum number of results returned can be controlled using the \u003ccode\u003eresultCount\u003c/code\u003e query parameter, with a default of 10 and a maximum of 500.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization is required using either the \u003ccode\u003ehttps://www.googleapis.com/auth/plus.business.manage\u003c/code\u003e or \u003ccode\u003ehttps://www.googleapis.com/auth/business.manage\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],[],null,["# Method: chains.search\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.SearchChainsResponse.SCHEMA_REPRESENTATION)\n- [Authorization Scopes](#body.aspect)\n\nSearches the chain based on chain name.\n\n### HTTP request\n\n`GET https://mybusiness.googleapis.com/v4/chains:search`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|--------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|\n| `chainDisplayName` | `string` Search for a chain by its name. Exact/partial/fuzzy/related queries are supported. Examples: \"walmart\", \"wal-mart\", \"walmmmart\", \"沃尔玛\" |\n| `resultCount` | `integer` The maximum number of matched chains to return from this query. The default is 10. The maximum possible value is 500. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\nResponse message for Locations.SearchChains.\n\n| JSON representation ||\n|------------------------------------------------------------------------------------|---|\n| ``` { \"chains\": [ { object (/my-business/reference/rest/v4/chains#Chain) } ] } ``` |\n\n| Fields ||\n|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `chains[]` | `object (`[Chain](/my-business/reference/rest/v4/chains#Chain)`)` Chains that match the queried chainDisplayName in SearchChainsRequest. If there are no matches, this field will be empty. Results are listed in order of relevance. |\n\n### Authorization Scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/plus.business.manage`\n- `https://www.googleapis.com/auth/business.manage`\n\nFor more information, see the [OAuth 2.0 Overview](https://developers.google.com/identity/protocols/OAuth2)."]]