/
realtimebidding-gen.go
9307 lines (8491 loc) · 354 KB
/
realtimebidding-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 2023 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 realtimebidding provides access to the Real-time Bidding API.
//
// For product documentation, see: https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/
//
// # Creating a client
//
// Usage example:
//
// import "google.golang.org/api/realtimebidding/v1"
// ...
// ctx := context.Background()
// realtimebiddingService, err := realtimebidding.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:
//
// realtimebiddingService, err := realtimebidding.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, ...)
// realtimebiddingService, err := realtimebidding.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))
//
// See https://godoc.org/google.golang.org/api/option/ for details on options.
package realtimebidding // import "google.golang.org/api/realtimebidding/v1"
import (
"bytes"
"context"
"encoding/json"
"errors"
"fmt"
"io"
"net/http"
"net/url"
"strconv"
"strings"
googleapi "google.golang.org/api/googleapi"
internal "google.golang.org/api/internal"
gensupport "google.golang.org/api/internal/gensupport"
option "google.golang.org/api/option"
internaloption "google.golang.org/api/option/internaloption"
htransport "google.golang.org/api/transport/http"
)
// Always reference these packages, just in case the auto-generated code
// below doesn't.
var _ = bytes.NewBuffer
var _ = strconv.Itoa
var _ = fmt.Sprintf
var _ = json.NewDecoder
var _ = io.Copy
var _ = url.Parse
var _ = gensupport.MarshalJSON
var _ = googleapi.Version
var _ = errors.New
var _ = strings.Replace
var _ = context.Canceled
var _ = internaloption.WithDefaultEndpoint
var _ = internal.Version
const apiId = "realtimebidding:v1"
const apiName = "realtimebidding"
const apiVersion = "v1"
const basePath = "https://realtimebidding.googleapis.com/"
const mtlsBasePath = "https://realtimebidding.mtls.googleapis.com/"
// OAuth2 scopes used by this API.
const (
// See, create, edit, and delete your Authorized Buyers and Open Bidding
// account entities
RealtimeBiddingScope = "https://www.googleapis.com/auth/realtime-bidding"
)
// NewService creates a new Service.
func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error) {
scopesOption := internaloption.WithDefaultScopes(
"https://www.googleapis.com/auth/realtime-bidding",
)
// 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.Bidders = NewBiddersService(s)
s.Buyers = NewBuyersService(s)
return s, nil
}
type Service struct {
client *http.Client
BasePath string // API endpoint base URL
UserAgent string // optional additional User-Agent fragment
Bidders *BiddersService
Buyers *BuyersService
}
func (s *Service) userAgent() string {
if s.UserAgent == "" {
return googleapi.UserAgent
}
return googleapi.UserAgent + " " + s.UserAgent
}
func NewBiddersService(s *Service) *BiddersService {
rs := &BiddersService{s: s}
rs.Creatives = NewBiddersCreativesService(s)
rs.Endpoints = NewBiddersEndpointsService(s)
rs.PretargetingConfigs = NewBiddersPretargetingConfigsService(s)
rs.PublisherConnections = NewBiddersPublisherConnectionsService(s)
return rs
}
type BiddersService struct {
s *Service
Creatives *BiddersCreativesService
Endpoints *BiddersEndpointsService
PretargetingConfigs *BiddersPretargetingConfigsService
PublisherConnections *BiddersPublisherConnectionsService
}
func NewBiddersCreativesService(s *Service) *BiddersCreativesService {
rs := &BiddersCreativesService{s: s}
return rs
}
type BiddersCreativesService struct {
s *Service
}
func NewBiddersEndpointsService(s *Service) *BiddersEndpointsService {
rs := &BiddersEndpointsService{s: s}
return rs
}
type BiddersEndpointsService struct {
s *Service
}
func NewBiddersPretargetingConfigsService(s *Service) *BiddersPretargetingConfigsService {
rs := &BiddersPretargetingConfigsService{s: s}
return rs
}
type BiddersPretargetingConfigsService struct {
s *Service
}
func NewBiddersPublisherConnectionsService(s *Service) *BiddersPublisherConnectionsService {
rs := &BiddersPublisherConnectionsService{s: s}
return rs
}
type BiddersPublisherConnectionsService struct {
s *Service
}
func NewBuyersService(s *Service) *BuyersService {
rs := &BuyersService{s: s}
rs.Creatives = NewBuyersCreativesService(s)
rs.UserLists = NewBuyersUserListsService(s)
return rs
}
type BuyersService struct {
s *Service
Creatives *BuyersCreativesService
UserLists *BuyersUserListsService
}
func NewBuyersCreativesService(s *Service) *BuyersCreativesService {
rs := &BuyersCreativesService{s: s}
return rs
}
type BuyersCreativesService struct {
s *Service
}
func NewBuyersUserListsService(s *Service) *BuyersUserListsService {
rs := &BuyersUserListsService{s: s}
return rs
}
type BuyersUserListsService struct {
s *Service
}
// ActivatePretargetingConfigRequest: A request to activate a
// pretargeting configuration. Sets the configuration's state to ACTIVE.
type ActivatePretargetingConfigRequest struct {
}
// AdTechnologyProviders: The list of detected Ad Technology Providers
// for this creative. Bids placed for inventory that will serve to EEA
// or UK users are expected to comply with GDPR requirements. You must
// ensure that the creatives used in such bids should contain only user
// consented ad technology providers as indicated in the bid request.
// Google reserves the right to filter non-compliant bids. User
// consented ad technology providers can be found in the Google Protocol
// (https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto)
// with the `BidRequest.adslot.consented_providers_settings` field, and
// can be found as an OpenRTB extension
// (https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto)
// with the `BidRequest.user.ext.consented_providers_settings` and
// `BidRequest.user.ext.consent` fields. See
// https://support.google.com/authorizedbuyers/answer/9789378 for
// additional information about the Google TCF v2 integration.
type AdTechnologyProviders struct {
// DetectedGvlIds: The detected IAB Global Vendor List (GVL) IDs for
// this creative. See the IAB Global Vendor List at
// https://vendor-list.consensu.org/v2/vendor-list.json for details
// about the vendors.
DetectedGvlIds googleapi.Int64s `json:"detectedGvlIds,omitempty"`
// DetectedProviderIds: The detected Google Ad Tech Providers (ATP)
// (https://support.google.com/admanager/answer/9012903) for this
// creative. See
// https://storage.googleapis.com/adx-rtb-dictionaries/providers.csv for
// mapping of provider ID to provided name, a privacy policy URL, and a
// list of domains which can be attributed to the provider.
DetectedProviderIds googleapi.Int64s `json:"detectedProviderIds,omitempty"`
// UnidentifiedProviderDomains: Domains of detected unidentified ad
// technology providers (if any). You must ensure that the creatives
// used in bids placed for inventory that will serve to EEA or UK users
// does not contain unidentified ad technology providers. Google
// reserves the right to filter non-compliant bids.
UnidentifiedProviderDomains []string `json:"unidentifiedProviderDomains,omitempty"`
// ForceSendFields is a list of field names (e.g. "DetectedGvlIds") 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. "DetectedGvlIds") 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 *AdTechnologyProviders) MarshalJSON() ([]byte, error) {
type NoMethod AdTechnologyProviders
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// AddTargetedAppsRequest: A request to start targeting the provided app
// IDs in a specific pretargeting configuration. The pretargeting
// configuration itself specifies how these apps are targeted. in
// PretargetingConfig.appTargeting.mobileAppTargeting.
type AddTargetedAppsRequest struct {
// AppIds: A list of app IDs to target in the pretargeting
// configuration. These values will be added to the list of targeted app
// IDs in PretargetingConfig.appTargeting.mobileAppTargeting.values.
AppIds []string `json:"appIds,omitempty"`
// TargetingMode: Required. The targeting mode that should be applied to
// the list of app IDs. If there are existing targeted app IDs, must be
// equal to the existing
// PretargetingConfig.appTargeting.mobileAppTargeting.targetingMode or a
// 400 bad request error will be returned.
//
// Possible values:
// "TARGETING_MODE_UNSPECIFIED" - Placeholder for undefined targeting
// mode.
// "INCLUSIVE" - The inclusive list type. Inventory must match an item
// in this list to be targeted.
// "EXCLUSIVE" - The exclusive list type. Inventory must not match any
// item in this list to be targeted.
TargetingMode string `json:"targetingMode,omitempty"`
// ForceSendFields is a list of field names (e.g. "AppIds") 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. "AppIds") 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 *AddTargetedAppsRequest) MarshalJSON() ([]byte, error) {
type NoMethod AddTargetedAppsRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// AddTargetedPublishersRequest: A request to start targeting the
// provided publishers in a specific pretargeting configuration. The
// pretargeting configuration itself specifies how these publishers are
// targeted in PretargetingConfig.publisherTargeting.
type AddTargetedPublishersRequest struct {
// PublisherIds: A list of publisher IDs to target in the pretargeting
// configuration. These values will be added to the list of targeted
// publisher IDs in PretargetingConfig.publisherTargeting.values.
// Publishers are identified by their publisher ID from ads.txt /
// app-ads.txt. See https://iabtechlab.com/ads-txt/ and
// https://iabtechlab.com/app-ads-txt/ for more details.
PublisherIds []string `json:"publisherIds,omitempty"`
// TargetingMode: Required. The targeting mode that should be applied to
// the list of publisher IDs. If are existing publisher IDs, must be
// equal to the existing
// PretargetingConfig.publisherTargeting.targetingMode or a 400 bad
// request error will be returned.
//
// Possible values:
// "TARGETING_MODE_UNSPECIFIED" - Placeholder for undefined targeting
// mode.
// "INCLUSIVE" - The inclusive list type. Inventory must match an item
// in this list to be targeted.
// "EXCLUSIVE" - The exclusive list type. Inventory must not match any
// item in this list to be targeted.
TargetingMode string `json:"targetingMode,omitempty"`
// ForceSendFields is a list of field names (e.g. "PublisherIds") 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. "PublisherIds") 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 *AddTargetedPublishersRequest) MarshalJSON() ([]byte, error) {
type NoMethod AddTargetedPublishersRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// AddTargetedSitesRequest: A request to start targeting the provided
// sites in a specific pretargeting configuration. The pretargeting
// configuration itself specifies how these sites are targeted in
// PretargetingConfig.webTargeting.
type AddTargetedSitesRequest struct {
// Sites: A list of site URLs to target in the pretargeting
// configuration. These values will be added to the list of targeted
// URLs in PretargetingConfig.webTargeting.values.
Sites []string `json:"sites,omitempty"`
// TargetingMode: Required. The targeting mode that should be applied to
// the list of site URLs. If there are existing targeted sites, must be
// equal to the existing PretargetingConfig.webTargeting.targetingMode
// or a 400 bad request error will be returned.
//
// Possible values:
// "TARGETING_MODE_UNSPECIFIED" - Placeholder for undefined targeting
// mode.
// "INCLUSIVE" - The inclusive list type. Inventory must match an item
// in this list to be targeted.
// "EXCLUSIVE" - The exclusive list type. Inventory must not match any
// item in this list to be targeted.
TargetingMode string `json:"targetingMode,omitempty"`
// ForceSendFields is a list of field names (e.g. "Sites") 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. "Sites") 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 *AddTargetedSitesRequest) MarshalJSON() ([]byte, error) {
type NoMethod AddTargetedSitesRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// AdvertiserAndBrand: Detected advertiser and brand information.
type AdvertiserAndBrand struct {
// AdvertiserId: See
// https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt
// for the list of possible values. Can be used to filter the response
// of the creatives.list method.
AdvertiserId int64 `json:"advertiserId,omitempty,string"`
// AdvertiserName: Advertiser name. Can be used to filter the response
// of the creatives.list method.
AdvertiserName string `json:"advertiserName,omitempty"`
// BrandId: Detected brand ID or zero if no brand has been detected. See
// https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt for
// the list of possible values. Can be used to filter the response of
// the creatives.list method.
BrandId int64 `json:"brandId,omitempty,string"`
// BrandName: Brand name. Can be used to filter the response of the
// creatives.list method.
BrandName string `json:"brandName,omitempty"`
// ForceSendFields is a list of field names (e.g. "AdvertiserId") 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. "AdvertiserId") 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 *AdvertiserAndBrand) MarshalJSON() ([]byte, error) {
type NoMethod AdvertiserAndBrand
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// AppTargeting: A subset of app inventory to target. Bid requests that
// match criteria in at least one of the specified dimensions will be
// sent.
type AppTargeting struct {
// MobileAppCategoryTargeting: Lists of included and excluded mobile app
// categories as defined in
// https://developers.google.com/adwords/api/docs/appendix/mobileappcategories.csv.
MobileAppCategoryTargeting *NumericTargetingDimension `json:"mobileAppCategoryTargeting,omitempty"`
// MobileAppTargeting: Targeted app IDs. App IDs can refer to those
// found in an app store or ones that are not published in an app store.
// A maximum of 30,000 app IDs can be targeted.
MobileAppTargeting *StringTargetingDimension `json:"mobileAppTargeting,omitempty"`
// ForceSendFields is a list of field names (e.g.
// "MobileAppCategoryTargeting") 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.
// "MobileAppCategoryTargeting") 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 *AppTargeting) MarshalJSON() ([]byte, error) {
type NoMethod AppTargeting
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// BatchApprovePublisherConnectionsRequest: A request to approve a batch
// of publisher connections.
type BatchApprovePublisherConnectionsRequest struct {
// Names: Required. The names of the publishers with which connections
// will be approved. In the pattern
// `bidders/{bidder}/publisherConnections/{publisher}` where `{bidder}`
// is the account ID of the bidder, and `{publisher}` is the
// ads.txt/app-ads.txt publisher ID.
Names []string `json:"names,omitempty"`
// ForceSendFields is a list of field names (e.g. "Names") 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. "Names") 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 *BatchApprovePublisherConnectionsRequest) MarshalJSON() ([]byte, error) {
type NoMethod BatchApprovePublisherConnectionsRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// BatchApprovePublisherConnectionsResponse: A response for the request
// to approve a batch of publisher connections.
type BatchApprovePublisherConnectionsResponse struct {
// PublisherConnections: The publisher connections that have been
// approved.
PublisherConnections []*PublisherConnection `json:"publisherConnections,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g.
// "PublisherConnections") 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. "PublisherConnections") 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 *BatchApprovePublisherConnectionsResponse) MarshalJSON() ([]byte, error) {
type NoMethod BatchApprovePublisherConnectionsResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// BatchRejectPublisherConnectionsRequest: A request to reject a batch
// of publisher connections.
type BatchRejectPublisherConnectionsRequest struct {
// Names: Required. The names of the publishers with whom connection
// will be rejected. In the pattern
// `bidders/{bidder}/publisherConnections/{publisher}` where `{bidder}`
// is the account ID of the bidder, and `{publisher}` is the
// ads.txt/app-ads.txt publisher ID.
Names []string `json:"names,omitempty"`
// ForceSendFields is a list of field names (e.g. "Names") 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. "Names") 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 *BatchRejectPublisherConnectionsRequest) MarshalJSON() ([]byte, error) {
type NoMethod BatchRejectPublisherConnectionsRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// BatchRejectPublisherConnectionsResponse: A response for the request
// to reject a batch of publisher connections.
type BatchRejectPublisherConnectionsResponse struct {
// PublisherConnections: The publisher connections that have been
// rejected.
PublisherConnections []*PublisherConnection `json:"publisherConnections,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g.
// "PublisherConnections") 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. "PublisherConnections") 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 *BatchRejectPublisherConnectionsResponse) MarshalJSON() ([]byte, error) {
type NoMethod BatchRejectPublisherConnectionsResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Bidder: Bidder settings.
type Bidder struct {
// BypassNonguaranteedDealsPretargeting: Output only. An option to
// bypass pretargeting for private auctions and preferred deals. When
// true, bid requests from these nonguaranteed deals will always be
// sent. When false, bid requests will be subject to regular
// pretargeting configurations. Programmatic Guaranteed deals will
// always be sent to the bidder, regardless of the value for this flag.
// Auction packages are not impacted by this value and are subject to
// the regular pretargeting configurations.
BypassNonguaranteedDealsPretargeting bool `json:"bypassNonguaranteedDealsPretargeting,omitempty"`
// CookieMatchingNetworkId: Output only. The buyer's network ID used for
// cookie matching. This ID corresponds to the `google_nid` parameter in
// the URL used in cookie match requests. Refer to
// https://developers.google.com/authorized-buyers/rtb/cookie-guide for
// further information.
CookieMatchingNetworkId string `json:"cookieMatchingNetworkId,omitempty"`
// CookieMatchingUrl: Output only. The base URL used in cookie match
// requests. Refer to
// https://developers.google.com/authorized-buyers/rtb/cookie-guide for
// further information.
CookieMatchingUrl string `json:"cookieMatchingUrl,omitempty"`
// DealsBillingId: Output only. The billing ID for the deals
// pretargeting config. This billing ID is sent on the bid request for
// guaranteed and nonguaranteed deals matched in pretargeting.
DealsBillingId string `json:"dealsBillingId,omitempty"`
// Name: Output only. Name of the bidder resource that must follow the
// pattern `bidders/{bidderAccountId}`, where `{bidderAccountId}` is the
// account ID of the bidder whose information is to be received. One can
// get their account ID on the Authorized Buyers or Open Bidding UI, or
// by contacting their Google account manager.
Name string `json:"name,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g.
// "BypassNonguaranteedDealsPretargeting") 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.
// "BypassNonguaranteedDealsPretargeting") 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 *Bidder) MarshalJSON() ([]byte, error) {
type NoMethod Bidder
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Buyer: RTB Buyer account information.
type Buyer struct {
// ActiveCreativeCount: Output only. The number of creatives that this
// buyer submitted through the API or bid with in the last 30 days. This
// is counted against the maximum number of active creatives.
ActiveCreativeCount int64 `json:"activeCreativeCount,omitempty,string"`
// Bidder: Output only. The name of the bidder resource that is
// responsible for receiving bidding traffic for this account. The
// bidder name must follow the pattern `bidders/{bidderAccountId}`,
// where `{bidderAccountId}` is the account ID of the bidder receiving
// traffic for this buyer.
Bidder string `json:"bidder,omitempty"`
// BillingIds: Output only. A list of billing IDs associated with this
// account. These IDs appear on: 1. A bid request, to signal which
// buyers are eligible to bid on a given opportunity, and which
// pretargeting configurations were matched for each eligible buyer. 2.
// The bid response, to attribute a winning impression to a specific
// account for billing, reporting, policy and publisher block
// enforcement.
BillingIds []string `json:"billingIds,omitempty"`
// DisplayName: Output only. The diplay name associated with this buyer
// account, as visible to sellers.
DisplayName string `json:"displayName,omitempty"`
// MaximumActiveCreativeCount: Output only. The maximum number of active
// creatives that this buyer can have.
MaximumActiveCreativeCount int64 `json:"maximumActiveCreativeCount,omitempty,string"`
// Name: Output only. Name of the buyer resource that must follow the
// pattern `buyers/{buyerAccountId}`, where `{buyerAccountId}` is the
// account ID of the buyer account whose information is to be received.
// One can get their account ID on the Authorized Buyers or Open Bidding
// UI, or by contacting their Google account manager.
Name string `json:"name,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "ActiveCreativeCount")
// 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. "ActiveCreativeCount") 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 *Buyer) MarshalJSON() ([]byte, error) {
type NoMethod Buyer
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// CloseUserListRequest: A request to close a specified user list.
type CloseUserListRequest struct {
}
// Creative: A creative and its classification data.
type Creative struct {
// AccountId: Output only. ID of the buyer account that this creative is
// owned by. Can be used to filter the response of the creatives.list
// method with equality and inequality check.
AccountId int64 `json:"accountId,omitempty,string"`
// AdChoicesDestinationUrl: The link to AdChoices destination page. This
// is only supported for native ads.
AdChoicesDestinationUrl string `json:"adChoicesDestinationUrl,omitempty"`
// AdvertiserName: The name of the company being advertised in the
// creative. Can be used to filter the response of the creatives.list
// method.
AdvertiserName string `json:"advertiserName,omitempty"`
// AgencyId: The agency ID for this creative.
AgencyId int64 `json:"agencyId,omitempty,string"`
// ApiUpdateTime: Output only. The last update timestamp of the creative
// through the API.
ApiUpdateTime string `json:"apiUpdateTime,omitempty"`
// CreativeFormat: Output only. The format of this creative. Can be used
// to filter the response of the creatives.list method.
//
// Possible values:
// "CREATIVE_FORMAT_UNSPECIFIED" - The format is unknown.
// "HTML" - HTML creative.
// "VIDEO" - Video creative.
// "NATIVE" - Native creative.
CreativeFormat string `json:"creativeFormat,omitempty"`
// CreativeId: Buyer-specific creative ID that references this creative
// in bid responses. This field is Ignored in update operations. Can be
// used to filter the response of the creatives.list method. The maximum
// length of the creative ID is 128 bytes.
CreativeId string `json:"creativeId,omitempty"`
// CreativeServingDecision: Output only. Top level status and detected
// attributes of a creative (for example domain, language, advertiser,
// product category, etc.) that affect whether (status) and where
// (context) a creative will be allowed to serve.
CreativeServingDecision *CreativeServingDecision `json:"creativeServingDecision,omitempty"`
// DealIds: Output only. IDs of all of the deals with which this
// creative has been used in bidding. Can be used to filter the response
// of the creatives.list method.
DealIds []string `json:"dealIds,omitempty"`
// DeclaredAttributes: All declared attributes for the ads that may be
// shown from this creative. Can be used to filter the response of the
// creatives.list method. If the `excluded_attribute` field of a bid
// request
// (https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto")
// contains one of the attributes that were declared or detected for a
// given creative, and a bid is submitted with that creative, the bid
// will be filtered before the auction.
//
// Possible values:
// "ATTRIBUTE_UNSPECIFIED" - Do not use. This is a placeholder value
// only.
// "IMAGE_RICH_MEDIA" - The creative is of type image/rich media. For
// pretargeting.
// "ADOBE_FLASH_FLV" - The creative is of video type Adobe Flash FLV.
// For pretargeting.
// "IS_TAGGED" - The creative is tagged.
// "IS_COOKIE_TARGETED" - The creative is cookie targeted.
// "IS_USER_INTEREST_TARGETED" - The creative is user interest
// targeted.
// "EXPANDING_DIRECTION_NONE" - The creative does not expand.
// "EXPANDING_DIRECTION_UP" - The creative expands up.
// "EXPANDING_DIRECTION_DOWN" - The creative expands down.
// "EXPANDING_DIRECTION_LEFT" - The creative expands left.
// "EXPANDING_DIRECTION_RIGHT" - The creative expands right.
// "EXPANDING_DIRECTION_UP_LEFT" - The creative expands up and left.
// "EXPANDING_DIRECTION_UP_RIGHT" - The creative expands up and right.
// "EXPANDING_DIRECTION_DOWN_LEFT" - The creative expands down and
// left.
// "EXPANDING_DIRECTION_DOWN_RIGHT" - The creative expands down and
// right.
// "CREATIVE_TYPE_HTML" - The creative type is HTML.
// "CREATIVE_TYPE_VAST_VIDEO" - The creative type is VAST video.
// "EXPANDING_DIRECTION_UP_OR_DOWN" - The creative expands up or down.
// "EXPANDING_DIRECTION_LEFT_OR_RIGHT" - The creative expands left or
// right.
// "EXPANDING_DIRECTION_ANY_DIAGONAL" - The creative expands on any
// diagonal.
// "EXPANDING_ACTION_ROLLOVER_TO_EXPAND" - The creative expands when
// rolled over.
// "INSTREAM_VAST_VIDEO_TYPE_VPAID_FLASH" - The instream vast video
// type is vpaid flash.
// "RICH_MEDIA_CAPABILITY_TYPE_MRAID" - The creative is MRAID.
// "RICH_MEDIA_CAPABILITY_TYPE_FLASH" - The creative is Flash.
// "RICH_MEDIA_CAPABILITY_TYPE_HTML5" - The creative is HTML5.
// "SKIPPABLE_INSTREAM_VIDEO" - The creative has an instream VAST
// video type of skippable instream video. For pretargeting.
// "RICH_MEDIA_CAPABILITY_TYPE_SSL" - The creative is SSL.
// "RICH_MEDIA_CAPABILITY_TYPE_NON_SSL" - The creative is non-SSL.
// "RICH_MEDIA_CAPABILITY_TYPE_INTERSTITIAL" - The creative is an
// interstitial.
// "NON_SKIPPABLE_INSTREAM_VIDEO" - The creative has an instream VAST
// video type of non-skippable instream video. For pretargeting.
// "NATIVE_ELIGIBILITY_ELIGIBLE" - The creative is eligible for
// native.
// "NON_VPAID" - The creative has an instream VAST video type of
// non-VPAID. For pretargeting.
// "NATIVE_ELIGIBILITY_NOT_ELIGIBLE" - The creative is not eligible
// for native.
// "ANY_INTERSTITIAL" - The creative has an interstitial size of any
// interstitial. For pretargeting.
// "NON_INTERSTITIAL" - The creative has an interstitial size of non
// interstitial. For pretargeting.
// "IN_BANNER_VIDEO" - The video type is in-banner video.
// "RENDERING_SIZELESS_ADX" - The creative can dynamically resize to
// fill a variety of slot sizes.
// "OMSDK_1_0" - The open measurement SDK is supported.
DeclaredAttributes []string `json:"declaredAttributes,omitempty"`
// DeclaredClickThroughUrls: The set of declared destination URLs for
// the creative. Can be used to filter the response of the
// creatives.list method.
DeclaredClickThroughUrls []string `json:"declaredClickThroughUrls,omitempty"`
// DeclaredRestrictedCategories: All declared restricted categories for
// the ads that may be shown from this creative. Can be used to filter
// the response of the creatives.list method.
//
// Possible values:
// "RESTRICTED_CATEGORY_UNSPECIFIED" - Default value that should never
// be used.
// "ALCOHOL" - The alcohol restricted category.
DeclaredRestrictedCategories []string `json:"declaredRestrictedCategories,omitempty"`
// DeclaredVendorIds: IDs for the declared ad technology vendors that
// may be used by this creative. See
// https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for
// possible values. Can be used to filter the response of the
// creatives.list method.
DeclaredVendorIds []int64 `json:"declaredVendorIds,omitempty"`
// Html: An HTML creative.
Html *HtmlContent `json:"html,omitempty"`
// ImpressionTrackingUrls: The set of URLs to be called to record an
// impression.
ImpressionTrackingUrls []string `json:"impressionTrackingUrls,omitempty"`
// Name: Output only. Name of the creative. Follows the pattern
// `buyers/{buyer}/creatives/{creative}`, where `{buyer}` represents the
// account ID of the buyer who owns the creative, and `{creative}` is
// the buyer-specific creative ID that references this creative in the
// bid response.
Name string `json:"name,omitempty"`
// Native: A native creative.
Native *NativeContent `json:"native,omitempty"`
// RenderUrl: Experimental field that can be used during the FLEDGE
// Origin Trial (/authorized-buyers/rtb/fledge-origin-trial). The URL to
// fetch an interest group ad used in TURTLEDOVE on-device auction
// (https://github.com/WICG/turtledove/blob/main/FLEDGE.md#1-browsers-record-interest-groups").
// This should be unique among all creatives for a given `accountId`.
// This URL should be the same as the URL returned by generateBid()
// (https://github.com/WICG/turtledove/blob/main/FLEDGE.md#32-on-device-bidding).
RenderUrl string `json:"renderUrl,omitempty"`
// RestrictedCategories: All restricted categories for the ads that may
// be shown from this creative.
//
// Possible values:
// "RESTRICTED_CATEGORY_UNSPECIFIED" - Default value that should never
// be used.
// "ALCOHOL" - The alcohol restricted category.
RestrictedCategories []string `json:"restrictedCategories,omitempty"`
// Version: Output only. The version of the creative. Version for a new
// creative is 1 and it increments during subsequent creative updates.
Version int64 `json:"version,omitempty"`
// Video: A video creative.
Video *VideoContent `json:"video,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "AccountId") 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. "AccountId") to include in
// API requests with the JSON null value. By default, fields with empty