-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
admob-gen.go
3087 lines (2794 loc) · 124 KB
/
admob-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 admob provides access to the AdMob API.
//
// For product documentation, see: https://developers.google.com/admob/api/
//
// Creating a client
//
// Usage example:
//
// import "google.golang.org/api/admob/v1beta"
// ...
// ctx := context.Background()
// admobService, err := admob.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:
//
// admobService, err := admob.NewService(ctx, option.WithScopes(admob.AdmobReportScope))
//
// To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey:
//
// admobService, err := admob.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, ...)
// admobService, err := admob.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))
//
// See https://godoc.org/google.golang.org/api/option/ for details on options.
package admob // import "google.golang.org/api/admob/v1beta"
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 = "admob:v1beta"
const apiName = "admob"
const apiVersion = "v1beta"
const basePath = "https://admob.googleapis.com/"
const mtlsBasePath = "https://admob.mtls.googleapis.com/"
// OAuth2 scopes used by this API.
const (
// See your AdMob data
AdmobReadonlyScope = "https://www.googleapis.com/auth/admob.readonly"
// See your AdMob data
AdmobReportScope = "https://www.googleapis.com/auth/admob.report"
)
// NewService creates a new Service.
func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error) {
scopesOption := internaloption.WithDefaultScopes(
"https://www.googleapis.com/auth/admob.readonly",
"https://www.googleapis.com/auth/admob.report",
)
// 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.Accounts = NewAccountsService(s)
return s, nil
}
type Service struct {
client *http.Client
BasePath string // API endpoint base URL
UserAgent string // optional additional User-Agent fragment
Accounts *AccountsService
}
func (s *Service) userAgent() string {
if s.UserAgent == "" {
return googleapi.UserAgent
}
return googleapi.UserAgent + " " + s.UserAgent
}
func NewAccountsService(s *Service) *AccountsService {
rs := &AccountsService{s: s}
rs.AdSources = NewAccountsAdSourcesService(s)
rs.AdUnits = NewAccountsAdUnitsService(s)
rs.Apps = NewAccountsAppsService(s)
rs.MediationReport = NewAccountsMediationReportService(s)
rs.NetworkReport = NewAccountsNetworkReportService(s)
return rs
}
type AccountsService struct {
s *Service
AdSources *AccountsAdSourcesService
AdUnits *AccountsAdUnitsService
Apps *AccountsAppsService
MediationReport *AccountsMediationReportService
NetworkReport *AccountsNetworkReportService
}
func NewAccountsAdSourcesService(s *Service) *AccountsAdSourcesService {
rs := &AccountsAdSourcesService{s: s}
return rs
}
type AccountsAdSourcesService struct {
s *Service
}
func NewAccountsAdUnitsService(s *Service) *AccountsAdUnitsService {
rs := &AccountsAdUnitsService{s: s}
return rs
}
type AccountsAdUnitsService struct {
s *Service
}
func NewAccountsAppsService(s *Service) *AccountsAppsService {
rs := &AccountsAppsService{s: s}
return rs
}
type AccountsAppsService struct {
s *Service
}
func NewAccountsMediationReportService(s *Service) *AccountsMediationReportService {
rs := &AccountsMediationReportService{s: s}
return rs
}
type AccountsMediationReportService struct {
s *Service
}
func NewAccountsNetworkReportService(s *Service) *AccountsNetworkReportService {
rs := &AccountsNetworkReportService{s: s}
return rs
}
type AccountsNetworkReportService struct {
s *Service
}
// AdSource: Definition of a mediation ad source.
type AdSource struct {
// AdSourceId: ID of this ad source.
AdSourceId string `json:"adSourceId,omitempty"`
// Name: Resource name of this ad source. Format is:
// accounts/{publisher_id}/adSources/{ad_source_id}
Name string `json:"name,omitempty"`
// Title: Display name of this ad source.
Title string `json:"title,omitempty"`
// ForceSendFields is a list of field names (e.g. "AdSourceId") 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. "AdSourceId") 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 *AdSource) MarshalJSON() ([]byte, error) {
type NoMethod AdSource
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// AdUnit: Describes an AdMob ad unit.
type AdUnit struct {
// AdFormat: AdFormat of the ad unit. Possible values are as follows:
// "BANNER" - Banner ad format. "BANNER_INTERSTITIAL" - Legacy format
// that can be used as either banner or interstitial. This format can no
// longer be created but can be targeted by mediation groups.
// "INTERSTITIAL" - A full screen ad. Supported ad types are
// "RICH_MEDIA" and "VIDEO". "NATIVE" - Native ad format. "REWARDED" -
// An ad that, once viewed, gets a callback verifying the view so that a
// reward can be given to the user. Supported ad types are "RICH_MEDIA"
// (interactive) and video where video can not be excluded.
AdFormat string `json:"adFormat,omitempty"`
// AdTypes: Ad media type supported by this ad unit. Possible values as
// follows: "RICH_MEDIA" - Text, image, and other non-video media.
// "VIDEO" - Video media.
AdTypes []string `json:"adTypes,omitempty"`
// AdUnitId: The externally visible ID of the ad unit which can be used
// to integrate with the AdMob SDK. This is a read only property.
// Example: ca-app-pub-9876543210987654/0123456789
AdUnitId string `json:"adUnitId,omitempty"`
// AppId: The externally visible ID of the app this ad unit is
// associated with. Example: ca-app-pub-9876543210987654~0123456789
AppId string `json:"appId,omitempty"`
// DisplayName: The display name of the ad unit as shown in the AdMob
// UI, which is provided by the user. The maximum length allowed is 80
// characters.
DisplayName string `json:"displayName,omitempty"`
// Name: Resource name for this ad unit. Format is
// accounts/{publisher_id}/adUnits/{ad_unit_id_fragment} Example:
// accounts/pub-9876543210987654/adUnits/0123456789
Name string `json:"name,omitempty"`
// ForceSendFields is a list of field names (e.g. "AdFormat") 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. "AdFormat") 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 *AdUnit) MarshalJSON() ([]byte, error) {
type NoMethod AdUnit
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// App: Describes an AdMob app for a specific platform (For example:
// Android or iOS).
type App struct {
// AppId: The externally visible ID of the app which can be used to
// integrate with the AdMob SDK. This is a read only property. Example:
// ca-app-pub-9876543210987654~0123456789
AppId string `json:"appId,omitempty"`
// LinkedAppInfo: Immutable. The information for an app that is linked
// to an app store. This field is present if and only if the app is
// linked to an app store.
LinkedAppInfo *AppLinkedAppInfo `json:"linkedAppInfo,omitempty"`
// ManualAppInfo: The information for an app that is not linked to any
// app store. After an app is linked, this information is still
// retrivable. If no name is provided for the app upon creation, a
// placeholder name will be used.
ManualAppInfo *AppManualAppInfo `json:"manualAppInfo,omitempty"`
// Name: Resource name for this app. Format is
// accounts/{publisher_id}/apps/{app_id_fragment} Example:
// accounts/pub-9876543210987654/apps/0123456789
Name string `json:"name,omitempty"`
// Platform: Describes the platform of the app. Limited to "IOS" and
// "ANDROID".
Platform string `json:"platform,omitempty"`
// ForceSendFields is a list of field names (e.g. "AppId") 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. "AppId") 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 *App) MarshalJSON() ([]byte, error) {
type NoMethod App
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// AppLinkedAppInfo: Information from the app store if the app is linked
// to an app store.
type AppLinkedAppInfo struct {
// AppStoreId: The app store ID of the app; present if and only if the
// app is linked to an app store. If the app is added to the Google Play
// store, it will be the application ID of the app. For example:
// "com.example.myapp". See
// https://developer.android.com/studio/build/application-id. If the app
// is added to the Apple App Store, it will be app store ID. For example
// "105169111". Note that setting the app store id is considered an
// irreversible action. Once an app is linked, it cannot be unlinked.
AppStoreId string `json:"appStoreId,omitempty"`
// DisplayName: Output only. Display name of the app as it appears in
// the app store. This is an output-only field, and may be empty if the
// app cannot be found in the store.
DisplayName string `json:"displayName,omitempty"`
// ForceSendFields is a list of field names (e.g. "AppStoreId") 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. "AppStoreId") 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 *AppLinkedAppInfo) MarshalJSON() ([]byte, error) {
type NoMethod AppLinkedAppInfo
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// AppManualAppInfo: Information provided for manual apps which are not
// linked to an application store (Example: Google Play, App Store).
type AppManualAppInfo struct {
// DisplayName: The display name of the app as shown in the AdMob UI,
// which is provided by the user. The maximum length allowed is 80
// characters.
DisplayName string `json:"displayName,omitempty"`
// ForceSendFields is a list of field names (e.g. "DisplayName") 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. "DisplayName") 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 *AppManualAppInfo) MarshalJSON() ([]byte, error) {
type NoMethod AppManualAppInfo
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)
}
// DateRange: Specification of a single date range. Both dates are
// inclusive.
type DateRange struct {
// EndDate: End date of the date range, inclusive. Must be greater than
// or equal to the start date.
EndDate *Date `json:"endDate,omitempty"`
// StartDate: Start date of the date range, inclusive. Must be less than
// or equal to the end date.
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 *DateRange) MarshalJSON() ([]byte, error) {
type NoMethod DateRange
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GenerateMediationReportRequest: Request to generate an AdMob
// Mediation report.
type GenerateMediationReportRequest struct {
// ReportSpec: Network report specification.
ReportSpec *MediationReportSpec `json:"reportSpec,omitempty"`
// ForceSendFields is a list of field names (e.g. "ReportSpec") 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. "ReportSpec") 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 *GenerateMediationReportRequest) MarshalJSON() ([]byte, error) {
type NoMethod GenerateMediationReportRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GenerateMediationReportResponse: The streaming response for the AdMob
// Mediation report where the first response contains the report header,
// then a stream of row responses, and finally a footer as the last
// response message. For example: [{ "header": { "date_range": {
// "start_date": {"year": 2018, "month": 9, "day": 1}, "end_date":
// {"year": 2018, "month": 9, "day": 1} }, "localization_settings": {
// "currency_code": "USD", "language_code": "en-US" } } }, { "row": {
// "dimension_values": { "DATE": {"value": "20180918"}, "APP": {
// "value": "ca-app-pub-8123415297019784~1001342552", "display_label":
// "My app name!" } }, "metric_values": { "ESTIMATED_EARNINGS":
// {"decimal_value": "1324746"} } } }, { "footer":
// {"matching_row_count": 1} }]
type GenerateMediationReportResponse struct {
// Footer: Additional information about the generated report, such as
// warnings about the data.
Footer *ReportFooter `json:"footer,omitempty"`
// Header: Report generation settings that describes the report
// contents, such as the report date range and localization settings.
Header *ReportHeader `json:"header,omitempty"`
// Row: Actual report data.
Row *ReportRow `json:"row,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Footer") 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. "Footer") 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 *GenerateMediationReportResponse) MarshalJSON() ([]byte, error) {
type NoMethod GenerateMediationReportResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GenerateNetworkReportRequest: Request to generate an AdMob Network
// report.
type GenerateNetworkReportRequest struct {
// ReportSpec: Network report specification.
ReportSpec *NetworkReportSpec `json:"reportSpec,omitempty"`
// ForceSendFields is a list of field names (e.g. "ReportSpec") 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. "ReportSpec") 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 *GenerateNetworkReportRequest) MarshalJSON() ([]byte, error) {
type NoMethod GenerateNetworkReportRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GenerateNetworkReportResponse: The streaming response for the AdMob
// Network report where the first response contains the report header,
// then a stream of row responses, and finally a footer as the last
// response message. For example: [{ "header": { "dateRange": {
// "startDate": {"year": 2018, "month": 9, "day": 1}, "endDate":
// {"year": 2018, "month": 9, "day": 1} }, "localizationSettings": {
// "currencyCode": "USD", "languageCode": "en-US" } } }, { "row": {
// "dimensionValues": { "DATE": {"value": "20180918"}, "APP": { "value":
// "ca-app-pub-8123415297019784~1001342552", displayLabel: "My app
// name!" } }, "metricValues": { "ESTIMATED_EARNINGS": {"microsValue":
// 6500000} } } }, { "footer": {"matchingRowCount": 1} }]
type GenerateNetworkReportResponse struct {
// Footer: Additional information about the generated report, such as
// warnings about the data.
Footer *ReportFooter `json:"footer,omitempty"`
// Header: Report generation settings that describes the report
// contents, such as the report date range and localization settings.
Header *ReportHeader `json:"header,omitempty"`
// Row: Actual report data.
Row *ReportRow `json:"row,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Footer") 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. "Footer") 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 *GenerateNetworkReportResponse) MarshalJSON() ([]byte, error) {
type NoMethod GenerateNetworkReportResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// ListAdSourcesResponse: Response for the ListAdSourcesRequest.
type ListAdSourcesResponse struct {
// AdSources: The ad sources.
AdSources []*AdSource `json:"adSources,omitempty"`
// NextPageToken: Used to set the `page_token` in the
// `ListAdSourcesRequest` to retrieve the next page. If this field is
// omitted, there are no subsequent pages.
NextPageToken string `json:"nextPageToken,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "AdSources") 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. "AdSources") 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 *ListAdSourcesResponse) MarshalJSON() ([]byte, error) {
type NoMethod ListAdSourcesResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// ListAdUnitsResponse: Response for the ad units list request.
type ListAdUnitsResponse struct {
// AdUnits: The resulting ad units for the requested account.
AdUnits []*AdUnit `json:"adUnits,omitempty"`
// NextPageToken: If not empty, indicates that there may be more ad
// units for the request; this value should be passed in a new
// `ListAdUnitsRequest`.
NextPageToken string `json:"nextPageToken,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "AdUnits") 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. "AdUnits") 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 *ListAdUnitsResponse) MarshalJSON() ([]byte, error) {
type NoMethod ListAdUnitsResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// ListAppsResponse: Response for the apps list request.
type ListAppsResponse struct {
// Apps: The resulting apps for the requested account.
Apps []*App `json:"apps,omitempty"`
// NextPageToken: If not empty, indicates that there may be more apps
// for the request; this value should be passed in a new
// `ListAppsRequest`.
NextPageToken string `json:"nextPageToken,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Apps") 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. "Apps") 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 *ListAppsResponse) MarshalJSON() ([]byte, error) {
type NoMethod ListAppsResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// ListPublisherAccountsResponse: Response for the publisher account
// list request.
type ListPublisherAccountsResponse struct {
// Account: Publisher that the client credentials can access.
Account []*PublisherAccount `json:"account,omitempty"`
// NextPageToken: If not empty, indicates that there might be more
// accounts for the request; you must pass this value in a new
// `ListPublisherAccountsRequest`.
NextPageToken string `json:"nextPageToken,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Account") 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. "Account") 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 *ListPublisherAccountsResponse) MarshalJSON() ([]byte, error) {
type NoMethod ListPublisherAccountsResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// LocalizationSettings: Localization settings for reports, such as
// currency and language. It affects how metrics are calculated.
type LocalizationSettings struct {
// CurrencyCode: Currency code of the earning related metrics, which is
// the 3-letter code defined in ISO 4217. The daily average rate is used
// for the currency conversion. Defaults to the account currency code if
// unspecified.
CurrencyCode string `json:"currencyCode,omitempty"`
// LanguageCode: Language used for any localized text, such as some
// dimension value display labels. The language tag defined in the IETF
// BCP47. Defaults to 'en-US' if unspecified.
LanguageCode string `json:"languageCode,omitempty"`
// ForceSendFields is a list of field names (e.g. "CurrencyCode") 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. "CurrencyCode") 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 *LocalizationSettings) MarshalJSON() ([]byte, error) {
type NoMethod LocalizationSettings
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// MediationReportSpec: The specification for generating an AdMob
// Mediation report. For example, the specification to get observed ECPM
// sliced by ad source and app for the 'US' and 'CN' countries can look
// like the following example: { "date_range": { "start_date": {"year":
// 2021, "month": 9, "day": 1}, "end_date": {"year": 2021, "month": 9,
// "day": 30} }, "dimensions": ["AD_SOURCE", "APP", "COUNTRY"],
// "metrics": ["OBSERVED_ECPM"], "dimension_filters": [ { "dimension":
// "COUNTRY", "matches_any": {"values": [{"value": "US", "value":
// "CN"}]} } ], "sort_conditions": [ {"dimension":"APP", order:
// "ASCENDING"} ], "localization_settings": { "currency_code": "USD",
// "language_code": "en-US" } } For a better understanding, you can
// treat the preceding specification like the following pseudo SQL:
// SELECT AD_SOURCE, APP, COUNTRY, OBSERVED_ECPM FROM MEDIATION_REPORT
// WHERE DATE >= '2021-09-01' AND DATE <= '2021-09-30' AND COUNTRY IN
// ('US', 'CN') GROUP BY AD_SOURCE, APP, COUNTRY ORDER BY APP ASC;
type MediationReportSpec struct {
// DateRange: The date range for which the report is generated.
DateRange *DateRange `json:"dateRange,omitempty"`
// DimensionFilters: Describes which report rows to match based on their
// dimension values.
DimensionFilters []*MediationReportSpecDimensionFilter `json:"dimensionFilters,omitempty"`
// Dimensions: List of dimensions of the report. The value combination
// of these dimensions determines the row of the report. If no
// dimensions are specified, the report returns a single row of
// requested metrics for the entire account.
//
// Possible values:
// "DIMENSION_UNSPECIFIED" - Default value for an unset field. Do not
// use.
// "DATE" - A date in the YYYYMMDD format (for example, "20210701").
// Requests can specify at most one time dimension.
// "MONTH" - A month in the YYYYMM format (for example, "202107").
// Requests can specify at most one time dimension.
// "WEEK" - The date of the first day of a week in the YYYYMMDD format
// (for example, "20210701"). Requests can specify at most one time
// dimension.
// "AD_SOURCE" - The [unique ID of the ad
// source](/admob/api/v1/ad_sources) (for example, "5450213213286189855"
// and "AdMob Network" as label value).
// "AD_SOURCE_INSTANCE" - The unique ID of the ad source instance (for
// example, "ca-app-pub-1234:asi:5678" and "AdMob (default)" as label
// value).
// "AD_UNIT" - The unique ID of the ad unit (for example,
// "ca-app-pub-1234/8790"). If AD_UNIT dimension is specified, then APP
// is included automatically.
// "APP" - The unique ID of the mobile application (for example,
// "ca-app-pub-1234~1234").
// "MEDIATION_GROUP" - The unique ID of the mediation group (for
// example, "ca-app-pub-1234:mg:1234" and "AdMob (default)" as label
// value).
// "COUNTRY" - CLDR country code of the place where the ad
// views/clicks occur (for example, "US" or "FR"). This is a geography
// dimension.
// "FORMAT" - Format of the ad unit (for example, "banner", "native"),
// an ad delivery dimension.
// "PLATFORM" - Mobile OS platform of the app (for example, "Android"
// or "iOS").
// "MOBILE_OS_VERSION" - Mobile operating system version, e.g. "iOS
// 13.5.1". **Warning:** The dimension is incompatible with
// [ESTIMATED_EARNINGS](#Metric.ENUM_VALUES.ESTIMATED_EARNINGS),
// [OBSERVED_ECPM](#Metric.ENUM_VALUES.OBSERVED_ECPM) metrics.
// "GMA_SDK_VERSION" - GMA SDK version, e.g. "iOS 7.62.0".
// **Warning:** The dimension is incompatible with
// [ESTIMATED_EARNINGS](#Metric.ENUM_VALUES.ESTIMATED_EARNINGS),
// [OBSERVED_ECPM](#Metric.ENUM_VALUES.OBSERVED_ECPM) metrics.
// "APP_VERSION_NAME" - For Android, the app version name can be found
// in versionName in PackageInfo. For iOS, the app version name can be
// found in CFBundleShortVersionString. **Warning:** The dimension is
// incompatible with
// [ESTIMATED_EARNINGS](#Metric.ENUM_VALUES.ESTIMATED_EARNINGS),
// [OBSERVED_ECPM](#Metric.ENUM_VALUES.OBSERVED_ECPM) metrics.
// "SERVING_RESTRICTION" - Restriction mode for ads serving (e.g.
// "Non-personalized ads"). **Warning:** The dimension is incompatible
// with [ESTIMATED_EARNINGS](#Metric.ENUM_VALUES.ESTIMATED_EARNINGS)
// metric.
Dimensions []string `json:"dimensions,omitempty"`
// LocalizationSettings: Localization settings of the report.
LocalizationSettings *LocalizationSettings `json:"localizationSettings,omitempty"`
// MaxReportRows: Maximum number of report data rows to return. If the
// value is not set, the API returns as many rows as possible, up to
// 100000. Acceptable values are 1-100000, inclusive. Values larger than
// 100000 return an error.
MaxReportRows int64 `json:"maxReportRows,omitempty"`
// Metrics: List of metrics of the report. A report must specify at
// least one metric.
//
// Possible values:
// "METRIC_UNSPECIFIED" - Default value for an unset field. Do not
// use.
// "AD_REQUESTS" - The number of requests. The value is an integer.
// "CLICKS" - The number of times a user clicks an ad. The value is an
// integer.
// "ESTIMATED_EARNINGS" - The estimated earnings of the AdMob
// publisher. The currency unit (USD, EUR, or other) of the earning
// metrics are determined by the localization setting for currency. The
// amount is in micros. For example, $6.50 would be represented as
// 6500000. Estimated earnings per mediation group and per ad source
// instance level is supported dating back to October 20, 2019.
// Third-party estimated earnings will show 0 for dates prior to October
// 20, 2019.
// "IMPRESSIONS" - The total number of ads shown to users. The value
// is an integer.
// "IMPRESSION_CTR" - The ratio of clicks over impressions. The value
// is a double precision (approximate) decimal value.
// "MATCHED_REQUESTS" - The number of times ads are returned in
// response to a request. The value is an integer.
// "MATCH_RATE" - The ratio of matched ad requests over the total ad
// requests. The value is a double precision (approximate) decimal
// value.
// "OBSERVED_ECPM" - The third-party ad network's estimated average
// eCPM. The currency unit (USD, EUR, or other) of the earning metrics
// are determined by the localization setting for currency. The amount
// is in micros. For example, $2.30 would be represented as 2300000. The
// estimated average eCPM per mediation group and per ad source instance
// level is supported dating back to October 20, 2019. Third-party
// estimated average eCPM will show 0 for dates prior to October 20,
// 2019.
Metrics []string `json:"metrics,omitempty"`
// SortConditions: Describes the sorting of report rows. The order of
// the condition in the list defines its precedence; the earlier the
// condition, the higher its precedence. If no sort conditions are
// specified, the row ordering is undefined.
SortConditions []*MediationReportSpecSortCondition `json:"sortConditions,omitempty"`
// TimeZone: A report time zone. Accepts an IANA TZ name values, such as
// "America/Los_Angeles." If no time zone is defined, the account
// default takes effect. Check default value by the get account action.
// **Warning:** The "America/Los_Angeles" is the only supported value at
// the moment.
TimeZone string `json:"timeZone,omitempty"`
// ForceSendFields is a list of field names (e.g. "DateRange") 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