Pagespeedapi: runpagespeed

Exécute une analyse PageSpeed sur la page à l'URL spécifiée et renvoie les scores PageSpeed, une liste de suggestions pour accélérer le chargement de cette page et d'autres informations. Essayer maintenant

Requête

Requête HTTP

GET https://www.googleapis.com/pagespeedonline/v5/runPagespeed

Paramètres

Nom du paramètre	Valeur	Description
Paramètres de requête obligatoires
url	string	URL à extraire et à analyser
Paramètres de requête facultatifs
category	string	Catégorie Lighthouse à exécuter. Si aucune n'est spécifiée, seule la catégorie "Performances" sera exécutée. Les valeurs acceptables sont les suivantes : "accessibility" "best-practices" "performance" "seo"
locale	string	Paramètres régionaux utilisés pour localiser les résultats mis en forme
strategy	string	Stratégie d'analyse à utiliser (ordinateur ou mobile). La valeur par défaut est "desktop". Les valeurs acceptables sont les suivantes : "desktop" : récupère et analyse l'URL pour les navigateurs pour ordinateur "mobile" : récupérer et analyser l'URL pour les appareils mobiles
utm_campaign	string	Nom de la campagne pour les données analytiques.
utm_source	string	Source de la campagne pour Analytics.

Corps de la requête

Ne spécifiez pas de corps de requête pour cette méthode.

Réponse

Si la requête aboutit, cette méthode renvoie un corps de réponse présentant la structure suivante :

{
  "captchaResult": string,
  "kind": "pagespeedonline#result",
  "id": string,
  "loadingExperience": {
    "id": string,
    "metrics": {
      (key): {
        "percentile": integer,
        "distributions": [
          {
            "min": integer,
            "max": integer,
            "proportion": double
          }
        ],
        "category": string
      }
    },
    "overall_category": string,
    "initial_url": string
  },
  "originLoadingExperience": {
    "id": string,
    "metrics": {
      (key): {
        "percentile": integer,
        "distributions": [
          {
            "min": integer,
            "max": integer,
            "proportion": double
          }
        ],
        "category": string
      }
    },
    "overall_category": string,
    "initial_url": string
  },
  "lighthouseResult": {
    "requestedUrl": string,
    "finalUrl": string,
    "lighthouseVersion": string,
    "userAgent": string,
    "fetchTime": string,
    "environment": {
      "networkUserAgent": string,
      "hostUserAgent": string,
      "benchmarkIndex": double
    },
    "runWarnings": [
      (value)
    ],
    "configSettings": {
      "emulatedFormFactor": string,
      "locale": string,
      "onlyCategories": (value),
      "onlyCategories": (value)
    },
    "audits": {
      (key): {
        "id": string,
        "title": string,
        "description": string,
        "score": (value),
        "score": (value),
        "scoreDisplayMode": string,
        "displayValue": string,
        "explanation": string,
        "errorMessage": string,
        "warnings": (value),
        "warnings": (value),
        "details": {
          (key): (value)
        }
      }
    },
    "categories": {
      (key): {
        "id": string,
        "title": string,
        "description": string,
        "score": (value),
        "score": (value),
        "manualDescription": string,
        "auditRefs": [
          {
            "id": string,
            "weight": double,
            "group": string
          }
        ]
      }
    },
    "categoryGroups": {
      (key): {
        "title": string,
        "description": string
      }
    },
    "runtimeError": {
      "code": string,
      "message": string
    },
    "timing": {
      "total": double
    },
    "i18n": {
      "rendererFormattedStrings": {
        "varianceDisclaimer": string,
        "opportunityResourceColumnLabel": string,
        "opportunitySavingsColumnLabel": string,
        "errorMissingAuditInfo": string,
        "errorLabel": string,
        "warningHeader": string,
        "auditGroupExpandTooltip": string,
        "passedAuditsGroupTitle": string,
        "notApplicableAuditsGroupTitle": string,
        "manualAuditsGroupTitle": string,
        "toplevelWarningsMessage": string,
        "scorescaleLabel": string,
        "crcLongestDurationLabel": string,
        "crcInitialNavigation": string,
        "lsPerformanceCategoryDescription": string,
        "labDataTitle": string
      }
    }
  },
  "analysisUTCTimestamp": string,
  "version": {
    "major": integer,
    "minor": integer
  }
}

Nom de propriété	Valeur	Description	Remarques
captchaResult	string	Résultat de la validation du captcha Les valeurs acceptées sont les suivantes : "CAPTCHA_BLOCKING" "CAPTCHA_MATCHED" "CAPTCHA_NEEDED" "CAPTCHA_NOT_NEEDED" "CAPTCHA_UNMATCHED"
kind	string	Type de résultat.
id	string	URL canonique et finale du document, après avoir suivi les redirections de page (le cas échéant).
loadingExperience	nested object	Métriques sur l'expérience de chargement des pages pour les utilisateurs finaux.
loadingExperience.id	string	URL, modèle ou origine sur lesquels se trouvent les métriques.
loadingExperience.metrics	object
loadingExperience.metrics.(key)	object	Type de métrique.
loadingExperience.metrics.(key).distributions[]	list
loadingExperience.metrics.(key).distributions[].min	integer
loadingExperience.metrics.(key).distributions[].max	integer
loadingExperience.metrics.(key).distributions[].proportion	double
version	object	Version de PageSpeed utilisée pour générer ces résultats.
version.major	integer	Numéro de version majeure de PageSpeed utilisé pour générer ces résultats.
version.minor	integer	Numéro de version mineure de PageSpeed utilisé pour générer ces résultats.
loadingExperience.metrics.(key).category	string	Les valeurs acceptées sont les suivantes : "AVERAGE" "FAST" "NONE" "SLOW"
loadingExperience.overall_category	string	Les valeurs acceptées sont les suivantes : "AVERAGE" "FAST" "NONE" "SLOW"
loadingExperience.initial_url	string
loadingExperience.metrics.(key).percentile	integer
originLoadingExperience	nested object	Métriques de l'expérience de chargement de page agrégée de l'origine
originLoadingExperience.id	string	URL, modèle ou origine sur lesquels se trouvent les métriques.
originLoadingExperience.metrics	object
originLoadingExperience.metrics.(key)	object	Type de métrique.
originLoadingExperience.metrics.(key).percentile	integer
originLoadingExperience.metrics.(key).distributions[]	list
originLoadingExperience.metrics.(key).distributions[].min	integer
originLoadingExperience.metrics.(key).distributions[].max	integer
originLoadingExperience.metrics.(key).distributions[].proportion	double
originLoadingExperience.metrics.(key).category	string	Les valeurs acceptées sont les suivantes : "AVERAGE" "FAST" "NONE" "SLOW"
originLoadingExperience.overall_category	string	Les valeurs acceptées sont les suivantes : "AVERAGE" "FAST" "NONE" "SLOW"
originLoadingExperience.initial_url	string
analysisUTCTimestamp	string	Code temporel UTC de cette analyse.
lighthouseResult	nested object	Réponse Lighthouse pour l'URL d'audit sous forme d'objet.
lighthouseResult.requestedUrl	string	URL demandée d'origine.
lighthouseResult.finalUrl	string	URL finale résolue qui a été auditée.
lighthouseResult.lighthouseVersion	string	Version de Lighthouse utilisée pour générer ce rapport LHR.
lighthouseResult.userAgent	string	User-agent utilisé pour exécuter ce rapport LHR.
lighthouseResult.fetchTime	string	Heure à laquelle cette exécution a été récupérée.
lighthouseResult.environment	object	Paramètres d'environnement utilisés lors de la création de cette LHR.
lighthouseResult.environment.networkUserAgent	string
lighthouseResult.environment.hostUserAgent	string
lighthouseResult.environment.benchmarkIndex	double
lighthouseResult.runWarnings[]	list	Liste de tous les avertissements d'exécution dans le LHR. La sortie sera toujours au moins "[]".
lighthouseResult.configSettings	object	Paramètres de configuration de ce LHR.
lighthouseResult.configSettings.emulatedFormFactor	string	Facteur de forme que l'émulation doit utiliser. Les valeurs acceptables sont les suivantes : "UNKNOWN_FORM_FACTOR" "desktop" "mobile" "none"
lighthouseResult.configSettings.locale	string	Paramètres régionaux
lighthouseResult.configSettings.onlyCategories	nested object
lighthouseResult.audits	object	Carte des audits dans le LHR.
lighthouseResult.audits.(key)	nested object
lighthouseResult.audits.(key).id	string	ID de l'audit.
lighthouseResult.audits.(key).title	string	Titre lisible.
lighthouseResult.audits.(key).description	string	Description de l'audit.
lighthouseResult.audits.(key).score	nested object
lighthouseResult.audits.(key).scoreDisplayMode	string	Mode d'affichage du score énuméré. Les valeurs acceptées sont les suivantes : "SCORE_DISPLAY_MODE_UNSPECIFIED" "binary" "error" "informative" "manual" "not_applicable" "numeric"
lighthouseResult.audits.(key).displayValue	string	Valeur à afficher dans l'UI pour cet audit.
lighthouseResult.audits.(key).explanation	string	Explication des erreurs dans l'audit.
lighthouseResult.audits.(key).errorMessage	string	Message d'erreur provenant d'une erreur générée dans l'audit.
lighthouseResult.audits.(key).warnings	nested object
lighthouseResult.audits.(key).details	object	Section "Détails" du rapport d'audit.
lighthouseResult.audits.(key).details.(key)	any value
lighthouseResult.categories	object	Carte des catégories dans le LHR.
lighthouseResult.categories.(key)	nested object
lighthouseResult.categories.(key).id	string	Identifiant de chaîne de la catégorie.
lighthouseResult.categories.(key).title	string	Nom convivial de la catégorie
lighthouseResult.categories.(key).description	string	Description plus détaillée de la catégorie et de son importance.
lighthouseResult.categories.(key).score	nested object
lighthouseResult.categories.(key).manualDescription	string	Description des vérifications manuelles de la catégorie.
lighthouseResult.categories.(key).auditRefs[]	list	Tableau de références à tous les membres de l'audit de cette catégorie.
lighthouseResult.categories.(key).auditRefs[].id	string	ID de référence de l'audit.
lighthouseResult.categories.(key).auditRefs[].weight	double	Pondération du score de cet audit sur le score global de la catégorie.
lighthouseResult.categories.(key).auditRefs[].group	string	Groupe de catégories auquel appartient l'audit (facultatif).
lighthouseResult.categoryGroups	object	Carte des groupes de catégories dans le LHR.
lighthouseResult.categoryGroups.(key)	object
lighthouseResult.categoryGroups.(key).title	string
lighthouseResult.categoryGroups.(key).description	string
lighthouseResult.runtimeError	object	Objet contenant le code et le message de toutes les erreurs d'exécution générées.
lighthouseResult.runtimeError.code	string	Les valeurs acceptées sont les suivantes : "ERRORED_DOCUMENT_REQUEST" "FAILED_DOCUMENT_REQUEST" "INSECURE_DOCUMENT_REQUEST" "INVALID_SPEEDLINE" "NO_DCL" "NO_DOCUMENT_REQUEST" "NO_ERROR" "NO_FCP" "NO_NAVSTART" "NO_SCREENSHOTS" "NO_SPEEDLINE_FRAMES" "NO_TRACING_STARTED" "PARSING_PROBLEM" "PROTOCOL_TIMEOUT" "READ_FAILED" "SPEEDINDEX_OF_ZERO" "TRACING_ALREADY_STARTED" "UNKNOWN_ERROR"
lighthouseResult.runtimeError.message	string
lighthouseResult.timing	object	Informations de timing pour cette LHR.
lighthouseResult.timing.total	double	Durée totale de l'exécution de Lighthouse
lighthouseResult.i18n	object	Chaînes d'internationalisation requises pour afficher le LHR.
lighthouseResult.i18n.rendererFormattedStrings	object
lighthouseResult.i18n.rendererFormattedStrings.varianceDisclaimer	string
lighthouseResult.i18n.rendererFormattedStrings.opportunityResourceColumnLabel	string
lighthouseResult.i18n.rendererFormattedStrings.opportunitySavingsColumnLabel	string
lighthouseResult.i18n.rendererFormattedStrings.errorMissingAuditInfo	string
lighthouseResult.i18n.rendererFormattedStrings.errorLabel	string
lighthouseResult.i18n.rendererFormattedStrings.warningHeader	string
lighthouseResult.i18n.rendererFormattedStrings.auditGroupExpandTooltip	string
lighthouseResult.i18n.rendererFormattedStrings.passedAuditsGroupTitle	string
lighthouseResult.i18n.rendererFormattedStrings.notApplicableAuditsGroupTitle	string
lighthouseResult.i18n.rendererFormattedStrings.manualAuditsGroupTitle	string
lighthouseResult.i18n.rendererFormattedStrings.toplevelWarningsMessage	string
lighthouseResult.i18n.rendererFormattedStrings.scorescaleLabel	string
lighthouseResult.i18n.rendererFormattedStrings.crcLongestDurationLabel	string
lighthouseResult.i18n.rendererFormattedStrings.crcInitialNavigation	string
lighthouseResult.i18n.rendererFormattedStrings.lsPerformanceCategoryDescription	string
lighthouseResult.i18n.rendererFormattedStrings.labDataTitle	string

Essayer

Utilisez l'explorateur d'API ci-dessous pour appeler cette méthode sur des données en direct, puis observez la réponse.