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 )
กําลังขอ 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
|
กลยุทธ์การค้นหา
Enum |
FETCH_LIVE_DOC |
กลยุทธ์ FETCH_LIVE_DOC ประกอบด้วยการดึงข้อมูลเอกสารแบบเรียลไทม์ของ URL ที่ไม่พบในดัชนี ระบบจะรวบรวมข้อมูล URL คําขอที่ไม่พบในดัชนีแบบเรียลไทม์ เพื่อตรวจสอบว่ามี URL ของ AMP ที่เกี่ยวข้องหรือไม่ กลยุทธ์นี้ครอบคลุมพื้นที่เพิ่มมากขึ้นแต่มีเวลาในการตอบสนองที่เพิ่มขึ้นซึ่งได้จากการรวบรวมข้อมูลแบบเรียลไทม์ กลยุทธ์นี้เป็นค่าเริ่มต้น แอปพลิเคชันที่ใช้กลยุทธ์นี้ควรตั้งค่าระยะหมดเวลาของการเรียก API ที่สูงขึ้น |
IN_INDEX_DOC |
กลยุทธ์ IN_INDEX_DOC ข้ามการเรียกเอกสารแบบเรียลไทม์ของ URL ที่ไม่พบในดัชนี ขอแนะนําให้ใช้แอปพลิเคชันที่ต้องใช้กลยุทธ์ IN_INDEX_DOC ในเวลาในการตอบสนองต่ํา |
AMP URL
การตอบกลับ URL ของ AMP สําหรับ URL ที่ขอ
การแสดง JSON |
{
"originalUrl": string,
"ampUrl": string,
"cdnAmpUrl": string,
} |
ช่อง |
originalUrl |
string
URL เดิมที่ไม่ใช่ AMP
|
ampUrl |
string
URL ของ AMP ที่ชี้ไปยังเว็บเซิร์ฟเวอร์ของผู้เผยแพร่โฆษณา
|
cdnAmpUrl |
string
URL แคช AMP ที่ชี้ไปยังเอกสารที่แคชไว้ในแคช AMP ของ Google
|
ข้อผิดพลาด URL ของ AMP
ทรัพยากรข้อผิดพลาด URL ของ AMP สําหรับ URL ที่ขอซึ่งอาจไม่พบรหัส #39
การแสดง JSON |
{
"errorCode": enum(ErrorCode),
"errorMessage": string,
"originalUrl": string,
} |
ช่อง |
errorCode |
enum(ErrorCode )
รหัสข้อผิดพลาดของการเรียก API
|
errorMessage |
string
ข้อความแสดงข้อผิดพลาดที่สื่อความหมายซึ่งไม่บังคับ
|
originalUrl |
string
URL เดิมที่ไม่ใช่ AMP
|
รหัสข้อผิดพลาด
รหัสข้อผิดพลาดสําหรับการค้นหา URL ของ AMP แบบกลุ่ม
Enum |
ERROR_CODE_UNSPECIFIED |
ไม่ได้ระบุข้อผิดพลาด |
INPUT_URL_NOT_FOUND |
ระบุว่าไม่พบ URL ที่ขอในดัชนี ซึ่งอาจเป็นเพราะไม่พบ 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 ที่ถูกต้อง |
เนื้อหาของหน้าเว็บนี้ได้รับอนุญาตภายใต้ใบอนุญาตที่ต้องระบุที่มาของครีเอทีฟคอมมอนส์ 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-------"]]