Exécute l'analyse PageSpeed sur la page à l'URL spécifiée et renvoie les 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 |
Une catégorie Lighthouse à exécuter. Si aucune catégorie n'est spécifiée, seule la catégorie "Performances" sera exécutée. |
locale |
Paramètres régionaux utilisés pour localiser les résultats mis en forme. |
strategy |
Stratégie d'analyse (ordinateur ou mobile) à utiliser (ordinateur par défaut) |
url |
Obligatoire. URL à extraire et à analyser |
utm_campaign |
Nom de la campagne à des fins d'analyse. |
utm_source |
Source de la campagne pour l'analyse. |
captchaToken |
Jeton captcha transmis lors du remplissage 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 ( |
Champs | |
---|---|
kind |
Type de résultat. |
captchaResult |
Résultat de validation du captcha |
id |
URL canonique et finale du document, après redirection de page (le cas échéant) |
loadingExperience |
Métriques sur l'expérience de chargement des pages des utilisateurs finaux. |
originLoadingExperience |
Métriques sur l'expérience de chargement agrégée des pages au niveau de l'origine |
analysisUTCTimestamp |
Code temporel UTC de cette analyse. |
lighthouseResult |
Réponse Lighthouse pour l'URL d'audit en tant qu'objet. |
version |
Version de PageSpeed 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 UNDEFINED par défaut. |
ACCESSIBILITY |
Accessibilité (a11y), catégorie relative à la capacité d'un site Web à être accessible à tous les utilisateurs. |
BEST_PRACTICES |
Meilleures pratiques, catégorie relative à la conformité d'un site Web avec les meilleures pratiques du Web. |
PERFORMANCE |
Performances : catégorie liée aux performances d'un site Web. |
SEO |
Référencement naturel (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 pour l'analyse.
Enums | |
---|---|
STRATEGY_UNSPECIFIED |
NON DÉFINI. |
DESKTOP |
Extrayez et analysez l'URL pour les navigateurs pour ordinateur. |
MOBILE |
Extrayez et analysez l'URL pour les appareils mobiles. |
PagespeedApiLoadingExperienceV5
Objet d'expérience de chargement CrUX qui contient les répartitions des données CrUX.
Représentation JSON | |
---|---|
{
"id": string,
"metrics": {
string: {
object ( |
Champs | |
---|---|
id |
URL, format ou origine sur lesquels se trouvent les métriques. |
metrics |
Carte de <metrics, data>. Objet contenant une liste de paires |
overall_category |
La "catégorie" de vitesse, dans un format intelligible, de l'ID. |
initial_url |
URL demandée, qui peut être différente de l'ID résolu. |
origin_fallback |
"True" si le résultat est une origine de remplacement à partir d'une page, sinon "false". |
LighthouseResultV5
Objet résultat Lighthouse.
Représentation JSON | |
---|---|
{ "fetchTime": string, "requestedUrl": string, "finalUrl": string, "lighthouseVersion": string, "i18n": { object ( |
Champs | |
---|---|
fetchTime |
Heure à laquelle cette exécution a été récupérée. |
requestedUrl |
URL demandée d'origine. |
finalUrl |
URL résolue finale qui a fait l'objet d'un audit. |
lighthouseVersion |
Version phare utilisée pour générer cette LHR. |
i18n |
Chaînes d'internationalisation requises pour afficher la LHR. |
userAgent |
User-agent utilisé pour exécuter cette LHR. |
audits |
Carte des audits dans la LHR. Objet contenant une liste de paires |
categoryGroups |
Carte des groupes de catégories dans la LHR. Objet contenant une liste de paires |
stackPacks[] |
Chaînes de conseils Stack Pack. |
environment |
Paramètres d'environnement utilisés au moment de la configuration de cette fonctionnalité LHR. |
runWarnings |
Liste de tous les avertissements d'exécution dans la LHR. Le résultat sera toujours au moins égal à |
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 |
Carte des catégories dans la LHR. |
timing |
Informations temporelles pour cette LHR. |
configSettings |
Paramètres de configuration de cette LHR. |
Localisation
Message contenant les données i18n pour la version 1 de LHR.
Représentation JSON | |
---|---|
{
"rendererFormattedStrings": {
object ( |
Champs | |
---|---|
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 |
Clause de non-responsabilité affichée sous la valeur d'une métrique de performances. |
opportunityResourceColumnLabel |
Titre de l'opportunité d'économies estimées sur le chargement des pages dans un audit. |
opportunitySavingsColumnLabel |
Titre de l'estimation des économies de chargement des pages réalisées dans le cadre des audits sur les opportunités. |
errorMissingAuditInfo |
Chaîne d'erreur affichée à côté d'un audit d'erreurs. |
errorLabel |
Libellé affiché à côté d'un audit ou d'une métrique comportant une erreur. |
warningHeader |
Libellé affiché au-dessus d'une liste à puces d'avertissements. |
auditGroupExpandTooltip |
Texte de l'info-bulle sur une icône en forme de chevron extensible. |
passedAuditsGroupTitle |
Titre affiché au-dessus d'une liste d'audits réussis. |
notApplicableAuditsGroupTitle |
L'en-tête affiché au-dessus d'une liste d'audits qui ne s'appliquent pas à une page. |
manualAuditsGroupTitle |
L'en-tête affiché au-dessus d'une liste d'audits qui n'ont pas été informatisés pendant l'exécution. |
toplevelWarningsMessage |
Libellé affiché précédant les avertissements importants susceptibles d'avoir invalidé un rapport entier. |
scorescaleLabel |
L'étiquette qui explique l'échelle des jauges de score (0-49, 50-89, 90-100). |
crcLongestDurationLabel |
Étiquette des valeurs affichées dans le résumé des chaînes de requêtes critiques. |
crcInitialNavigation |
Étiquette de la requête initiale dans une chaîne de requête critique. |
lsPerformanceCategoryDescription |
La clause de non-responsabilité affichée sous "Performances" indique que le réseau peut varier. |
labDataTitle |
Titre de la catégorie de performances des données de test. |
StackPack
Message contenant des informations sur le pack de piles.
Représentation JSON | |
---|---|
{ "id": string, "title": string, "iconDataURL": string, "descriptions": { string: string, ... } } |
Champs | |
---|---|
id |
ID du pack de pile. |
title |
Titre du pack de piles. |
iconDataURL |
URI de données de l'icône du pack de piles. |
descriptions |
Chaînes de conseils du pack de pile. Objet contenant une liste de paires |
Environnement
Message contenant la configuration de l'environnement pour une exécution Lighthouse.
Représentation JSON | |
---|---|
{ "networkUserAgent": string, "hostUserAgent": string, "benchmarkIndex": number } |
Champs | |
---|---|
networkUserAgent |
Chaîne user-agent envoyée sur le réseau. |
hostUserAgent |
Chaîne user-agent de la version de Chrome utilisée |
benchmarkIndex |
Numéro d'index de benchmark qui indique la classe d'appareil approximative. |
RuntimeError
Message contenant une configuration d'erreur d'exécution.
Représentation JSON | |
---|---|
{ "code": string, "message": string } |
Champs | |
---|---|
code |
Code d'erreur Lighthouse énuméré. |
message |
Message lisible expliquant le code d'erreur. |
Categories
Les catégories d'un Lighthouse sont exécutées.
Représentation JSON | |
---|---|
{ "accessibility": { object ( |
Champs | |
---|---|
accessibility |
Catégorie d'accessibilité, contenant tous les audits liés à l'accessibilité. |
best-practices |
La catégorie des bonnes pratiques, contenant toutes les audits liés aux bonnes pratiques. |
seo |
Catégorie SEO (Search Engine-Optimization), contenant tous les audits liés à ce sujet. |
performance |
Catégorie de performance contenant tous les audits liés aux performances. |
LighthouseCategoryV5
Catégorie Lighthouse.
Représentation JSON | |
---|---|
{
"id": string,
"title": string,
"description": string,
"manualDescription": string,
"auditRefs": [
{
object ( |
Champs | |
---|---|
id |
Identifiant de chaîne de la catégorie. |
title |
Nom convivial de la catégorie. |
description |
Une description plus détaillée de la catégorie et de son importance. |
manualDescription |
Description des audits manuels de la catégorie. |
auditRefs[] |
Tableau de références à tous les membres de l'audit de cette catégorie. |
score |
Score global de la catégorie, moyenne pondérée de tous ses audits. (Le score de la catégorie peut être nul.) |
AuditRefs
Légère référence à un audit par identifiant, qui permet de regrouper et de pondérer les audits d'une catégorie donnée.
Représentation JSON | |
---|---|
{ "id": string, "weight": number, "group": string } |
Champs | |
---|---|
id |
ID de référence d'audit. |
weight |
Pondération du score de cet audit sur la note globale de la catégorie. |
group |
Groupe de catégories auquel l'audit appartient (facultatif). |
Délai
Message contenant les données temporelles des performances pour l'exécution de Lighthouse.
Représentation JSON | |
---|---|
{ "total": number } |
Champs | |
---|---|
total |
Durée totale d'exécution de Lighthouse. |
ConfigSettings
Message contenant les paramètres de configuration de l'exécution de Lighthouse.
Représentation JSON | |
---|---|
{ "onlyCategories": value, "emulatedFormFactor": string, "locale": string, "channel": string, "formFactor": string } |
Champs | |
---|---|
onlyCategories |
Liste des catégories d'audits que l'exécution doit effectuer. |
emulatedFormFactor |
Facteur de forme que l'émulation doit utiliser. Ce champ est obsolète. Utilisez "formFactor" à la place. |
locale |
Paramètre régional. |
channel |
la manière dont Lighthouse a été exécuté, par exemple à partir de l'extension Chrome ou du module npm ; |
formFactor |
Comment Lighthouse doit-il interpréter cette exécution pour évaluer les métriques de performances et ignorer les tests sur ordinateur ? |
PagespeedVersion
Objet Version PageSpeed
Représentation JSON | |
---|---|
{ "major": string, "minor": string } |
Champs | |
---|---|
major |
Numéro de version majeure de PageSpeed utilisé pour générer ces résultats. |
minor |
Numéro de version mineure de PageSpeed utilisé pour générer ces résultats. |