Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / a527de24cda7c7d62a371203158fd5f617a1c08c / . / docs / dyn / searchconsole_v1.urlTestingTools.mobileFriendlyTest.html
blob: e1ccd9c5d599aab24ac3aa7dc22c02ff31b56af2 [file] [log] [blame]
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]75<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>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]78 <code><a href="#run">run(body=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]79<p class="firstline">Runs Mobile-Friendly Test for a given URL.</p>
80<h3>Method Details</h3>
81<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]82 <code class="details" id="run">run(body=None, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]83 <pre>Runs Mobile-Friendly Test for a given URL.
84
85Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]86 body: object, The request body.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]87 The object takes the form of:
88
89{ # Mobile-friendly test request.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]90 &quot;url&quot;: &quot;A String&quot;, # URL for inspection.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]91 &quot;requestScreenshot&quot;: True or False, # Whether or not screenshot is requested. Default is false.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]92 }
93
94 x__xgafv: string, V1 error format.
95 Allowed values
96 1 - v1 error format
97 2 - v2 error format
98
99Returns:
100 An object of the form:
101
102 { # Mobile-friendly test response, including mobile-friendly issues and resource
103 # issues.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]104 &quot;resourceIssues&quot;: [ # Information about embedded resources issues.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]105 { # Information about a resource with issue.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]106 &quot;blockedResource&quot;: { # Blocked resource. # Describes a blocked resource issue.
107 &quot;url&quot;: &quot;A String&quot;, # URL of the blocked resource.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]108 },
109 },
110 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]111 &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.
112 &quot;details&quot;: &quot;A String&quot;, # Error details if applicable.
113 &quot;status&quot;: &quot;A String&quot;, # Status of the test.
114 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]115 &quot;screenshot&quot;: { # Describe image data. # Screenshot of the requested URL.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]116 &quot;data&quot;: &quot;A String&quot;, # Image data in format determined by the mime type. Currently, the format
117 # will always be &quot;image/png&quot;, but this might change in the future.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]118 &quot;mimeType&quot;: &quot;A String&quot;, # The mime-type of the image data.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]119 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]120 &quot;mobileFriendliness&quot;: &quot;A String&quot;, # Test verdict, whether the page is mobile friendly or not.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]121 &quot;mobileFriendlyIssues&quot;: [ # List of mobile-usability issues.
122 { # Mobile-friendly issue.
123 &quot;rule&quot;: &quot;A String&quot;, # Rule violated.
124 },
125 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]126 }</pre>
127</div>
128
129</body></html>