Method: ampUrls.batchGet
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
בקשת HTTP
POST https://acceleratedmobilepageurl.googleapis.com/v1/ampUrls:batchGet
כתובת ה-URL כוללת תחביר הערת HTTP של Google API.
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
| ייצוג JSON |
{
"urls": [
string
]
"lookupStrategy": enum(LookupStrategy),
} |
| שדות |
urls[] |
string
רשימת כתובות URL שיש לחפש לפי כתובות ה-URL של AMP שהותאמו. כתובות ה-URL הן תלויות אותיות רישיות. עד 50 כתובות URL לכל חיפוש (מידע נוסף זמין במאמר מגבלות שימוש).
|
lookupStrategy |
enum(LookupStrategy)
שיטת החיפוש המבוקשת.
|
גוף התגובה
אם התגובה מוצלחת, גוף התגובה מכיל נתונים במבנה הבא:
תגובה בכמות גדולה של כתובות URL ב-AMP.
| ייצוג JSON |
{
"ampUrls": [
{
object(AmpUrl)
}
],
"urlErrors": [
{
object(AmpUrlError)
}
],
}
|
| שדות |
ampUrls[] |
object(AmpUrl)
עבור כל כתובת URL ב-BatchAmpUrlsRequest, התגובה לכתובת ה-URL. ייתכן שהתגובה לא תהיה זהה לזו של כתובות ה-URL בבקשת האצווה. אם BatchAmpUrlsRequest מכיל כתובות URL משוכפלות, AmpUrl נוצרת פעם אחת בלבד.
|
urlErrors[] |
object(AmpUrlError)
השגיאות בכתובות ה-URL המבוקשות שאין להן כתובת URL של AMP.
|
שיטת חיפוש
| Enums |
FETCH_LIVE_DOC |
אסטרטגיית FETCH_LIVE_DOC כרוכה באחזור מסמכים פעיל של כתובות אתרים שלא נמצאו באינדקס. כל כתובת URL של בקשה שלא נמצאת באינדקס נסרקת בזמן אמת כדי לאמת אם יש כתובת URL תואמת של AMP. לשיטה הזו יש כיסוי גבוה יותר, אבל זמן אחזור נוסף נוצר על ידי סריקה בזמן אמת. זוהי שיטת ברירת המחדל. לאפליקציות שמשתמשות בשיטה הזו יש להגדיר זמני קצוב לתפוגה גבוהים יותר של HTTP בקריאות ל-API. |
IN_INDEX_DOC |
השיטה IN_INDEX_DOC מדלגת על מסמכים פעילים של כתובות אתרים שלא נמצאו באינדקס. לאפליקציות שבהן נדרש זמן אחזור קצר באסטרטגיה של IN_INDEX_DOC. |
כתובת URL של AMP
תגובה של כתובת URL מסוג AMP לכתובת URL מבוקשת.
| ייצוג JSON |
{
"originalUrl": string,
"ampUrl": string,
"cdnAmpUrl": string,
} |
| שדות |
originalUrl |
string
כתובת ה-URL המקורית שאינה בפורמט AMP.
|
ampUrl |
string
כתובת ה-URL של ה-AMP שמפנה לשרת האינטרנט של בעל התוכן הדיגיטלי.
|
cdnAmpUrl |
string
כתובת ה-URL של מטמון ה-AMP שמפנה למסמך שבמטמון במטמון Google AMP.
|
שגיאת AmpUrl
משאב שגיאה של כתובת אתר AMP שלא ניתן למצוא.
| ייצוג JSON |
{
"errorCode": enum(ErrorCode),
"errorMessage": string,
"originalUrl": string,
} |
| שדות |
errorCode |
enum(ErrorCode)
קוד השגיאה של קריאה ל-API.
|
errorMessage |
string
הודעת שגיאה תיאורית אופציונלית.
|
originalUrl |
string
כתובת ה-URL המקורית שאינה בפורמט AMP.
|
קוד שגיאה
קודי שגיאה לחיפוש קבוצת כתובות URL ב-AMP.
| Enums |
ERROR_CODE_UNSPECIFIED |
שגיאה לא מוגדרת. |
INPUT_URL_NOT_FOUND |
מציין שכתובת ה-URL המבוקשת לא נמצאה באינדקס, אולי מפני שלא ניתן למצוא אותה, כאשר Googlebot לא יכול לגשת אליה או בשל שגיאה אחרת. |
NO_AMP_URL |
מציין שלא נמצאה כתובת URL של AMP שתואמת לכתובת ה-URL המבוקשת. |
APPLICATION_ERROR |
מציין סוג של שגיאת יישום שקרתה בשרת. מומלץ ללקוח לנסות שוב. |
URL_IS_VALID_AMP |
הוצא משימוש: מציין שכתובת ה-URL המבוקשת היא כתובת URL חוקית של AMP. זהו מצב שאינו שגוי, ולכן אין להתייחס אליו כסימן להצלחה או לכישלון. הוא יוסר בגרסאות עתידיות של ה-API. |
URL_IS_INVALID_AMP |
מציין שכתובת ה-URL של AMP נמצאה שתואמת לכתובת ה-URL של הבקשה, אבל היא לא מסוג AMP HTML תקין. |
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2023-08-30 (שעון UTC).
[null,null,["עדכון אחרון: 2023-08-30 (שעון UTC)."],[[["\u003cp\u003eReturns AMP URLs and their corresponding AMP Cache URLs for given input URLs.\u003c/p\u003e\n"],["\u003cp\u003eUses a batch request containing up to 50 URLs and a lookup strategy (FETCH_LIVE_DOC or IN_INDEX_DOC).\u003c/p\u003e\n"],["\u003cp\u003eThe response includes the AMP URL and AMP Cache URL for successful lookups and error details for unsuccessful ones.\u003c/p\u003e\n"],["\u003cp\u003ePossible error codes include URL not found, no corresponding AMP URL, application error, and invalid AMP HTML.\u003c/p\u003e\n"],["\u003cp\u003eLeverages the Google AMP Cache for faster delivery of AMP content.\u003c/p\u003e\n"]]],["This API facilitates retrieving AMP URLs and their corresponding Google AMP Cache URLs. It uses a `POST` request to `ampUrls:batchGet`, taking a list of up to 50 URLs and a `lookupStrategy` (either `FETCH_LIVE_DOC` or `IN_INDEX_DOC`) in the request body. The response contains an array of `ampUrls` (with original, AMP, and cache URLs) and `urlErrors` (with error codes and messages). Error codes are specified for issues like \"URL not found\" and \"no AMP URL found.\"\n"],null,["# Method: ampUrls.batchGet\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n - [JSON representation](#body.BatchGetAmpUrlsResponse.SCHEMA_REPRESENTATION)\n- [LookupStrategy](#LookupStrategy)\n- [AmpUrl](#AmpUrl)\n - [JSON representation](#AmpUrl.SCHEMA_REPRESENTATION)\n- [AmpUrlError](#AmpUrlError)\n - [JSON representation](#AmpUrlError.SCHEMA_REPRESENTATION)\n- [ErrorCode](#ErrorCode)\n- [Try it!](#try-it)\n\nReturns AMP URL(s) and equivalent [AMP Cache URL(s)](/amp/cache/overview#amp-cache-url-format).\n\n### HTTP request\n\n`POST https://acceleratedmobilepageurl.googleapis.com/v1/ampUrls:batchGet`\n\nThe URL uses [Google API HTTP annotation](https://github.com/googleapis/googleapis/blob/master/google/api/http.proto) syntax.\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation ||\n|--------------------------------------------------------------------------------|---|\n| ```gdscript { \"urls\": [ string ] \"lookupStrategy\": enum(LookupStrategy), } ``` |\n\n| Fields ||\n|------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `urls[]` | `string` List of URLs to look up for the paired AMP URLs. The URLs are case-sensitive. Up to 50 URLs per lookup (see [Usage Limits](/amp/cache/reference/limits)). |\n| `lookupStrategy` | `enum(`[LookupStrategy](/amp/cache/reference/acceleratedmobilepageurl/rest/v1/ampUrls/batchGet#LookupStrategy)`)` The lookupStrategy being requested. |\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\nBatch AMP URL response.\n\n| JSON representation ||\n|----------------------------------------------------------------------------------------------|---|\n| ```text { \"ampUrls\": [ { object(AmpUrl) } ], \"urlErrors\": [ { object(AmpUrlError) } ], } ``` |\n\n| Fields ||\n|---------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `ampUrls[]` | `object(`[AmpUrl](/amp/cache/reference/acceleratedmobilepageurl/rest/v1/ampUrls/batchGet#AmpUrl)`)` For each URL in BatchAmpUrlsRequest, the URL response. The response might not be in the same order as URLs in the batch request. If BatchAmpUrlsRequest contains duplicate URLs, AmpUrl is generated only once. |\n| `urlErrors[]` | `object(`[AmpUrlError](/amp/cache/reference/acceleratedmobilepageurl/rest/v1/ampUrls/batchGet#AmpUrlError)`)` The errors for requested URLs that have no AMP URL. |\n\nLookupStrategy\n--------------\n\n| Enums ||\n|------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `FETCH_LIVE_DOC` | FETCH_LIVE_DOC strategy involves live document fetch of URLs not found in the index. Any request URL not found in the index is crawled in realtime to validate if there is a corresponding AMP URL. This strategy has higher coverage but with extra latency introduced by realtime crawling. This is the default strategy. Applications using this strategy should set higher HTTP timeouts of the API calls. |\n| `IN_INDEX_DOC` | IN_INDEX_DOC strategy skips fetching live documents of URL(s) not found in index. For applications which need low latency use of IN_INDEX_DOC strategy is recommended. |\n\nAmpUrl\n------\n\nAMP URL response for a requested URL.\n\n| JSON representation ||\n|-------------------------------------------------------------------------------|---|\n| ```text { \"originalUrl\": string, \"ampUrl\": string, \"cdnAmpUrl\": string, } ``` |\n\n| Fields ||\n|---------------|---------------------------------------------------------------------------------------------------------------------------------|\n| `originalUrl` | `string` The original non-AMP URL. |\n| `ampUrl` | `string` The AMP URL pointing to the publisher's web server. |\n| `cdnAmpUrl` | `string` The [AMP Cache URL](/amp/cache/overview#amp-cache-url-format) pointing to the cached document in the Google AMP Cache. |\n\nAmpUrlError\n-----------\n\nAMP URL Error resource for a requested URL that couldn't be found.\n\n| JSON representation ||\n|--------------------------------------------------------------------------------------------------|---|\n| ```gdscript { \"errorCode\": enum(ErrorCode), \"errorMessage\": string, \"originalUrl\": string, } ``` |\n\n| Fields ||\n|----------------|----------------------------------------------------------------------------------------------------------------------------------------|\n| `errorCode` | `enum(`[ErrorCode](/amp/cache/reference/acceleratedmobilepageurl/rest/v1/ampUrls/batchGet#ErrorCode)`)` The error code of an API call. |\n| `errorMessage` | `string` An optional descriptive error message. |\n| `originalUrl` | `string` The original non-AMP URL. |\n\nErrorCode\n---------\n\nError codes for a batch AMP URL lookup.\n\n| Enums ||\n|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `ERROR_CODE_UNSPECIFIED` | Not specified error. |\n| `INPUT_URL_NOT_FOUND` | Indicates the requested URL is not found in the index, possibly because it's unable to be found, not able to be accessed by Googlebot, or some other error. |\n| `NO_AMP_URL` | Indicates no AMP URL has been found that corresponds to the requested URL. |\n| `APPLICATION_ERROR` | Indicates some kind of application error occurred at the server. Client advised to retry. |\n| `URL_IS_VALID_AMP` | DEPRECATED: Indicates the requested URL is a valid AMP URL. This is a non-error state, should not be relied upon as a sign of success or failure. It will be removed in future versions of the API. |\n| `URL_IS_INVALID_AMP` | Indicates that an AMP URL has been found that corresponds to the request URL, but it is not valid AMP HTML. |\n\nTry it!\n-------"]]
