Method: ampUrls.batchGet
با مجموعهها، منظم بمانید
ذخیره و طبقهبندی محتوا براساس اولویتهای شما.
درخواست HTTP
POST https://acceleratedmobilepageurl.googleapis.com/v1/ampUrls:batchGet
URL از نحو حاشیه نویسی Google API HTTP استفاده می کند.
درخواست بدن
بدنه درخواست شامل داده هایی با ساختار زیر است:
نمایندگی JSON |
---|
{
"urls": [
string
]
"lookupStrategy": enum(LookupStrategy),
} |
زمینه های |
---|
urls[] | string فهرست نشانیهای اینترنتی برای جستجوی نشانیهای اینترنتی AMP جفتشده. URL ها به حروف کوچک و بزرگ حساس هستند. حداکثر 50 URL در هر جستجو (به محدودیت های استفاده مراجعه کنید). |
lookupStrategy | enum( LookupStrategy ) جستجو استراتژی درخواست شده است. |
بدن پاسخگو
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
نمایندگی 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 از واکشی اسناد زنده URL(هایی) که در فهرست یافت نمی شوند صرف نظر می کند. برای برنامههایی که نیاز به تأخیر کم دارند، استفاده از استراتژی IN_INDEX_DOC توصیه میشود. |
AmpUrl
پاسخ URL AMP برای URL درخواستی.
نمایندگی JSON |
---|
{
"originalUrl": string,
"ampUrl": string,
"cdnAmpUrl": string,
} |
زمینه های |
---|
originalUrl | string URL اصلی غیر AMP. |
ampUrl | string نشانی اینترنتی AMP که به سرور وب ناشر اشاره می کند. |
cdnAmpUrl | string نشانی اینترنتی حافظه پنهان AMP که به سند ذخیره شده در حافظه پنهان Google AMP اشاره می کند. |
AmpUrlError
منبع خطای URL AMP برای URL درخواستی که پیدا نشد.
نمایندگی 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 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده 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-------"]]