• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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
75<h1><a href="searchconsole_v1.html">Google Search Console URL Testing Tools API</a> . <a href="searchconsole_v1.urlTestingTools.html">urlTestingTools</a> . <a href="searchconsole_v1.urlTestingTools.mobileFriendlyTest.html">mobileFriendlyTest</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#run">run(body, x__xgafv=None)</a></code></p>
79<p class="firstline">Runs Mobile-Friendly Test for a given URL.</p>
80<h3>Method Details</h3>
81<div class="method">
82    <code class="details" id="run">run(body, x__xgafv=None)</code>
83  <pre>Runs Mobile-Friendly Test for a given URL.
84
85Args:
86  body: object, The request body. (required)
87    The object takes the form of:
88
89{ # Mobile-friendly test request.
90    "url": "A String", # URL for inspection.
91    "requestScreenshot": True or False, # Whether or not screenshot is requested. Default is false.
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.
104    "testStatus": { # Final state of the test, including error details if necessary. # Final state of the test, can be either complete or an error.
105      "status": "A String", # Status of the test.
106      "details": "A String", # Error details if applicable.
107    },
108    "resourceIssues": [ # Information about embedded resources issues.
109      { # Information about a resource with issue.
110        "blockedResource": { # Blocked resource. # Describes a blocked resource issue.
111          "url": "A String", # URL of the blocked resource.
112        },
113      },
114    ],
115    "mobileFriendliness": "A String", # Test verdict, whether the page is mobile friendly or not.
116    "screenshot": { # Describe image data. # Screenshot of the requested URL.
117      "mimeType": "A String", # The mime-type of the image data.
118      "data": "A String", # Image data in format determined by the mime type. Currently, the format
119          # will always be "image/png", but this might change in the future.
120    },
121    "mobileFriendlyIssues": [ # List of mobile-usability issues.
122      { # Mobile-friendly issue.
123        "rule": "A String", # Rule violated.
124      },
125    ],
126  }</pre>
127</div>
128
129</body></html>