Method: ampUrls.batchGet
Mantieni tutto organizzato con le raccolte
Salva e classifica i contenuti in base alle tue preferenze.
Richiesta HTTP
POST https://acceleratedmobilepageurl.googleapis.com/v1/ampUrls:batchGet
L'URL utilizza la sintassi di annotazione HTTP dell'API di Google.
Corpo della richiesta
Il corpo della richiesta contiene i dati con la seguente struttura:
Rappresentazione JSON |
{
"urls": [
string
]
"lookupStrategy": enum(LookupStrategy),
} |
Campi |
urls[] |
string
Elenco di URL da cercare per gli URL AMP accoppiati. Gli URL sono sensibili alle maiuscole. Fino a 50 URL per ricerca (vedi Limiti di utilizzo).
|
lookupStrategy |
enum(LookupStrategy )
La richiesta di ricerca richiesta.
|
Corpo della risposta
In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:
Rappresentazione JSON |
{
"ampUrls": [
{
object(AmpUrl)
}
],
"urlErrors": [
{
object(AmpUrlError)
}
],
}
|
Campi |
ampUrls[] |
object(AmpUrl )
Per ogni URL in BatchAmpUrlsRequest, la risposta dell'URL. La risposta potrebbe non seguire lo stesso ordine degli URL nella richiesta in batch. Se BatchAmpUrlsRequest contiene URL duplicati, AmpUrl viene generato solo una volta.
|
urlErrors[] |
object(AmpUrlError )
Gli errori per gli URL richiesti che non hanno un URL AMP.
|
Strategia di ricerca
Enum |
FETCH_LIVE_DOC |
La strategia FETCH_LIVE_DOC prevede il recupero in tempo reale dei documenti degli URL non trovati nell'indice. Qualsiasi URL di richiesta non trovato nell'indice viene sottoposto a scansione in tempo reale per verificare se è presente un URL AMP corrispondente. Questa strategia ha una copertura più elevata, ma con una latenza aggiuntiva introdotta dalla scansione in tempo reale. Questa è la strategia predefinita. Le applicazioni che utilizzano questa strategia dovrebbero impostare timeout HTTP più elevati delle chiamate API. |
IN_INDEX_DOC |
La strategia IN_INDEX_DOC ignora il recupero dei documenti pubblicati di URL non trovati nell'indice. Per le applicazioni che richiedono una bassa latenza, si consiglia l'uso della strategia IN_INDEX_DOC. |
URLAmp
Risposta URL AMP per un URL richiesto.
Rappresentazione JSON |
{
"originalUrl": string,
"ampUrl": string,
"cdnAmpUrl": string,
} |
Campi |
originalUrl |
string
L'URL non AMP originale.
|
ampUrl |
string
L'URL AMP che rimanda al server web del publisher.
|
cdnAmpUrl |
string
L'URL AMP Cache che rimanda al documento memorizzato nella cache in Google AMP Cache.
|
Errore AmpUrl
Risorsa di errore URL AMP per un URL richiesto che non è stato possibile trovare.
Rappresentazione JSON |
{
"errorCode": enum(ErrorCode),
"errorMessage": string,
"originalUrl": string,
} |
Campi |
errorCode |
enum(ErrorCode )
Il codice di errore di una chiamata API.
|
errorMessage |
string
Un messaggio di errore descrittivo facoltativo.
|
originalUrl |
string
L'URL non AMP originale.
|
ErrorCode
Codici di errore per una ricerca batch di URL AMP.
Enum |
ERROR_CODE_UNSPECIFIED |
Errore non specificato. |
INPUT_URL_NOT_FOUND |
Indica che l'URL richiesto non è stato trovato nell'indice, probabilmente perché non è stato trovato, non è accessibile a Googlebot o perché esiste un altro errore. |
NO_AMP_URL |
Indica che non è stato trovato alcun URL AMP corrispondente all'URL richiesto. |
APPLICATION_ERROR |
Indica un qualche tipo di errore dell'applicazione sul server. Il client consiglia di riprovare. |
URL_IS_VALID_AMP |
OBSOLETO: indica che l'URL richiesto è un URL AMP valido. Questo è uno stato non di errore, su cui non si deve fare affidamento come segno di successo o errore. Verrà rimosso nelle versioni future dell'API. |
URL_IS_INVALID_AMP |
Indica che è stato trovato un URL AMP che corrisponde all'URL della richiesta, ma non è un codice HTML AMP valido. |
Salvo quando diversamente specificato, i contenuti di questa pagina sono concessi in base alla licenza Creative Commons Attribution 4.0, mentre gli esempi di codice sono concessi in base alla licenza Apache 2.0. Per ulteriori dettagli, consulta le norme del sito di Google Developers. Java è un marchio registrato di Oracle e/o delle sue consociate.
Ultimo aggiornamento 2023-08-30 UTC.
[null,null,["Ultimo aggiornamento 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-------"]]