Method: ampUrls.batchGet
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Requête HTTP
POST https://acceleratedmobilepageurl.googleapis.com/v1/ampUrls:batchGet
L'URL utilise la syntaxe d'annotation HTTP de l'API Google.
Corps de la requête
Le corps de la requête contient des données qui ont la structure suivante :
Représentation JSON |
{
"urls": [
string
]
"lookupStrategy": enum(LookupStrategy),
} |
Champs |
urls[] |
string
Liste des URL à rechercher pour les URL des pages AMP correspondantes. Les URL sont sensibles à la casse. Le maximum est de 50 URL par recherche (voir Limites d'utilisation).
|
lookupStrategy |
enum(LookupStrategy )
Stratégie de recherche (lookupStrategy) demandée.
|
Corps de la réponse
Si la requête aboutit, le corps de la réponse contient des données présentant la structure suivante :
Réponse groupée d'URL AMP.
Représentation JSON |
{
"ampUrls": [
{
object(AmpUrl)
}
],
"urlErrors": [
{
object(AmpUrlError)
}
],
}
|
Champs |
ampUrls[] |
object(AmpUrl )
Liste des URL en réponse à chaque URL dans BatchAmpUrlsRequest. L'ordre des URL en réponse peut être différent de celui des URL de la demande groupée. Si BatchAmpUrlsRequest contient des URL en double, la valeur correspondante AmpUrl n'est générée qu'une fois.
|
urlErrors[] |
object(AmpUrlError )
Erreurs pour les URL demandées n'ayant pas d'URL AMP.
|
LookupStrategy
Énumérations |
FETCH_LIVE_DOC |
La stratégie FETCH_LIVE_DOC prévoit le chargement de documents en direct lorsque les URL ne figurent pas dans l'index. Toute URL de la demande non trouvée dans l'index fait l'objet d'une exploration en temps réel pour vérifier s'il existe une URL AMP correspondante. Cette stratégie offre une couverture plus étendue, mais avec une latence supplémentaire introduite par l'exploration en temps réel. C'est la stratégie par défaut. Les applications utilisant cette stratégie doivent définir des délais d'expiration HTTP plus élevés pour les appels d'API. |
IN_INDEX_DOC |
La stratégie IN_INDEX_DOC ignore le chargement des documents en direct lorsque les URL ne figurent pas dans l'index. Pour les applications nécessitant une faible latence, l'utilisation de la stratégie IN_INDEX_DOC est recommandée. |
AmpUrl
URL AMP en réponse à une URL demandée.
Représentation JSON |
{
"originalUrl": string,
"ampUrl": string,
"cdnAmpUrl": string,
} |
Champs |
originalUrl |
string
L'URL d'origine non-AMP.
|
ampUrl |
string
URL AMP renvoyant vers le serveur Web de l'éditeur.
|
cdnAmpUrl |
string
URL AMP Cache renvoyant vers le document mis en cache dans Google AMP Cache.
|
AmpUrlError
Ressource d'erreur d'URL AMP indiquant que l'URL demandée est introuvable.
Représentation JSON |
{
"errorCode": enum(ErrorCode),
"errorMessage": string,
"originalUrl": string,
} |
Champs |
errorCode |
enum(ErrorCode )
Le code d'erreur d'un appel d'API.
|
errorMessage |
string
Un message facultatif décrivant l'erreur.
|
originalUrl |
string
L'URL d'origine non-AMP.
|
ErrorCode
Codes d'erreur pour une recherche groupée d'URL AMP.
Énumérations |
ERROR_CODE_UNSPECIFIED |
Erreur non spécifiée. |
INPUT_URL_NOT_FOUND |
Indique que l'URL demandée est introuvable dans l'index, soit parce qu'elle n'y figure pas, soit parce que Googlebot ne peut pas y accéder, soit en raison d'une autre erreur. |
NO_AMP_URL |
Indique qu'aucune URL AMP correspondant à l'URL demandée n'a été trouvée. |
APPLICATION_ERROR |
Indique qu'une erreur d'application s'est produite sur le serveur. Une nouvelle tentative de la part du client est suggérée. |
URL_IS_VALID_AMP |
OBSOLÈTE : indique que l'URL demandée est une URL AMP valide. Cet état n'est pas une erreur et ne doit pas être considéré comme un signe de réussite ou d'échec. Il sera supprimé dans les futures versions de l'API. |
URL_IS_INVALID_AMP |
Indique qu'une URL AMP correspondant à l'URL demandée a été trouvée, mais que son code AMP HTML n'est pas valide. |
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/08/04 (UTC).
[null,null,["Dernière mise à jour le 2025/08/04 (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-------"]]