지정된 URL의 페이지에 대해 PageSpeed 분석을 실행하고 PageSpeed 점수, 페이지 속도를 높이기 위한 제안사항 목록 및 기타 정보를 반환합니다.
HTTP 요청
GET https://pagespeedonline.googleapis.com/pagespeedonline/v5/runPagespeed
URL은 gRPC 트랜스코딩 구문을 사용합니다.
쿼리 매개변수
매개변수 | |
---|---|
category |
실행할 Lighthouse 카테고리 카테고리를 지정하지 않으면 실적 카테고리만 실행됩니다. |
locale |
형식이 지정된 결과를 현지화하는 데 사용되는 언어 |
strategy |
사용할 분석 전략 (데스크톱 또는 모바일)이며 데스크톱이 기본값입니다. |
url |
필수 항목입니다. 가져오고 분석할 URL입니다. |
utm_campaign |
분석을 위한 캠페인 이름입니다. |
utm_source |
분석을 위한 캠페인 소스입니다. |
captchaToken |
보안문자를 입력할 때 전달된 보안문자 토큰입니다. |
요청 본문
요청 본문은 비어 있어야 합니다.
응답 본문
성공할 경우 응답 본문에 다음 구조의 데이터가 포함됩니다.
Pagespeed API 응답 객체입니다.
JSON 표현 | |
---|---|
{ "kind": string, "captchaResult": string, "id": string, "loadingExperience": { object ( |
필드 | |
---|---|
kind |
결과의 종류입니다. |
captchaResult |
보안문자 확인 결과 |
id |
다음 페이지 리디렉션 후 (있는 경우) 문서의 표준화된 최종 URL입니다. |
loadingExperience |
최종 사용자의 페이지 로드 환경입니다. |
originLoadingExperience |
출처의 집계된 페이지 로드 경험의 측정항목 |
analysisUTCTimestamp |
이 분석의 UTC 타임스탬프입니다. |
lighthouseResult |
감사 URL에 대한 Lighthouse 응답입니다. |
version |
검색 결과를 생성하는 데 사용된 PageSpeed 버전입니다. |
승인 범위
다음 OAuth 범위가 필요합니다.
openid
자세한 내용은 OAuth 2.0 개요를 참고하세요.
카테고리
분석해야 하는 열거형 카테고리입니다.
열거형 | |
---|---|
CATEGORY_UNSPECIFIED |
기본 UNDEFINED 카테고리입니다. |
ACCESSIBILITY |
접근성 (a11y) - 모든 사용자가 액세스할 수 있는 웹사이트의 기능과 관련된 카테고리입니다. |
BEST_PRACTICES |
권장사항, 웹사이트의 웹 권장사항 준수와 관련된 카테고리입니다. |
PERFORMANCE |
실적, 웹사이트 실적과 관련된 카테고리입니다. |
SEO |
검색엔진 최적화 (SEO), 검색엔진에서 웹사이트의 색인을 생성할 수 있는 기능과 관련된 카테고리입니다. |
전략
분석에 사용할 기기 실행 전략입니다.
열거형 | |
---|---|
STRATEGY_UNSPECIFIED |
정의되지 않음. |
DESKTOP |
데스크톱 브라우저의 URL을 가져오고 분석합니다. |
MOBILE |
휴대기기 URL을 가져오고 분석합니다. |
PagespeedApiLoadingExperienceV5
CrUX 데이터 분류가 포함된 CrUX 로드 환경 객체입니다.
JSON 표현 | |
---|---|
{
"id": string,
"metrics": {
string: {
object ( |
필드 | |
---|---|
id |
측정항목이 있는 URL, 패턴 또는 출처입니다. |
metrics |
<metrics, data>의 맵입니다.
|
overall_category |
사람이 읽을 수 있는 속도 '카테고리' 있습니다. |
initial_url |
요청된 URL입니다. 확인된 'id'와 다를 수 있습니다. |
origin_fallback |
결과가 페이지의 출처 대체인 경우 true, 그렇지 않은 경우 false입니다. |
LighthouseResultV5
Lighthouse 결과 객체입니다.
JSON 표현 | |
---|---|
{ "fetchTime": string, "requestedUrl": string, "finalUrl": string, "lighthouseVersion": string, "i18n": { object ( |
필드 | |
---|---|
fetchTime |
이 실행을 가져온 시간입니다. |
requestedUrl |
원래 요청된 URL입니다. |
finalUrl |
감사를 거친 확인된 최종 URL입니다. |
lighthouseVersion |
이 LHR을 생성하는 데 사용된 Lighthouse 버전입니다. |
i18n |
LHR을 렌더링하는 데 필요한 국제화 문자열입니다. |
userAgent |
이 LHR을 실행하는 데 사용된 사용자 에이전트입니다. |
audits |
LHR의 감사 지도입니다.
|
categoryGroups |
LHR의 카테고리 그룹 지도입니다.
|
stackPacks[] |
스택 팩 조언 문자열입니다. |
environment |
이 LHR을 만들 때 사용된 환경 설정입니다. |
runWarnings |
LHR의 모든 실행 경고 목록입니다. 항상 |
runtimeError |
최상위 오류 메시지(존재하는 경우)는 이 Lighthouse 결과를 삭제해야 할 정도로 심각한 문제가 있음을 나타냅니다. |
categories |
LHR의 카테고리 지도입니다. |
timing |
이 LHR의 타이밍 정보입니다. |
configSettings |
이 LHR의 구성 설정입니다. |
국제화
LHR - 버전 1의 i18n 데이터가 포함된 메시지입니다.
JSON 표현 | |
---|---|
{
"rendererFormattedStrings": {
object ( |
필드 | |
---|---|
rendererFormattedStrings |
configSettings의 언어로 형식이 지정되는 국제화된 문자열입니다. |
RendererFormattedStrings
렌더러에 사용되는 형식이 지정된 문자열을 포함하는 메시지입니다.
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 |
실적 측정항목 값 아래에 표시되는 면책 조항입니다. |
opportunityResourceColumnLabel |
감사의 예상 페이지 로드 절감 기회에 대한 제목입니다. |
opportunitySavingsColumnLabel |
기회 감사에 따른 예상 페이지 로드 절약에 관한 제목입니다. |
errorMissingAuditInfo |
오류가 발생한 감사 옆에 표시되는 오류 문자열입니다. |
errorLabel |
오류가 발생한 감사 또는 측정항목 옆에 표시되는 라벨입니다. |
warningHeader |
경고의 글머리기호 목록 위에 표시된 라벨입니다. |
auditGroupExpandTooltip |
확장형 V자 아이콘의 도움말 텍스트입니다. |
passedAuditsGroupTitle |
통과한 감사 목록 위에 표시되는 제목입니다. |
notApplicableAuditsGroupTitle |
페이지에 적용되지 않는 감사 목록 위에 표시된 제목 |
manualAuditsGroupTitle |
실행 중 컴퓨터화되지 않은 감사 목록 위에 표시된 제목 |
toplevelWarningsMessage |
앞에 표시된 라벨로, 전체 보고서를 무효화했을 수 있는 중요한 경고입니다. |
scorescaleLabel |
점수 게이지 척도 (0~49, 50~89, 90~100)를 설명하는 라벨입니다. |
crcLongestDurationLabel |
중요한 요청 체인 요약에 표시되는 값의 라벨입니다. |
crcInitialNavigation |
중요한 요청 체인의 초기 요청 라벨입니다. |
lsPerformanceCategoryDescription |
실적 아래에 표시된 면책 조항으로 네트워크가 달라질 수 있음을 설명합니다. |
labDataTitle |
실습 데이터 성과 카테고리의 제목입니다. |
StackPack
스택 팩 정보가 포함된 메시지입니다.
JSON 표현 | |
---|---|
{ "id": string, "title": string, "iconDataURL": string, "descriptions": { string: string, ... } } |
필드 | |
---|---|
id |
스택 팩 ID입니다. |
title |
스택 팩 제목 |
iconDataURL |
스택 팩 아이콘 데이터 URI |
descriptions |
스택 팩 조언 문자열입니다.
|
환경
Lighthouse 실행의 환경 구성이 포함된 메시지입니다.
JSON 표현 | |
---|---|
{ "networkUserAgent": string, "hostUserAgent": string, "benchmarkIndex": number } |
필드 | |
---|---|
networkUserAgent |
네트워크를 통해 전송된 사용자 에이전트 문자열입니다. |
hostUserAgent |
사용된 Chrome 버전의 사용자 에이전트 문자열입니다. |
benchmarkIndex |
대략적인 기기 클래스를 나타내는 벤치마크 색인 번호입니다. |
RuntimeError
런타임 오류 구성이 포함된 메시지입니다.
JSON 표현 | |
---|---|
{ "code": string, "message": string } |
필드 | |
---|---|
code |
열거된 Lighthouse 오류 코드입니다. |
message |
사람이 읽을 수 있는 오류 코드를 설명하는 메시지입니다. |
카테고리
Lighthouse 실행의 카테고리입니다.
JSON 표현 | |
---|---|
{ "accessibility": { object ( |
필드 | |
---|---|
accessibility |
모든 접근성 관련 감사가 포함된 접근성 카테고리입니다. |
best-practices |
모든 권장사항 관련 감사가 포함된 권장사항 카테고리입니다. |
seo |
모든 검색엔진 최적화(SEO) 관련 감사가 포함된 검색엔진 최적화(SEO) 카테고리입니다. |
performance |
모든 성능 관련 감사가 포함된 성능 카테고리입니다. |
LighthouseCategoryV5
Lighthouse 카테고리입니다.
JSON 표현 | |
---|---|
{
"id": string,
"title": string,
"description": string,
"manualDescription": string,
"auditRefs": [
{
object ( |
필드 | |
---|---|
id |
카테고리의 문자열 식별자입니다. |
title |
사람이 읽을 수 있는 카테고리 이름입니다. |
description |
카테고리 및 중요도에 대한 자세한 설명 |
manualDescription |
카테고리의 수동 감사에 대한 설명입니다. |
auditRefs[] |
이 카테고리의 모든 감사 구성원에 대한 참조의 배열입니다. |
score |
카테고리의 전체 점수, 모든 감사에 대한 가중 평균입니다. (카테고리 점수이며 null일 수 있습니다.) |
AuditRefs
ID별 감사에 대한 간단한 참조로, 특정 카테고리에서 감사를 그룹화하고 가중치를 부여하는 데 사용됩니다.
JSON 표현 | |
---|---|
{ "id": string, "weight": number, "group": string } |
필드 | |
---|---|
id |
감사 참조 ID입니다. |
weight |
전체 카테고리 점수에서 이 감사의 점수가 갖는 가중치입니다. |
group |
감사가 속한 카테고리 그룹입니다 (선택사항). |
타이밍
Lighthouse 실행의 성능 타이밍 데이터가 포함된 메시지입니다.
JSON 표현 | |
---|---|
{ "total": number } |
필드 | |
---|---|
total |
Lighthouse의 총 실행 시간입니다. |
ConfigSettings
Lighthouse 실행의 구성 설정이 포함된 메시지입니다.
JSON 표현 | |
---|---|
{ "onlyCategories": value, "emulatedFormFactor": string, "locale": string, "channel": string, "formFactor": string } |
필드 | |
---|---|
onlyCategories |
실행에서 수행해야 하는 감사 카테고리 목록입니다. |
emulatedFormFactor |
에뮬레이션에서 사용해야 하는 폼 팩터입니다. 이 필드는 지원 중단되었으므로 폼 팩터를 대신 사용해야 합니다. |
locale |
언어 설정입니다. |
channel |
Lighthouse가 실행된 방식(예: npm 모듈로부터 가져올 수 있습니다. |
formFactor |
Lighthouse가 성능 측정항목의 점수 산정과 데스크톱에서 모바일 전용 테스트를 건너뛰는 것과 관련하여 이 실행을 해석하는 방법. |
PagespeedVersion
Pagespeed 버전 객체입니다.
JSON 표현 | |
---|---|
{ "major": string, "minor": string } |
필드 | |
---|---|
major |
결과를 생성하는 데 사용된 PageSpeed의 주 버전 번호입니다. |
minor |
결과를 생성하는 데 사용된 PageSpeed의 마이너 버전 번호입니다. |