Method: pagespeedapi.runpagespeed

Exécute l'analyse PageSpeed sur la page à l'URL spécifiée, et renvoie des scores PageSpeed, une liste de suggestions pour améliorer la vitesse de la page, ainsi que d'autres informations.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de requête

Paramètres
category

enum (Category)

Une catégorie Lighthouse à exécuter Si aucune n'est spécifiée, seule la catégorie "Performances" sera utilisée.
locale

string

Paramètres régionaux utilisés pour localiser les résultats mis en forme
strategy

enum (Strategy)

La stratégie d'analyse (ordinateur ou mobile) à utiliser (l'ordinateur est la stratégie par défaut)
url

string

Obligatoire. URL à récupérer et à analyser
utm_campaign

string

Nom de la campagne à des fins d'analyse.
utm_source

string

Source de la campagne pour les données analytiques.
captchaToken

string

Jeton captcha transmis lors de la saisie d'un captcha.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Objet de réponse de l'API Pagespeed.

Représentation JSON 
{
  "kind": string,
  "captchaResult": string,
  "id": string,
  "loadingExperience": {
    object (PagespeedApiLoadingExperienceV5)
  },
  "originLoadingExperience": {
    object (PagespeedApiLoadingExperienceV5)
  },
  "analysisUTCTimestamp": string,
  "lighthouseResult": {
    object (LighthouseResultV5)
  },
  "version": {
    object (PagespeedVersion)
  }
}
Champs
kind

string

Type de résultat.
captchaResult

string

Résultat de la vérification du captcha
id

string

URL canonique et finale du document, après avoir suivi les redirections de la page (le cas échéant).
loadingExperience

object (PagespeedApiLoadingExperienceV5)

Les métriques des performances lors du chargement de pages.
originLoadingExperience

object (PagespeedApiLoadingExperienceV5)

Métriques du chargement de page cumulé de l'origine
analysisUTCTimestamp

string

Code temporel UTC de cette analyse.
lighthouseResult

object (LighthouseResultV5)

Réponse Lighthouse pour l'URL d'audit en tant qu'objet.
version

object (PagespeedVersion)

Version de Page Speed utilisée pour générer ces résultats.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • openid

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

Catégorie

Catégories énumérées à analyser.

Enums
CATEGORY_UNSPECIFIED Catégorie non définie par défaut.
ACCESSIBILITY Accessibilité (a11y), catégorie indiquant la capacité d'un site Web à être accessible à tous les utilisateurs.
BEST_PRACTICES Bonnes pratiques, catégorie relative à la conformité d'un site Web avec les bonnes pratiques Web.
PERFORMANCE Performances : catégorie relative aux performances d'un site Web.
SEO Optimisation du référencement (SEO, Search Engine Optimization), catégorie relative à la capacité d'un site Web à être indexé par les moteurs de recherche.

Stratégie

Stratégie d'exécution de l'appareil à utiliser lors de l'analyse.

Enums
STRATEGY_UNSPECIFIED NON DÉFINIE.
DESKTOP Extrayez et analysez l'URL pour les navigateurs pour ordinateur.
MOBILE Extraire et analyser l'URL pour les appareils mobiles

PagespeedApiLoadingExperienceV5

Objet de l'expérience de chargement CrUX contenant les répartitions des données CrUX.

Représentation JSON 
{
  "id": string,
  "metrics": {
    string: {
      object (UserPageLoadMetricV5)
    },
    ...
  },
  "overall_category": string,
  "initial_url": string,
  "origin_fallback": boolean
}
Champs
id

string

URL, format ou origine concernés par les métriques.
metrics

map (key: string, value: object (UserPageLoadMetricV5))

Carte de <metrics, data>.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
overall_category

string

La "catégorie" de vitesse, lisible par l'humain, de l'ID.
initial_url

string

URL demandée, qui peut être différente de l'"id" résolu.
origin_fallback

boolean

"True" si le résultat est une origine de remplacement à partir d'une page, "false" dans le cas contraire.

LighthouseResultV5

Objet de résultat Lighthouse.

Représentation JSON 
{
  "fetchTime": string,
  "requestedUrl": string,
  "finalUrl": string,
  "lighthouseVersion": string,
  "i18n": {
    object (I18n)
  },
  "userAgent": string,
  "audits": {
    string: {
      object (LighthouseAuditResultV5)
    },
    ...
  },
  "categoryGroups": {
    string: {
      object (CategoryGroupV5)
    },
    ...
  },
  "stackPacks": [
    {
      object (StackPack)
    }
  ],
  "environment": {
    object (Environment)
  },
  "runWarnings": array,
  "runtimeError": {
    object (RuntimeError)
  },
  "categories": {
    object (Categories)
  },
  "timing": {
    object (Timing)
  },
  "configSettings": {
    object (ConfigSettings)
  }
}
Champs
fetchTime

string

Heure à laquelle cette exécution a été récupérée.
requestedUrl

string

URL demandée à l'origine.
finalUrl

string

URL finale résolue qui a fait l'objet d'un audit.
lighthouseVersion

string

Version du phare utilisée pour générer cette LHR.
i18n

object (I18n)

Chaînes d'internationalisation requises pour afficher la LHR.
userAgent

string

User-agent utilisé pour exécuter cette requête LHR.
audits

map (key: string, value: object (LighthouseAuditResultV5))

Carte des audits dans le LHR.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
categoryGroups

map (key: string, value: object (CategoryGroupV5))

Carte des groupes de catégories dans la LHR.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
stackPacks[]

object (StackPack)

Chaînes de conseils du Stack Pack.
environment

object (Environment)

Paramètres d'environnement utilisés lors de la création de ce LHR.
runWarnings

array (ListValue format)

Liste de tous les avertissements d'exécution dans le LHR. Renvoie toujours au moins [].
runtimeError

object (RuntimeError)

Message d'erreur de premier niveau qui, s'il est présent, indique un problème suffisamment grave pour que ce résultat Lighthouse doive être supprimé.
categories

object (Categories)

Carte des catégories dans le LHR.
timing

object (Timing)

Informations temporelles pour ce LHR.
configSettings

object (ConfigSettings)

Paramètres de configuration de ce LHR.

Localisation

Message contenant les données i18n pour le LHR - Version 1.

Représentation JSON 
{
  "rendererFormattedStrings": {
    object (RendererFormattedStrings)
  }
}
Champs
rendererFormattedStrings

object (RendererFormattedStrings)

Chaînes internationalisées mises en forme selon les paramètres régionaux dans configSettings.

RendererFormattedStrings

Message contenant les chaînes mises en forme utilisées dans le moteur de rendu.

Représentation JSON 
{
  "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
}
Champs
varianceDisclaimer

string

Clause de non-responsabilité affichée en dessous d'une valeur de métrique de performances.
opportunityResourceColumnLabel

string

Titre de l'opportunité d'économies estimées sur le chargement des pages dans le cadre d'un audit.
opportunitySavingsColumnLabel

string

Titre de l'estimation des économies de chargement des pages liées aux audits d'opportunités.
errorMissingAuditInfo

string

Chaîne d'erreur affichée à côté d'un audit d'erreur.
errorLabel

string

Libellé affiché à côté d'un audit ou d'une métrique comportant une erreur.
warningHeader

string

Libellé affiché au-dessus d'une liste à puces d'avertissements.
auditGroupExpandTooltip

string

Texte de l'info-bulle sur une icône en forme de chevron pouvant être développée.
passedAuditsGroupTitle

string

En-tête affiché au-dessus d'une liste des audits réussis.
notApplicableAuditsGroupTitle

string

Le titre affiché au-dessus d'une liste d'audits qui ne s'appliquent pas à une page.
manualAuditsGroupTitle

string

L'en-tête affiché au-dessus d'une liste des audits qui n'ont pas été informatisés lors de l'exécution.
toplevelWarningsMessage

string

Libellé affiché précédant les avertissements importants susceptibles d'avoir invalidé un rapport entier.
scorescaleLabel

string

Étiquette qui explique l'échelle des jauges (0-49, 50-89, 90-100).
crcLongestDurationLabel

string

Libellé des valeurs affichées dans le récapitulatif des chaînes de requêtes critiques.
crcInitialNavigation

string

Libellé de la requête initiale dans une chaîne de requête critique.
lsPerformanceCategoryDescription

string

Clause de non-responsabilité affichée sous "Explication des performances", indiquant que le réseau peut varier
labDataTitle

string

Titre de la catégorie "Performances des données de laboratoire".

StackPack

Message contenant des informations sur le Stack Pack.

Représentation JSON 
{
  "id": string,
  "title": string,
  "iconDataURL": string,
  "descriptions": {
    string: string,
    ...
  }
}
Champs
id

string

ID du pack de piles.
title

string

Titre du pack de piles.
iconDataURL

string

URI de données de l'icône du pack de piles.
descriptions

map (key: string, value: string)

Chaînes de conseils du pack de piles.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Environnement

Message contenant la configuration de l'environnement pour une exécution Lighthouse.

Représentation JSON 
{
  "networkUserAgent": string,
  "hostUserAgent": string,
  "benchmarkIndex": number
}
Champs
networkUserAgent

string

La chaîne user-agent qui a été envoyée sur le réseau.
hostUserAgent

string

Chaîne user-agent de la version de Chrome utilisée.
benchmarkIndex

number

Numéro d'index de benchmark qui indique la classe approximative de l'appareil.

RuntimeError

Message contenant une configuration d'erreur d'exécution.

Représentation JSON 
{
  "code": string,
  "message": string
}
Champs
code

string

Code d'erreur Lighthouse énuméré.
message

string

Message lisible expliquant le code d'erreur.

Catégories

Catégories dans une exécution Lighthouse.

Représentation JSON 
{
  "accessibility": {
    object (LighthouseCategoryV5)
  },
  "best-practices": {
    object (LighthouseCategoryV5)
  },
  "seo": {
    object (LighthouseCategoryV5)
  },
  },
  "performance": {
    object (LighthouseCategoryV5)
  }
}
Champs
accessibility

object (LighthouseCategoryV5)

Catégorie d'accessibilité, qui contient tous les audits liés à l'accessibilité.
best-practices

object (LighthouseCategoryV5)

Catégorie des bonnes pratiques, contenant tous les audits associés aux bonnes pratiques.
seo

object (LighthouseCategoryV5)

Catégorie SEO, contenant tous les audits liés à l'optimisation du référencement.
performance

object (LighthouseCategoryV5)

Catégorie de performances, contenant tous les audits liés aux performances.

LighthouseCategoryV5

Une catégorie Lighthouse.

Représentation JSON 
{
  "id": string,
  "title": string,
  "description": string,
  "manualDescription": string,
  "auditRefs": [
    {
      object (AuditRefs)
    }
  ],
  "score": value
}
Champs
id

string

Identifiant de chaîne de la catégorie.
title

string

Nom convivial de la catégorie.
description

string

Une description plus détaillée de la catégorie et de son importance.
manualDescription

string

Description des audits manuels de la catégorie.
auditRefs[]

object (AuditRefs)

Tableau de références à tous les membres de l'audit de cette catégorie.
score

value (Value format)

Note globale de la catégorie et moyenne pondérée de tous ses audits. (Le score de la catégorie peut être nul.)

AuditRefs

Référence à un audit par ID, utilisée pour regrouper et pondérer les audits dans une catégorie donnée.

Représentation JSON 
{
  "id": string,
  "weight": number,
  "group": string
}
Champs
id

string

ID de référence de l'audit.
weight

number

Pondération du score de cet audit sur la note globale de la catégorie.
group

string

Groupe de catégories auquel l'audit appartient (facultatif).

Durée

Message contenant les données de durée de performance pour l'exécution de Lighthouse.

Représentation JSON 
{
  "total": number
}
Champs
total

number

Durée totale d'exécution de Lighthouse.

ConfigSettings

Message contenant les paramètres de configuration pour l'exécution de Lighthouse.

Représentation JSON 
{
  "onlyCategories": value,
  "emulatedFormFactor": string,
  "locale": string,
  "channel": string,
  "formFactor": string
}
Champs
onlyCategories

value (Value format)

Liste des catégories d'audits que l'exécution doit effectuer.
emulatedFormFactor
(deprecated)

string

Facteur de forme que l'émulation doit utiliser. Ce champ étant obsolète, formFactor doit être utilisé à la place.
locale

string

Paramètre régional.
channel

string

Comment Lighthouse a-t-il été exécuté ? à partir de l'extension Chrome ou du module npm.
formFactor

string

Comment Lighthouse doit-il interpréter cette exécution pour évaluer les métriques de performances et ignorer les tests réservés aux mobiles sur ordinateur ?

PagespeedVersion

Objet Version Pagespeed.

Représentation JSON 
{
  "major": string,
  "minor": string
}
Champs
major

string

Numéro de version majeure de Page Speed utilisée pour générer ces résultats.
minor

string

Numéro de version mineure de PageSpeed utilisé pour générer ces résultats.