-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
surveys-gen.go
1998 lines (1779 loc) · 68.4 KB
/
surveys-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 2019 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 surveys provides access to the Surveys API.
//
// Creating a client
//
// Usage example:
//
// import "google.golang.org/api/surveys/v2"
// ...
// ctx := context.Background()
// surveysService, err := surveys.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:
//
// surveysService, err := surveys.NewService(ctx, option.WithScopes(surveys.UserinfoEmailScope))
//
// To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey:
//
// surveysService, err := surveys.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, ...)
// surveysService, err := surveys.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))
//
// See https://godoc.org/google.golang.org/api/option/ for details on options.
package surveys // import "google.golang.org/api/surveys/v2"
import (
"bytes"
"context"
"encoding/json"
"errors"
"fmt"
"io"
"net/http"
"net/url"
"strconv"
"strings"
gensupport "google.golang.org/api/gensupport"
googleapi "google.golang.org/api/googleapi"
option "google.golang.org/api/option"
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
const apiId = "surveys:v2"
const apiName = "surveys"
const apiVersion = "v2"
const basePath = "https://www.googleapis.com/surveys/v2/"
// OAuth2 scopes used by this API.
const (
// View and manage your surveys and results
SurveysScope = "https://www.googleapis.com/auth/surveys"
// View your surveys and survey results
SurveysReadonlyScope = "https://www.googleapis.com/auth/surveys.readonly"
// View your email address
UserinfoEmailScope = "https://www.googleapis.com/auth/userinfo.email"
)
// NewService creates a new Service.
func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error) {
scopesOption := option.WithScopes(
"https://www.googleapis.com/auth/surveys",
"https://www.googleapis.com/auth/surveys.readonly",
"https://www.googleapis.com/auth/userinfo.email",
)
// NOTE: prepend, so we don't override user-specified scopes.
opts = append([]option.ClientOption{scopesOption}, opts...)
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.Results = NewResultsService(s)
s.Surveys = NewSurveysService(s)
return s, nil
}
type Service struct {
client *http.Client
BasePath string // API endpoint base URL
UserAgent string // optional additional User-Agent fragment
Results *ResultsService
Surveys *SurveysService
}
func (s *Service) userAgent() string {
if s.UserAgent == "" {
return googleapi.UserAgent
}
return googleapi.UserAgent + " " + s.UserAgent
}
func NewResultsService(s *Service) *ResultsService {
rs := &ResultsService{s: s}
return rs
}
type ResultsService struct {
s *Service
}
func NewSurveysService(s *Service) *SurveysService {
rs := &SurveysService{s: s}
return rs
}
type SurveysService struct {
s *Service
}
type FieldMask struct {
Fields []*FieldMask `json:"fields,omitempty"`
Id int64 `json:"id,omitempty"`
// ForceSendFields is a list of field names (e.g. "Fields") 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. "Fields") 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 *FieldMask) MarshalJSON() ([]byte, error) {
type NoMethod FieldMask
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
type PageInfo struct {
ResultPerPage int64 `json:"resultPerPage,omitempty"`
StartIndex int64 `json:"startIndex,omitempty"`
TotalResults int64 `json:"totalResults,omitempty"`
// ForceSendFields is a list of field names (e.g. "ResultPerPage") 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. "ResultPerPage") 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 *PageInfo) MarshalJSON() ([]byte, error) {
type NoMethod PageInfo
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
type ResultsGetRequest struct {
ResultMask *ResultsMask `json:"resultMask,omitempty"`
// ForceSendFields is a list of field names (e.g. "ResultMask") 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. "ResultMask") 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 *ResultsGetRequest) MarshalJSON() ([]byte, error) {
type NoMethod ResultsGetRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
type ResultsMask struct {
Fields []*FieldMask `json:"fields,omitempty"`
Projection string `json:"projection,omitempty"`
// ForceSendFields is a list of field names (e.g. "Fields") 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. "Fields") 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 *ResultsMask) MarshalJSON() ([]byte, error) {
type NoMethod ResultsMask
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Survey: Representation of an individual survey object.
type Survey struct {
// Audience: Targeting-criteria message containing demographic
// information
Audience *SurveyAudience `json:"audience,omitempty"`
// Cost: Cost to run the survey and collect the necessary number of
// responses.
Cost *SurveyCost `json:"cost,omitempty"`
// CustomerData: Additional information to store on behalf of the API
// consumer and associate with this question. This binary blob is
// treated as opaque. This field is limited to 64K bytes.
CustomerData string `json:"customerData,omitempty"`
// Description: Text description of the survey.
Description string `json:"description,omitempty"`
// Owners: List of email addresses for survey owners. Must contain at
// least the address of the user making the API call.
Owners []string `json:"owners,omitempty"`
// Questions: List of questions defining the survey.
Questions []*SurveyQuestion `json:"questions,omitempty"`
// RejectionReason: Reason for the survey being rejected. Only present
// if the survey state is rejected.
RejectionReason *SurveyRejection `json:"rejectionReason,omitempty"`
// State: State that the survey is in.
State string `json:"state,omitempty"`
// SurveyUrlId: Unique survey ID, that is viewable in the URL of the
// Survey Creator UI
SurveyUrlId string `json:"surveyUrlId,omitempty"`
// Title: Optional name that will be given to the survey.
Title string `json:"title,omitempty"`
// WantedResponseCount: Number of responses desired for the survey.
WantedResponseCount int64 `json:"wantedResponseCount,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Audience") 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. "Audience") 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 *Survey) MarshalJSON() ([]byte, error) {
type NoMethod Survey
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// SurveyAudience: Specifications for the target audience of a survey
// run through the API.
type SurveyAudience struct {
// Ages: Optional list of age buckets to target. Supported age buckets
// are: ['18-24', '25-34', '35-44', '45-54', '55-64', '65+']
Ages []string `json:"ages,omitempty"`
// Country: Required country code that surveys should be targeted to.
// Accepts standard ISO 3166-1 2 character language codes. For instance,
// 'US' for the United States, and 'GB' for the United Kingdom.
Country string `json:"country,omitempty"`
// CountrySubdivision: Country subdivision (states/provinces/etc) that
// surveys should be targeted to. For all countries except GB,
// ISO-3166-2 subdivision code is required (eg. 'US-OH' for Ohio, United
// States). For GB, NUTS 1 statistical region codes for the United
// Kingdom is required (eg. 'UK-UKC' for North East England).
CountrySubdivision string `json:"countrySubdivision,omitempty"`
// Gender: Optional gender to target.
Gender string `json:"gender,omitempty"`
// Languages: Language code that surveys should be targeted to. For
// instance, 'en-US'. Surveys may target bilingual users by specifying a
// list of language codes (for example, 'de' and 'en-US'). In that case,
// all languages will be used for targeting users but the survey content
// (which is displayed) must match the first language listed. Accepts
// standard BCP47 language codes. See specification.
Languages []string `json:"languages,omitempty"`
// PopulationSource: Online population source where the respondents are
// sampled from.
PopulationSource string `json:"populationSource,omitempty"`
// ForceSendFields is a list of field names (e.g. "Ages") 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. "Ages") 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 *SurveyAudience) MarshalJSON() ([]byte, error) {
type NoMethod SurveyAudience
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// SurveyCost: Message defining the cost to run a given survey through
// API.
type SurveyCost struct {
// CostPerResponseNanos: Cost per survey response in nano units of the
// given currency. To get the total cost for a survey, multiply this
// value by wanted_response_count.
CostPerResponseNanos int64 `json:"costPerResponseNanos,omitempty,string"`
// CurrencyCode: Currency code that the cost is given in.
CurrencyCode string `json:"currencyCode,omitempty"`
// MaxCostPerResponseNanos: *Deprecated* Threshold to start a survey
// automatically if the quoted price is at most this value. When a
// survey has a Screener (threshold) question, it must go through an
// incidence pricing test to determine the final cost per response.
// Typically you will have to make a followup call to start the survey
// giving the final computed cost per response. If the survey has no
// threshold_answers, setting this property will return an error. By
// specifying this property, you indicate the max price per response you
// are willing to pay in advance of the incidence test. If the price
// turns out to be lower than the specified value, the survey will begin
// immediately and you will be charged at the rate determined by the
// incidence pricing test. If the price turns out to be greater than the
// specified value the survey will not be started and you will instead
// be notified what price was determined by the incidence test. At that
// point, you must raise the value of this property to be greater than
// or equal to that cost before attempting to start the survey again.
// This will immediately start the survey as long the incidence test was
// run within the last 21 days. This will no longer be available after
// June 2018.
MaxCostPerResponseNanos int64 `json:"maxCostPerResponseNanos,omitempty,string"`
// Nanos: Cost of survey in nano units of the given currency. DEPRECATED
// in favor of cost_per_response_nanos
Nanos int64 `json:"nanos,omitempty,string"`
// ForceSendFields is a list of field names (e.g.
// "CostPerResponseNanos") 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. "CostPerResponseNanos") 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 *SurveyCost) MarshalJSON() ([]byte, error) {
type NoMethod SurveyCost
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// SurveyQuestion: Message defining the question specifications.
type SurveyQuestion struct {
// AnswerOrder: The randomization option for multiple choice and
// multi-select questions. If not specified, this option defaults to
// randomize.
AnswerOrder string `json:"answerOrder,omitempty"`
// Answers: Required list of answer options for a question.
Answers []string `json:"answers,omitempty"`
// HasOther: Option to allow open-ended text box for Single Answer and
// Multiple Answer question types. This can be used with SINGLE_ANSWER,
// SINGLE_ANSWER_WITH_IMAGE, MULTIPLE_ANSWERS, and
// MULTIPLE_ANSWERS_WITH_IMAGE question types.
HasOther bool `json:"hasOther,omitempty"`
// HighValueLabel: For rating questions, the text for the higher end of
// the scale, such as 'Best'. For numeric questions, a string
// representing a floating-point that is the maximum allowed number for
// a response.
HighValueLabel string `json:"highValueLabel,omitempty"`
Images []*SurveyQuestionImage `json:"images,omitempty"`
// LastAnswerPositionPinned: Currently only support pinning an answer
// option to the last position.
LastAnswerPositionPinned bool `json:"lastAnswerPositionPinned,omitempty"`
// LowValueLabel: For rating questions, the text for the lower end of
// the scale, such as 'Worst'. For numeric questions, a string
// representing a floating-point that is the minimum allowed number for
// a response.
LowValueLabel string `json:"lowValueLabel,omitempty"`
// MustPickSuggestion: Option to force the user to pick one of the open
// text suggestions. This requires that suggestions are provided for
// this question.
MustPickSuggestion bool `json:"mustPickSuggestion,omitempty"`
// NumStars: Number of stars to use for ratings questions.
NumStars string `json:"numStars,omitempty"`
// OpenTextPlaceholder: Placeholder text for an open text question.
OpenTextPlaceholder string `json:"openTextPlaceholder,omitempty"`
// OpenTextSuggestions: A list of suggested answers for open text
// question auto-complete. This is only valid if single_line_response is
// true.
OpenTextSuggestions []string `json:"openTextSuggestions,omitempty"`
// Question: Required question text shown to the respondent.
Question string `json:"question,omitempty"`
// SentimentText: Used by the Rating Scale with Text question type. This
// text goes along with the question field that is presented to the
// respondent, and is the actual text that the respondent is asked to
// rate.
SentimentText string `json:"sentimentText,omitempty"`
// SingleLineResponse: Option to allow multiple line open text responses
// instead of a single line response. Note that we don't show
// auto-complete suggestions with multiple line responses.
SingleLineResponse bool `json:"singleLineResponse,omitempty"`
// ThresholdAnswers: The threshold/screener answer options, which will
// screen a user into the rest of the survey. These will be a subset of
// the answer option strings.
ThresholdAnswers []string `json:"thresholdAnswers,omitempty"`
// Type: Required field defining the question type. For details about
// configuring different type of questions, consult the question
// configuration guide.
Type string `json:"type,omitempty"`
// UnitOfMeasurementLabel: Optional unit of measurement for display (for
// example: hours, people, miles).
UnitOfMeasurementLabel string `json:"unitOfMeasurementLabel,omitempty"`
// VideoId: The YouTube video ID to be show in video questions.
VideoId string `json:"videoId,omitempty"`
// ForceSendFields is a list of field names (e.g. "AnswerOrder") 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. "AnswerOrder") 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 *SurveyQuestion) MarshalJSON() ([]byte, error) {
type NoMethod SurveyQuestion
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// SurveyQuestionImage: Container object for image data and alt_text.
type SurveyQuestionImage struct {
// AltText: The alt text property used in image tags is required for all
// images.
AltText string `json:"altText,omitempty"`
// Data: Inline jpeg, gif, tiff, bmp, or png image raw bytes for an
// image question types.
Data string `json:"data,omitempty"`
// Url: The read-only URL for the hosted images.
Url string `json:"url,omitempty"`
// ForceSendFields is a list of field names (e.g. "AltText") 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. "AltText") 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 *SurveyQuestionImage) MarshalJSON() ([]byte, error) {
type NoMethod SurveyQuestionImage
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// SurveyRejection: Message representing why the survey was rejected
// from review, if it was.
type SurveyRejection struct {
// Explanation: A human-readable explanation of what was wrong with the
// survey.
Explanation string `json:"explanation,omitempty"`
// Type: Which category of rejection this was. See the Google Surveys
// Help Center for additional details on each category.
Type string `json:"type,omitempty"`
// ForceSendFields is a list of field names (e.g. "Explanation") 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. "Explanation") 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 *SurveyRejection) MarshalJSON() ([]byte, error) {
type NoMethod SurveyRejection
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// SurveyResults: Reference to the current results for a given survey.
type SurveyResults struct {
// Status: Human readable string describing the status of the request.
Status string `json:"status,omitempty"`
// SurveyUrlId: External survey ID as viewable by survey owners in the
// editor view.
SurveyUrlId string `json:"surveyUrlId,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Status") 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. "Status") 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 *SurveyResults) MarshalJSON() ([]byte, error) {
type NoMethod SurveyResults
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
type SurveysDeleteResponse struct {
// RequestId: Unique request ID used for logging and debugging. Please
// include in any error reporting or troubleshooting requests.
RequestId string `json:"requestId,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "RequestId") 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. "RequestId") 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 *SurveysDeleteResponse) MarshalJSON() ([]byte, error) {
type NoMethod SurveysDeleteResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
type SurveysListResponse struct {
PageInfo *PageInfo `json:"pageInfo,omitempty"`
// RequestId: Unique request ID used for logging and debugging. Please
// include in any error reporting or troubleshooting requests.
RequestId string `json:"requestId,omitempty"`
// Resources: An individual survey resource.
Resources []*Survey `json:"resources,omitempty"`
TokenPagination *TokenPagination `json:"tokenPagination,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "PageInfo") 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. "PageInfo") 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 *SurveysListResponse) MarshalJSON() ([]byte, error) {
type NoMethod SurveysListResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
type SurveysStartRequest struct {
// MaxCostPerResponseNanos: *Deprecated* Threshold to start a survey
// automatically if the quoted prices is less than or equal to this
// value. See Survey.Cost for more details. This will no longer be
// available after June 2018.
MaxCostPerResponseNanos int64 `json:"maxCostPerResponseNanos,omitempty,string"`
// ForceSendFields is a list of field names (e.g.
// "MaxCostPerResponseNanos") 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. "MaxCostPerResponseNanos")
// 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 *SurveysStartRequest) MarshalJSON() ([]byte, error) {
type NoMethod SurveysStartRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
type SurveysStartResponse struct {
// RequestId: Unique request ID used for logging and debugging. Please
// include in any error reporting or troubleshooting requests.
RequestId string `json:"requestId,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "RequestId") 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. "RequestId") 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 *SurveysStartResponse) MarshalJSON() ([]byte, error) {
type NoMethod SurveysStartResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
type SurveysStopResponse struct {
// RequestId: Unique request ID used for logging and debugging. Please
// include in any error reporting or troubleshooting requests.
RequestId string `json:"requestId,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "RequestId") 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. "RequestId") 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 *SurveysStopResponse) MarshalJSON() ([]byte, error) {
type NoMethod SurveysStopResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
type TokenPagination struct {
NextPageToken string `json:"nextPageToken,omitempty"`
PreviousPageToken string `json:"previousPageToken,omitempty"`
// ForceSendFields is a list of field names (e.g. "NextPageToken") 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. "NextPageToken") 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 *TokenPagination) MarshalJSON() ([]byte, error) {
type NoMethod TokenPagination
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// method id "surveys.results.get":
type ResultsGetCall struct {
s *Service
surveyUrlId string
resultsgetrequest *ResultsGetRequest
urlParams_ gensupport.URLParams
ifNoneMatch_ string
ctx_ context.Context
header_ http.Header
}
// Get: Retrieves any survey results that have been produced so far.
// Results are formatted as an Excel file. You must add "?alt=media" to
// the URL as an argument to get results.
func (r *ResultsService) Get(surveyUrlId string, resultsgetrequest *ResultsGetRequest) *ResultsGetCall {
c := &ResultsGetCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.surveyUrlId = surveyUrlId
c.resultsgetrequest = resultsgetrequest
return c
}
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
func (c *ResultsGetCall) Fields(s ...googleapi.Field) *ResultsGetCall {
c.urlParams_.Set("fields", googleapi.CombineFields(s))
return c
}
// IfNoneMatch sets the optional parameter which makes the operation
// fail if the object's ETag matches the given value. This is useful for
// getting updates only after the object has changed since the last
// request. Use googleapi.IsNotModified to check whether the response
// error from Do is the result of In-None-Match.
func (c *ResultsGetCall) IfNoneMatch(entityTag string) *ResultsGetCall {
c.ifNoneMatch_ = entityTag
return c
}
// Context sets the context to be used in this call's Do and Download
// methods. Any pending HTTP request will be aborted if the provided
// context is canceled.
func (c *ResultsGetCall) Context(ctx context.Context) *ResultsGetCall {
c.ctx_ = ctx
return c
}
// Header returns an http.Header that can be modified by the caller to
// add HTTP headers to the request.
func (c *ResultsGetCall) Header() http.Header {
if c.header_ == nil {
c.header_ = make(http.Header)
}
return c.header_
}
func (c *ResultsGetCall) doRequest(alt string) (*http.Response, error) {
reqHeaders := make(http.Header)
reqHeaders.Set("x-goog-api-client", "gl-go/1.11.0 gdcl/20190802")
for k, v := range c.header_ {
reqHeaders[k] = v
}
reqHeaders.Set("User-Agent", c.s.userAgent())
if c.ifNoneMatch_ != "" {
reqHeaders.Set("If-None-Match", c.ifNoneMatch_)
}
var body io.Reader = nil
c.urlParams_.Set("alt", alt)
c.urlParams_.Set("prettyPrint", "false")
urls := googleapi.ResolveRelative(c.s.BasePath, "surveys/{surveyUrlId}/results")
urls += "?" + c.urlParams_.Encode()
req, err := http.NewRequest("GET", urls, body)
if err != nil {
return nil, err
}
req.Header = reqHeaders
googleapi.Expand(req.URL, map[string]string{
"surveyUrlId": c.surveyUrlId,
})
return gensupport.SendRequest(c.ctx_, c.s.client, req)
}
// Download fetches the API endpoint's "media" value, instead of the normal
// API response value. If the returned error is nil, the Response is guaranteed to
// have a 2xx status code. Callers must close the Response.Body as usual.
func (c *ResultsGetCall) Download(opts ...googleapi.CallOption) (*http.Response, error) {
gensupport.SetOptions(c.urlParams_, opts...)
res, err := c.doRequest("media")
if err != nil {
return nil, err
}
if err := googleapi.CheckMediaResponse(res); err != nil {
res.Body.Close()
return nil, err
}
return res, nil
}
// Do executes the "surveys.results.get" call.
// Exactly one of *SurveyResults or error will be non-nil. Any non-2xx
// status code is an error. Response headers are in either
// *SurveyResults.ServerResponse.Header or (if a response was returned
// at all) in error.(*googleapi.Error).Header. Use
// googleapi.IsNotModified to check whether the returned error was
// because http.StatusNotModified was returned.
func (c *ResultsGetCall) Do(opts ...googleapi.CallOption) (*SurveyResults, error) {
gensupport.SetOptions(c.urlParams_, opts...)
res, err := c.doRequest("json")
if res != nil && res.StatusCode == http.StatusNotModified {
if res.Body != nil {
res.Body.Close()
}
return nil, &googleapi.Error{
Code: res.StatusCode,
Header: res.Header,
}
}
if err != nil {
return nil, err
}
defer googleapi.CloseBody(res)
if err := googleapi.CheckResponse(res); err != nil {
return nil, err
}
ret := &SurveyResults{
ServerResponse: googleapi.ServerResponse{
Header: res.Header,
HTTPStatusCode: res.StatusCode,
},
}
target := &ret
if err := gensupport.DecodeResponse(target, res); err != nil {