Méthode : ampUrls.batchGet

Renvoie les URL de pages AMP et les URL équivalentes de Google AMP Cache.

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 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'analyse 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 Google 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.

Essayer