blob: e1ccd9c5d599aab24ac3aa7dc22c02ff31b56af2 [file] [log] [blame]
<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="searchconsole_v1.html">Google Search Console API</a> . <a href="searchconsole_v1.urlTestingTools.html">urlTestingTools</a> . <a href="searchconsole_v1.urlTestingTools.mobileFriendlyTest.html">mobileFriendlyTest</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#run">run(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Runs Mobile-Friendly Test for a given URL.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="run">run(body=None, x__xgafv=None)</code>
<pre>Runs Mobile-Friendly Test for a given URL.
Args:
body: object, The request body.
The object takes the form of:
{ # Mobile-friendly test request.
&quot;url&quot;: &quot;A String&quot;, # URL for inspection.
&quot;requestScreenshot&quot;: True or False, # Whether or not screenshot is requested. Default is false.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Mobile-friendly test response, including mobile-friendly issues and resource
# issues.
&quot;resourceIssues&quot;: [ # Information about embedded resources issues.
{ # Information about a resource with issue.
&quot;blockedResource&quot;: { # Blocked resource. # Describes a blocked resource issue.
&quot;url&quot;: &quot;A String&quot;, # URL of the blocked resource.
},
},
],
&quot;testStatus&quot;: { # Final state of the test, including error details if necessary. # Final state of the test, can be either complete or an error.
&quot;details&quot;: &quot;A String&quot;, # Error details if applicable.
&quot;status&quot;: &quot;A String&quot;, # Status of the test.
},
&quot;screenshot&quot;: { # Describe image data. # Screenshot of the requested URL.
&quot;data&quot;: &quot;A String&quot;, # Image data in format determined by the mime type. Currently, the format
# will always be &quot;image/png&quot;, but this might change in the future.
&quot;mimeType&quot;: &quot;A String&quot;, # The mime-type of the image data.
},
&quot;mobileFriendliness&quot;: &quot;A String&quot;, # Test verdict, whether the page is mobile friendly or not.
&quot;mobileFriendlyIssues&quot;: [ # List of mobile-usability issues.
{ # Mobile-friendly issue.
&quot;rule&quot;: &quot;A String&quot;, # Rule violated.
},
],
}</pre>
</div>
</body></html>