Method: ampUrls.batchGet
Sử dụng bộ sưu tập để sắp xếp ngăn nắp các trang
Lưu và phân loại nội dung dựa trên lựa chọn ưu tiên của bạn.
Yêu cầu HTTP
POST https://acceleratedmobilepageurl.googleapis.com/v1/ampUrls:batchGet
URL sử dụng cú pháp chú thích Google API HTTP.
Nội dung yêu cầu
Nội dung yêu cầu chứa dữ liệu có cấu trúc sau:
Biểu diễn dưới dạng JSON |
{
"urls": [
string
]
"lookupStrategy": enum(LookupStrategy),
} |
Các trường |
urls[] |
string
Danh sách URL cần tra cứu để tìm các URL AMP được ghép nối. Các URL có phân biệt chữ hoa chữ thường. Tối đa 50 URL cho mỗi lần tra cứu (xem Giới hạn sử dụng).
|
lookupStrategy |
enum(LookupStrategy )
Chiến lược tra cứu đang được yêu cầu.
|
Nội dung phản hồi
Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:
Phản hồi hàng loạt URL AMP.
Biểu diễn dưới dạng JSON |
{
"ampUrls": [
{
object(AmpUrl)
}
],
"urlErrors": [
{
object(AmpUrlError)
}
],
}
|
Các trường |
ampUrls[] |
object(AmpUrl )
Đối với mỗi URL trong BatchAmpUrlsRequest, URL phản hồi là URL. Nội dung phản hồi có thể không theo thứ tự như các URL trong yêu cầu hàng loạt. Nếu BatchAmpUrlsRequest chứa các URL trùng lặp, thì AmpUrl chỉ được tạo một lần.
|
urlErrors[] |
object(AmpUrlError )
Lỗi cho những URL được yêu cầu không có URL AMP.
|
Chiến lược tìm kiếm
Enum |
FETCH_LIVE_DOC |
Chiến lược SwG_LIVE_DOC sử dụng quy trình tìm nạp tài liệu trực tiếp gồm các URL không có trong chỉ mục. Mọi URL yêu cầu không tìm thấy trong chỉ mục đều được thu thập dữ liệu trong thời gian thực để xác thực xem có URL AMP tương ứng hay không. Chiến lược này có phạm vi bao quát hơn nhưng có độ trễ cao hơn do hoạt động thu thập dữ liệu theo thời gian thực đưa ra. Đây là chiến lược mặc định. Các ứng dụng sử dụng chiến lược này nên đặt thời gian chờ HTTP cao hơn trong các lệnh gọi API. |
IN_INDEX_DOC |
Chiến lược IN_INDEX_DOC bỏ qua việc tìm nạp tài liệu trực tiếp của(các) URL không tìm thấy trong chỉ mục. Đối với các ứng dụng cần độ trễ thấp, chiến lược IN_INDEX_DOC được đề xuất. |
AmpUrl
Phản hồi URL AMP cho URL được yêu cầu.
Biểu diễn dưới dạng JSON |
{
"originalUrl": string,
"ampUrl": string,
"cdnAmpUrl": string,
} |
Các trường |
originalUrl |
string
URL gốc không phải AMP.
|
ampUrl |
string
URL AMP trỏ đến máy chủ web của nhà xuất bản.
|
cdnAmpUrl |
string
URL Bộ nhớ đệm AMP trỏ đến tài liệu được lưu vào bộ nhớ đệm trong Bộ nhớ đệm AMP của Google.
|
Lỗi AmpUrl
Tài nguyên Lỗi URL AMP cho một URL được yêu cầu không tìm thấy.
Biểu diễn dưới dạng JSON |
{
"errorCode": enum(ErrorCode),
"errorMessage": string,
"originalUrl": string,
} |
Các trường |
errorCode |
enum(ErrorCode )
Mã lỗi của lệnh gọi API.
|
errorMessage |
string
Một thông báo lỗi mô tả (không bắt buộc).
|
originalUrl |
string
URL gốc không phải AMP.
|
Mã lỗi
Mã lỗi để tra cứu URL AMP hàng loạt.
Enum |
ERROR_CODE_UNSPECIFIED |
Lỗi không xác định. |
INPUT_URL_NOT_FOUND |
Cho biết không tìm thấy URL được yêu cầu trong chỉ mục, có thể là do Googlebot không tìm thấy, không thể truy cập vào Googlebot hoặc một số lỗi khác. |
NO_AMP_URL |
Cho biết không tìm thấy URL AMP tương ứng với URL được yêu cầu. |
APPLICATION_ERROR |
Cho biết đã xảy ra lỗi ứng dụng nào đó trên máy chủ. Khách hàng nên thử lại. |
URL_IS_VALID_AMP |
ĐÃ NGỪNG HOẠT ĐỘNG: Cho biết URL được yêu cầu là URL AMP hợp lệ. Đây là trạng thái không phải lỗi, không nên coi là dấu hiệu cho biết thành công hay không. Phiên bản này sẽ bị xoá trong các phiên bản sau của API. |
URL_IS_INVALID_AMP |
Cho biết rằng đã có một URL AMP tương ứng với URL yêu cầu nhưng không phải là HTML AMP hợp lệ. |
Trừ phi có lưu ý khác, nội dung của trang này được cấp phép theo Giấy phép ghi nhận tác giả 4.0 của Creative Commons và các mẫu mã lập trình được cấp phép theo Giấy phép Apache 2.0. Để biết thông tin chi tiết, vui lòng tham khảo Chính sách trang web của Google Developers. Java là nhãn hiệu đã đăng ký của Oracle và/hoặc các đơn vị liên kết với Oracle.
Cập nhật lần gần đây nhất: 2023-08-30 UTC.
[null,null,["Cập nhật lần gần đây nhất: 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-------"]]