Pagespeedapi: runpagespeed

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

Запрос

HTTP-запрос

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

Параметры

Имя параметра Ценить Описание
Обязательные параметры запроса
url string URL-адрес для получения и анализа
Необязательные параметры запроса
filter_third_party_resources boolean Указывает, следует ли отфильтровывать сторонние ресурсы перед анализом PageSpeed. (По умолчанию: false )
locale string Языковой стандарт, используемый для локализации форматированных результатов.
rule string Правило PageSpeed ​​для запуска; если ничего не указано, выполняются все правила
screenshot boolean Указывает, следует ли включать двоичные данные, содержащие снимок экрана (по умолчанию: false ).
snapshots boolean Указывает, следует ли включать двоичные данные, содержащие изображения моментальных снимков (по умолчанию: false ).
strategy string Используемая стратегия анализа (настольный компьютер или мобильный телефон), настольный компьютер используется по умолчанию.

Приемлемые значения:
  • « desktop »: получение и анализ URL-адреса для настольных браузеров.
  • « mobile »: получение и анализ URL-адреса для мобильных устройств.
utm_campaign string Название кампании для аналитики.
utm_source string Источник кампании для аналитики.

Тело запроса

Не предоставляйте тело запроса с помощью этого метода.

Ответ

В случае успеха этот метод возвращает тело ответа следующей структуры:

{
  "captchaResult": string,
  "kind": "pagespeedonline#result",
  "id": string,
  "responseCode": integer,
  "title": string,
  "ruleGroups": {
    (key): {
      "score": integer,
      "pass": boolean
    }
  },
  "loadingExperience": {
    "id": string,
    "metrics": {
      (key): {
        "median": integer,
        "distributions": [
          {
            "min": integer,
            "max": integer,
            "proportion": double
          }
        ],
        "category": string
      }
    },
    "overall_category": string,
    "initial_url": string
  },
  "pageStats": {
    "numberResources": integer,
    "numberHosts": integer,
    "totalRequestBytes": long,
    "numberStaticResources": integer,
    "htmlResponseBytes": long,
    "textResponseBytes": long,
    "overTheWireResponseBytes": long,
    "cssResponseBytes": long,
    "imageResponseBytes": long,
    "javascriptResponseBytes": long,
    "flashResponseBytes": long,
    "otherResponseBytes": long,
    "numberJsResources": integer,
    "numberCssResources": integer,
    "numberRobotedResources": integer,
    "numberTransientFetchFailureResources": integer,
    "numTotalRoundTrips": integer,
    "numRenderBlockingRoundTrips": integer,
    "robotedUrls": [
      string
    ],
    "transientFetchFailureUrls": [
      string
    ],
    "cms": string
  },
  "formattedResults": {
    "locale": string,
    "ruleResults": {
      (key): {
        "localizedRuleName": string,
        "ruleImpact": double,
        "beta": boolean,
        "groups": [
          string
        ],
        "summary": {
          "format": string,
          "args": [
            {
              "type": string,
              "key": string,
              "value": string,
              "rects": [
                {
                  "left": integer,
                  "top": integer,
                  "width": integer,
                  "height": integer
                }
              ],
              "secondary_rects": [
                {
                  "left": integer,
                  "top": integer,
                  "width": integer,
                  "height": integer
                }
              ]
            }
          ]
        },
        "urlBlocks": [
          {
            "header": {
              "format": string,
              "args": [
                {
                  "type": string,
                  "key": string,
                  "value": string,
                  "rects": [
                    {
                      "left": integer,
                      "top": integer,
                      "width": integer,
                      "height": integer
                    }
                  ],
                  "secondary_rects": [
                    {
                      "left": integer,
                      "top": integer,
                      "width": integer,
                      "height": integer
                    }
                  ]
                }
              ]
            },
            "urls": [
              {
                "result": {
                  "format": string,
                  "args": [
                    {
                      "type": string,
                      "key": string,
                      "value": string,
                      "rects": [
                        {
                          "left": integer,
                          "top": integer,
                          "width": integer,
                          "height": integer
                        }
                      ],
                      "secondary_rects": [
                        {
                          "left": integer,
                          "top": integer,
                          "width": integer,
                          "height": integer
                        }
                      ]
                    }
                  ]
                },
                "details": [
                  {
                    "format": string,
                    "args": [
                      {
                        "type": string,
                        "key": string,
                        "value": string,
                        "rects": [
                          {
                            "left": integer,
                            "top": integer,
                            "width": integer,
                            "height": integer
                          }
                        ],
                        "secondary_rects": [
                          {
                            "left": integer,
                            "top": integer,
                            "width": integer,
                            "height": integer
                          }
                        ]
                      }
                    ]
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  },
  "version": {
    "major": integer,
    "minor": integer
  },
  "invalidRules": [
    string
  ],
  "screenshot": {
    "key": string,
    "mime_type": string,
    "data": bytes,
    "width": integer,
    "height": integer,
    "page_rect": {
      "left": integer,
      "top": integer,
      "width": integer,
      "height": integer
    }
  },
  "snapshots": [
    {
      "key": string,
      "mime_type": string,
      "data": bytes,
      "width": integer,
      "height": integer,
      "page_rect": {
        "left": integer,
        "top": integer,
        "width": integer,
        "height": integer
      }
    }
  ]
}
Имя свойства Ценить Описание Примечания
captchaResult string Результат проверки капчи

Приемлемые значения:
  • " CAPTCHA_BLOCKING "
  • " CAPTCHA_MATCHED "
  • " CAPTCHA_NEEDED "
  • " CAPTCHA_NOT_NEEDED "
  • " CAPTCHA_UNMATCHED "
kind string Типа результат.
id string Канонизированный и конечный URL-адрес документа после следующих перенаправлений страниц (если таковые имеются).
responseCode integer Код ответа для документа. 200 означает нормальную загрузку страницы. 4xx/5xx указывает на ошибку.
title string Название страницы, отображаемое в строке заголовка браузера.
ruleGroups object Карта с одной записью для каждой группы правил в этих результатах.
ruleGroups. (key) object Имя этой группы правил: одно из «СКОРОСТЬ», «УДОБСТВО ИСПОЛЬЗОВАНИЯ» или «БЕЗОПАСНОСТЬ».
ruleGroups.(key). score integer Оценка (0–100) для этой группы правил, которая указывает, насколько лучше могла бы быть страница в этой категории (например, насколько быстрее, насколько удобнее или насколько безопаснее). Высокий балл указывает на отсутствие возможностей для улучшения, а более низкий балл указывает на большие возможности для улучшения.
ruleGroups.(key). pass boolean
loadingExperience object Метрики опыта загрузки страниц конечных пользователей.
loadingExperience. id string URL-адрес, шаблон или источник, для которого используются метрики.
loadingExperience. metrics object
loadingExperience.metrics. (key) object Тип метрики.
loadingExperience.metrics.(key). median integer
loadingExperience.metrics.(key). distributions[] list
loadingExperience.metrics.(key).distributions[]. min integer
loadingExperience.metrics.(key).distributions[]. max integer
loadingExperience.metrics.(key).distributions[]. proportion double
pageStats object Сводная статистика для страницы, такая как количество байтов JavaScript, количество байтов HTML и т. д.
pageStats. numberResources integer Количество HTTP-ресурсов, загруженных страницей.
pageStats. numberHosts integer Количество уникальных хостов, на которые ссылается страница.
pageStats. totalRequestBytes long Общий размер всех байтов запроса, отправленных страницей.
pageStats. numberStaticResources integer Количество статических (т. е. кэшируемых) ресурсов на странице.
pageStats. htmlResponseBytes long Количество несжатых байтов ответа для основного HTML-документа и всех iframe на странице.
pageStats. textResponseBytes long Количество несжатых байтов ответа для текстовых ресурсов, не охваченных другой статистикой (т. е. ресурсов, отличных от HTML, скриптов и CSS) на странице.
pageStats. overTheWireResponseBytes long Количество байтов, передаваемых по сети, в качестве оценки используется стратегия сжатия gzip по умолчанию.
pageStats. cssResponseBytes long Количество несжатых байтов ответа для ресурсов CSS на странице.
pageStats. imageResponseBytes long Количество байтов ответа для ресурсов изображения на странице.
pageStats. javascriptResponseBytes long Количество несжатых байтов ответа для ресурсов JS на странице.
pageStats. flashResponseBytes long Количество байтов ответа для флэш-ресурсов на странице.
pageStats. otherResponseBytes long Количество байтов ответа для других ресурсов на странице.
pageStats. numberJsResources integer Количество ресурсов JavaScript, на которые ссылается страница.
pageStats. numberCssResources integer Количество ресурсов CSS, на которые ссылается страница.
pageStats. numberRobotedResources integer Количество роботизированных ресурсов.
pageStats. numberTransientFetchFailureResources integer Количество ресурсов с временным сбоем.
pageStats. numTotalRoundTrips integer Необходимые обходы для загрузки полной страницы
pageStats. numRenderBlockingRoundTrips integer Необходимые обходы для загрузки ресурсов блокировки рендеринга
pageStats. robotedUrls[] list Список роботизированных URL-адресов.
pageStats. transientFetchFailureUrls[] list Список URL-адресов с временными ошибками получения.
pageStats. cms string Система управления контентом (CMS), используемая на странице.

Приемлемые значения:
  • « BITRIX »
  • « BLOGGER »
  • " DATALIFE_ENGINE "
  • « DRUPAL »
  • " GOOGLE_SITES "
  • " JOOMLA "
  • " MAGENTO "
  • " PRESTASHOP "
  • " TUMBLR "
  • " UNKNOWN "
  • " VBULLETIN "
  • " WORDPRESS "
formattedResults object Локализованные результаты PageSpeed. Содержит запись ruleResults для каждого правила PageSpeed, созданного и запущенного сервером.
formattedResults. locale string Локаль форматированных результатов, например «en_US».
formattedResults. ruleResults object Словарь результатов отформатированных правил с одной записью для каждого правила PageSpeed, созданного и запущенного сервером.
formattedResults.ruleResults. (key) object Перечисляемый идентификатор для этого правила. Например, «EnableKeepAlive» или «AvoidCssImport». Не локализован.
formattedResults.ruleResults.(key). localizedRuleName string Локализованное имя правила, предназначенное для представления пользователю.
formattedResults.ruleResults.(key). ruleImpact double Влияние (неограниченное значение с плавающей запятой), которое реализация предложений для этого правила окажет на ускорение страницы. Влияние правил сравнивается, чтобы определить, какие предложения правил окажут большее или меньшее влияние на ускорение страницы. Например, если включение сжатия позволит сэкономить 1 МБ, а оптимизация изображений — 500 КБ, то правило включения сжатия будет иметь в два раза больший эффект, чем правило оптимизации изображений, при прочих равных условиях.
formattedResults.ruleResults.(key). beta boolean Является ли это правило бета-версией. Правила в бета-версии — это новые правила, которые проходят тестирование и не влияют на общий балл.
formattedResults.ruleResults.(key). groups[] list Список групп правил, которым принадлежит это правило. Каждая запись в списке имеет значение «СКОРОСТЬ», «УДОБСТВО ИСПОЛЬЗОВАНИЯ» или «БЕЗОПАСНОСТЬ».
formattedResults.ruleResults.(key). summary nested object Краткое суммарное описание правила, указывающее на высоком уровне, что следует сделать, чтобы следовать правилу, и какую выгоду можно получить от этого.
formattedResults.ruleResults.(key).summary. format string Строка локализованного формата с заполнителями , где FOO — это ключ аргумента, значение которого необходимо заменить. Для аргументов HYPERLINK строка формата вместо этого будет содержать и для аргумента с ключом «FOO».
formattedResults.ruleResults.(key).summary. args[] list Список аргументов для строки формата.
formattedResults.ruleResults.(key).summary.args[]. type string Тип аргумента. Один из URL, STRING_LITERAL, INT_LITERAL, BYTES, DURATION, VERBATIM_STRING, PERCENTAGE, HYPERLINK или SNAPSHOT_RECT.

Приемлемые значения:
  • " BYTES "
  • « DISTANCE »
  • " DURATION "
  • « HYPERLINK »
  • " INT_LITERAL "
  • " PERCENTAGE "
  • " SNAPSHOT_RECT "
  • " STRING_LITERAL "
  • " URL "
  • " VERBATIM_STRING "
formattedResults.ruleResults.(key).summary.args[]. key string Ключ-заполнитель для этого аргумента в виде строки.
formattedResults.ruleResults.(key).summary.args[]. value string Значение аргумента в виде локализованной строки.
formattedResults.ruleResults.(key).summary.args[]. rects[] list Речь идет о прямоугольниках экрана, размеры которых измеряются в CSS-пикселях. Это используется только для аргументов SNAPSHOT_RECT. Если это отсутствует для аргумента SNAPSHOT_RECT, это означает, что этот аргумент относится ко всему моментальному снимку.
formattedResults.ruleResults.(key).summary.args[].rects[]. left integer
formattedResults.ruleResults.(key).summary.args[].rects[]. top integer
formattedResults.ruleResults.(key).summary.args[].rects[]. width integer
formattedResults.ruleResults.(key).summary.args[].rects[]. height integer
formattedResults.ruleResults.(key).summary.args[]. secondary_rects[] list Имеются в виду прямоугольники вторичного экрана, размеры которых измеряются в пикселях CSS. Это используется только для аргументов SNAPSHOT_RECT.
formattedResults.ruleResults.(key).summary.args[].secondary_rects[]. left integer
formattedResults.ruleResults.(key).summary.args[].secondary_rects[]. top integer
formattedResults.ruleResults.(key).summary.args[].secondary_rects[]. width integer
formattedResults.ruleResults.(key).summary.args[].secondary_rects[]. height integer
formattedResults.ruleResults.(key). urlBlocks[] list Список блоков URL-адресов. Каждый блок может содержать заголовок и список URL-адресов. Каждый URL-адрес может дополнительно включать дополнительную информацию.
formattedResults.ruleResults.(key).urlBlocks[]. header nested object Заголовок, который будет отображаться со списком URL-адресов.
formattedResults.ruleResults.(key).urlBlocks[].header. format string Строка локализованного формата с заполнителями , где FOO — это ключ аргумента, значение которого необходимо заменить. Для аргументов HYPERLINK строка формата вместо этого будет содержать и для аргумента с ключом «FOO».
formattedResults.ruleResults.(key).urlBlocks[].header. args[] list Список аргументов для строки формата.
formattedResults.ruleResults.(key).urlBlocks[].header.args[]. type string Тип аргумента. Один из URL, STRING_LITERAL, INT_LITERAL, BYTES, DURATION, VERBATIM_STRING, PERCENTAGE, HYPERLINK или SNAPSHOT_RECT.

Приемлемые значения:
  • " BYTES "
  • « DISTANCE »
  • " DURATION "
  • « HYPERLINK »
  • " INT_LITERAL "
  • " PERCENTAGE "
  • " SNAPSHOT_RECT "
  • " STRING_LITERAL "
  • " URL "
  • " VERBATIM_STRING "
formattedResults.ruleResults.(key).urlBlocks[].header.args[]. key string Ключ-заполнитель для этого аргумента в виде строки.
formattedResults.ruleResults.(key).urlBlocks[].header.args[]. value string Значение аргумента в виде локализованной строки.
formattedResults.ruleResults.(key).urlBlocks[].header.args[]. rects[] list Речь идет о прямоугольниках экрана, размеры которых измеряются в CSS-пикселях. Это используется только для аргументов SNAPSHOT_RECT. Если это отсутствует для аргумента SNAPSHOT_RECT, это означает, что этот аргумент относится ко всему моментальному снимку.
formattedResults.ruleResults.(key).urlBlocks[].header.args[].rects[]. left integer
formattedResults.ruleResults.(key).urlBlocks[].header.args[].rects[]. top integer
formattedResults.ruleResults.(key).urlBlocks[].header.args[].rects[]. width integer
formattedResults.ruleResults.(key).urlBlocks[].header.args[].rects[]. height integer
formattedResults.ruleResults.(key).urlBlocks[].header.args[]. secondary_rects[] list Имеются в виду прямоугольники вторичного экрана, размеры которых измеряются в пикселях CSS. Это используется только для аргументов SNAPSHOT_RECT.
formattedResults.ruleResults.(key).urlBlocks[].header.args[].secondary_rects[]. left integer
formattedResults.ruleResults.(key).urlBlocks[].header.args[].secondary_rects[]. top integer
formattedResults.ruleResults.(key).urlBlocks[].header.args[].secondary_rects[]. width integer
formattedResults.ruleResults.(key).urlBlocks[].header.args[].secondary_rects[]. height integer
formattedResults.ruleResults.(key).urlBlocks[]. urls[] list Список записей, предоставляющих информацию об URL-адресах в блоке URL-адресов. Необязательный.
formattedResults.ruleResults.(key).urlBlocks[].urls[]. result nested object Строка формата, предоставляющая информацию об URL-адресе, и список аргументов для этой строки формата.
formattedResults.ruleResults.(key).urlBlocks[].urls[].result. format string Строка локализованного формата с заполнителями , где FOO — это ключ аргумента, значение которого необходимо заменить. Для аргументов HYPERLINK строка формата вместо этого будет содержать и для аргумента с ключом «FOO».
formattedResults.ruleResults.(key).urlBlocks[].urls[].result. args[] list Список аргументов для строки формата.
formattedResults.ruleResults.(key).urlBlocks[].urls[].result.args[]. type string Тип аргумента. Один из URL, STRING_LITERAL, INT_LITERAL, BYTES, DURATION, VERBATIM_STRING, PERCENTAGE, HYPERLINK или SNAPSHOT_RECT.

Приемлемые значения:
  • " BYTES "
  • « DISTANCE »
  • " DURATION "
  • « HYPERLINK »
  • " INT_LITERAL "
  • " PERCENTAGE "
  • " SNAPSHOT_RECT "
  • " STRING_LITERAL "
  • " URL "
  • " VERBATIM_STRING "
formattedResults.ruleResults.(key).urlBlocks[].urls[].result.args[]. key string Ключ-заполнитель для этого аргумента в виде строки.
formattedResults.ruleResults.(key).urlBlocks[].urls[].result.args[]. value string Значение аргумента в виде локализованной строки.
formattedResults.ruleResults.(key).urlBlocks[].urls[].result.args[]. rects[] list Речь идет о прямоугольниках экрана, размеры которых измеряются в CSS-пикселях. Это используется только для аргументов SNAPSHOT_RECT. Если это отсутствует для аргумента SNAPSHOT_RECT, это означает, что этот аргумент относится ко всему моментальному снимку.
formattedResults.ruleResults.(key).urlBlocks[].urls[].result.args[].rects[]. left integer
formattedResults.ruleResults.(key).urlBlocks[].urls[].result.args[].rects[]. top integer
formattedResults.ruleResults.(key).urlBlocks[].urls[].result.args[].rects[]. width integer
formattedResults.ruleResults.(key).urlBlocks[].urls[].result.args[].rects[]. height integer
formattedResults.ruleResults.(key).urlBlocks[].urls[].result.args[]. secondary_rects[] list Имеются в виду прямоугольники вторичного экрана, размеры которых измеряются в пикселях CSS. Это используется только для аргументов SNAPSHOT_RECT.
formattedResults.ruleResults.(key).urlBlocks[].urls[].result.args[].secondary_rects[]. left integer
formattedResults.ruleResults.(key).urlBlocks[].urls[].result.args[].secondary_rects[]. top integer
formattedResults.ruleResults.(key).urlBlocks[].urls[].result.args[].secondary_rects[]. width integer
formattedResults.ruleResults.(key).urlBlocks[].urls[].result.args[].secondary_rects[]. height integer
formattedResults.ruleResults.(key).urlBlocks[].urls[]. details[] list Список записей, предоставляющих дополнительную информацию об одном URL-адресе. Необязательный.
formattedResults.ruleResults.(key).urlBlocks[].urls[].details[]. format string Строка локализованного формата с заполнителями , где FOO — это ключ аргумента, значение которого необходимо заменить. Для аргументов HYPERLINK строка формата вместо этого будет содержать и для аргумента с ключом «FOO».
formattedResults.ruleResults.(key).urlBlocks[].urls[].details[]. args[] list Список аргументов для строки формата.
formattedResults.ruleResults.(key).urlBlocks[].urls[].details[].args[]. type string Тип аргумента. Один из URL, STRING_LITERAL, INT_LITERAL, BYTES, DURATION, VERBATIM_STRING, PERCENTAGE, HYPERLINK или SNAPSHOT_RECT.

Приемлемые значения:
  • " BYTES "
  • « DISTANCE »
  • " DURATION "
  • « HYPERLINK »
  • " INT_LITERAL "
  • " PERCENTAGE "
  • " SNAPSHOT_RECT "
  • " STRING_LITERAL "
  • " URL "
  • " VERBATIM_STRING "
formattedResults.ruleResults.(key).urlBlocks[].urls[].details[].args[]. key string Ключ-заполнитель для этого аргумента в виде строки.
formattedResults.ruleResults.(key).urlBlocks[].urls[].details[].args[]. value string Значение аргумента в виде локализованной строки.
formattedResults.ruleResults.(key).urlBlocks[].urls[].details[].args[]. rects[] list Речь идет о прямоугольниках экрана, размеры которых измеряются в CSS-пикселях. Это используется только для аргументов SNAPSHOT_RECT. Если это отсутствует для аргумента SNAPSHOT_RECT, это означает, что этот аргумент относится ко всему моментальному снимку.
formattedResults.ruleResults.(key).urlBlocks[].urls[].details[].args[].rects[]. left integer
formattedResults.ruleResults.(key).urlBlocks[].urls[].details[].args[].rects[]. top integer
formattedResults.ruleResults.(key).urlBlocks[].urls[].details[].args[].rects[]. width integer
formattedResults.ruleResults.(key).urlBlocks[].urls[].details[].args[].rects[]. height integer
formattedResults.ruleResults.(key).urlBlocks[].urls[].details[].args[]. secondary_rects[] list Имеются в виду прямоугольники вторичного экрана, размеры которых измеряются в пикселях CSS. Это используется только для аргументов SNAPSHOT_RECT.
formattedResults.ruleResults.(key).urlBlocks[].urls[].details[].args[].secondary_rects[]. left integer
formattedResults.ruleResults.(key).urlBlocks[].urls[].details[].args[].secondary_rects[]. top integer
formattedResults.ruleResults.(key).urlBlocks[].urls[].details[].args[].secondary_rects[]. width integer
formattedResults.ruleResults.(key).urlBlocks[].urls[].details[].args[].secondary_rects[]. height integer
version object Версия PageSpeed, использованная для получения этих результатов.
version. major integer Основной номер версии PageSpeed, использованной для создания этих результатов.
version. minor integer Младший номер версии PageSpeed, используемый для создания этих результатов.
invalidRules[] list Список правил, которые были указаны в запросе, но которые сервер не знал, как создать экземпляр.
screenshot nested object Скриншот проанализированной страницы в кодировке Base64.
screenshot. key string Уникальный строковый ключ, если таковой имеется, идентифицирующий это изображение.
screenshot. mime_type string MIME-тип данных изображения (например, «image/jpeg»).
screenshot. data bytes Данные изображения закодированы в базе данных base64.
screenshot. width integer Ширина скриншота в пикселях.
screenshot. height integer Высота скриншота в пикселях.
screenshot. page_rect object
screenshot.page_rect. left integer
screenshot.page_rect. top integer
screenshot.page_rect. width integer
screenshot.page_rect. height integer
snapshots[] list Дополнительные снимки экрана страницы в кодировке Base64 в различных состояниях частичной отрисовки.
snapshots[]. key string Уникальный строковый ключ, если таковой имеется, идентифицирующий это изображение.
snapshots[]. mime_type string MIME-тип данных изображения (например, «image/jpeg»).
snapshots[]. data bytes Данные изображения закодированы в базе данных base64.
snapshots[]. width integer Ширина скриншота в пикселях.
snapshots[]. height integer Высота скриншота в пикселях.
snapshots[]. page_rect object
snapshots[].page_rect. left integer
snapshots[].page_rect. top integer
snapshots[].page_rect. width integer
snapshots[].page_rect. height integer
loadingExperience.metrics.(key). category string

Приемлемые значения:
  • " AVERAGE "
  • " FAST "
  • " NONE "
  • " SLOW "
loadingExperience. overall_category string

Приемлемые значения:
  • " AVERAGE "
  • " FAST "
  • " NONE "
  • " SLOW "
loadingExperience. initial_url string

Попробуйте!

Используйте API-интерфейс ниже, чтобы вызвать этот метод для реальных данных и просмотреть ответ.