Method: ampUrls.batchGet
Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
Permintaan HTTP
POST https://acceleratedmobilepageurl.googleapis.com/v1/ampUrls:batchGet
URL menggunakan sintaks anotasi HTTP Google API.
Isi permintaan
Isi permintaan memuat data dengan struktur berikut:
Representasi JSON |
{
"urls": [
string
]
"lookupStrategy": enum(LookupStrategy),
} |
Kolom |
urls[] |
string
Daftar URL yang akan dicari untuk URL AMP yang disambungkan. URL peka huruf besar/kecil. Hingga 50 URL per pencarian (lihat Batas Penggunaan).
|
lookupStrategy |
enum(LookupStrategy )
lookupStrategy yang diminta.
|
Isi respons
Jika berhasil, isi respons memuat data dengan struktur berikut:
Representasi JSON |
{
"ampUrls": [
{
object(AmpUrl)
}
],
"urlErrors": [
{
object(AmpUrlError)
}
],
}
|
Kolom |
ampUrls[] |
object(AmpUrl )
Untuk setiap URL di BatchAmpUrlsRequest, respons URL. Respons mungkin tidak dalam urutan yang sama seperti URL dalam permintaan batch. Jika BatchAmpUrlsRequest berisi URL duplikat, AmpUrl hanya akan dibuat sekali.
|
urlErrors[] |
object(AmpUrlError )
Error untuk URL yang diminta yang tidak memiliki URL AMP.
|
Strategi Pencarian
Enumerasi |
FETCH_LIVE_DOC |
Strategi FETCH_LIVE_DOC melibatkan pengambilan dokumen secara langsung dari URL yang tidak ditemukan dalam indeks. Setiap URL permintaan yang tidak ditemukan dalam indeks akan di-crawl secara real time untuk memvalidasi jika ada URL AMP yang sesuai. Strategi ini memiliki cakupan yang lebih tinggi, tetapi dengan latensi tambahan yang diperkenalkan oleh crawling realtime. Ini adalah strategi default. Aplikasi yang menggunakan strategi ini harus menyetel waktu tunggu HTTP yang lebih tinggi untuk panggilan API. |
IN_INDEX_DOC |
Strategi IN_INDEX_DOC melewati pengambilan dokumen aktif URL yang tidak ditemukan dalam indeks. Untuk aplikasi yang memerlukan penggunaan latensi rendah, strategi IN_INDEX_DOC direkomendasikan. |
URLAmp
Respons URL AMP untuk URL yang diminta.
Representasi JSON |
{
"originalUrl": string,
"ampUrl": string,
"cdnAmpUrl": string,
} |
Kolom |
originalUrl |
string
URL non-AMP asli.
|
ampUrl |
string
URL AMP yang mengarah ke server web penayang.
|
cdnAmpUrl |
string
URL Cache AMP yang mengarah ke dokumen yang di-cache di Google AMP Cache.
|
KesalahanAmpUrl
Resource Error URL AMP untuk URL yang diminta yang tidak dapat ditemukan.
Representasi JSON |
{
"errorCode": enum(ErrorCode),
"errorMessage": string,
"originalUrl": string,
} |
Kolom |
errorCode |
enum(ErrorCode )
Kode error panggilan API.
|
errorMessage |
string
Pesan error deskriptif opsional.
|
originalUrl |
string
URL non-AMP asli.
|
ErrorCode
Kode error untuk pencarian URL AMP batch.
Enumerasi |
ERROR_CODE_UNSPECIFIED |
Error tidak ditentukan. |
INPUT_URL_NOT_FOUND |
Mengindikasikan bahwa URL yang diminta tidak ditemukan dalam indeks, mungkin karena URL tidak dapat ditemukan, tidak dapat diakses oleh Googlebot, atau error lainnya. |
NO_AMP_URL |
Mengindikasikan tidak ada URL AMP yang sesuai dengan URL yang diminta. |
APPLICATION_ERROR |
Mengindikasikan semacam error aplikasi pada server. Klien disarankan untuk mencoba lagi. |
URL_IS_VALID_AMP |
TIDAK DIGUNAKAN LAGI: Menunjukkan URL yang diminta adalah URL AMP yang valid. Ini adalah status non-error, tidak boleh diandalkan sebagai tanda berhasil atau gagal. API ini akan dihapus pada versi API mendatang. |
URL_IS_INVALID_AMP |
Menunjukkan bahwa URL AMP telah ditemukan yang sesuai dengan URL permintaan, tetapi bukan HTML AMP yang valid. |
Kecuali dinyatakan lain, konten di halaman ini dilisensikan berdasarkan Lisensi Creative Commons Attribution 4.0, sedangkan contoh kode dilisensikan berdasarkan Lisensi Apache 2.0. Untuk mengetahui informasi selengkapnya, lihat Kebijakan Situs Google Developers. Java adalah merek dagang terdaftar dari Oracle dan/atau afiliasinya.
Terakhir diperbarui pada 2023-08-30 UTC.
[null,null,["Terakhir diperbarui pada 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-------"]]