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 في الطلب المجمّع. إذا كان BatchAmpUrlsRequest يحتوي على عناوين URL مكرّرة، يتم إنشاء AmpUrl مرة واحدة فقط.
|
urlErrors[] |
object(AmpUrlError)
أخطاء عناوين URL المطلوبة التي لا تتضمّن عنوان URL لصفحة AMP
|
استراتيجية البحث
| عمليات التعداد |
FETCH_LIVE_DOC |
تشتمل استراتيجية FETCH_LIVE_DOC على استرجاع المستندات مباشرةً من عناوين URL التي لم يتم العثور عليها في الفهرس. يتم الزحف في أي وقت إلى أي عنوان URL لطلب لم يتم العثور عليه في الفهرس للتحقّق مما إذا كان هناك عنوان URL مقابل AMP. تتميز هذه الاستراتيجية بتغطية أعلى، ولكن يتم إدخال وقت استجابة إضافي من خلال الزحف في الوقت الفعلي. وهذه هي الاستراتيجية التلقائية. يجب أن تضبط التطبيقات التي تستخدم هذه الاستراتيجية مهلات HTTP أعلى لاستدعاءات واجهة برمجة التطبيقات. |
IN_INDEX_DOC |
تتجاوز استراتيجية IN_INDEX_DOC استرجاع المستندات المباشرة لعناوين URL التي لم يتم العثور عليها في الفهرس. بالنسبة إلى التطبيقات التي تحتاج إلى استخدام وقت استجابة منخفض في استراتيجية IN_INDEX_DOC. |
AmpUrl
استجابة عنوان URL لصفحات AMP لعنوان URL مطلوب
| تمثيل JSON |
{
"originalUrl": string,
"ampUrl": string,
"cdnAmpUrl": string,
} |
| الحقول |
originalUrl |
string
عنوان URL الأصلي بغير تنسيق AMP.
|
ampUrl |
string
عنوان URL لصفحة AMP الذي يشير إلى خادم الويب للناشر.
|
cdnAmpUrl |
string
عنوان URL لذاكرة التخزين المؤقت لصفحات AMP الذي يشير إلى المستند المخزّن مؤقتًا في ذاكرة التخزين المؤقت لصفحات AMP على Google
|
خطأ AmpUrl
تعذّر العثور على مورد الخطأ لعنوان URL لصفحة AMP لعنوان URL المطلوب الذي تعذّر العثور عليه.
| تمثيل JSON |
{
"errorCode": enum(ErrorCode),
"errorMessage": string,
"originalUrl": string,
} |
| الحقول |
errorCode |
enum(ErrorCode)
رمز الخطأ في طلب بيانات من واجهة برمجة التطبيقات
|
errorMessage |
string
رسالة خطأ وصفية اختيارية.
|
originalUrl |
string
عنوان URL الأصلي بغير تنسيق AMP.
|
رمز الخطأ
رموز الخطأ للبحث المجمّع عن عناوين URL لصفحات AMP.
| عمليات التعداد |
ERROR_CODE_UNSPECIFIED |
لم يتم تحديد الخطأ. |
INPUT_URL_NOT_FOUND |
تشير هذه القيمة إلى عدم العثور على عنوان URL المطلوب في الفهرس، وقد يكون السبب هو تعذُّر العثور عليه أو تعذُّر وصول Googlebot إليه أو حدوث خطأ آخر. |
NO_AMP_URL |
تشير إلى عدم العثور على عنوان URL لصفحة AMP يتوافق مع عنوان URL المطلوب. |
APPLICATION_ERROR |
يشير إلى نوع من أخطاء التطبيق التي حدثت على الخادم. يُنصح العميل بإعادة المحاولة. |
URL_IS_VALID_AMP |
تم الإيقاف: يشير إلى أن عنوان URL المطلوب هو عنوان URL صالح لصفحات AMP. وهذه الحالة ليست متعلقة بخطأ، ويجب عدم الاعتماد عليها كدليل على نجاح العملية أو فشلها. وستتم إزالته في الإصدارات المستقبلية من واجهة برمجة التطبيقات. |
URL_IS_INVALID_AMP |
يشير إلى أنّه تم العثور على عنوان URL لصفحة AMP يتوافق مع عنوان URL للطلب، ولكنه غير صالح. |
إنّ محتوى هذه الصفحة مرخّص بموجب ترخيص Creative Commons Attribution 4.0 ما لم يُنصّ على خلاف ذلك، ونماذج الرموز مرخّصة بموجب ترخيص Apache 2.0. للاطّلاع على التفاصيل، يُرجى مراجعة سياسات موقع Google Developers. إنّ Java هي علامة تجارية مسجَّلة لشركة Oracle و/أو شركائها التابعين.
تاريخ التعديل الأخير: 2023-08-30 (حسب التوقيت العالمي المتفَّق عليه)
[null,null,["تاريخ التعديل الأخير: 2023-08-30 (حسب التوقيت العالمي المتفَّق عليه)"],[[["\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-------"]]
