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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
|
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module SearchconsoleV1
# Google Search Console API
#
# The Search Console API provides access to both Search Console data (verified
# users only) and to public information on an URL basis (anyone)
#
# @example
# require 'google/apis/searchconsole_v1'
#
# Searchconsole = Google::Apis::SearchconsoleV1 # Alias the module
# service = Searchconsole::SearchConsoleService.new
#
# @see https://developers.google.com/webmaster-tools/search-console-api/
class SearchConsoleService < Google::Apis::Core::BaseService
# @return [String]
# API key. Your API key identifies your project and provides you with API access,
# quota, and reports. Required unless you provide an OAuth 2.0 token.
attr_accessor :key
# @return [String]
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
attr_accessor :quota_user
def initialize
super('https://searchconsole.googleapis.com/', '')
@batch_path = 'batch'
end
# Query your data with filters and parameters that you define. Returns zero or
# more rows grouped by the row keys that you define. You must define a date
# range of one or more days. When date is one of the group by values, any days
# without data are omitted from the result list. If you need to know which days
# have data, issue a broad date range query grouped by date for any metric, and
# see which day rows are returned.
# @param [String] site_url
# The site's URL, including protocol. For example: `http://www.example.com/`.
# @param [Google::Apis::SearchconsoleV1::SearchAnalyticsQueryRequest] search_analytics_query_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::SearchconsoleV1::SearchAnalyticsQueryResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::SearchconsoleV1::SearchAnalyticsQueryResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def query_searchanalytic(site_url, search_analytics_query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'webmasters/v3/sites/{siteUrl}/searchAnalytics/query', options)
command.request_representation = Google::Apis::SearchconsoleV1::SearchAnalyticsQueryRequest::Representation
command.request_object = search_analytics_query_request_object
command.response_representation = Google::Apis::SearchconsoleV1::SearchAnalyticsQueryResponse::Representation
command.response_class = Google::Apis::SearchconsoleV1::SearchAnalyticsQueryResponse
command.params['siteUrl'] = site_url unless site_url.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes a sitemap from this site.
# @param [String] site_url
# The site's URL, including protocol. For example: `http://www.example.com/`.
# @param [String] feedpath
# The URL of the actual sitemap. For example: `http://www.example.com/sitemap.
# xml`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [NilClass] No result returned for this method
# @yieldparam err [StandardError] error object if request failed
#
# @return [void]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_sitemap(site_url, feedpath, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'webmasters/v3/sites/{siteUrl}/sitemaps/{feedpath}', options)
command.params['siteUrl'] = site_url unless site_url.nil?
command.params['feedpath'] = feedpath unless feedpath.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Retrieves information about a specific sitemap.
# @param [String] site_url
# The site's URL, including protocol. For example: `http://www.example.com/`.
# @param [String] feedpath
# The URL of the actual sitemap. For example: `http://www.example.com/sitemap.
# xml`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::SearchconsoleV1::WmxSitemap] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::SearchconsoleV1::WmxSitemap]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_sitemap(site_url, feedpath, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'webmasters/v3/sites/{siteUrl}/sitemaps/{feedpath}', options)
command.response_representation = Google::Apis::SearchconsoleV1::WmxSitemap::Representation
command.response_class = Google::Apis::SearchconsoleV1::WmxSitemap
command.params['siteUrl'] = site_url unless site_url.nil?
command.params['feedpath'] = feedpath unless feedpath.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists the [sitemaps-entries](/webmaster-tools/v3/sitemaps) submitted for this
# site, or included in the sitemap index file (if `sitemapIndex` is specified in
# the request).
# @param [String] site_url
# The site's URL, including protocol. For example: `http://www.example.com/`.
# @param [String] sitemap_index
# A URL of a site's sitemap index. For example: `http://www.example.com/
# sitemapindex.xml`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::SearchconsoleV1::SitemapsListResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::SearchconsoleV1::SitemapsListResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_sitemaps(site_url, sitemap_index: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'webmasters/v3/sites/{siteUrl}/sitemaps', options)
command.response_representation = Google::Apis::SearchconsoleV1::SitemapsListResponse::Representation
command.response_class = Google::Apis::SearchconsoleV1::SitemapsListResponse
command.params['siteUrl'] = site_url unless site_url.nil?
command.query['sitemapIndex'] = sitemap_index unless sitemap_index.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Submits a sitemap for a site.
# @param [String] site_url
# The site's URL, including protocol. For example: `http://www.example.com/`.
# @param [String] feedpath
# The URL of the actual sitemap. For example: `http://www.example.com/sitemap.
# xml`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [NilClass] No result returned for this method
# @yieldparam err [StandardError] error object if request failed
#
# @return [void]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def submit_sitemap(site_url, feedpath, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:put, 'webmasters/v3/sites/{siteUrl}/sitemaps/{feedpath}', options)
command.params['siteUrl'] = site_url unless site_url.nil?
command.params['feedpath'] = feedpath unless feedpath.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Adds a site to the set of the user's sites in Search Console.
# @param [String] site_url
# The URL of the site to add.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [NilClass] No result returned for this method
# @yieldparam err [StandardError] error object if request failed
#
# @return [void]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def add_site(site_url, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:put, 'webmasters/v3/sites/{siteUrl}', options)
command.params['siteUrl'] = site_url unless site_url.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Removes a site from the set of the user's Search Console sites.
# @param [String] site_url
# The URI of the property as defined in Search Console. **Examples:** `http://
# www.example.com/` or `sc-domain:example.com`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [NilClass] No result returned for this method
# @yieldparam err [StandardError] error object if request failed
#
# @return [void]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_site(site_url, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'webmasters/v3/sites/{siteUrl}', options)
command.params['siteUrl'] = site_url unless site_url.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Retrieves information about specific site.
# @param [String] site_url
# The URI of the property as defined in Search Console. **Examples:** `http://
# www.example.com/` or `sc-domain:example.com`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::SearchconsoleV1::WmxSite] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::SearchconsoleV1::WmxSite]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_site(site_url, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'webmasters/v3/sites/{siteUrl}', options)
command.response_representation = Google::Apis::SearchconsoleV1::WmxSite::Representation
command.response_class = Google::Apis::SearchconsoleV1::WmxSite
command.params['siteUrl'] = site_url unless site_url.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists the user's Search Console sites.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::SearchconsoleV1::SitesListResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::SearchconsoleV1::SitesListResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_sites(fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'webmasters/v3/sites', options)
command.response_representation = Google::Apis::SearchconsoleV1::SitesListResponse::Representation
command.response_class = Google::Apis::SearchconsoleV1::SitesListResponse
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Runs Mobile-Friendly Test for a given URL.
# @param [Google::Apis::SearchconsoleV1::RunMobileFriendlyTestRequest] run_mobile_friendly_test_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::SearchconsoleV1::RunMobileFriendlyTestResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::SearchconsoleV1::RunMobileFriendlyTestResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def run_mobile_friendly_test(run_mobile_friendly_test_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/urlTestingTools/mobileFriendlyTest:run', options)
command.request_representation = Google::Apis::SearchconsoleV1::RunMobileFriendlyTestRequest::Representation
command.request_object = run_mobile_friendly_test_request_object
command.response_representation = Google::Apis::SearchconsoleV1::RunMobileFriendlyTestResponse::Representation
command.response_class = Google::Apis::SearchconsoleV1::RunMobileFriendlyTestResponse
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
protected
def apply_command_defaults(command)
command.query['key'] = key unless key.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
end
end
end
end
end
|
