File: searchconsole_v1.urlTestingTools.mobileFriendlyTest.html

package info (click to toggle)
python-googleapi 2.182.0-1
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 533,852 kB
  • sloc: python: 11,076; javascript: 249; sh: 114; makefile: 59
file content (135 lines) | stat: -rw-r--r-- 3,612 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
<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="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<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="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<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;requestScreenshot&quot;: True or False, # Whether or not screenshot is requested. Default is false.
  &quot;url&quot;: &quot;A String&quot;, # URL for inspection.
}

  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;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.
    },
  ],
  &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;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;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.
  },
}</pre>
</div>

</body></html>