docs/dyn/pagespeedonline_v1.pagespeedapi.html - platform/external/python/google-api-python-client - Gitiles

 <html><body>
 <style>

 body, h1, h2, h3, div, span, p, pre, a {
   margin: 0;
   padding: 0;
   border: 0;
   font-weight: inherit;
   font-style: inherit;
   font-size: 100%;
   font-family: inherit;
   vertical-align: baseline;
 }

 body {
   font-size: 13px;
   padding: 1em;
 }

 h1 {
   font-size: 26px;
   margin-bottom: 1em;
 }

 h2 {
   font-size: 24px;
   margin-bottom: 1em;
 }

 h3 {
   font-size: 20px;
   margin-bottom: 1em;
   margin-top: 1em;
 }

 pre, code {
   line-height: 1.5;
   font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
 }

 pre {
   margin-top: 0.5em;
 }

 h1, h2, h3, p {
   font-family: Arial, sans serif;
 }

 h1, h2, h3 {
   border-bottom: solid #CCC 1px;
 }

 .toc_element {
   margin-top: 0.5em;
 }

 .firstline {
   margin-left: 2 em;
 }

 .method  {
   margin-top: 1em;
   border: solid 1px #CCC;
   padding: 1em;
   background: #EEE;
 }

 .details {
   font-weight: bold;
   font-size: 14px;
 }

 </style>

 <h1><a href="pagespeedonline_v1.html">Page Speed Online API</a> . <a href="pagespeedonline_v1.pagespeedapi.html">pagespeedapi</a></h1>
 <h2>Instance Methods</h2>
 <p class="toc_element">
   <code><a href="#runpagespeed">runpagespeed(url, locale=None, rule=None, strategy=None)</a></code></p>
 <p class="firstline">Runs Page Speed analysis on the page at the specified URL, and returns a Page Speed score, a list of suggestions to make that page faster, and other information.</p>
 <h3>Method Details</h3>
 <div class="method">
     <code class="details" id="runpagespeed">runpagespeed(url, locale=None, rule=None, strategy=None)</code>
   <pre>Runs Page Speed analysis on the page at the specified URL, and returns a Page Speed score, a list of suggestions to make that page faster, and other information.

 Args:
   url: string, The URL to fetch and analyze (required)
   locale: string, The locale used to localize formatted results
   rule: string, A Page Speed rule to run; if none are given, all rules are run (repeated)
   strategy: string, The analysis strategy to use
     Allowed values
       desktop - Fetch and analyze the URL for desktop browsers
       mobile - Fetch and analyze the URL for mobile devices

 Returns:
   An object of the form:

     {
     "kind": "pagespeedonline#result", # Kind of result.
     "formattedResults": { # Localized Page Speed results. Contains a ruleResults entry for each Page Speed rule instantiated and run by the server.
       "locale": "A String", # The locale of the formattedResults, e.g. "en_US".
       "ruleResults": { # Dictionary of formatted rule results, with one entry for each Page Speed rule instantiated and run by the server.
       },
     },
     "title": "A String", # Title of the page, as displayed in the browser's title bar.
     "version": { # The version of the Page Speed SDK used to generate these results.
       "major": 42, # The major version number of the Page Speed SDK used to generate these results.
       "minor": 42, # The minor version number of the Page Speed SDK used to generate these results.
     },
     "score": 42, # The Page Speed Score (0-100), which indicates how much faster a page could be. A high score indicates little room for improvement, while a lower score indicates more room for improvement.
     "responseCode": 42, # Response code for the document. 200 indicates a normal page load. 4xx/5xx indicates an error.
     "invalidRules": [ # List of rules that were specified in the request, but which the server did not know how to instantiate.
       "A String",
     ],
     "pageStats": { # Summary statistics for the page, such as number of JavaScript bytes, number of HTML bytes, etc.
       "otherResponseBytes": "A String", # Number of response bytes for other resources on the page.
       "flashResponseBytes": "A String", # Number of response bytes for flash resources on the page.
       "totalRequestBytes": "A String", # Total size of all request bytes sent by the page.
       "numberCssResources": 42, # Number of CSS resources referenced by the page.
       "numberResources": 42, # Number of HTTP resources loaded by the page.
       "cssResponseBytes": "A String", # Number of uncompressed response bytes for CSS resources on the page.
       "javascriptResponseBytes": "A String", # Number of uncompressed response bytes for JS resources on the page.
       "imageResponseBytes": "A String", # Number of response bytes for image resources on the page.
       "numberHosts": 42, # Number of unique hosts referenced by the page.
       "numberStaticResources": 42, # Number of static (i.e. cacheable) resources on the page.
       "htmlResponseBytes": "A String", # Number of uncompressed response bytes for the main HTML document and all iframes on the page.
       "numberJsResources": 42, # Number of JavaScript resources referenced by the page.
       "textResponseBytes": "A String", # Number of uncompressed response bytes for text resources not covered by other statistics (i.e non-HTML, non-script, non-CSS resources) on the page.
     },
     "id": "A String", # Canonicalized and final URL for the document, after following page redirects (if any).
   }</pre>
 </div>

 </body></html>
	<html><body>
	<style>

	body, h1, h2, h3, div, span, p, pre, a {
	margin: 0;
	padding: 0;
	border: 0;
	font-weight: inherit;
	font-style: inherit;
	font-size: 100%;
	font-family: inherit;
	vertical-align: baseline;
	}

	body {
	font-size: 13px;
	padding: 1em;
	}

	h1 {
	font-size: 26px;
	margin-bottom: 1em;
	}

	h2 {
	font-size: 24px;
	margin-bottom: 1em;
	}

	h3 {
	font-size: 20px;
	margin-bottom: 1em;
	margin-top: 1em;
	}

	pre, code {
	line-height: 1.5;
	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
	}

	pre {
	margin-top: 0.5em;
	}

	h1, h2, h3, p {
	font-family: Arial, sans serif;
	}

	h1, h2, h3 {
	border-bottom: solid #CCC 1px;
	}

	.toc_element {
	margin-top: 0.5em;
	}

	.firstline {
	margin-left: 2 em;
	}

	.method {
	margin-top: 1em;
	border: solid 1px #CCC;
	padding: 1em;
	background: #EEE;
	}

	.details {
	font-weight: bold;
	font-size: 14px;
	}

	</style>

	<h1><a href="pagespeedonline_v1.html">Page Speed Online API</a> . <a href="pagespeedonline_v1.pagespeedapi.html">pagespeedapi</a></h1>
	<h2>Instance Methods</h2>
	<p class="toc_element">
	<code><a href="#runpagespeed">runpagespeed(url, locale=None, rule=None, strategy=None)</a></code></p>
	<p class="firstline">Runs Page Speed analysis on the page at the specified URL, and returns a Page Speed score, a list of suggestions to make that page faster, and other information.</p>
	<h3>Method Details</h3>
	<div class="method">
	<code class="details" id="runpagespeed">runpagespeed(url, locale=None, rule=None, strategy=None)</code>
	<pre>Runs Page Speed analysis on the page at the specified URL, and returns a Page Speed score, a list of suggestions to make that page faster, and other information.

	Args:
	url: string, The URL to fetch and analyze (required)
	locale: string, The locale used to localize formatted results
	rule: string, A Page Speed rule to run; if none are given, all rules are run (repeated)
	strategy: string, The analysis strategy to use
	Allowed values
	desktop - Fetch and analyze the URL for desktop browsers
	mobile - Fetch and analyze the URL for mobile devices

	Returns:
	An object of the form:

	{
	"kind": "pagespeedonline#result", # Kind of result.
	"formattedResults": { # Localized Page Speed results. Contains a ruleResults entry for each Page Speed rule instantiated and run by the server.
	"locale": "A String", # The locale of the formattedResults, e.g. "en_US".
	"ruleResults": { # Dictionary of formatted rule results, with one entry for each Page Speed rule instantiated and run by the server.
	},
	},
	"title": "A String", # Title of the page, as displayed in the browser's title bar.
	"version": { # The version of the Page Speed SDK used to generate these results.
	"major": 42, # The major version number of the Page Speed SDK used to generate these results.
	"minor": 42, # The minor version number of the Page Speed SDK used to generate these results.
	},
	"score": 42, # The Page Speed Score (0-100), which indicates how much faster a page could be. A high score indicates little room for improvement, while a lower score indicates more room for improvement.
	"responseCode": 42, # Response code for the document. 200 indicates a normal page load. 4xx/5xx indicates an error.
	"invalidRules": [ # List of rules that were specified in the request, but which the server did not know how to instantiate.
	"A String",
	],
	"pageStats": { # Summary statistics for the page, such as number of JavaScript bytes, number of HTML bytes, etc.
	"otherResponseBytes": "A String", # Number of response bytes for other resources on the page.
	"flashResponseBytes": "A String", # Number of response bytes for flash resources on the page.
	"totalRequestBytes": "A String", # Total size of all request bytes sent by the page.
	"numberCssResources": 42, # Number of CSS resources referenced by the page.
	"numberResources": 42, # Number of HTTP resources loaded by the page.
	"cssResponseBytes": "A String", # Number of uncompressed response bytes for CSS resources on the page.
	"javascriptResponseBytes": "A String", # Number of uncompressed response bytes for JS resources on the page.
	"imageResponseBytes": "A String", # Number of response bytes for image resources on the page.
	"numberHosts": 42, # Number of unique hosts referenced by the page.
	"numberStaticResources": 42, # Number of static (i.e. cacheable) resources on the page.
	"htmlResponseBytes": "A String", # Number of uncompressed response bytes for the main HTML document and all iframes on the page.
	"numberJsResources": 42, # Number of JavaScript resources referenced by the page.
	"textResponseBytes": "A String", # Number of uncompressed response bytes for text resources not covered by other statistics (i.e non-HTML, non-script, non-CSS resources) on the page.
	},
	"id": "A String", # Canonicalized and final URL for the document, after following page redirects (if any).
	}</pre>
	</div>

	</body></html>