-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
searchconsole-gen.go
2300 lines (2069 loc) · 79.6 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 2021 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"
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 := option.WithScopes(
"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.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
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 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
}
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 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"
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 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 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 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)
}
// 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 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)
}
// 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" - Viewsport 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 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)
}
// 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 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. "BlockedResource") 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 *ResourceIssue) MarshalJSON() ([]byte, error) {
type NoMethod ResourceIssue
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// RunMobileFriendlyTestRequest: Mobile-friendly test request.
type RunMobileFriendlyTestRequest struct {
// RequestScreenshot: Whether or not screenshot is requested. Default is
// false.
RequestScreenshot bool `json:"requestScreenshot,omitempty"`
// Url: URL for inspection.
Url string `json:"url,omitempty"`
// ForceSendFields is a list of field names (e.g. "RequestScreenshot")
// to unconditionally include in API requests. By default, fields with
// empty 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. "RequestScreenshot") 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 *RunMobileFriendlyTestRequest) MarshalJSON() ([]byte, error) {
type NoMethod RunMobileFriendlyTestRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// RunMobileFriendlyTestResponse: Mobile-friendly test response,
// including mobile-friendly issues and resource issues.
type RunMobileFriendlyTestResponse struct {
// MobileFriendliness: Test verdict, whether the page is mobile friendly
// or not.
//
// Possible values:
// "MOBILE_FRIENDLY_TEST_RESULT_UNSPECIFIED" - Internal error when
// running this test. Please try running the test again.
// "MOBILE_FRIENDLY" - The page is mobile friendly.
// "NOT_MOBILE_FRIENDLY" - The page is not mobile friendly.
MobileFriendliness string `json:"mobileFriendliness,omitempty"`
// MobileFriendlyIssues: List of mobile-usability issues.
MobileFriendlyIssues []*MobileFriendlyIssue `json:"mobileFriendlyIssues,omitempty"`
// ResourceIssues: Information about embedded resources issues.
ResourceIssues []*ResourceIssue `json:"resourceIssues,omitempty"`
// Screenshot: Screenshot of the requested URL.
Screenshot *Image `json:"screenshot,omitempty"`
// TestStatus: Final state of the test, can be either complete or an
// error.
TestStatus *TestStatus `json:"testStatus,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "MobileFriendliness")
// to unconditionally include in API requests. By default, fields with
// empty 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. "MobileFriendliness") 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 *RunMobileFriendlyTestResponse) MarshalJSON() ([]byte, error) {
type NoMethod RunMobileFriendlyTestResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
type SearchAnalyticsQueryRequest struct {
// AggregationType: [Optional; Default is \"auto\"] How data is
// aggregated. If aggregated by property, all data for the same property
// is aggregated; if aggregated by page, all data is aggregated by
// canonical URI. If you filter or group by page, choose AUTO; otherwise
// you can aggregate either by property or by page, depending on how you
// want your data calculated; see the help documentation to learn how
// data is calculated differently by site versus by page. **Note:** If
// you group or filter by page, you cannot aggregate by property. If you
// specify any value other than AUTO, the aggregation type in the result
// will match the requested type, or if you request an invalid type, you
// will get an error. The API will never change your aggregation type if
// the requested type is invalid.
//
// Possible values:
// "AUTO"
// "BY_PROPERTY"
// "BY_PAGE"
AggregationType string `json:"aggregationType,omitempty"`
// DataState: The data state to be fetched, can be full or all, the
// latter including full and partial data.
//
// Possible values:
// "DATA_STATE_UNSPECIFIED" - Default value, should not be used.
// "FINAL" - Include full final data only, without partial.
// "ALL" - Include all data, full and partial.
DataState string `json:"dataState,omitempty"`
// DimensionFilterGroups: [Optional] Zero or more filters to apply to
// the dimension grouping values; for example, 'query contains \"buy\"'
// to see only data where the query string contains the substring
// \"buy\" (not case-sensitive). You can filter by a dimension without
// grouping by it.
DimensionFilterGroups []*ApiDimensionFilterGroup `json:"dimensionFilterGroups,omitempty"`
// Dimensions: [Optional] Zero or more dimensions to group results by.
// Dimensions are the group-by values in the Search Analytics page.
// Dimensions are combined to create a unique row key for each row.
// Results are grouped in the order that you supply these dimensions.
//
// Possible values:
// "DATE"
// "QUERY"
// "PAGE"
// "COUNTRY"
// "DEVICE"
// "SEARCH_APPEARANCE"
Dimensions []string `json:"dimensions,omitempty"`
// EndDate: [Required] End date of the requested date range, in
// YYYY-MM-DD format, in PST (UTC - 8:00). Must be greater than or equal
// to the start date. This value is included in the range.
EndDate string `json:"endDate,omitempty"`
// RowLimit: [Optional; Default is 1000] The maximum number of rows to
// return. Must be a number from 1 to 25,000 (inclusive).
RowLimit int64 `json:"rowLimit,omitempty"`
// SearchType: [Optional; Default is \"web\"] The search type to filter
// for.
//
// Possible values:
// "WEB"
// "IMAGE"
// "VIDEO"
// "NEWS"
SearchType string `json:"searchType,omitempty"`
// StartDate: [Required] Start date of the requested date range, in
// YYYY-MM-DD format, in PST time (UTC - 8:00). Must be less than or
// equal to the end date. This value is included in the range.
StartDate string `json:"startDate,omitempty"`
// StartRow: [Optional; Default is 0] Zero-based index of the first row
// in the response. Must be a non-negative number.
StartRow int64 `json:"startRow,omitempty"`
// ForceSendFields is a list of field names (e.g. "AggregationType") to
// unconditionally include in API requests. By default, fields with
// empty 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. "AggregationType") 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 *SearchAnalyticsQueryRequest) MarshalJSON() ([]byte, error) {
type NoMethod SearchAnalyticsQueryRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// SearchAnalyticsQueryResponse: A list of rows, one per result, grouped
// by key. Metrics in each row are aggregated for all data grouped by
// that key either by page or property, as specified by the aggregation
// type parameter.
type SearchAnalyticsQueryResponse struct {
// ResponseAggregationType: How the results were aggregated.
//
// Possible values:
// "AUTO"
// "BY_PROPERTY"
// "BY_PAGE"
ResponseAggregationType string `json:"responseAggregationType,omitempty"`
// Rows: A list of rows grouped by the key values in the order given in
// the query.
Rows []*ApiDataRow `json:"rows,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g.
// "ResponseAggregationType") to unconditionally include in API
// requests. By default, fields with empty 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. "ResponseAggregationType")
// 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 *SearchAnalyticsQueryResponse) MarshalJSON() ([]byte, error) {
type NoMethod SearchAnalyticsQueryResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// SitemapsListResponse: List of sitemaps.
type SitemapsListResponse struct {
// Sitemap: Contains detailed information about a specific URL submitted
// as a sitemap (https://support.google.com/webmasters/answer/156184).
Sitemap []*WmxSitemap `json:"sitemap,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Sitemap") to
// unconditionally include in API requests. By default, fields with
// empty 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. "Sitemap") 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 *SitemapsListResponse) MarshalJSON() ([]byte, error) {
type NoMethod SitemapsListResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// SitesListResponse: List of sites with access level information.
type SitesListResponse struct {
// SiteEntry: Contains permission level information about a Search
// Console site. For more information, see Permissions in Search Console
// (https://support.google.com/webmasters/answer/2451999).
SiteEntry []*WmxSite `json:"siteEntry,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "SiteEntry") to
// unconditionally include in API requests. By default, fields with
// empty 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. "SiteEntry") 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 *SitesListResponse) MarshalJSON() ([]byte, error) {
type NoMethod SitesListResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// TestStatus: Final state of the test, including error details if
// necessary.
type TestStatus struct {
// Details: Error details if applicable.
Details string `json:"details,omitempty"`
// Status: Status of the test.
//
// Possible values:
// "TEST_STATUS_UNSPECIFIED" - Internal error when running this test.
// Please try running the test again.
// "COMPLETE" - Inspection has completed without errors.
// "INTERNAL_ERROR" - Inspection terminated in an error state. This
// indicates a problem in Google's infrastructure, not a user error.
// Please try again later.
// "PAGE_UNREACHABLE" - Google can not access the URL because of a
// user error such as a robots.txt blockage, a 403 or 500 code etc.
// Please make sure that the URL provided is accessible by Googlebot and
// is not password protected.
Status string `json:"status,omitempty"`
// ForceSendFields is a list of field names (e.g. "Details") to
// unconditionally include in API requests. By default, fields with
// empty 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. "Details") 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 *TestStatus) MarshalJSON() ([]byte, error) {
type NoMethod TestStatus
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// WmxSite: Contains permission level information about a Search Console
// site. For more information, see Permissions in Search Console
// (https://support.google.com/webmasters/answer/2451999).
type WmxSite struct {
// PermissionLevel: The user's permission level for the site.
//
// Possible values:
// "SITE_PERMISSION_LEVEL_UNSPECIFIED"
// "SITE_OWNER" - Owner has complete access to the site.
// "SITE_FULL_USER" - Full users can access all data, and perform most
// of the operations.
// "SITE_RESTRICTED_USER" - Restricted users can access most of the
// data, and perform some operations.
// "SITE_UNVERIFIED_USER" - Unverified user has no access to site's
// data.
PermissionLevel string `json:"permissionLevel,omitempty"`
// SiteUrl: The URL of the site.
SiteUrl string `json:"siteUrl,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "PermissionLevel") to
// unconditionally include in API requests. By default, fields with
// empty 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. "PermissionLevel") 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 *WmxSite) MarshalJSON() ([]byte, error) {
type NoMethod WmxSite
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// WmxSitemap: Contains detailed information about a specific URL
// submitted as a sitemap
// (https://support.google.com/webmasters/answer/156184).
type WmxSitemap struct {
// Contents: The various content types in the sitemap.
Contents []*WmxSitemapContent `json:"contents,omitempty"`
// Errors: Number of errors in the sitemap. These are issues with the
// sitemap itself that need to be fixed before it can be processed
// correctly.
Errors int64 `json:"errors,omitempty,string"`
// IsPending: If true, the sitemap has not been processed.
IsPending bool `json:"isPending,omitempty"`
// IsSitemapsIndex: If true, the sitemap is a collection of sitemaps.
IsSitemapsIndex bool `json:"isSitemapsIndex,omitempty"`
// LastDownloaded: Date & time in which this sitemap was last
// downloaded. Date format is in RFC 3339 format (yyyy-mm-dd).
LastDownloaded string `json:"lastDownloaded,omitempty"`
// LastSubmitted: Date & time in which this sitemap was submitted. Date
// format is in RFC 3339 format (yyyy-mm-dd).
LastSubmitted string `json:"lastSubmitted,omitempty"`
// Path: The url of the sitemap.
Path string `json:"path,omitempty"`
// Type: The type of the sitemap. For example: `rssFeed`.
//
// Possible values:
// "NOT_SITEMAP"
// "URL_LIST"
// "SITEMAP"
// "RSS_FEED"
// "ATOM_FEED"
// "PATTERN_SITEMAP" - Unsupported sitemap types.
// "OCEANFRONT"
Type string `json:"type,omitempty"`
// Warnings: Number of warnings for the sitemap. These are generally
// non-critical issues with URLs in the sitemaps.
Warnings int64 `json:"warnings,omitempty,string"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Contents") to
// unconditionally include in API requests. By default, fields with
// empty 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. "Contents") 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 *WmxSitemap) MarshalJSON() ([]byte, error) {
type NoMethod WmxSitemap
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// WmxSitemapContent: Information about the various content types in the
// sitemap.
type WmxSitemapContent struct {
// Indexed: The number of URLs from the sitemap that were indexed (of
// the content type).
Indexed int64 `json:"indexed,omitempty,string"`
// Submitted: The number of URLs in the sitemap (of the content type).
Submitted int64 `json:"submitted,omitempty,string"`
// Type: The specific type of content in this sitemap. For example:
// `web`.
//
// Possible values:
// "WEB"
// "IMAGE"
// "VIDEO"
// "NEWS"
// "MOBILE"
// "ANDROID_APP"
// "PATTERN" - Unsupported content type.
// "IOS_APP"
// "DATA_FEED_ELEMENT" - Unsupported content type.
Type string `json:"type,omitempty"`
// ForceSendFields is a list of field names (e.g. "Indexed") to
// unconditionally include in API requests. By default, fields with
// empty 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. "Indexed") 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 *WmxSitemapContent) MarshalJSON() ([]byte, error) {
type NoMethod WmxSitemapContent
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// method id "webmasters.searchanalytics.query":
type SearchanalyticsQueryCall struct {
s *Service
siteUrl string
searchanalyticsqueryrequest *SearchAnalyticsQueryRequest
urlParams_ gensupport.URLParams
ctx_ context.Context