-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
doubleclickbidmanager-gen.go
2148 lines (1926 loc) · 76.7 KB
/
doubleclickbidmanager-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 doubleclickbidmanager provides access to the DoubleClick Bid Manager API.
//
// For product documentation, see: https://developers.google.com/bid-manager/
//
// Creating a client
//
// Usage example:
//
// import "google.golang.org/api/doubleclickbidmanager/v2"
// ...
// ctx := context.Background()
// doubleclickbidmanagerService, err := doubleclickbidmanager.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
//
// To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey:
//
// doubleclickbidmanagerService, err := doubleclickbidmanager.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, ...)
// doubleclickbidmanagerService, err := doubleclickbidmanager.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))
//
// See https://godoc.org/google.golang.org/api/option/ for details on options.
package doubleclickbidmanager // import "google.golang.org/api/doubleclickbidmanager/v2"
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 = "doubleclickbidmanager:v2"
const apiName = "doubleclickbidmanager"
const apiVersion = "v2"
const basePath = "https://doubleclickbidmanager.googleapis.com/v2/"
const mtlsBasePath = "https://doubleclickbidmanager.mtls.googleapis.com/v2/"
// OAuth2 scopes used by this API.
const (
// View and manage your reports in DoubleClick Bid Manager
DoubleclickbidmanagerScope = "https://www.googleapis.com/auth/doubleclickbidmanager"
)
// NewService creates a new Service.
func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error) {
scopesOption := internaloption.WithDefaultScopes(
"https://www.googleapis.com/auth/doubleclickbidmanager",
)
// 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.Queries = NewQueriesService(s)
return s, nil
}
type Service struct {
client *http.Client
BasePath string // API endpoint base URL
UserAgent string // optional additional User-Agent fragment
Queries *QueriesService
}
func (s *Service) userAgent() string {
if s.UserAgent == "" {
return googleapi.UserAgent
}
return googleapi.UserAgent + " " + s.UserAgent
}
func NewQueriesService(s *Service) *QueriesService {
rs := &QueriesService{s: s}
rs.Reports = NewQueriesReportsService(s)
return rs
}
type QueriesService struct {
s *Service
Reports *QueriesReportsService
}
func NewQueriesReportsService(s *Service) *QueriesReportsService {
rs := &QueriesReportsService{s: s}
return rs
}
type QueriesReportsService struct {
s *Service
}
// ChannelGrouping: A channel grouping defines a set of rules that can
// be used to categorize events in a path report.
type ChannelGrouping struct {
// FallbackName: The name to apply to an event that does not match any
// of the rules in the channel grouping.
FallbackName string `json:"fallbackName,omitempty"`
// Name: Channel Grouping name.
Name string `json:"name,omitempty"`
// Rules: Rules within Channel Grouping. There is a limit of 100 rules
// that can be set per channel grouping.
Rules []*Rule `json:"rules,omitempty"`
// ForceSendFields is a list of field names (e.g. "FallbackName") 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. "FallbackName") 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 *ChannelGrouping) MarshalJSON() ([]byte, error) {
type NoMethod ChannelGrouping
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// DataRange: Report data range.
type DataRange struct {
// CustomEndDate: The ending date for the data that is shown in the
// report. Note, `customEndDate` is required if `range` is
// `CUSTOM_DATES` and ignored otherwise.
CustomEndDate *Date `json:"customEndDate,omitempty"`
// CustomStartDate: The starting data for the data that is shown in the
// report. Note, `customStartDate` is required if `range` is
// `CUSTOM_DATES` and ignored otherwise.
CustomStartDate *Date `json:"customStartDate,omitempty"`
// Range: Report data range used to generate the report.
//
// Possible values:
// "RANGE_UNSPECIFIED" - Default value when range is not specified or
// is unknown in this version.
// "CUSTOM_DATES" - Custom range specified by custom_start_date and
// custom_end_date fields.
// "CURRENT_DAY" - Current day.
// "PREVIOUS_DAY" - Previous day.
// "WEEK_TO_DATE" - All days, including the current day, since the
// most recent Sunday.
// "MONTH_TO_DATE" - All days, including the current day, since the
// start of the current month.
// "QUARTER_TO_DATE" - All days, including the current day, since the
// start of the current quarter.
// "YEAR_TO_DATE" - All days, including the current day, since the
// start of the current calendar year.
// "PREVIOUS_WEEK" - The previous completed week, beginning from
// Sunday.
// "PREVIOUS_MONTH" - The previous completed calendar month.
// "PREVIOUS_QUARTER" - The previous completed quarter.
// "PREVIOUS_YEAR" - The previous completed calendar year.
// "LAST_7_DAYS" - The previous 7 days, excluding the current day.
// "LAST_30_DAYS" - The previous 30 days, excluding the current day.
// "LAST_90_DAYS" - The previous 90 days, excluding the current day.
// "LAST_365_DAYS" - The previous 365 days, excluding the current day.
// "ALL_TIME" - All time for which data is available, excluding the
// current day.
// "LAST_14_DAYS" - The previous 14 days, excluding the current day.
// "LAST_60_DAYS" - The previous 60 days, excluding the current day.
Range string `json:"range,omitempty"`
// ForceSendFields is a list of field names (e.g. "CustomEndDate") 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. "CustomEndDate") 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 *DataRange) MarshalJSON() ([]byte, error) {
type NoMethod DataRange
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Date: Represents a whole or partial calendar date, such as a
// birthday. The time of day and time zone are either specified
// elsewhere or are insignificant. The date is relative to the Gregorian
// Calendar. This can represent one of the following: * A full date,
// with non-zero year, month, and day values. * A month and day, with a
// zero year (for example, an anniversary). * A year on its own, with a
// zero month and a zero day. * A year and month, with a zero day (for
// example, a credit card expiration date). Related types: *
// google.type.TimeOfDay * google.type.DateTime *
// google.protobuf.Timestamp
type Date struct {
// Day: Day of a month. Must be from 1 to 31 and valid for the year and
// month, or 0 to specify a year by itself or a year and month where the
// day isn't significant.
Day int64 `json:"day,omitempty"`
// Month: Month of a year. Must be from 1 to 12, or 0 to specify a year
// without a month and day.
Month int64 `json:"month,omitempty"`
// Year: Year of the date. Must be from 1 to 9999, or 0 to specify a
// date without a year.
Year int64 `json:"year,omitempty"`
// ForceSendFields is a list of field names (e.g. "Day") 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. "Day") 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 *Date) MarshalJSON() ([]byte, error) {
type NoMethod Date
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// DisjunctiveMatchStatement: DisjunctiveMatchStatement that OR's all
// contained filters.
type DisjunctiveMatchStatement struct {
// EventFilters: Filters. There is a limit of 100 filters that can be
// set per disjunctive match statement.
EventFilters []*EventFilter `json:"eventFilters,omitempty"`
// ForceSendFields is a list of field names (e.g. "EventFilters") 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. "EventFilters") 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 *DisjunctiveMatchStatement) MarshalJSON() ([]byte, error) {
type NoMethod DisjunctiveMatchStatement
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// EventFilter: Defines the type of filter to be applied to the path, a
// DV360 event dimension filter.
type EventFilter struct {
// DimensionFilter: Filter on a dimension.
DimensionFilter *PathQueryOptionsFilter `json:"dimensionFilter,omitempty"`
// ForceSendFields is a list of field names (e.g. "DimensionFilter") 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. "DimensionFilter") 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 *EventFilter) MarshalJSON() ([]byte, error) {
type NoMethod EventFilter
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// FilterPair: Filter used to match traffic data in your report.
type FilterPair struct {
// Type: Filter type.
Type string `json:"type,omitempty"`
// Value: Filter value.
Value string `json:"value,omitempty"`
// ForceSendFields is a list of field names (e.g. "Type") 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. "Type") 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 *FilterPair) MarshalJSON() ([]byte, error) {
type NoMethod FilterPair
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
type ListQueriesResponse struct {
// NextPageToken: A token, which can be sent as page_token to retrieve
// the next page of queries. If this field is omitted, there are no
// subsequent pages.
NextPageToken string `json:"nextPageToken,omitempty"`
// Queries: The list of queries.
Queries []*Query `json:"queries,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "NextPageToken") 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. "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 *ListQueriesResponse) MarshalJSON() ([]byte, error) {
type NoMethod ListQueriesResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
type ListReportsResponse struct {
// NextPageToken: A token, which can be sent as page_token to retrieve
// the next page of reports. If this field is omitted, there are no
// subsequent pages.
NextPageToken string `json:"nextPageToken,omitempty"`
// Reports: Retrieved reports.
Reports []*Report `json:"reports,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "NextPageToken") 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. "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 *ListReportsResponse) MarshalJSON() ([]byte, error) {
type NoMethod ListReportsResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Options: Additional query options.
type Options struct {
// IncludeOnlyTargetedUserLists: Set to true and filter your report by
// `FILTER_INSERTION_ORDER` or `FILTER_LINE_ITEM` to include data for
// audience lists specifically targeted by those items.
IncludeOnlyTargetedUserLists bool `json:"includeOnlyTargetedUserLists,omitempty"`
// PathQueryOptions: Options that contain Path Filters and Custom
// Channel Groupings.
PathQueryOptions *PathQueryOptions `json:"pathQueryOptions,omitempty"`
// ForceSendFields is a list of field names (e.g.
// "IncludeOnlyTargetedUserLists") 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.
// "IncludeOnlyTargetedUserLists") 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 *Options) MarshalJSON() ([]byte, error) {
type NoMethod Options
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Parameters: Parameters of a query or report.
type Parameters struct {
// Filters: Filters used to match traffic data in your report.
Filters []*FilterPair `json:"filters,omitempty"`
// GroupBys: Data is grouped by the filters listed in this field.
GroupBys []string `json:"groupBys,omitempty"`
// Metrics: Metrics to include as columns in your report.
Metrics []string `json:"metrics,omitempty"`
// Options: Additional query options.
Options *Options `json:"options,omitempty"`
// Type: The type of the report. The type of the report will dictate
// what dimesions, filters, and metrics can be used.
//
// Possible values:
// "REPORT_TYPE_UNSPECIFIED" - Default value when report type is not
// specified or is unknown in this version.
// "STANDARD" - Standard report.
// "INVENTORY_AVAILABILITY" - Inventory Availability report.
// "AUDIENCE_COMPOSITION" - Audience Composition report.
// "FLOODLIGHT" - Floodlight report.
// "YOUTUBE" - YouTube report.
// "GRP" - GRP report.
// "YOUTUBE_PROGRAMMATIC_GUARANTEED" - YouTube Programmatic Guaranteed
// report.
// "REACH" - Reach report.
// "UNIQUE_REACH_AUDIENCE" - Unique Reach Audience report.
// "FULL_PATH" - Full Path report.
// "PATH_ATTRIBUTION" - Path Attribution report.
Type string `json:"type,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 *Parameters) MarshalJSON() ([]byte, error) {
type NoMethod Parameters
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// PathFilter: Path filters specify which paths to include in a report.
// A path is the result of combining DV360 events based on User ID to
// create a workflow of users' actions. When a path filter is set, the
// resulting report will only include paths that match the specified
// event at the specified position. All other paths will be excluded.
type PathFilter struct {
// EventFilters: Filter on an event to be applied to some part of the
// path.
EventFilters []*EventFilter `json:"eventFilters,omitempty"`
// PathMatchPosition: The position of the path the filter should match
// to (first, last, or any event in path).
//
// Possible values:
// "PATH_MATCH_POSITION_UNSPECIFIED" - Default value when path match
// position is not specified or is unknown in this version.
// "ANY" - Any position in the path.
// "FIRST" - The first position in the path.
// "LAST" - The last position in the path.
PathMatchPosition string `json:"pathMatchPosition,omitempty"`
// ForceSendFields is a list of field names (e.g. "EventFilters") 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. "EventFilters") 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 *PathFilter) MarshalJSON() ([]byte, error) {
type NoMethod PathFilter
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// PathQueryOptions: Path Query Options for Report Options.
type PathQueryOptions struct {
// ChannelGrouping: Custom Channel Groupings.
ChannelGrouping *ChannelGrouping `json:"channelGrouping,omitempty"`
// PathFilters: Path Filters. There is a limit of 100 path filters that
// can be set per report.
PathFilters []*PathFilter `json:"pathFilters,omitempty"`
// ForceSendFields is a list of field names (e.g. "ChannelGrouping") 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. "ChannelGrouping") 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 *PathQueryOptions) MarshalJSON() ([]byte, error) {
type NoMethod PathQueryOptions
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// PathQueryOptionsFilter: Dimension filter on path events.
type PathQueryOptionsFilter struct {
// Filter: Dimension the filter is applied to.
Filter string `json:"filter,omitempty"`
// Match: Match logic of the filter.
//
// Possible values:
// "UNKNOWN" - Default value when match is not specified or is unknown
// in this version.
// "EXACT" - Matches a value exactly.
// "PARTIAL" - Matches a value partially.
// "BEGINS_WITH" - Begins with a value.
// "WILDCARD_EXPRESSION" - Matches a value, utilizing wildcard
// character logic in the value.
Match string `json:"match,omitempty"`
// Values: Values to filter on.
Values []string `json:"values,omitempty"`
// ForceSendFields is a list of field names (e.g. "Filter") 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. "Filter") 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 *PathQueryOptionsFilter) MarshalJSON() ([]byte, error) {
type NoMethod PathQueryOptionsFilter
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Query: Represents a query.
type Query struct {
// Metadata: Query metadata.
Metadata *QueryMetadata `json:"metadata,omitempty"`
// Params: Query parameters.
Params *Parameters `json:"params,omitempty"`
// QueryId: Output only. Query ID.
QueryId int64 `json:"queryId,omitempty,string"`
// Schedule: Information on how often and when to run a query. If
// `ONE_TIME` is set to the frequency field, the query will only be run
// at the time of creation.
Schedule *QuerySchedule `json:"schedule,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Metadata") 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. "Metadata") 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 *Query) MarshalJSON() ([]byte, error) {
type NoMethod Query
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// QueryMetadata: Query metadata.
type QueryMetadata struct {
// DataRange: Range of report data. All reports will be based on the
// same time zone as used by the advertiser.
DataRange *DataRange `json:"dataRange,omitempty"`
// Format: Format of the generated report.
//
// Possible values:
// "FORMAT_UNSPECIFIED" - Default value when format is not specified
// or is unknown in this version.
// "CSV" - CSV.
// "XLSX" - Excel.
Format string `json:"format,omitempty"`
// SendNotification: Whether to send an email notification when a report
// is ready. Defaults to false.
SendNotification bool `json:"sendNotification,omitempty"`
// ShareEmailAddress: List of email addresses which are sent email
// notifications when the report is finished. Separate from
// send_notification.
ShareEmailAddress []string `json:"shareEmailAddress,omitempty"`
// Title: Query title. It is used to name the reports generated from
// this query.
Title string `json:"title,omitempty"`
// ForceSendFields is a list of field names (e.g. "DataRange") 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. "DataRange") 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 *QueryMetadata) MarshalJSON() ([]byte, error) {
type NoMethod QueryMetadata
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// QuerySchedule: Information on when and how frequently to run a query.
type QuerySchedule struct {
// EndDate: Date to periodically run the query until. Not applicable to
// `ONE_TIME` frequency.
EndDate *Date `json:"endDate,omitempty"`
// Frequency: How often the query is run.
//
// Possible values:
// "FREQUENCY_UNSPECIFIED" - Default value when frequency is not
// specified or is unknown in this version.
// "ONE_TIME" - Only once.
// "DAILY" - Once a day.
// "WEEKLY" - Once a week.
// "SEMI_MONTHLY" - Twice a month.
// "MONTHLY" - Once a month.
// "QUARTERLY" - Once a quarter
// "YEARLY" - Once a year.
Frequency string `json:"frequency,omitempty"`
// NextRunTimezoneCode: Canonical timezone code for report generation
// time. Defaults to `America/New_York`.
NextRunTimezoneCode string `json:"nextRunTimezoneCode,omitempty"`
// StartDate: When to start running the query. Not applicable to
// `ONE_TIME` frequency.
StartDate *Date `json:"startDate,omitempty"`
// ForceSendFields is a list of field names (e.g. "EndDate") 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. "EndDate") 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 *QuerySchedule) MarshalJSON() ([]byte, error) {
type NoMethod QuerySchedule
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Report: Represents a report.
type Report struct {
// Key: Key used to identify a report.
Key *ReportKey `json:"key,omitempty"`
// Metadata: Report metadata.
Metadata *ReportMetadata `json:"metadata,omitempty"`
// Params: Report parameters.
Params *Parameters `json:"params,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Key") 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. "Key") 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 *Report) MarshalJSON() ([]byte, error) {
type NoMethod Report
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// ReportKey: Key used to identify a report.
type ReportKey struct {
// QueryId: Output only. Query ID.
QueryId int64 `json:"queryId,omitempty,string"`
// ReportId: Output only. Report ID.
ReportId int64 `json:"reportId,omitempty,string"`
// ForceSendFields is a list of field names (e.g. "QueryId") 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. "QueryId") 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 *ReportKey) MarshalJSON() ([]byte, error) {
type NoMethod ReportKey
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// ReportMetadata: Report metadata.
type ReportMetadata struct {
// GoogleCloudStoragePath: Output only. The path to the location in
// Google Cloud Storage where the report is stored.
GoogleCloudStoragePath string `json:"googleCloudStoragePath,omitempty"`
// ReportDataEndDate: The ending time for the data that is shown in the
// report.
ReportDataEndDate *Date `json:"reportDataEndDate,omitempty"`
// ReportDataStartDate: The starting time for the data that is shown in
// the report.
ReportDataStartDate *Date `json:"reportDataStartDate,omitempty"`
// Status: Report status.
Status *ReportStatus `json:"status,omitempty"`
// ForceSendFields is a list of field names (e.g.
// "GoogleCloudStoragePath") 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. "GoogleCloudStoragePath")
// 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 *ReportMetadata) MarshalJSON() ([]byte, error) {
type NoMethod ReportMetadata
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// ReportStatus: Report status.
type ReportStatus struct {
// FinishTime: Output only. The time when this report either completed
// successfully or failed.
FinishTime string `json:"finishTime,omitempty"`
// Format: The file type of the report.
//
// Possible values:
// "FORMAT_UNSPECIFIED" - Default value when format is not specified
// or is unknown in this version.
// "CSV" - CSV.
// "XLSX" - Excel.
Format string `json:"format,omitempty"`
// State: Output only. The state of the report.
//
// Possible values:
// "STATE_UNSPECIFIED" - Default value when state is not specified or
// is unknown in this version.
// "QUEUED" - The report is queued to run.
// "RUNNING" - The report is currently running.
// "DONE" - The report has finished running successfully.
// "FAILED" - The report has finished running in failure.
State string `json:"state,omitempty"`
// ForceSendFields is a list of field names (e.g. "FinishTime") 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. "FinishTime") 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 *ReportStatus) MarshalJSON() ([]byte, error) {
type NoMethod ReportStatus
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Rule: A Rule defines a name, and a boolean expression in [conjunctive
// normal form]
// (http://mathworld.wolfram.com/ConjunctiveNormalForm.html){.external}
// that can be applied to a path event to determine if that name should
// be applied.
type Rule struct {
// DisjunctiveMatchStatements: DisjunctiveMatchStatements within a Rule.
// DisjunctiveMatchStatement OR's all contained filters.
DisjunctiveMatchStatements []*DisjunctiveMatchStatement `json:"disjunctiveMatchStatements,omitempty"`