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
136
137
138
139
140
141
142
143
|
<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="webmasters_v3.html">Search Console API</a> . <a href="webmasters_v3.sites.html">sites</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#add">add(siteUrl)</a></code></p>
<p class="firstline">Adds a site to the set of the user's sites in Search Console.</p>
<p class="toc_element">
<code><a href="#delete">delete(siteUrl)</a></code></p>
<p class="firstline">Removes a site from the set of the user's Search Console sites.</p>
<p class="toc_element">
<code><a href="#get">get(siteUrl)</a></code></p>
<p class="firstline">Retrieves information about specific site.</p>
<p class="toc_element">
<code><a href="#list">list()</a></code></p>
<p class="firstline">Lists the user's Search Console sites.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="add">add(siteUrl)</code>
<pre>Adds a site to the set of the user's sites in Search Console.
Args:
siteUrl: string, The URL of the site to add. (required)
</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(siteUrl)</code>
<pre>Removes a site from the set of the user's Search Console sites.
Args:
siteUrl: string, The URI of the property as defined in Search Console. Examples: http://www.example.com/ or android-app://com.example/ (required)
</pre>
</div>
<div class="method">
<code class="details" id="get">get(siteUrl)</code>
<pre>Retrieves information about specific site.
Args:
siteUrl: string, The URI of the property as defined in Search Console. Examples: http://www.example.com/ or android-app://com.example/ (required)
Returns:
An object of the form:
{ # Contains permission level information about a Search Console site. For more information, see Permissions in Search Console.
"permissionLevel": "A String", # The user's permission level for the site.
"siteUrl": "A String", # The URL of the site.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list()</code>
<pre>Lists the user's Search Console sites.
Args:
Returns:
An object of the form:
{ # List of sites with access level information.
"siteEntry": [ # Contains permission level information about a Search Console site. For more information, see Permissions in Search Console.
{ # Contains permission level information about a Search Console site. For more information, see Permissions in Search Console.
"permissionLevel": "A String", # The user's permission level for the site.
"siteUrl": "A String", # The URL of the site.
},
],
}</pre>
</div>
</body></html>
|
