Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / cc94ec86e652769e9d3d5cb6d6491efb8d76dd21 / . / docs / dyn / webmasters_v3.sites.html
blob: 24981921ac07ad2610ab29b68f1ce08908f63f80 [file] [log] [blame]
Craig Citro0e5b9bf2014-10-15 10:26:14 -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
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]75<h1><a href="webmasters_v3.html">Search Console API</a> . <a href="webmasters_v3.sites.html">sites</a></h1>
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#add">add(siteUrl)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]79<p class="firstline">Adds a site to the set of the user's sites in Search Console.</p>
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]80<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]81 <code><a href="#close">close()</a></code></p>
82<p class="firstline">Close httplib2 connections.</p>
83<p class="toc_element">
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]84 <code><a href="#delete">delete(siteUrl)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]85<p class="firstline">Removes a site from the set of the user's Search Console sites.</p>
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]86<p class="toc_element">
87 <code><a href="#get">get(siteUrl)</a></code></p>
88<p class="firstline">Retrieves information about specific site.</p>
89<p class="toc_element">
90 <code><a href="#list">list()</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]91<p class="firstline">Lists the user's Search Console sites.</p>
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]92<h3>Method Details</h3>
93<div class="method">
94 <code class="details" id="add">add(siteUrl)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]95 <pre>Adds a site to the set of the user&#x27;s sites in Search Console.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]96
97Args:
98 siteUrl: string, The URL of the site to add. (required)
99</pre>
100</div>
101
102<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]103 <code class="details" id="close">close()</code>
104 <pre>Close httplib2 connections.</pre>
105</div>
106
107<div class="method">
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]108 <code class="details" id="delete">delete(siteUrl)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]109 <pre>Removes a site from the set of the user&#x27;s Search Console sites.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]110
111Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]112 siteUrl: string, The URI of the property as defined in Search Console. Examples: http://www.example.com/ or android-app://com.example/ Note: for property-sets, use the URI that starts with sc-set: which is used in Search Console URLs. (required)
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]113</pre>
114</div>
115
116<div class="method">
117 <code class="details" id="get">get(siteUrl)</code>
118 <pre>Retrieves information about specific site.
119
120Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]121 siteUrl: string, The URI of the property as defined in Search Console. Examples: http://www.example.com/ or android-app://com.example/ Note: for property-sets, use the URI that starts with sc-set: which is used in Search Console URLs. (required)
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]122
123Returns:
124 An object of the form:
125
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]126 { # Contains permission level information about a Search Console site. For more information, see Permissions in Search Console.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]127 &quot;permissionLevel&quot;: &quot;A String&quot;, # The user&#x27;s permission level for the site.
128 &quot;siteUrl&quot;: &quot;A String&quot;, # The URL of the site.
129}</pre>
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]130</div>
131
132<div class="method">
133 <code class="details" id="list">list()</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]134 <pre>Lists the user&#x27;s Search Console sites.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]135
136Args:
137
138Returns:
139 An object of the form:
140
141 { # List of sites with access level information.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]142 &quot;siteEntry&quot;: [ # Contains permission level information about a Search Console site. For more information, see Permissions in Search Console.
143 { # Contains permission level information about a Search Console site. For more information, see Permissions in Search Console.
144 &quot;permissionLevel&quot;: &quot;A String&quot;, # The user&#x27;s permission level for the site.
145 &quot;siteUrl&quot;: &quot;A String&quot;, # The URL of the site.
146 },
147 ],
148}</pre>
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]149</div>
150
151</body></html>