Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 8045c4550a7f366dd071a6ffb27dba362e59bf95 / . / docs / dyn / searchconsole_v1.sites.html
blob: 59a7e47528e7feb288ce704fbab50128a53e3a8c [file] [log] [blame]
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[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
75<h1><a href="searchconsole_v1.html">Google Search Console API</a> . <a href="searchconsole_v1.sites.html">sites</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#add">add(siteUrl, x__xgafv=None)</a></code></p>
79<p class="firstline"> Adds a site to the set of the user's sites in Search Console.</p>
80<p class="toc_element">
81 <code><a href="#close">close()</a></code></p>
82<p class="firstline">Close httplib2 connections.</p>
83<p class="toc_element">
84 <code><a href="#delete">delete(siteUrl, x__xgafv=None)</a></code></p>
85<p class="firstline"> Removes a site from the set of the user's Search Console sites.</p>
86<p class="toc_element">
87 <code><a href="#get">get(siteUrl, x__xgafv=None)</a></code></p>
88<p class="firstline"> Retrieves information about specific site.</p>
89<p class="toc_element">
90 <code><a href="#list">list(x__xgafv=None)</a></code></p>
91<p class="firstline"> Lists the user's Search Console sites.</p>
92<h3>Method Details</h3>
93<div class="method">
94 <code class="details" id="add">add(siteUrl, x__xgafv=None)</code>
95 <pre> Adds a site to the set of the user&#x27;s sites in Search Console.
96
97Args:
98 siteUrl: string, The URL of the site to add. (required)
99 x__xgafv: string, V1 error format.
100 Allowed values
101 1 - v1 error format
102 2 - v2 error format
103</pre>
104</div>
105
106<div class="method">
107 <code class="details" id="close">close()</code>
108 <pre>Close httplib2 connections.</pre>
109</div>
110
111<div class="method">
112 <code class="details" id="delete">delete(siteUrl, x__xgafv=None)</code>
113 <pre> Removes a site from the set of the user&#x27;s Search Console sites.
114
115Args:
116 siteUrl: string, The URI of the property as defined in Search Console. **Examples:** `http://www.example.com/` or `sc-domain:example.com`. (required)
117 x__xgafv: string, V1 error format.
118 Allowed values
119 1 - v1 error format
120 2 - v2 error format
121</pre>
122</div>
123
124<div class="method">
125 <code class="details" id="get">get(siteUrl, x__xgafv=None)</code>
126 <pre> Retrieves information about specific site.
127
128Args:
129 siteUrl: string, The URI of the property as defined in Search Console. **Examples:** `http://www.example.com/` or `sc-domain:example.com`. (required)
130 x__xgafv: string, V1 error format.
131 Allowed values
132 1 - v1 error format
133 2 - v2 error format
134
135Returns:
136 An object of the form:
137
138 { # Contains permission level information about a Search Console site. For more information, see [Permissions in Search Console](https://support.google.com/webmasters/answer/2451999).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]139 &quot;permissionLevel&quot;: &quot;A String&quot;, # The user&#x27;s permission level for the site.
140 &quot;siteUrl&quot;: &quot;A String&quot;, # The URL of the site.
141}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]142</div>
143
144<div class="method">
145 <code class="details" id="list">list(x__xgafv=None)</code>
146 <pre> Lists the user&#x27;s Search Console sites.
147
148Args:
149 x__xgafv: string, V1 error format.
150 Allowed values
151 1 - v1 error format
152 2 - v2 error format
153
154Returns:
155 An object of the form:
156
157 { # List of sites with access level information.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]158 &quot;siteEntry&quot;: [ # Contains permission level information about a Search Console site. For more information, see [Permissions in Search Console](https://support.google.com/webmasters/answer/2451999).
159 { # Contains permission level information about a Search Console site. For more information, see [Permissions in Search Console](https://support.google.com/webmasters/answer/2451999).
160 &quot;permissionLevel&quot;: &quot;A String&quot;, # The user&#x27;s permission level for the site.
161 &quot;siteUrl&quot;: &quot;A String&quot;, # The URL of the site.
162 },
163 ],
164}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]165</div>
166
167</body></html>