-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
searchconsole-gen.go
3109 lines (2782 loc) · 113 KB
/
searchconsole-gen.go
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
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright 2022 Google LLC.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
// Code generated file. DO NOT EDIT.
// Package searchconsole provides access to the Google Search Console API.
//
// For product documentation, see: https://developers.google.com/webmaster-tools/search-console-api/
//
// # Creating a client
//
// Usage example:
//
// import "google.golang.org/api/searchconsole/v1"
// ...
// ctx := context.Background()
// searchconsoleService, err := searchconsole.NewService(ctx)
//
// In this example, Google Application Default Credentials are used for authentication.
//
// For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.
//
// # Other authentication options
//
// By default, all available scopes (see "Constants") are used to authenticate. To restrict scopes, use option.WithScopes:
//
// searchconsoleService, err := searchconsole.NewService(ctx, option.WithScopes(searchconsole.WebmastersReadonlyScope))
//
// To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey:
//
// searchconsoleService, err := searchconsole.NewService(ctx, option.WithAPIKey("AIza..."))
//
// To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow), use option.WithTokenSource:
//
// config := &oauth2.Config{...}
// // ...
// token, err := config.Exchange(ctx, ...)
// searchconsoleService, err := searchconsole.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))
//
// See https://godoc.org/google.golang.org/api/option/ for details on options.
package searchconsole // import "google.golang.org/api/searchconsole/v1"
import (
"bytes"
"context"
"encoding/json"
"errors"
"fmt"
"io"
"net/http"
"net/url"
"strconv"
"strings"
googleapi "google.golang.org/api/googleapi"
internal "google.golang.org/api/internal"
gensupport "google.golang.org/api/internal/gensupport"
option "google.golang.org/api/option"
internaloption "google.golang.org/api/option/internaloption"
htransport "google.golang.org/api/transport/http"
)
// Always reference these packages, just in case the auto-generated code
// below doesn't.
var _ = bytes.NewBuffer
var _ = strconv.Itoa
var _ = fmt.Sprintf
var _ = json.NewDecoder
var _ = io.Copy
var _ = url.Parse
var _ = gensupport.MarshalJSON
var _ = googleapi.Version
var _ = errors.New
var _ = strings.Replace
var _ = context.Canceled
var _ = internaloption.WithDefaultEndpoint
const apiId = "searchconsole:v1"
const apiName = "searchconsole"
const apiVersion = "v1"
const basePath = "https://searchconsole.googleapis.com/"
const mtlsBasePath = "https://searchconsole.mtls.googleapis.com/"
// OAuth2 scopes used by this API.
const (
// View and manage Search Console data for your verified sites
WebmastersScope = "https://www.googleapis.com/auth/webmasters"
// View Search Console data for your verified sites
WebmastersReadonlyScope = "https://www.googleapis.com/auth/webmasters.readonly"
)
// NewService creates a new Service.
func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error) {
scopesOption := internaloption.WithDefaultScopes(
"https://www.googleapis.com/auth/webmasters",
"https://www.googleapis.com/auth/webmasters.readonly",
)
// NOTE: prepend, so we don't override user-specified scopes.
opts = append([]option.ClientOption{scopesOption}, opts...)
opts = append(opts, internaloption.WithDefaultEndpoint(basePath))
opts = append(opts, internaloption.WithDefaultMTLSEndpoint(mtlsBasePath))
client, endpoint, err := htransport.NewClient(ctx, opts...)
if err != nil {
return nil, err
}
s, err := New(client)
if err != nil {
return nil, err
}
if endpoint != "" {
s.BasePath = endpoint
}
return s, nil
}
// New creates a new Service. It uses the provided http.Client for requests.
//
// Deprecated: please use NewService instead.
// To provide a custom HTTP client, use option.WithHTTPClient.
// If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.
func New(client *http.Client) (*Service, error) {
if client == nil {
return nil, errors.New("client is nil")
}
s := &Service{client: client, BasePath: basePath}
s.Searchanalytics = NewSearchanalyticsService(s)
s.Sitemaps = NewSitemapsService(s)
s.Sites = NewSitesService(s)
s.UrlInspection = NewUrlInspectionService(s)
s.UrlTestingTools = NewUrlTestingToolsService(s)
return s, nil
}
type Service struct {
client *http.Client
BasePath string // API endpoint base URL
UserAgent string // optional additional User-Agent fragment
Searchanalytics *SearchanalyticsService
Sitemaps *SitemapsService
Sites *SitesService
UrlInspection *UrlInspectionService
UrlTestingTools *UrlTestingToolsService
}
func (s *Service) userAgent() string {
if s.UserAgent == "" {
return googleapi.UserAgent
}
return googleapi.UserAgent + " " + s.UserAgent
}
func NewSearchanalyticsService(s *Service) *SearchanalyticsService {
rs := &SearchanalyticsService{s: s}
return rs
}
type SearchanalyticsService struct {
s *Service
}
func NewSitemapsService(s *Service) *SitemapsService {
rs := &SitemapsService{s: s}
return rs
}
type SitemapsService struct {
s *Service
}
func NewSitesService(s *Service) *SitesService {
rs := &SitesService{s: s}
return rs
}
type SitesService struct {
s *Service
}
func NewUrlInspectionService(s *Service) *UrlInspectionService {
rs := &UrlInspectionService{s: s}
rs.Index = NewUrlInspectionIndexService(s)
return rs
}
type UrlInspectionService struct {
s *Service
Index *UrlInspectionIndexService
}
func NewUrlInspectionIndexService(s *Service) *UrlInspectionIndexService {
rs := &UrlInspectionIndexService{s: s}
return rs
}
type UrlInspectionIndexService struct {
s *Service
}
func NewUrlTestingToolsService(s *Service) *UrlTestingToolsService {
rs := &UrlTestingToolsService{s: s}
rs.MobileFriendlyTest = NewUrlTestingToolsMobileFriendlyTestService(s)
return rs
}
type UrlTestingToolsService struct {
s *Service
MobileFriendlyTest *UrlTestingToolsMobileFriendlyTestService
}
func NewUrlTestingToolsMobileFriendlyTestService(s *Service) *UrlTestingToolsMobileFriendlyTestService {
rs := &UrlTestingToolsMobileFriendlyTestService{s: s}
return rs
}
type UrlTestingToolsMobileFriendlyTestService struct {
s *Service
}
// AmpInspectionResult: AMP inspection result of the live page or the
// current information from Google's index, depending on whether you
// requested a live inspection or not.
type AmpInspectionResult struct {
// AmpIndexStatusVerdict: Index status of the AMP URL.
//
// Possible values:
// "VERDICT_UNSPECIFIED" - Unknown verdict.
// "PASS" - Equivalent to "Valid" for the page or item in Search
// Console.
// "PARTIAL" - Equivalent to "Valid with warnings" for the page or
// item in Search Console.
// "FAIL" - Equivalent to "Error" or "Invalid" for the page or item in
// Search Console.
// "NEUTRAL" - Equivalent to "Excluded" for the page or item in Search
// Console.
AmpIndexStatusVerdict string `json:"ampIndexStatusVerdict,omitempty"`
// AmpUrl: URL of the AMP that was inspected. If the submitted URL is a
// desktop page that refers to an AMP version, the AMP version will be
// inspected.
AmpUrl string `json:"ampUrl,omitempty"`
// IndexingState: Whether or not the page blocks indexing through a
// noindex rule.
//
// Possible values:
// "AMP_INDEXING_STATE_UNSPECIFIED" - Unknown indexing status.
// "AMP_INDEXING_ALLOWED" - Indexing allowed.
// "BLOCKED_DUE_TO_NOINDEX" - Indexing not allowed, 'noindex'
// detected.
// "BLOCKED_DUE_TO_EXPIRED_UNAVAILABLE_AFTER" - Indexing not allowed,
// 'unavailable_after' date expired.
IndexingState string `json:"indexingState,omitempty"`
// Issues: A list of zero or more AMP issues found for the inspected
// URL.
Issues []*AmpIssue `json:"issues,omitempty"`
// LastCrawlTime: Last time this AMP version was crawled by Google.
// Absent if the URL was never crawled successfully.
LastCrawlTime string `json:"lastCrawlTime,omitempty"`
// PageFetchState: Whether or not Google could fetch the AMP.
//
// Possible values:
// "PAGE_FETCH_STATE_UNSPECIFIED" - Unknown fetch state.
// "SUCCESSFUL" - Successful fetch.
// "SOFT_404" - Soft 404.
// "BLOCKED_ROBOTS_TXT" - Blocked by robots.txt.
// "NOT_FOUND" - Not found (404).
// "ACCESS_DENIED" - Blocked due to unauthorized request (401).
// "SERVER_ERROR" - Server error (5xx).
// "REDIRECT_ERROR" - Redirection error.
// "ACCESS_FORBIDDEN" - Blocked due to access forbidden (403).
// "BLOCKED_4XX" - Blocked due to other 4xx issue (not 403, 404).
// "INTERNAL_CRAWL_ERROR" - Internal error.
// "INVALID_URL" - Invalid URL.
PageFetchState string `json:"pageFetchState,omitempty"`
// RobotsTxtState: Whether or not the page is blocked to Google by a
// robots.txt rule.
//
// Possible values:
// "ROBOTS_TXT_STATE_UNSPECIFIED" - Unknown robots.txt state,
// typically because the page wasn't fetched or found, or because
// robots.txt itself couldn't be reached.
// "ALLOWED" - Crawl allowed by robots.txt.
// "DISALLOWED" - Crawl blocked by robots.txt.
RobotsTxtState string `json:"robotsTxtState,omitempty"`
// Verdict: The status of the most severe error on the page. If a page
// has both warnings and errors, the page status is error. Error status
// means the page cannot be shown in Search results.
//
// Possible values:
// "VERDICT_UNSPECIFIED" - Unknown verdict.
// "PASS" - Equivalent to "Valid" for the page or item in Search
// Console.
// "PARTIAL" - Equivalent to "Valid with warnings" for the page or
// item in Search Console.
// "FAIL" - Equivalent to "Error" or "Invalid" for the page or item in
// Search Console.
// "NEUTRAL" - Equivalent to "Excluded" for the page or item in Search
// Console.
Verdict string `json:"verdict,omitempty"`
// ForceSendFields is a list of field names (e.g.
// "AmpIndexStatusVerdict") to unconditionally include in API requests.
// By default, fields with empty or default values are omitted from API
// requests. However, any non-pointer, non-interface field appearing in
// ForceSendFields will be sent to the server regardless of whether the
// field is empty or not. This may be used to include empty fields in
// Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AmpIndexStatusVerdict") to
// include in API requests with the JSON null value. By default, fields
// with empty values are omitted from API requests. However, any field
// with an empty value appearing in NullFields will be sent to the
// server as null. It is an error if a field in this list has a
// non-empty value. This may be used to include null fields in Patch
// requests.
NullFields []string `json:"-"`
}
func (s *AmpInspectionResult) MarshalJSON() ([]byte, error) {
type NoMethod AmpInspectionResult
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// AmpIssue: AMP issue.
type AmpIssue struct {
// IssueMessage: Brief description of this issue.
IssueMessage string `json:"issueMessage,omitempty"`
// Severity: Severity of this issue: WARNING or ERROR.
//
// Possible values:
// "SEVERITY_UNSPECIFIED" - Unknown severity.
// "WARNING" - Warning.
// "ERROR" - Error.
Severity string `json:"severity,omitempty"`
// ForceSendFields is a list of field names (e.g. "IssueMessage") to
// unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. However, any
// non-pointer, non-interface field appearing in ForceSendFields will be
// sent to the server regardless of whether the field is empty or not.
// This may be used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "IssueMessage") to include
// in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. However, any field with
// an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *AmpIssue) MarshalJSON() ([]byte, error) {
type NoMethod AmpIssue
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
type ApiDataRow struct {
Clicks float64 `json:"clicks,omitempty"`
Ctr float64 `json:"ctr,omitempty"`
Impressions float64 `json:"impressions,omitempty"`
Keys []string `json:"keys,omitempty"`
Position float64 `json:"position,omitempty"`
// ForceSendFields is a list of field names (e.g. "Clicks") to
// unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. However, any
// non-pointer, non-interface field appearing in ForceSendFields will be
// sent to the server regardless of whether the field is empty or not.
// This may be used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Clicks") to include in API
// requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *ApiDataRow) MarshalJSON() ([]byte, error) {
type NoMethod ApiDataRow
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
func (s *ApiDataRow) UnmarshalJSON(data []byte) error {
type NoMethod ApiDataRow
var s1 struct {
Clicks gensupport.JSONFloat64 `json:"clicks"`
Ctr gensupport.JSONFloat64 `json:"ctr"`
Impressions gensupport.JSONFloat64 `json:"impressions"`
Position gensupport.JSONFloat64 `json:"position"`
*NoMethod
}
s1.NoMethod = (*NoMethod)(s)
if err := json.Unmarshal(data, &s1); err != nil {
return err
}
s.Clicks = float64(s1.Clicks)
s.Ctr = float64(s1.Ctr)
s.Impressions = float64(s1.Impressions)
s.Position = float64(s1.Position)
return nil
}
// ApiDimensionFilter: A filter test to be applied to each row in the
// data set, where a match can return the row. Filters are string
// comparisons, and values and dimension names are not case-sensitive.
// Individual filters are either AND'ed or OR'ed within their parent
// filter group, according to the group's group type. You do not need to
// group by a specified dimension to filter against it.
type ApiDimensionFilter struct {
// Possible values:
// "QUERY"
// "PAGE"
// "COUNTRY"
// "DEVICE"
// "SEARCH_APPEARANCE"
Dimension string `json:"dimension,omitempty"`
Expression string `json:"expression,omitempty"`
// Possible values:
// "EQUALS"
// "NOT_EQUALS"
// "CONTAINS"
// "NOT_CONTAINS"
// "INCLUDING_REGEX"
// "EXCLUDING_REGEX"
Operator string `json:"operator,omitempty"`
// ForceSendFields is a list of field names (e.g. "Dimension") to
// unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. However, any
// non-pointer, non-interface field appearing in ForceSendFields will be
// sent to the server regardless of whether the field is empty or not.
// This may be used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Dimension") to include in
// API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *ApiDimensionFilter) MarshalJSON() ([]byte, error) {
type NoMethod ApiDimensionFilter
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// ApiDimensionFilterGroup: A set of dimension value filters to test
// against each row. Only rows that pass all filter groups will be
// returned. All results within a filter group are either AND'ed or
// OR'ed together, depending on the group type selected. All filter
// groups are AND'ed together.
type ApiDimensionFilterGroup struct {
Filters []*ApiDimensionFilter `json:"filters,omitempty"`
// Possible values:
// "AND"
GroupType string `json:"groupType,omitempty"`
// ForceSendFields is a list of field names (e.g. "Filters") to
// unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. However, any
// non-pointer, non-interface field appearing in ForceSendFields will be
// sent to the server regardless of whether the field is empty or not.
// This may be used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Filters") to include in
// API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *ApiDimensionFilterGroup) MarshalJSON() ([]byte, error) {
type NoMethod ApiDimensionFilterGroup
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// BlockedResource: Blocked resource.
type BlockedResource struct {
// Url: URL of the blocked resource.
Url string `json:"url,omitempty"`
// ForceSendFields is a list of field names (e.g. "Url") to
// unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. However, any
// non-pointer, non-interface field appearing in ForceSendFields will be
// sent to the server regardless of whether the field is empty or not.
// This may be used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Url") to include in API
// requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *BlockedResource) MarshalJSON() ([]byte, error) {
type NoMethod BlockedResource
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// DetectedItems: Rich Results items grouped by type.
type DetectedItems struct {
// Items: List of Rich Results items.
Items []*Item `json:"items,omitempty"`
// RichResultType: Rich Results type
RichResultType string `json:"richResultType,omitempty"`
// ForceSendFields is a list of field names (e.g. "Items") to
// unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. However, any
// non-pointer, non-interface field appearing in ForceSendFields will be
// sent to the server regardless of whether the field is empty or not.
// This may be used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Items") to include in API
// requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *DetectedItems) MarshalJSON() ([]byte, error) {
type NoMethod DetectedItems
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Image: Describe image data.
type Image struct {
// Data: Image data in format determined by the mime type. Currently,
// the format will always be "image/png", but this might change in the
// future.
Data string `json:"data,omitempty"`
// MimeType: The mime-type of the image data.
MimeType string `json:"mimeType,omitempty"`
// ForceSendFields is a list of field names (e.g. "Data") to
// unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. However, any
// non-pointer, non-interface field appearing in ForceSendFields will be
// sent to the server regardless of whether the field is empty or not.
// This may be used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Data") to include in API
// requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *Image) MarshalJSON() ([]byte, error) {
type NoMethod Image
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// IndexStatusInspectionResult: Results of index status inspection for
// either the live page or the version in Google's index, depending on
// whether you requested a live inspection or not. For more information,
// see the Index coverage report documentation
// (https://support.google.com/webmasters/answer/7440203).
type IndexStatusInspectionResult struct {
// CoverageState: Could Google find and index the page. More details
// about page indexing appear in 'indexing_state'.
CoverageState string `json:"coverageState,omitempty"`
// CrawledAs: Primary crawler that was used by Google to crawl your
// site.
//
// Possible values:
// "CRAWLING_USER_AGENT_UNSPECIFIED" - Unknown user agent.
// "DESKTOP" - Desktop user agent.
// "MOBILE" - Mobile user agent.
CrawledAs string `json:"crawledAs,omitempty"`
// GoogleCanonical: The URL of the page that Google selected as
// canonical. If the page was not indexed, this field is absent.
GoogleCanonical string `json:"googleCanonical,omitempty"`
// IndexingState: Whether or not the page blocks indexing through a
// noindex rule.
//
// Possible values:
// "INDEXING_STATE_UNSPECIFIED" - Unknown indexing status.
// "INDEXING_ALLOWED" - Indexing allowed.
// "BLOCKED_BY_META_TAG" - Indexing not allowed, 'noindex' detected in
// 'robots' meta tag.
// "BLOCKED_BY_HTTP_HEADER" - Indexing not allowed, 'noindex' detected
// in 'X-Robots-Tag' http header.
// "BLOCKED_BY_ROBOTS_TXT" - Reserved, no longer in use.
IndexingState string `json:"indexingState,omitempty"`
// LastCrawlTime: Last time this URL was crawled by Google using the
// primary crawler
// (https://support.google.com/webmasters/answer/7440203#primary_crawler).
// Absent if the URL was never crawled successfully.
LastCrawlTime string `json:"lastCrawlTime,omitempty"`
// PageFetchState: Whether or not Google could retrieve the page from
// your server. Equivalent to "page fetch"
// (https://support.google.com/webmasters/answer/9012289#index_coverage)
// in the URL inspection report.
//
// Possible values:
// "PAGE_FETCH_STATE_UNSPECIFIED" - Unknown fetch state.
// "SUCCESSFUL" - Successful fetch.
// "SOFT_404" - Soft 404.
// "BLOCKED_ROBOTS_TXT" - Blocked by robots.txt.
// "NOT_FOUND" - Not found (404).
// "ACCESS_DENIED" - Blocked due to unauthorized request (401).
// "SERVER_ERROR" - Server error (5xx).
// "REDIRECT_ERROR" - Redirection error.
// "ACCESS_FORBIDDEN" - Blocked due to access forbidden (403).
// "BLOCKED_4XX" - Blocked due to other 4xx issue (not 403, 404).
// "INTERNAL_CRAWL_ERROR" - Internal error.
// "INVALID_URL" - Invalid URL.
PageFetchState string `json:"pageFetchState,omitempty"`
// ReferringUrls: URLs that link to the inspected URL, directly and
// indirectly.
ReferringUrls []string `json:"referringUrls,omitempty"`
// RobotsTxtState: Whether or not the page is blocked to Google by a
// robots.txt rule.
//
// Possible values:
// "ROBOTS_TXT_STATE_UNSPECIFIED" - Unknown robots.txt state,
// typically because the page wasn't fetched or found, or because
// robots.txt itself couldn't be reached.
// "ALLOWED" - Crawl allowed by robots.txt.
// "DISALLOWED" - Crawl blocked by robots.txt.
RobotsTxtState string `json:"robotsTxtState,omitempty"`
// Sitemap: Any sitemaps that this URL was listed in, as known by
// Google. Not guaranteed to be an exhaustive list, especially if Google
// did not discover this URL through a sitemap. Absent if no sitemaps
// were found.
Sitemap []string `json:"sitemap,omitempty"`
// UserCanonical: The URL that your page or site declares as canonical
// (https://developers.google.com/search/docs/advanced/crawling/consolidate-duplicate-urls?#define-canonical).
// If you did not declare a canonical URL, this field is absent.
UserCanonical string `json:"userCanonical,omitempty"`
// Verdict: High level verdict about whether the URL *is* indexed
// (indexed status), or *can be* indexed (live inspection).
//
// Possible values:
// "VERDICT_UNSPECIFIED" - Unknown verdict.
// "PASS" - Equivalent to "Valid" for the page or item in Search
// Console.
// "PARTIAL" - Equivalent to "Valid with warnings" for the page or
// item in Search Console.
// "FAIL" - Equivalent to "Error" or "Invalid" for the page or item in
// Search Console.
// "NEUTRAL" - Equivalent to "Excluded" for the page or item in Search
// Console.
Verdict string `json:"verdict,omitempty"`
// ForceSendFields is a list of field names (e.g. "CoverageState") to
// unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. However, any
// non-pointer, non-interface field appearing in ForceSendFields will be
// sent to the server regardless of whether the field is empty or not.
// This may be used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "CoverageState") to include
// in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. However, any field with
// an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *IndexStatusInspectionResult) MarshalJSON() ([]byte, error) {
type NoMethod IndexStatusInspectionResult
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// InspectUrlIndexRequest: Index inspection request.
type InspectUrlIndexRequest struct {
// InspectionUrl: Required. URL to inspect. Must be under the property
// specified in "site_url".
InspectionUrl string `json:"inspectionUrl,omitempty"`
// LanguageCode: Optional. An IETF BCP-47
// (https://en.wikipedia.org/wiki/IETF_language_tag) language code
// representing the requested language for translated issue messages,
// e.g. "en-US", "or "de-CH". Default value is "en-US".
LanguageCode string `json:"languageCode,omitempty"`
// SiteUrl: Required. The URL of the property as defined in Search
// Console. **Examples:** `http://www.example.com/` for a URL-prefix
// property, or `sc-domain:example.com` for a Domain property.
SiteUrl string `json:"siteUrl,omitempty"`
// ForceSendFields is a list of field names (e.g. "InspectionUrl") to
// unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. However, any
// non-pointer, non-interface field appearing in ForceSendFields will be
// sent to the server regardless of whether the field is empty or not.
// This may be used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "InspectionUrl") to include
// in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. However, any field with
// an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *InspectUrlIndexRequest) MarshalJSON() ([]byte, error) {
type NoMethod InspectUrlIndexRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// InspectUrlIndexResponse: Index-Status inspection response.
type InspectUrlIndexResponse struct {
// InspectionResult: URL inspection results.
InspectionResult *UrlInspectionResult `json:"inspectionResult,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "InspectionResult") to
// unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. However, any
// non-pointer, non-interface field appearing in ForceSendFields will be
// sent to the server regardless of whether the field is empty or not.
// This may be used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "InspectionResult") to
// include in API requests with the JSON null value. By default, fields
// with empty values are omitted from API requests. However, any field
// with an empty value appearing in NullFields will be sent to the
// server as null. It is an error if a field in this list has a
// non-empty value. This may be used to include null fields in Patch
// requests.
NullFields []string `json:"-"`
}
func (s *InspectUrlIndexResponse) MarshalJSON() ([]byte, error) {
type NoMethod InspectUrlIndexResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Item: A specific rich result found on the page.
type Item struct {
// Issues: A list of zero or more rich result issues found for this
// instance.
Issues []*RichResultsIssue `json:"issues,omitempty"`
// Name: The user-provided name of this item.
Name string `json:"name,omitempty"`
// ForceSendFields is a list of field names (e.g. "Issues") to
// unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. However, any
// non-pointer, non-interface field appearing in ForceSendFields will be
// sent to the server regardless of whether the field is empty or not.
// This may be used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Issues") to include in API
// requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *Item) MarshalJSON() ([]byte, error) {
type NoMethod Item
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// MobileFriendlyIssue: Mobile-friendly issue.
type MobileFriendlyIssue struct {
// Rule: Rule violated.
//
// Possible values:
// "MOBILE_FRIENDLY_RULE_UNSPECIFIED" - Unknown rule. Sorry, we don't
// have any description for the rule that was broken.
// "USES_INCOMPATIBLE_PLUGINS" - Plugins incompatible with mobile
// devices are being used. [Learn more]
// (https://support.google.com/webmasters/answer/6352293#flash_usage).
// "CONFIGURE_VIEWPORT" - Viewport is not specified using the meta
// viewport tag. [Learn more]
// (https://support.google.com/webmasters/answer/6352293#viewport_not_configured).
// "FIXED_WIDTH_VIEWPORT" - Viewport defined to a fixed width. [Learn
// more]
// (https://support.google.com/webmasters/answer/6352293#fixed-width_viewport).
// "SIZE_CONTENT_TO_VIEWPORT" - Content not sized to viewport. [Learn
// more]
// (https://support.google.com/webmasters/answer/6352293#content_not_sized_to_viewport).
// "USE_LEGIBLE_FONT_SIZES" - Font size is too small for easy reading
// on a small screen. [Learn More]
// (https://support.google.com/webmasters/answer/6352293#small_font_size).
// "TAP_TARGETS_TOO_CLOSE" - Touch elements are too close to each
// other. [Learn more]
// (https://support.google.com/webmasters/answer/6352293#touch_elements_too_close).
Rule string `json:"rule,omitempty"`
// ForceSendFields is a list of field names (e.g. "Rule") to
// unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. However, any
// non-pointer, non-interface field appearing in ForceSendFields will be
// sent to the server regardless of whether the field is empty or not.
// This may be used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Rule") to include in API
// requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *MobileFriendlyIssue) MarshalJSON() ([]byte, error) {
type NoMethod MobileFriendlyIssue
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// MobileUsabilityInspectionResult: Mobile-usability inspection results.
type MobileUsabilityInspectionResult struct {
// Issues: A list of zero or more mobile-usability issues detected for
// this URL.
Issues []*MobileUsabilityIssue `json:"issues,omitempty"`
// Verdict: High-level mobile-usability inspection result for this URL.
//
// Possible values:
// "VERDICT_UNSPECIFIED" - Unknown verdict.
// "PASS" - Equivalent to "Valid" for the page or item in Search
// Console.
// "PARTIAL" - Equivalent to "Valid with warnings" for the page or
// item in Search Console.
// "FAIL" - Equivalent to "Error" or "Invalid" for the page or item in
// Search Console.
// "NEUTRAL" - Equivalent to "Excluded" for the page or item in Search
// Console.
Verdict string `json:"verdict,omitempty"`
// ForceSendFields is a list of field names (e.g. "Issues") to
// unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. However, any
// non-pointer, non-interface field appearing in ForceSendFields will be
// sent to the server regardless of whether the field is empty or not.
// This may be used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Issues") to include in API
// requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *MobileUsabilityInspectionResult) MarshalJSON() ([]byte, error) {
type NoMethod MobileUsabilityInspectionResult
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// MobileUsabilityIssue: Mobile-usability issue.
type MobileUsabilityIssue struct {
// IssueType: Mobile-usability issue type.
//
// Possible values:
// "MOBILE_USABILITY_ISSUE_TYPE_UNSPECIFIED" - Unknown issue. Sorry,
// we don't have any description for the rule that was broken.
// "USES_INCOMPATIBLE_PLUGINS" - Plugins incompatible with mobile
// devices are being used. [Learn more]
// (https://support.google.com/webmasters/answer/6352293#flash_usage#error-list).
// "CONFIGURE_VIEWPORT" - Viewport is not specified using the meta
// viewport tag. [Learn more]
// (https://support.google.com/webmasters/answer/6352293#viewport_not_configured#error-list).
// "FIXED_WIDTH_VIEWPORT" - Viewport defined to a fixed width. [Learn
// more]
// (https://support.google.com/webmasters/answer/6352293#fixed-width_viewport#error-list).
// "SIZE_CONTENT_TO_VIEWPORT" - Content not sized to viewport. [Learn
// more]
// (https://support.google.com/webmasters/answer/6352293#content_not_sized_to_viewport#error-list).
// "USE_LEGIBLE_FONT_SIZES" - Font size is too small for easy reading
// on a small screen. [Learn More]
// (https://support.google.com/webmasters/answer/6352293#small_font_size#error-list).
// "TAP_TARGETS_TOO_CLOSE" - Touch elements are too close to each
// other. [Learn more]
// (https://support.google.com/webmasters/answer/6352293#touch_elements_too_close#error-list).
IssueType string `json:"issueType,omitempty"`
// Message: Additional information regarding the issue.
Message string `json:"message,omitempty"`
// Severity: Not returned; reserved for future use.
//
// Possible values:
// "SEVERITY_UNSPECIFIED" - Unknown severity.
// "WARNING" - Warning.
// "ERROR" - Error.
Severity string `json:"severity,omitempty"`
// ForceSendFields is a list of field names (e.g. "IssueType") to
// unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. However, any
// non-pointer, non-interface field appearing in ForceSendFields will be
// sent to the server regardless of whether the field is empty or not.
// This may be used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "IssueType") to include in
// API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *MobileUsabilityIssue) MarshalJSON() ([]byte, error) {
type NoMethod MobileUsabilityIssue
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// ResourceIssue: Information about a resource with issue.
type ResourceIssue struct {
// BlockedResource: Describes a blocked resource issue.
BlockedResource *BlockedResource `json:"blockedResource,omitempty"`
// ForceSendFields is a list of field names (e.g. "BlockedResource") to
// unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. However, any
// non-pointer, non-interface field appearing in ForceSendFields will be
// sent to the server regardless of whether the field is empty or not.