Method: pagespeedapi.runpagespeed

Запускает анализ PageSpeed ​​на странице по указанному URL-адресу и возвращает оценки PageSpeed, список предложений по ускорению этой страницы и другую информацию.

HTTP-запрос

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

URL-адрес использует синтаксис транскодирования gRPC .

Параметры запроса

Параметры
category

enum ( Category )

Категория «Маяк» для запуска; если ничего не указано, будет работать только категория «Производительность»

locale

string

Языковой стандарт, используемый для локализации форматированных результатов.

strategy

enum ( Strategy )

Используемая стратегия анализа (настольный компьютер или мобильный телефон), настольный компьютер используется по умолчанию.

url

string

Необходимый. URL-адрес для получения и анализа

utm_campaign

string

Название кампании для аналитики.

utm_source

string

Источник кампании для аналитики.

captchaToken

string

Токен капчи передается при заполнении капчи.

Тело запроса

Тело запроса должно быть пустым.

Тело ответа

В случае успеха тело ответа содержит данные следующей структуры:

Объект ответа API Pagespeed.

JSON-представление 
{
  "kind": string,
  "captchaResult": string,
  "id": string,
  "loadingExperience": {
    object (PagespeedApiLoadingExperienceV5)
  },
  "originLoadingExperience": {
    object (PagespeedApiLoadingExperienceV5)
  },
  "analysisUTCTimestamp": string,
  "lighthouseResult": {
    object (LighthouseResultV5)
  },
  "version": {
    object (PagespeedVersion)
  }
}
Поля
kind

string

Типа результат.

captchaResult

string

Результат проверки капчи

id

string

Канонизированный и конечный URL-адрес документа после следующих перенаправлений страниц (если таковые имеются).

loadingExperience

object ( PagespeedApiLoadingExperienceV5 )

Метрики опыта загрузки страниц конечных пользователей.

originLoadingExperience

object ( PagespeedApiLoadingExperienceV5 )

Метрики совокупного опыта загрузки страниц источника

analysisUTCTimestamp

string

Временная метка в формате UTC для этого анализа.

lighthouseResult

object ( LighthouseResultV5 )

Ответ маяка для URL-адреса аудита как объекта.

version

object ( PagespeedVersion )

Версия PageSpeed, использованная для получения этих результатов.

Области авторизации

Требуется следующая область действия OAuth:

  • openid

Дополнительную информацию см. в обзоре OAuth 2.0 .

Категория

Перечисленные категории, которые следует проанализировать.

Перечисления
CATEGORY_UNSPECIFIED Категория по умолчанию НЕОПРЕДЕЛЕНА.
ACCESSIBILITY Доступность (a11y), категория, относящаяся к способности веб-сайта быть доступным для всех пользователей.
BEST_PRACTICES Лучшие практики — категория, относящаяся к соответствию веб-сайта передовым веб-практикам.
PERFORMANCE Производительность, категория, относящаяся к производительности веб-сайта.
SEO Поисковая оптимизация (SEO), категория, относящаяся к способности веб-сайта индексироваться поисковыми системами.

Стратегия

Стратегия работы устройства, которая будет использоваться в анализе.

Перечисления
STRATEGY_UNSPECIFIED НЕОПРЕДЕЛЕННЫЙ.
DESKTOP Получите и проанализируйте URL-адрес для настольных браузеров.
MOBILE Получите и проанализируйте URL-адрес для мобильных устройств.

Скорость страницыApiLoadingExperienceV5

Объект опыта загрузки CrUX, содержащий разбивку данных CrUX.

JSON-представление 
{
  "id": string,
  "metrics": {
    string: {
      object (UserPageLoadMetricV5)
    },
    ...
  },
  "overall_category": string,
  "initial_url": string,
  "origin_fallback": boolean
}
Поля
id

string

URL-адрес, шаблон или источник, для которого используются метрики.

metrics

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

Карта <метрики, данные>.

Объект, содержащий список пар "key": value . Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

overall_category

string

Удобочитаемая «категория» скорости идентификатора.

initial_url

string

Запрошенный URL-адрес, который может отличаться от разрешенного «id».

origin_fallback

boolean

True, если результатом является резервный исходный код страницы, в противном случае — false.

МаякРезультатV5

Объект результата Маяк.

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)
  }
}
Поля
fetchTime

string

Время получения этого запуска.

requestedUrl

string

Исходный запрошенный URL.

finalUrl

string

Окончательный разрешенный URL, прошедший проверку.

lighthouseVersion

string

Версия маяка, которая использовалась для создания этого LHR.

i18n

object ( I18n )

Строки интернационализации, необходимые для отображения LHR.

userAgent

string

Пользовательский агент, который использовался для запуска этого LHR.

audits

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

Карта проверок в ЛРР.

Объект, содержащий список пар "key": value . Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

categoryGroups

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

Карта групп категорий в LHR.

Объект, содержащий список пар "key": value . Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

stackPacks[]

object ( StackPack )

Строки рекомендаций Stack Pack.

environment

object ( Environment )

Настройки среды, которые использовались при создании этого LHR.

runWarnings

array ( ListValue format)

Список всех предупреждений о запуске в LHR. Всегда будет выводиться как минимум в [] .

runtimeError

object ( RuntimeError )

Сообщение об ошибке верхнего уровня, которое, если оно присутствует, указывает на достаточно серьезную проблему, поэтому этот результат Lighthouse, возможно, придется отбросить.

categories

object ( Categories )

Карта категорий в LHR.

timing

object ( Timing )

Информация о времени для этого LHR.

configSettings

object ( ConfigSettings )

Параметры конфигурации для этого LHR.

I18n

Сообщение, содержащее данные i18n для LHR — Версия 1.

JSON-представление 
{
  "rendererFormattedStrings": {
    object (RendererFormattedStrings)
  }
}
Поля
rendererFormattedStrings

object ( RendererFormattedStrings )

Интернационализированные строки, отформатированные в соответствии с языковым стандартом в configSettings.

Средство рендерингаFormattedStrings

Сообщение, содержащее форматированные строки, используемые в средстве визуализации.

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
}
Поля
varianceDisclaimer

string

Отказ от ответственности, показанный под значением показателя производительности.

opportunityResourceColumnLabel

string

Заголовок предполагаемой возможности экономии загрузки страницы в результате аудита.

opportunitySavingsColumnLabel

string

Заголовок предполагаемой экономии загрузки страниц при аудите возможностей.

errorMissingAuditInfo

string

Строка ошибки, показанная рядом с ошибочным аудитом.

errorLabel

string

Метка, отображаемая рядом с аудитом или показателем, в котором возникла ошибка.

warningHeader

string

Ярлык, показанный над маркированным списком предупреждений.

auditGroupExpandTooltip

string

Текст подсказки на расширяемом значке шеврона.

passedAuditsGroupTitle

string

Заголовок, отображаемый над списком проходящих проверок.

notApplicableAuditsGroupTitle

string

В заголовке выше приведен список проверок, которые не применяются к странице.

manualAuditsGroupTitle

string

Заголовок, показанный выше, представляет собой список проверок, которые не были компьютеризированы в ходе выполнения.

toplevelWarningsMessage

string

Метка, отображаемая перед важными предупреждениями, которые могли сделать весь отчет недействительным.

scorescaleLabel

string

Метка, поясняющая шкалу шкалы оценок (0–49, 50–89, 90–100).

crcLongestDurationLabel

string

Метка значений, показанная в сводке критических цепочек запросов.

crcInitialNavigation

string

Метка первоначального запроса в критической цепочке запросов.

lsPerformanceCategoryDescription

string

Отказ от ответственности, показанный в разделе «Производительность», поясняет, что сеть может различаться.

labDataTitle

string

Название категории производительности лабораторных данных.

СтекПак

Сообщение, содержащее информацию о пакете стека.

JSON-представление 
{
  "id": string,
  "title": string,
  "iconDataURL": string,
  "descriptions": {
    string: string,
    ...
  }
}
Поля
id

string

Идентификатор пакета стека.

title

string

Название пакета стека.

iconDataURL

string

URI данных значка пакета стека.

descriptions

map (key: string, value: string)

Строки рекомендаций по пакету стека.

Объект, содержащий список пар "key": value . Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

Среда

Сообщение, содержащее конфигурацию среды для запуска Lighthouse.

JSON-представление 
{
  "networkUserAgent": string,
  "hostUserAgent": string,
  "benchmarkIndex": number
}
Поля
networkUserAgent

string

Строка пользовательского агента, отправленная по сети.

hostUserAgent

string

Строка пользовательского агента используемой версии Chrome.

benchmarkIndex

number

Номер эталонного индекса, указывающий грубый класс устройства.

Ошибка выполнения

Сообщение, содержащее конфигурацию ошибки времени выполнения.

JSON-представление 
{
  "code": string,
  "message": string
}
Поля
code

string

Перечисленный код ошибки Lighthouse.

message

string

Читабельное сообщение с объяснением кода ошибки.

Категории

Категории в Lighthouse run.

JSON-представление 
{
  "accessibility": {
    object (LighthouseCategoryV5)
  },
  "best-practices": {
    object (LighthouseCategoryV5)
  },
  "seo": {
    object (LighthouseCategoryV5)
  },
  },
  "performance": {
    object (LighthouseCategoryV5)
  }
}
Поля
accessibility

object ( LighthouseCategoryV5 )

Категория доступности, содержащая все аудиты, связанные с доступностью.

best-practices

object ( LighthouseCategoryV5 )

Категория лучших практик, содержащая все аудиты, связанные с лучшими практиками.

seo

object ( LighthouseCategoryV5 )

Категория «Поисковая оптимизация» (SEO), содержащая все аудиты, связанные с поисковой оптимизацией.

performance

object ( LighthouseCategoryV5 )

Категория производительности, содержащая все аудиты, связанные с производительностью.

МаякКатегорияV5

Категория «Маяк».

JSON-представление 
{
  "id": string,
  "title": string,
  "description": string,
  "manualDescription": string,
  "auditRefs": [
    {
      object (AuditRefs)
    }
  ],
  "score": value
}
Поля
id

string

Строковый идентификатор категории.

title

string

Понятное для пользователя имя категории.

description

string

Более подробное описание категории и ее важности.

manualDescription

string

Описание ручного аудита в категории.

auditRefs[]

object ( AuditRefs )

Массив ссылок на всех участников аудита этой категории.

score

value ( Value format)

Общий балл категории, средневзвешенное значение всех ее аудитов. (Оценка категории может быть нулевой.)

АудитРефс

Легкая ссылка на аудит по идентификатору, используемая для группировки и взвешивания аудитов в данной категории.

JSON-представление 
{
  "id": string,
  "weight": number,
  "group": string
}
Поля
id

string

Идентификатор аудита.

weight

number

Вес, который оценка этого аудита имеет в общей оценке категории.

group

string

Группа категорий, к которой относится аудит (необязательно).

Тайминг

Сообщение, содержащее данные о времени выполнения для запуска Lighthouse.

JSON-представление 
{
  "total": number
}
Поля
total

number

Общая продолжительность работы Маяка.

Настройки конфигурации

Сообщение, содержащее настройки конфигурации для запуска Lighthouse.

JSON-представление 
{
  "onlyCategories": value,
  "emulatedFormFactor": string,
  "locale": string,
  "channel": string,
  "formFactor": string
}
Поля
onlyCategories

value ( Value format)

Перечень категорий проверок, которые должен провести пробег.

emulatedFormFactor
(deprecated)

string

Форм-фактор, который должна использовать эмуляция. Это поле устарело, вместо него следует использовать formFactor.

locale

string

Настройка локали.

channel

string

Как запускался Lighthouse, например, из расширения Chrome или из модуля npm.

formFactor

string

Как Lighthouse следует интерпретировать этот запуск в отношении оценки показателей производительности и пропуска тестов только для мобильных устройств на настольных компьютерах.

СтраницаскоростьВерсия

Объект версии Pagespeed.

JSON-представление 
{
  "major": string,
  "minor": string
}
Поля
major

string

Основной номер версии PageSpeed, использованной для создания этих результатов.

minor

string

Младший номер версии PageSpeed, используемый для создания этих результатов.