google-apis-searchconsole_v1 0.5.0 → 0.9.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: cb640d39a941a2e9ee81bb2424ecd01ca9566822ae2ba8da52e372a2032d33e3
4
- data.tar.gz: e719e206e01ab01b9486f29e7838a0da8fd53f0a6c097063dbaeff6b885dca54
3
+ metadata.gz: 8eeba9bf11032e1fc00c2f7392b21ebc8b1fddba6d60541c52789bac3fef52f6
4
+ data.tar.gz: 361a845c7a04686f241451f67487d2e53f2542039e8cf1c928157aa88e04e137
5
5
  SHA512:
6
- metadata.gz: 7067c92389dacbc2c853ea8885d1954405f923b59a7d46b1c14414c30617b48f5ddea081dfb3446b35c1b13823f2ceafe58455fd222c3faf719fbcdf291dd09d
7
- data.tar.gz: ee6e4c3819c7248b3406c8e35fbf54b9d7a8db4dc2b569cc9dcf2f9db15916695d2580a8325d47cd5ce6322e91e98ce70d1597f9340d1857a25868b3304acf2f
6
+ metadata.gz: 4dc1e5c2a3dc9ce08c54d44723f45e79f44a7bcb1c9297ff1f55d58cd4dce03101df7d2d4f021e959d7ccbcb48fa52d9cc45d3b7990be5e4d51546e734babc4f
7
+ data.tar.gz: 12c57d5beb285eab3f9dc61808d059a568b11d706065463028bae3072a0a1e757933d2ef479fa6670ab3847e265d7b903006acf4a13cc475e0641fb0b94ab557
data/CHANGELOG.md CHANGED
@@ -1,5 +1,23 @@
1
1
  # Release history for google-apis-searchconsole_v1
2
2
 
3
+ ### v0.9.0 (2022-01-30)
4
+
5
+ * Regenerated from discovery document revision 20220128
6
+ * Regenerated using generator version 0.4.1
7
+
8
+ ### v0.8.0 (2022-01-09)
9
+
10
+ * Regenerated from discovery document revision 20220107
11
+ * Unspecified changes
12
+
13
+ ### v0.7.0 (2021-10-27)
14
+
15
+ * Regenerated from discovery document revision 20211026
16
+
17
+ ### v0.6.0 (2021-09-05)
18
+
19
+ * Regenerated from discovery document revision 20210903
20
+
3
21
  ### v0.5.0 (2021-06-29)
4
22
 
5
23
  * Regenerated using generator version 0.4.0
data/OVERVIEW.md CHANGED
@@ -51,7 +51,7 @@ require "google/apis/searchconsole_v1"
51
51
  client = Google::Apis::SearchconsoleV1::SearchConsoleService.new
52
52
 
53
53
  # Authenticate calls
54
- client.authentication = # ... use the googleauth gem to create credentials
54
+ client.authorization = # ... use the googleauth gem to create credentials
55
55
  ```
56
56
 
57
57
  See the class reference docs for information on the methods you can call from a client.
@@ -60,8 +60,8 @@ See the class reference docs for information on the methods you can call from a
60
60
 
61
61
  More detailed descriptions of the Google simple REST clients are available in two documents.
62
62
 
63
- * The [Usage Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/usage-guide.md) discusses how to make API calls, how to use the provided data structures, and how to work the various features of the client library, including media upload and download, error handling, retries, pagination, and logging.
64
- * The [Auth Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/auth-guide.md) discusses authentication in the client libraries, including API keys, OAuth 2.0, service accounts, and environment variables.
63
+ * The [Usage Guide](https://github.com/googleapis/google-api-ruby-client/blob/main/docs/usage-guide.md) discusses how to make API calls, how to use the provided data structures, and how to work the various features of the client library, including media upload and download, error handling, retries, pagination, and logging.
64
+ * The [Auth Guide](https://github.com/googleapis/google-api-ruby-client/blob/main/docs/auth-guide.md) discusses authentication in the client libraries, including API keys, OAuth 2.0, service accounts, and environment variables.
65
65
 
66
66
  (Note: the above documents are written for the simple REST clients in general, and their examples may not reflect the Searchconsole service in particular.)
67
67
 
@@ -22,6 +22,97 @@ module Google
22
22
  module Apis
23
23
  module SearchconsoleV1
24
24
 
25
+ # AMP inspection result of the live page or the current information from Google'
26
+ # s index, depending on whether you requested a live inspection or not.
27
+ class AmpInspectionResult
28
+ include Google::Apis::Core::Hashable
29
+
30
+ # Index status of the AMP URL.
31
+ # Corresponds to the JSON property `ampIndexStatusVerdict`
32
+ # @return [String]
33
+ attr_accessor :amp_index_status_verdict
34
+
35
+ # URL of the AMP that was inspected. If the submitted URL is a desktop page that
36
+ # refers to an AMP version, the AMP version will be inspected.
37
+ # Corresponds to the JSON property `ampUrl`
38
+ # @return [String]
39
+ attr_accessor :amp_url
40
+
41
+ # Whether or not the page blocks indexing through a noindex rule.
42
+ # Corresponds to the JSON property `indexingState`
43
+ # @return [String]
44
+ attr_accessor :indexing_state
45
+
46
+ # A list of zero or more AMP issues found for the inspected URL.
47
+ # Corresponds to the JSON property `issues`
48
+ # @return [Array<Google::Apis::SearchconsoleV1::AmpIssue>]
49
+ attr_accessor :issues
50
+
51
+ # Last time this AMP version was crawled by Google. Absent if the URL was never
52
+ # crawled successfully.
53
+ # Corresponds to the JSON property `lastCrawlTime`
54
+ # @return [String]
55
+ attr_accessor :last_crawl_time
56
+
57
+ # Whether or not Google could fetch the AMP.
58
+ # Corresponds to the JSON property `pageFetchState`
59
+ # @return [String]
60
+ attr_accessor :page_fetch_state
61
+
62
+ # Whether or not the page is blocked to Google by a robots.txt rule.
63
+ # Corresponds to the JSON property `robotsTxtState`
64
+ # @return [String]
65
+ attr_accessor :robots_txt_state
66
+
67
+ # The status of the most severe error on the page. If a page has both warnings
68
+ # and errors, the page status is error. Error status means the page cannot be
69
+ # shown in Search results.
70
+ # Corresponds to the JSON property `verdict`
71
+ # @return [String]
72
+ attr_accessor :verdict
73
+
74
+ def initialize(**args)
75
+ update!(**args)
76
+ end
77
+
78
+ # Update properties of this object
79
+ def update!(**args)
80
+ @amp_index_status_verdict = args[:amp_index_status_verdict] if args.key?(:amp_index_status_verdict)
81
+ @amp_url = args[:amp_url] if args.key?(:amp_url)
82
+ @indexing_state = args[:indexing_state] if args.key?(:indexing_state)
83
+ @issues = args[:issues] if args.key?(:issues)
84
+ @last_crawl_time = args[:last_crawl_time] if args.key?(:last_crawl_time)
85
+ @page_fetch_state = args[:page_fetch_state] if args.key?(:page_fetch_state)
86
+ @robots_txt_state = args[:robots_txt_state] if args.key?(:robots_txt_state)
87
+ @verdict = args[:verdict] if args.key?(:verdict)
88
+ end
89
+ end
90
+
91
+ # AMP issue.
92
+ class AmpIssue
93
+ include Google::Apis::Core::Hashable
94
+
95
+ # Brief description of this issue.
96
+ # Corresponds to the JSON property `issueMessage`
97
+ # @return [String]
98
+ attr_accessor :issue_message
99
+
100
+ # Severity of this issue: WARNING or ERROR.
101
+ # Corresponds to the JSON property `severity`
102
+ # @return [String]
103
+ attr_accessor :severity
104
+
105
+ def initialize(**args)
106
+ update!(**args)
107
+ end
108
+
109
+ # Update properties of this object
110
+ def update!(**args)
111
+ @issue_message = args[:issue_message] if args.key?(:issue_message)
112
+ @severity = args[:severity] if args.key?(:severity)
113
+ end
114
+ end
115
+
25
116
  #
26
117
  class ApiDataRow
27
118
  include Google::Apis::Core::Hashable
@@ -147,6 +238,31 @@ module Google
147
238
  end
148
239
  end
149
240
 
241
+ # Rich Results items grouped by type.
242
+ class DetectedItems
243
+ include Google::Apis::Core::Hashable
244
+
245
+ # List of Rich Results items.
246
+ # Corresponds to the JSON property `items`
247
+ # @return [Array<Google::Apis::SearchconsoleV1::Item>]
248
+ attr_accessor :items
249
+
250
+ # Rich Results type
251
+ # Corresponds to the JSON property `richResultType`
252
+ # @return [String]
253
+ attr_accessor :rich_result_type
254
+
255
+ def initialize(**args)
256
+ update!(**args)
257
+ end
258
+
259
+ # Update properties of this object
260
+ def update!(**args)
261
+ @items = args[:items] if args.key?(:items)
262
+ @rich_result_type = args[:rich_result_type] if args.key?(:rich_result_type)
263
+ end
264
+ end
265
+
150
266
  # Describe image data.
151
267
  class Image
152
268
  include Google::Apis::Core::Hashable
@@ -174,6 +290,178 @@ module Google
174
290
  end
175
291
  end
176
292
 
293
+ # Results of index status inspection for either the live page or the version in
294
+ # Google's index, depending on whether you requested a live inspection or not.
295
+ # For more information, see the [Index coverage report documentation](https://
296
+ # support.google.com/webmasters/answer/7440203).
297
+ class IndexStatusInspectionResult
298
+ include Google::Apis::Core::Hashable
299
+
300
+ # Could Google find and index the page. More details about page indexing appear
301
+ # in 'indexing_state'.
302
+ # Corresponds to the JSON property `coverageState`
303
+ # @return [String]
304
+ attr_accessor :coverage_state
305
+
306
+ # Primary crawler that was used by Google to crawl your site.
307
+ # Corresponds to the JSON property `crawledAs`
308
+ # @return [String]
309
+ attr_accessor :crawled_as
310
+
311
+ # The URL of the page that Google selected as canonical. If the page was not
312
+ # indexed, this field is absent.
313
+ # Corresponds to the JSON property `googleCanonical`
314
+ # @return [String]
315
+ attr_accessor :google_canonical
316
+
317
+ # Whether or not the page blocks indexing through a noindex rule.
318
+ # Corresponds to the JSON property `indexingState`
319
+ # @return [String]
320
+ attr_accessor :indexing_state
321
+
322
+ # Last time this URL was crawled by Google using the [primary crawler](https://
323
+ # support.google.com/webmasters/answer/7440203#primary_crawler). Absent if the
324
+ # URL was never crawled successfully.
325
+ # Corresponds to the JSON property `lastCrawlTime`
326
+ # @return [String]
327
+ attr_accessor :last_crawl_time
328
+
329
+ # Whether or not Google could retrieve the page from your server. Equivalent to [
330
+ # "page fetch"](https://support.google.com/webmasters/answer/9012289#
331
+ # index_coverage) in the URL inspection report.
332
+ # Corresponds to the JSON property `pageFetchState`
333
+ # @return [String]
334
+ attr_accessor :page_fetch_state
335
+
336
+ # URLs that link to the inspected URL, directly and indirectly.
337
+ # Corresponds to the JSON property `referringUrls`
338
+ # @return [Array<String>]
339
+ attr_accessor :referring_urls
340
+
341
+ # Whether or not the page is blocked to Google by a robots.txt rule.
342
+ # Corresponds to the JSON property `robotsTxtState`
343
+ # @return [String]
344
+ attr_accessor :robots_txt_state
345
+
346
+ # Any sitemaps that this URL was listed in, as known by Google. Not guaranteed
347
+ # to be an exhaustive list, especially if Google did not discover this URL
348
+ # through a sitemap. Absent if no sitemaps were found.
349
+ # Corresponds to the JSON property `sitemap`
350
+ # @return [Array<String>]
351
+ attr_accessor :sitemap
352
+
353
+ # The URL that your page or site [declares as canonical](https://developers.
354
+ # google.com/search/docs/advanced/crawling/consolidate-duplicate-urls?#define-
355
+ # canonical). If you did not declare a canonical URL, this field is absent.
356
+ # Corresponds to the JSON property `userCanonical`
357
+ # @return [String]
358
+ attr_accessor :user_canonical
359
+
360
+ # High level verdict about whether the URL *is* indexed (indexed status), or *
361
+ # can be* indexed (live inspection).
362
+ # Corresponds to the JSON property `verdict`
363
+ # @return [String]
364
+ attr_accessor :verdict
365
+
366
+ def initialize(**args)
367
+ update!(**args)
368
+ end
369
+
370
+ # Update properties of this object
371
+ def update!(**args)
372
+ @coverage_state = args[:coverage_state] if args.key?(:coverage_state)
373
+ @crawled_as = args[:crawled_as] if args.key?(:crawled_as)
374
+ @google_canonical = args[:google_canonical] if args.key?(:google_canonical)
375
+ @indexing_state = args[:indexing_state] if args.key?(:indexing_state)
376
+ @last_crawl_time = args[:last_crawl_time] if args.key?(:last_crawl_time)
377
+ @page_fetch_state = args[:page_fetch_state] if args.key?(:page_fetch_state)
378
+ @referring_urls = args[:referring_urls] if args.key?(:referring_urls)
379
+ @robots_txt_state = args[:robots_txt_state] if args.key?(:robots_txt_state)
380
+ @sitemap = args[:sitemap] if args.key?(:sitemap)
381
+ @user_canonical = args[:user_canonical] if args.key?(:user_canonical)
382
+ @verdict = args[:verdict] if args.key?(:verdict)
383
+ end
384
+ end
385
+
386
+ # Index inspection request.
387
+ class InspectUrlIndexRequest
388
+ include Google::Apis::Core::Hashable
389
+
390
+ # Required. URL to inspect. Must be under the property specified in "site_url".
391
+ # Corresponds to the JSON property `inspectionUrl`
392
+ # @return [String]
393
+ attr_accessor :inspection_url
394
+
395
+ # Optional. An [IETF BCP-47](https://en.wikipedia.org/wiki/IETF_language_tag)
396
+ # language code representing the requested language for translated issue
397
+ # messages, e.g. "en-US", "or "de-CH". Default value is "en-US".
398
+ # Corresponds to the JSON property `languageCode`
399
+ # @return [String]
400
+ attr_accessor :language_code
401
+
402
+ # Required. The URL of the property as defined in Search Console. **Examples:** `
403
+ # http://www.example.com/` for a URL-prefix property, or `sc-domain:example.com`
404
+ # for a Domain property.
405
+ # Corresponds to the JSON property `siteUrl`
406
+ # @return [String]
407
+ attr_accessor :site_url
408
+
409
+ def initialize(**args)
410
+ update!(**args)
411
+ end
412
+
413
+ # Update properties of this object
414
+ def update!(**args)
415
+ @inspection_url = args[:inspection_url] if args.key?(:inspection_url)
416
+ @language_code = args[:language_code] if args.key?(:language_code)
417
+ @site_url = args[:site_url] if args.key?(:site_url)
418
+ end
419
+ end
420
+
421
+ # Index-Status inspection response.
422
+ class InspectUrlIndexResponse
423
+ include Google::Apis::Core::Hashable
424
+
425
+ # URL inspection result, including all inspection results.
426
+ # Corresponds to the JSON property `inspectionResult`
427
+ # @return [Google::Apis::SearchconsoleV1::UrlInspectionResult]
428
+ attr_accessor :inspection_result
429
+
430
+ def initialize(**args)
431
+ update!(**args)
432
+ end
433
+
434
+ # Update properties of this object
435
+ def update!(**args)
436
+ @inspection_result = args[:inspection_result] if args.key?(:inspection_result)
437
+ end
438
+ end
439
+
440
+ # A specific rich result found on the page.
441
+ class Item
442
+ include Google::Apis::Core::Hashable
443
+
444
+ # A list of zero or more rich result issues found for this instance.
445
+ # Corresponds to the JSON property `issues`
446
+ # @return [Array<Google::Apis::SearchconsoleV1::RichResultsIssue>]
447
+ attr_accessor :issues
448
+
449
+ # The user-provided name of this item.
450
+ # Corresponds to the JSON property `name`
451
+ # @return [String]
452
+ attr_accessor :name
453
+
454
+ def initialize(**args)
455
+ update!(**args)
456
+ end
457
+
458
+ # Update properties of this object
459
+ def update!(**args)
460
+ @issues = args[:issues] if args.key?(:issues)
461
+ @name = args[:name] if args.key?(:name)
462
+ end
463
+ end
464
+
177
465
  # Mobile-friendly issue.
178
466
  class MobileFriendlyIssue
179
467
  include Google::Apis::Core::Hashable
@@ -193,6 +481,62 @@ module Google
193
481
  end
194
482
  end
195
483
 
484
+ # Mobile-usability inspection results.
485
+ class MobileUsabilityInspectionResult
486
+ include Google::Apis::Core::Hashable
487
+
488
+ # A list of zero or more mobile-usability issues detected for this URL.
489
+ # Corresponds to the JSON property `issues`
490
+ # @return [Array<Google::Apis::SearchconsoleV1::MobileUsabilityIssue>]
491
+ attr_accessor :issues
492
+
493
+ # High-level mobile-usability inspection result for this URL.
494
+ # Corresponds to the JSON property `verdict`
495
+ # @return [String]
496
+ attr_accessor :verdict
497
+
498
+ def initialize(**args)
499
+ update!(**args)
500
+ end
501
+
502
+ # Update properties of this object
503
+ def update!(**args)
504
+ @issues = args[:issues] if args.key?(:issues)
505
+ @verdict = args[:verdict] if args.key?(:verdict)
506
+ end
507
+ end
508
+
509
+ # Mobile-usability issue.
510
+ class MobileUsabilityIssue
511
+ include Google::Apis::Core::Hashable
512
+
513
+ # Mobile-usability issue type.
514
+ # Corresponds to the JSON property `issueType`
515
+ # @return [String]
516
+ attr_accessor :issue_type
517
+
518
+ # Additional information regarding the issue.
519
+ # Corresponds to the JSON property `message`
520
+ # @return [String]
521
+ attr_accessor :message
522
+
523
+ # Not returned; reserved for future use.
524
+ # Corresponds to the JSON property `severity`
525
+ # @return [String]
526
+ attr_accessor :severity
527
+
528
+ def initialize(**args)
529
+ update!(**args)
530
+ end
531
+
532
+ # Update properties of this object
533
+ def update!(**args)
534
+ @issue_type = args[:issue_type] if args.key?(:issue_type)
535
+ @message = args[:message] if args.key?(:message)
536
+ @severity = args[:severity] if args.key?(:severity)
537
+ end
538
+ end
539
+
196
540
  # Information about a resource with issue.
197
541
  class ResourceIssue
198
542
  include Google::Apis::Core::Hashable
@@ -212,6 +556,59 @@ module Google
212
556
  end
213
557
  end
214
558
 
559
+ # Rich-Results inspection result, including any rich results found at this URL.
560
+ class RichResultsInspectionResult
561
+ include Google::Apis::Core::Hashable
562
+
563
+ # A list of zero or more rich results detected on this page. Rich results that
564
+ # cannot even be parsed due to syntactic issues will not be listed here.
565
+ # Corresponds to the JSON property `detectedItems`
566
+ # @return [Array<Google::Apis::SearchconsoleV1::DetectedItems>]
567
+ attr_accessor :detected_items
568
+
569
+ # High-level rich results inspection result for this URL.
570
+ # Corresponds to the JSON property `verdict`
571
+ # @return [String]
572
+ attr_accessor :verdict
573
+
574
+ def initialize(**args)
575
+ update!(**args)
576
+ end
577
+
578
+ # Update properties of this object
579
+ def update!(**args)
580
+ @detected_items = args[:detected_items] if args.key?(:detected_items)
581
+ @verdict = args[:verdict] if args.key?(:verdict)
582
+ end
583
+ end
584
+
585
+ # Severity and status of a single issue affecting a single rich result instance
586
+ # on a page.
587
+ class RichResultsIssue
588
+ include Google::Apis::Core::Hashable
589
+
590
+ # Rich Results issue type.
591
+ # Corresponds to the JSON property `issueMessage`
592
+ # @return [String]
593
+ attr_accessor :issue_message
594
+
595
+ # Severity of this issue: WARNING, or ERROR. Items with an issue of status ERROR
596
+ # cannot appear with rich result features in Google Search results.
597
+ # Corresponds to the JSON property `severity`
598
+ # @return [String]
599
+ attr_accessor :severity
600
+
601
+ def initialize(**args)
602
+ update!(**args)
603
+ end
604
+
605
+ # Update properties of this object
606
+ def update!(**args)
607
+ @issue_message = args[:issue_message] if args.key?(:issue_message)
608
+ @severity = args[:severity] if args.key?(:severity)
609
+ end
610
+ end
611
+
215
612
  # Mobile-friendly test request.
216
613
  class RunMobileFriendlyTestRequest
217
614
  include Google::Apis::Core::Hashable
@@ -353,6 +750,12 @@ module Google
353
750
  # @return [Fixnum]
354
751
  attr_accessor :start_row
355
752
 
753
+ # Optional. [Optional; Default is \"web\"] Type of report: search type, or
754
+ # either Discover or Gnews.
755
+ # Corresponds to the JSON property `type`
756
+ # @return [String]
757
+ attr_accessor :type
758
+
356
759
  def initialize(**args)
357
760
  update!(**args)
358
761
  end
@@ -368,6 +771,7 @@ module Google
368
771
  @search_type = args[:search_type] if args.key?(:search_type)
369
772
  @start_date = args[:start_date] if args.key?(:start_date)
370
773
  @start_row = args[:start_row] if args.key?(:start_row)
774
+ @type = args[:type] if args.key?(:type)
371
775
  end
372
776
  end
373
777
 
@@ -464,6 +868,53 @@ module Google
464
868
  end
465
869
  end
466
870
 
871
+ # URL inspection result, including all inspection results.
872
+ class UrlInspectionResult
873
+ include Google::Apis::Core::Hashable
874
+
875
+ # AMP inspection result of the live page or the current information from Google'
876
+ # s index, depending on whether you requested a live inspection or not.
877
+ # Corresponds to the JSON property `ampResult`
878
+ # @return [Google::Apis::SearchconsoleV1::AmpInspectionResult]
879
+ attr_accessor :amp_result
880
+
881
+ # Results of index status inspection for either the live page or the version in
882
+ # Google's index, depending on whether you requested a live inspection or not.
883
+ # For more information, see the [Index coverage report documentation](https://
884
+ # support.google.com/webmasters/answer/7440203).
885
+ # Corresponds to the JSON property `indexStatusResult`
886
+ # @return [Google::Apis::SearchconsoleV1::IndexStatusInspectionResult]
887
+ attr_accessor :index_status_result
888
+
889
+ # Link to Search Console URL inspection.
890
+ # Corresponds to the JSON property `inspectionResultLink`
891
+ # @return [String]
892
+ attr_accessor :inspection_result_link
893
+
894
+ # Mobile-usability inspection results.
895
+ # Corresponds to the JSON property `mobileUsabilityResult`
896
+ # @return [Google::Apis::SearchconsoleV1::MobileUsabilityInspectionResult]
897
+ attr_accessor :mobile_usability_result
898
+
899
+ # Rich-Results inspection result, including any rich results found at this URL.
900
+ # Corresponds to the JSON property `richResultsResult`
901
+ # @return [Google::Apis::SearchconsoleV1::RichResultsInspectionResult]
902
+ attr_accessor :rich_results_result
903
+
904
+ def initialize(**args)
905
+ update!(**args)
906
+ end
907
+
908
+ # Update properties of this object
909
+ def update!(**args)
910
+ @amp_result = args[:amp_result] if args.key?(:amp_result)
911
+ @index_status_result = args[:index_status_result] if args.key?(:index_status_result)
912
+ @inspection_result_link = args[:inspection_result_link] if args.key?(:inspection_result_link)
913
+ @mobile_usability_result = args[:mobile_usability_result] if args.key?(:mobile_usability_result)
914
+ @rich_results_result = args[:rich_results_result] if args.key?(:rich_results_result)
915
+ end
916
+ end
917
+
467
918
  # Contains permission level information about a Search Console site. For more
468
919
  # information, see [Permissions in Search Console](https://support.google.com/
469
920
  # webmasters/answer/2451999).
@@ -569,7 +1020,7 @@ module Google
569
1020
  class WmxSitemapContent
570
1021
  include Google::Apis::Core::Hashable
571
1022
 
572
- # The number of URLs from the sitemap that were indexed (of the content type).
1023
+ # *Deprecated; do not use.*
573
1024
  # Corresponds to the JSON property `indexed`
574
1025
  # @return [Fixnum]
575
1026
  attr_accessor :indexed
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module SearchconsoleV1
18
18
  # Version of the google-apis-searchconsole_v1 gem
19
- GEM_VERSION = "0.5.0"
19
+ GEM_VERSION = "0.9.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
- GENERATOR_VERSION = "0.4.0"
22
+ GENERATOR_VERSION = "0.4.1"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20201209"
25
+ REVISION = "20220128"
26
26
  end
27
27
  end
28
28
  end
@@ -22,6 +22,18 @@ module Google
22
22
  module Apis
23
23
  module SearchconsoleV1
24
24
 
25
+ class AmpInspectionResult
26
+ class Representation < Google::Apis::Core::JsonRepresentation; end
27
+
28
+ include Google::Apis::Core::JsonObjectSupport
29
+ end
30
+
31
+ class AmpIssue
32
+ class Representation < Google::Apis::Core::JsonRepresentation; end
33
+
34
+ include Google::Apis::Core::JsonObjectSupport
35
+ end
36
+
25
37
  class ApiDataRow
26
38
  class Representation < Google::Apis::Core::JsonRepresentation; end
27
39
 
@@ -46,24 +58,78 @@ module Google
46
58
  include Google::Apis::Core::JsonObjectSupport
47
59
  end
48
60
 
61
+ class DetectedItems
62
+ class Representation < Google::Apis::Core::JsonRepresentation; end
63
+
64
+ include Google::Apis::Core::JsonObjectSupport
65
+ end
66
+
49
67
  class Image
50
68
  class Representation < Google::Apis::Core::JsonRepresentation; end
51
69
 
52
70
  include Google::Apis::Core::JsonObjectSupport
53
71
  end
54
72
 
73
+ class IndexStatusInspectionResult
74
+ class Representation < Google::Apis::Core::JsonRepresentation; end
75
+
76
+ include Google::Apis::Core::JsonObjectSupport
77
+ end
78
+
79
+ class InspectUrlIndexRequest
80
+ class Representation < Google::Apis::Core::JsonRepresentation; end
81
+
82
+ include Google::Apis::Core::JsonObjectSupport
83
+ end
84
+
85
+ class InspectUrlIndexResponse
86
+ class Representation < Google::Apis::Core::JsonRepresentation; end
87
+
88
+ include Google::Apis::Core::JsonObjectSupport
89
+ end
90
+
91
+ class Item
92
+ class Representation < Google::Apis::Core::JsonRepresentation; end
93
+
94
+ include Google::Apis::Core::JsonObjectSupport
95
+ end
96
+
55
97
  class MobileFriendlyIssue
56
98
  class Representation < Google::Apis::Core::JsonRepresentation; end
57
99
 
58
100
  include Google::Apis::Core::JsonObjectSupport
59
101
  end
60
102
 
103
+ class MobileUsabilityInspectionResult
104
+ class Representation < Google::Apis::Core::JsonRepresentation; end
105
+
106
+ include Google::Apis::Core::JsonObjectSupport
107
+ end
108
+
109
+ class MobileUsabilityIssue
110
+ class Representation < Google::Apis::Core::JsonRepresentation; end
111
+
112
+ include Google::Apis::Core::JsonObjectSupport
113
+ end
114
+
61
115
  class ResourceIssue
62
116
  class Representation < Google::Apis::Core::JsonRepresentation; end
63
117
 
64
118
  include Google::Apis::Core::JsonObjectSupport
65
119
  end
66
120
 
121
+ class RichResultsInspectionResult
122
+ class Representation < Google::Apis::Core::JsonRepresentation; end
123
+
124
+ include Google::Apis::Core::JsonObjectSupport
125
+ end
126
+
127
+ class RichResultsIssue
128
+ class Representation < Google::Apis::Core::JsonRepresentation; end
129
+
130
+ include Google::Apis::Core::JsonObjectSupport
131
+ end
132
+
67
133
  class RunMobileFriendlyTestRequest
68
134
  class Representation < Google::Apis::Core::JsonRepresentation; end
69
135
 
@@ -106,6 +172,12 @@ module Google
106
172
  include Google::Apis::Core::JsonObjectSupport
107
173
  end
108
174
 
175
+ class UrlInspectionResult
176
+ class Representation < Google::Apis::Core::JsonRepresentation; end
177
+
178
+ include Google::Apis::Core::JsonObjectSupport
179
+ end
180
+
109
181
  class WmxSite
110
182
  class Representation < Google::Apis::Core::JsonRepresentation; end
111
183
 
@@ -124,6 +196,29 @@ module Google
124
196
  include Google::Apis::Core::JsonObjectSupport
125
197
  end
126
198
 
199
+ class AmpInspectionResult
200
+ # @private
201
+ class Representation < Google::Apis::Core::JsonRepresentation
202
+ property :amp_index_status_verdict, as: 'ampIndexStatusVerdict'
203
+ property :amp_url, as: 'ampUrl'
204
+ property :indexing_state, as: 'indexingState'
205
+ collection :issues, as: 'issues', class: Google::Apis::SearchconsoleV1::AmpIssue, decorator: Google::Apis::SearchconsoleV1::AmpIssue::Representation
206
+
207
+ property :last_crawl_time, as: 'lastCrawlTime'
208
+ property :page_fetch_state, as: 'pageFetchState'
209
+ property :robots_txt_state, as: 'robotsTxtState'
210
+ property :verdict, as: 'verdict'
211
+ end
212
+ end
213
+
214
+ class AmpIssue
215
+ # @private
216
+ class Representation < Google::Apis::Core::JsonRepresentation
217
+ property :issue_message, as: 'issueMessage'
218
+ property :severity, as: 'severity'
219
+ end
220
+ end
221
+
127
222
  class ApiDataRow
128
223
  # @private
129
224
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -160,6 +255,15 @@ module Google
160
255
  end
161
256
  end
162
257
 
258
+ class DetectedItems
259
+ # @private
260
+ class Representation < Google::Apis::Core::JsonRepresentation
261
+ collection :items, as: 'items', class: Google::Apis::SearchconsoleV1::Item, decorator: Google::Apis::SearchconsoleV1::Item::Representation
262
+
263
+ property :rich_result_type, as: 'richResultType'
264
+ end
265
+ end
266
+
163
267
  class Image
164
268
  # @private
165
269
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -168,6 +272,49 @@ module Google
168
272
  end
169
273
  end
170
274
 
275
+ class IndexStatusInspectionResult
276
+ # @private
277
+ class Representation < Google::Apis::Core::JsonRepresentation
278
+ property :coverage_state, as: 'coverageState'
279
+ property :crawled_as, as: 'crawledAs'
280
+ property :google_canonical, as: 'googleCanonical'
281
+ property :indexing_state, as: 'indexingState'
282
+ property :last_crawl_time, as: 'lastCrawlTime'
283
+ property :page_fetch_state, as: 'pageFetchState'
284
+ collection :referring_urls, as: 'referringUrls'
285
+ property :robots_txt_state, as: 'robotsTxtState'
286
+ collection :sitemap, as: 'sitemap'
287
+ property :user_canonical, as: 'userCanonical'
288
+ property :verdict, as: 'verdict'
289
+ end
290
+ end
291
+
292
+ class InspectUrlIndexRequest
293
+ # @private
294
+ class Representation < Google::Apis::Core::JsonRepresentation
295
+ property :inspection_url, as: 'inspectionUrl'
296
+ property :language_code, as: 'languageCode'
297
+ property :site_url, as: 'siteUrl'
298
+ end
299
+ end
300
+
301
+ class InspectUrlIndexResponse
302
+ # @private
303
+ class Representation < Google::Apis::Core::JsonRepresentation
304
+ property :inspection_result, as: 'inspectionResult', class: Google::Apis::SearchconsoleV1::UrlInspectionResult, decorator: Google::Apis::SearchconsoleV1::UrlInspectionResult::Representation
305
+
306
+ end
307
+ end
308
+
309
+ class Item
310
+ # @private
311
+ class Representation < Google::Apis::Core::JsonRepresentation
312
+ collection :issues, as: 'issues', class: Google::Apis::SearchconsoleV1::RichResultsIssue, decorator: Google::Apis::SearchconsoleV1::RichResultsIssue::Representation
313
+
314
+ property :name, as: 'name'
315
+ end
316
+ end
317
+
171
318
  class MobileFriendlyIssue
172
319
  # @private
173
320
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -175,6 +322,24 @@ module Google
175
322
  end
176
323
  end
177
324
 
325
+ class MobileUsabilityInspectionResult
326
+ # @private
327
+ class Representation < Google::Apis::Core::JsonRepresentation
328
+ collection :issues, as: 'issues', class: Google::Apis::SearchconsoleV1::MobileUsabilityIssue, decorator: Google::Apis::SearchconsoleV1::MobileUsabilityIssue::Representation
329
+
330
+ property :verdict, as: 'verdict'
331
+ end
332
+ end
333
+
334
+ class MobileUsabilityIssue
335
+ # @private
336
+ class Representation < Google::Apis::Core::JsonRepresentation
337
+ property :issue_type, as: 'issueType'
338
+ property :message, as: 'message'
339
+ property :severity, as: 'severity'
340
+ end
341
+ end
342
+
178
343
  class ResourceIssue
179
344
  # @private
180
345
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -183,6 +348,23 @@ module Google
183
348
  end
184
349
  end
185
350
 
351
+ class RichResultsInspectionResult
352
+ # @private
353
+ class Representation < Google::Apis::Core::JsonRepresentation
354
+ collection :detected_items, as: 'detectedItems', class: Google::Apis::SearchconsoleV1::DetectedItems, decorator: Google::Apis::SearchconsoleV1::DetectedItems::Representation
355
+
356
+ property :verdict, as: 'verdict'
357
+ end
358
+ end
359
+
360
+ class RichResultsIssue
361
+ # @private
362
+ class Representation < Google::Apis::Core::JsonRepresentation
363
+ property :issue_message, as: 'issueMessage'
364
+ property :severity, as: 'severity'
365
+ end
366
+ end
367
+
186
368
  class RunMobileFriendlyTestRequest
187
369
  # @private
188
370
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -219,6 +401,7 @@ module Google
219
401
  property :search_type, as: 'searchType'
220
402
  property :start_date, as: 'startDate'
221
403
  property :start_row, as: 'startRow'
404
+ property :type, as: 'type'
222
405
  end
223
406
  end
224
407
 
@@ -255,6 +438,21 @@ module Google
255
438
  end
256
439
  end
257
440
 
441
+ class UrlInspectionResult
442
+ # @private
443
+ class Representation < Google::Apis::Core::JsonRepresentation
444
+ property :amp_result, as: 'ampResult', class: Google::Apis::SearchconsoleV1::AmpInspectionResult, decorator: Google::Apis::SearchconsoleV1::AmpInspectionResult::Representation
445
+
446
+ property :index_status_result, as: 'indexStatusResult', class: Google::Apis::SearchconsoleV1::IndexStatusInspectionResult, decorator: Google::Apis::SearchconsoleV1::IndexStatusInspectionResult::Representation
447
+
448
+ property :inspection_result_link, as: 'inspectionResultLink'
449
+ property :mobile_usability_result, as: 'mobileUsabilityResult', class: Google::Apis::SearchconsoleV1::MobileUsabilityInspectionResult, decorator: Google::Apis::SearchconsoleV1::MobileUsabilityInspectionResult::Representation
450
+
451
+ property :rich_results_result, as: 'richResultsResult', class: Google::Apis::SearchconsoleV1::RichResultsInspectionResult, decorator: Google::Apis::SearchconsoleV1::RichResultsInspectionResult::Representation
452
+
453
+ end
454
+ end
455
+
258
456
  class WmxSite
259
457
  # @private
260
458
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -88,7 +88,8 @@ module Google
88
88
  execute_or_queue_command(command, &block)
89
89
  end
90
90
 
91
- # Deletes a sitemap from this site.
91
+ # Deletes a sitemap from the Sitemaps report. Does not stop Google from crawling
92
+ # this sitemap or the URLs that were previously crawled in the deleted sitemap.
92
93
  # @param [String] site_url
93
94
  # The site's URL, including protocol. For example: `http://www.example.com/`.
94
95
  # @param [String] feedpath
@@ -337,6 +338,36 @@ module Google
337
338
  execute_or_queue_command(command, &block)
338
339
  end
339
340
 
341
+ # Index inspection.
342
+ # @param [Google::Apis::SearchconsoleV1::InspectUrlIndexRequest] inspect_url_index_request_object
343
+ # @param [String] fields
344
+ # Selector specifying which fields to include in a partial response.
345
+ # @param [String] quota_user
346
+ # Available to use for quota purposes for server-side applications. Can be any
347
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
348
+ # @param [Google::Apis::RequestOptions] options
349
+ # Request-specific options
350
+ #
351
+ # @yield [result, err] Result & error if block supplied
352
+ # @yieldparam result [Google::Apis::SearchconsoleV1::InspectUrlIndexResponse] parsed result object
353
+ # @yieldparam err [StandardError] error object if request failed
354
+ #
355
+ # @return [Google::Apis::SearchconsoleV1::InspectUrlIndexResponse]
356
+ #
357
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
358
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
359
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
360
+ def inspect_url_index(inspect_url_index_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
361
+ command = make_simple_command(:post, 'v1/urlInspection/index:inspect', options)
362
+ command.request_representation = Google::Apis::SearchconsoleV1::InspectUrlIndexRequest::Representation
363
+ command.request_object = inspect_url_index_request_object
364
+ command.response_representation = Google::Apis::SearchconsoleV1::InspectUrlIndexResponse::Representation
365
+ command.response_class = Google::Apis::SearchconsoleV1::InspectUrlIndexResponse
366
+ command.query['fields'] = fields unless fields.nil?
367
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
368
+ execute_or_queue_command(command, &block)
369
+ end
370
+
340
371
  # Runs Mobile-Friendly Test for a given URL.
341
372
  # @param [Google::Apis::SearchconsoleV1::RunMobileFriendlyTestRequest] run_mobile_friendly_test_request_object
342
373
  # @param [String] fields
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-searchconsole_v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.5.0
4
+ version: 0.9.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-07-05 00:00:00.000000000 Z
11
+ date: 2022-01-31 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -57,9 +57,9 @@ licenses:
57
57
  - Apache-2.0
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
- changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-searchconsole_v1/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-searchconsole_v1/v0.5.0
62
- source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-searchconsole_v1
60
+ changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-searchconsole_v1/CHANGELOG.md
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-searchconsole_v1/v0.9.0
62
+ source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-searchconsole_v1
63
63
  post_install_message:
64
64
  rdoc_options: []
65
65
  require_paths:
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
75
75
  - !ruby/object:Gem::Version
76
76
  version: '0'
77
77
  requirements: []
78
- rubygems_version: 3.2.17
78
+ rubygems_version: 3.3.5
79
79
  signing_key:
80
80
  specification_version: 4
81
81
  summary: Simple REST client for Google Search Console API V1