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 |
Une catégorie Lighthouse à exécuter Si aucune n'est spécifiée, seule la catégorie "Performances" sera utilisée. |
locale |
Paramètres régionaux utilisés pour localiser les résultats mis en forme |
strategy |
La stratégie d'analyse (ordinateur ou mobile) à utiliser (l'ordinateur est la stratégie par défaut) |
url |
Obligatoire. URL à récupérer et à analyser |
utm_campaign |
Nom de la campagne à des fins d'analyse. |
utm_source |
Source de la campagne pour les données analytiques. |
captchaToken |
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 ( |
Champs | |
---|---|
kind |
Type de résultat. |
captchaResult |
Résultat de la vérification du captcha |
id |
URL canonique et finale du document, après avoir suivi les redirections de la page (le cas échéant). |
loadingExperience |
Les métriques des performances lors du chargement de pages. |
originLoadingExperience |
Métriques du chargement de page cumulé 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 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 ( |
Champs | |
---|---|
id |
URL, format ou origine concernés par les métriques. |
metrics |
Carte de <metrics, data>. Objet contenant une liste de paires |
overall_category |
La "catégorie" de vitesse, lisible par l'humain, 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, "false" dans le cas contraire. |
LighthouseResultV5
Objet de 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 à l'origine. |
finalUrl |
URL finale résolue qui a fait l'objet d'un audit. |
lighthouseVersion |
Version du 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 requête LHR. |
audits |
Carte des audits dans le 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 du Stack Pack. |
environment |
Paramètres d'environnement utilisés lors de la création de ce LHR. |
runWarnings |
Liste de tous les avertissements d'exécution dans le LHR. Renvoie toujours au moins |
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 le LHR. |
timing |
Informations temporelles pour ce LHR. |
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 ( |
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 en dessous d'une valeur de métrique de performances. |
opportunityResourceColumnLabel |
Titre de l'opportunité d'économies estimées sur le chargement des pages dans le cadre d'un audit. |
opportunitySavingsColumnLabel |
Titre de l'estimation des économies de chargement des pages liées aux audits d'opportunités. |
errorMissingAuditInfo |
Chaîne d'erreur affichée à côté d'un audit d'erreur. |
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 pouvant être développée. |
passedAuditsGroupTitle |
En-tête affiché au-dessus d'une liste des audits réussis. |
notApplicableAuditsGroupTitle |
Le titre 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 des audits qui n'ont pas été informatisés lors de l'exécution. |
toplevelWarningsMessage |
Libellé affiché précédant les avertissements importants susceptibles d'avoir invalidé un rapport entier. |
scorescaleLabel |
Étiquette qui explique l'échelle des jauges (0-49, 50-89, 90-100). |
crcLongestDurationLabel |
Libellé des valeurs affichées dans le récapitulatif des chaînes de requêtes critiques. |
crcInitialNavigation |
Libellé de la requête initiale dans une chaîne de requête critique. |
lsPerformanceCategoryDescription |
Clause de non-responsabilité affichée sous "Explication des performances", indiquant que le réseau peut varier |
labDataTitle |
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 |
ID du pack de piles. |
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 piles. 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 |
La chaîne user-agent qui a été 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 approximative de l'appareil. |
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. |
Catégories
Catégories dans une exécution Lighthouse.
Représentation JSON | |
---|---|
{ "accessibility": { object ( |
Champs | |
---|---|
accessibility |
Catégorie d'accessibilité, qui contient tous les audits liés à l'accessibilité. |
best-practices |
Catégorie des bonnes pratiques, contenant tous les audits associés aux bonnes pratiques. |
seo |
Catégorie SEO, contenant tous les audits liés à l'optimisation du référencement. |
performance |
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 ( |
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 |
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 |
ID de référence de l'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). |
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 |
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 |
Liste des catégories d'audits que l'exécution doit effectuer. |
emulatedFormFactor |
Facteur de forme que l'émulation doit utiliser. Ce champ étant obsolète, formFactor doit être utilisé à la place. |
locale |
Paramètre régional. |
channel |
Comment Lighthouse a-t-il été exécuté ? à 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 réservés aux mobiles sur ordinateur ? |
PagespeedVersion
Objet Version Pagespeed.
Représentation JSON | |
---|---|
{ "major": string, "minor": string } |
Champs | |
---|---|
major |
Numéro de version majeure de Page Speed utilisée pour générer ces résultats. |
minor |
Numéro de version mineure de PageSpeed utilisé pour générer ces résultats. |