-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
authorizedbuyersmarketplace-gen.go
9046 lines (8231 loc) · 339 KB
/
authorizedbuyersmarketplace-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 authorizedbuyersmarketplace provides access to the Authorized Buyers Marketplace API.
//
// For product documentation, see: https://developers.google.com/authorized-buyers/apis/marketplace/reference/rest/
//
// Creating a client
//
// Usage example:
//
// import "google.golang.org/api/authorizedbuyersmarketplace/v1"
// ...
// ctx := context.Background()
// authorizedbuyersmarketplaceService, err := authorizedbuyersmarketplace.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:
//
// authorizedbuyersmarketplaceService, err := authorizedbuyersmarketplace.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, ...)
// authorizedbuyersmarketplaceService, err := authorizedbuyersmarketplace.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))
//
// See https://godoc.org/google.golang.org/api/option/ for details on options.
package authorizedbuyersmarketplace // import "google.golang.org/api/authorizedbuyersmarketplace/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
const apiId = "authorizedbuyersmarketplace:v1"
const apiName = "authorizedbuyersmarketplace"
const apiVersion = "v1"
const basePath = "https://authorizedbuyersmarketplace.googleapis.com/"
const mtlsBasePath = "https://authorizedbuyersmarketplace.mtls.googleapis.com/"
// OAuth2 scopes used by this API.
const (
// See, create, edit, and delete your Authorized Buyers Marketplace
// entities.
AuthorizedBuyersMarketplaceScope = "https://www.googleapis.com/auth/authorized-buyers-marketplace"
)
// NewService creates a new Service.
func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error) {
scopesOption := internaloption.WithDefaultScopes(
"https://www.googleapis.com/auth/authorized-buyers-marketplace",
)
// 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.FinalizedDeals = NewBiddersFinalizedDealsService(s)
return rs
}
type BiddersService struct {
s *Service
FinalizedDeals *BiddersFinalizedDealsService
}
func NewBiddersFinalizedDealsService(s *Service) *BiddersFinalizedDealsService {
rs := &BiddersFinalizedDealsService{s: s}
return rs
}
type BiddersFinalizedDealsService struct {
s *Service
}
func NewBuyersService(s *Service) *BuyersService {
rs := &BuyersService{s: s}
rs.AuctionPackages = NewBuyersAuctionPackagesService(s)
rs.Clients = NewBuyersClientsService(s)
rs.FinalizedDeals = NewBuyersFinalizedDealsService(s)
rs.Proposals = NewBuyersProposalsService(s)
rs.PublisherProfiles = NewBuyersPublisherProfilesService(s)
return rs
}
type BuyersService struct {
s *Service
AuctionPackages *BuyersAuctionPackagesService
Clients *BuyersClientsService
FinalizedDeals *BuyersFinalizedDealsService
Proposals *BuyersProposalsService
PublisherProfiles *BuyersPublisherProfilesService
}
func NewBuyersAuctionPackagesService(s *Service) *BuyersAuctionPackagesService {
rs := &BuyersAuctionPackagesService{s: s}
return rs
}
type BuyersAuctionPackagesService struct {
s *Service
}
func NewBuyersClientsService(s *Service) *BuyersClientsService {
rs := &BuyersClientsService{s: s}
rs.Users = NewBuyersClientsUsersService(s)
return rs
}
type BuyersClientsService struct {
s *Service
Users *BuyersClientsUsersService
}
func NewBuyersClientsUsersService(s *Service) *BuyersClientsUsersService {
rs := &BuyersClientsUsersService{s: s}
return rs
}
type BuyersClientsUsersService struct {
s *Service
}
func NewBuyersFinalizedDealsService(s *Service) *BuyersFinalizedDealsService {
rs := &BuyersFinalizedDealsService{s: s}
return rs
}
type BuyersFinalizedDealsService struct {
s *Service
}
func NewBuyersProposalsService(s *Service) *BuyersProposalsService {
rs := &BuyersProposalsService{s: s}
rs.Deals = NewBuyersProposalsDealsService(s)
return rs
}
type BuyersProposalsService struct {
s *Service
Deals *BuyersProposalsDealsService
}
func NewBuyersProposalsDealsService(s *Service) *BuyersProposalsDealsService {
rs := &BuyersProposalsDealsService{s: s}
return rs
}
type BuyersProposalsDealsService struct {
s *Service
}
func NewBuyersPublisherProfilesService(s *Service) *BuyersPublisherProfilesService {
rs := &BuyersPublisherProfilesService{s: s}
return rs
}
type BuyersPublisherProfilesService struct {
s *Service
}
// AcceptProposalRequest: Request to accept a proposal. Accepting a
// proposal implies acceptance of the publisher terms_and_conditions, if
// any.
type AcceptProposalRequest struct {
// ProposalRevision: The last known client revision number of the
// proposal.
ProposalRevision int64 `json:"proposalRevision,omitempty,string"`
// ForceSendFields is a list of field names (e.g. "ProposalRevision") 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. "ProposalRevision") 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 *AcceptProposalRequest) MarshalJSON() ([]byte, error) {
type NoMethod AcceptProposalRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// ActivateClientRequest: Request message for activating a client.
type ActivateClientRequest struct {
}
// ActivateClientUserRequest: Request message for activating a client
// user.
type ActivateClientUserRequest struct {
}
// AdSize: Represents size of a single ad slot, or a creative.
type AdSize struct {
// Height: The height of the ad slot in pixels. This field will be
// present only when size type is `PIXEL`.
Height int64 `json:"height,omitempty,string"`
// Type: The type of the ad slot size.
//
// Possible values:
// "TYPE_UNSPECIFIED" - A placeholder for an undefined size type.
// "PIXEL" - Ad slot with size specified by height and width in
// pixels.
// "INTERSTITIAL" - Special size to describe an interstitial ad slot.
// "NATIVE" - Native (mobile) ads rendered by the publisher.
// "FLUID" - Fluid size (responsive size) can be resized automatically
// with the change of outside environment.
Type string `json:"type,omitempty"`
// Width: The width of the ad slot in pixels. This field will be present
// only when size type is `PIXEL`.
Width int64 `json:"width,omitempty,string"`
// ForceSendFields is a list of field names (e.g. "Height") 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. "Height") 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 *AdSize) MarshalJSON() ([]byte, error) {
type NoMethod AdSize
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// AddCreativeRequest: Request message for adding creative to be used in
// the bidding process for the finalized deal.
type AddCreativeRequest struct {
// Creative: Name of the creative to add to the finalized deal, in the
// format `buyers/{buyerAccountId}/creatives/{creativeId}`. See
// creative.name.
Creative string `json:"creative,omitempty"`
// ForceSendFields is a list of field names (e.g. "Creative") 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. "Creative") 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 *AddCreativeRequest) MarshalJSON() ([]byte, error) {
type NoMethod AddCreativeRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// AddNoteRequest: Request to add a note.
type AddNoteRequest struct {
// Note: The note to add.
Note *Note `json:"note,omitempty"`
// ForceSendFields is a list of field names (e.g. "Note") 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. "Note") 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 *AddNoteRequest) MarshalJSON() ([]byte, error) {
type NoMethod AddNoteRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// AuctionPackage: Defines a segment of inventory that buyer wants to
// buy. It's created by buyer and could be shared with multiple buyers.
type AuctionPackage struct {
// CreateTime: Output only. Time the auction package was created.
CreateTime string `json:"createTime,omitempty"`
// Creator: Output only. The buyer that created this auction package.
// Format: `buyers/{buyerAccountId}`
Creator string `json:"creator,omitempty"`
// Description: Output only. A description of the auction package.
Description string `json:"description,omitempty"`
// DisplayName: The display_name assigned to the auction package.
DisplayName string `json:"displayName,omitempty"`
// Name: Immutable. The unique identifier for the auction package.
// Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` The
// auction_package_id part of name is sent in the BidRequest to all RTB
// bidders and is returned as deal_id by the bidder in the BidResponse.
Name string `json:"name,omitempty"`
// SubscribedClients: Output only. The list of clients of the current
// buyer that are subscribed to the AuctionPackage. Format:
// `buyers/{buyerAccountId}/clients/{clientAccountId}`
SubscribedClients []string `json:"subscribedClients,omitempty"`
// UpdateTime: Output only. Time the auction package was last updated.
// This value is only increased when this auction package is updated but
// never when a buyer subscribed.
UpdateTime string `json:"updateTime,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "CreateTime") 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. "CreateTime") 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 *AuctionPackage) MarshalJSON() ([]byte, error) {
type NoMethod AuctionPackage
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// BatchUpdateDealsRequest: Request message for batch updating deals.
type BatchUpdateDealsRequest struct {
// Requests: Required. List of request messages to update deals.
Requests []*UpdateDealRequest `json:"requests,omitempty"`
// ForceSendFields is a list of field names (e.g. "Requests") 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. "Requests") 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 *BatchUpdateDealsRequest) MarshalJSON() ([]byte, error) {
type NoMethod BatchUpdateDealsRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// BatchUpdateDealsResponse: Response message for batch updating deals.
type BatchUpdateDealsResponse struct {
// Deals: Deals updated.
Deals []*Deal `json:"deals,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Deals") 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. "Deals") 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 *BatchUpdateDealsResponse) MarshalJSON() ([]byte, error) {
type NoMethod BatchUpdateDealsResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// CancelNegotiationRequest: Request to cancel an ongoing negotiation.
type CancelNegotiationRequest struct {
}
// Client: A client represents an agency, a brand, or an advertiser
// customer of the buyer. Based on the client's role, its client users
// will have varying levels of restricted access to the Marketplace and
// certain other sections of the Authorized Buyers UI.
type Client struct {
// DisplayName: Required. Display name shown to publishers. Must be
// unique for clients without partnerClientId specified. Maximum length
// of 255 characters is allowed.
DisplayName string `json:"displayName,omitempty"`
// Name: Output only. The resource name of the client. Format:
// `buyers/{accountId}/clients/{clientAccountId}`
Name string `json:"name,omitempty"`
// PartnerClientId: Arbitrary unique identifier provided by the buyer.
// This field can be used to associate a client with an identifier in
// the namespace of the buyer, lookup clients by that identifier and
// verify whether an Authorized Buyers account of the client already
// exists. If present, must be unique across all the clients.
PartnerClientId string `json:"partnerClientId,omitempty"`
// Role: Required. The role assigned to the client. Each role implies a
// set of permissions granted to the client.
//
// Possible values:
// "CLIENT_ROLE_UNSPECIFIED" - A placeholder for an undefined client
// role. This value should never be specified in user input for create
// or update method, otherwise an error will be returned.
// "CLIENT_DEAL_VIEWER" - Users associated with this client role can
// only view proposals and deals in the Marketplace UI. They cannot
// negotiate or approve proposals and deals sent from publishers or send
// RFP to publishers.
// "CLIENT_DEAL_NEGOTIATOR" - Users associated with this client role
// can view and negotiate on the proposals and deals in the Marketplace
// UI sent from publishers and send RFP to publishers, but cannot
// approve the proposals and deals by themselves. The buyer can approve
// the proposals and deals on behalf of the client.
// "CLIENT_DEAL_APPROVER" - Users associated with this client role can
// view, negotiate and approve proposals and deals in the Marketplace UI
// and send RFP to publishers.
Role string `json:"role,omitempty"`
// SellerVisible: Whether the client will be visible to sellers.
SellerVisible bool `json:"sellerVisible,omitempty"`
// State: Output only. The state of the client.
//
// Possible values:
// "STATE_UNSPECIFIED" - A placeholder for an undefined client state.
// Should not be used.
// "ACTIVE" - A client that is currently active and allowed to access
// the Authorized Buyers UI.
// "INACTIVE" - A client that is currently inactive and not allowed to
// access the Authorized Buyers UI.
State string `json:"state,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// 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 *Client) MarshalJSON() ([]byte, error) {
type NoMethod Client
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// ClientUser: A user of a client who has restricted access to the
// Marketplace and certain other sections of the Authorized Buyers UI
// based on the role granted to the associated client.
type ClientUser struct {
// Email: Required. The client user's email address that has to be
// unique across all users for the same client.
Email string `json:"email,omitempty"`
// Name: Output only. The resource name of the client user. Format:
// `buyers/{accountId}/clients/{clientAccountId}/users/{userId}`
Name string `json:"name,omitempty"`
// State: Output only. The state of the client user.
//
// Possible values:
// "STATE_UNSPECIFIED" - A placeholder for an undefined user state.
// "INVITED" - A user who was created but hasn't accepted the
// invitation yet, not allowed to access the Authorized Buyers UI.
// "ACTIVE" - A user that is currently active and allowed to access
// the Authorized Buyers UI.
// "INACTIVE" - A user that is currently inactive and not allowed to
// access the Authorized Buyers UI.
State string `json:"state,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Email") 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. "Email") 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 *ClientUser) MarshalJSON() ([]byte, error) {
type NoMethod ClientUser
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Contact: Contains information on how a buyer or seller can be
// reached.
type Contact struct {
// DisplayName: The display_name of the contact.
DisplayName string `json:"displayName,omitempty"`
// Email: Email address for the contact.
Email string `json:"email,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 *Contact) MarshalJSON() ([]byte, error) {
type NoMethod Contact
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// CreativeRequirements: Message captures data about the creatives in
// the deal.
type CreativeRequirements struct {
// CreativeFormat: Output only. The format of the creative, only
// applicable for programmatic guaranteed and preferred deals.
//
// Possible values:
// "CREATIVE_FORMAT_UNSPECIFIED" - A placeholder for an unspecified
// creative format.
// "DISPLAY" - Banner creatives such as image or HTML5 assets.
// "VIDEO" - Video creatives that can be played in a video player.
CreativeFormat string `json:"creativeFormat,omitempty"`
// CreativePreApprovalPolicy: Output only. Specifies the creative
// pre-approval policy.
//
// Possible values:
// "CREATIVE_PRE_APPROVAL_POLICY_UNSPECIFIED" - A placeholder for an
// undefined creative pre-approval policy.
// "SELLER_PRE_APPROVAL_REQUIRED" - The seller needs to approve each
// creative before it can serve.
// "SELLER_PRE_APPROVAL_NOT_REQUIRED" - The seller does not need to
// approve each creative before it can serve.
CreativePreApprovalPolicy string `json:"creativePreApprovalPolicy,omitempty"`
// CreativeSafeFrameCompatibility: Output only. Specifies whether the
// creative is safeFrame compatible.
//
// Possible values:
// "CREATIVE_SAFE_FRAME_COMPATIBILITY_UNSPECIFIED" - A placeholder for
// an undefined creative safe-frame compatibility.
// "COMPATIBLE" - The creatives need to be compatible with the safe
// frame option.
// "INCOMPATIBLE" - The creatives can be incompatible with the safe
// frame option.
CreativeSafeFrameCompatibility string `json:"creativeSafeFrameCompatibility,omitempty"`
// MaxAdDurationMs: Output only. The max duration of the video creative
// in milliseconds. only applicable for deals with video creatives.
MaxAdDurationMs int64 `json:"maxAdDurationMs,omitempty,string"`
// ProgrammaticCreativeSource: Output only. Specifies the creative
// source for programmatic deals. PUBLISHER means creative is provided
// by seller and ADVERTISER means creative is provided by the buyer.
//
// Possible values:
// "PROGRAMMATIC_CREATIVE_SOURCE_UNSPECIFIED" - A placeholder for an
// undefined programmatic creative source.
// "ADVERTISER" - The advertiser provides the creatives.
// "PUBLISHER" - The publisher provides the creatives to be served.
ProgrammaticCreativeSource string `json:"programmaticCreativeSource,omitempty"`
// SkippableAdType: Output only. Skippable video ads allow viewers to
// skip ads after 5 seconds. Only applicable for deals with video
// creatives.
//
// Possible values:
// "SKIPPABLE_AD_TYPE_UNSPECIFIED" - A placeholder for an unspecified
// skippable ad type.
// "SKIPPABLE" - Video ad that can be skipped after 5 seconds. This
// value will appear in RTB bid requests as
// SkippableBidRequestType::REQUIRE_SKIPPABLE.
// "INSTREAM_SELECT" - Video ad that can be skipped after 5 seconds,
// and is counted as engaged view after 30 seconds. The creative is
// hosted on YouTube only, and viewcount of the YouTube video increments
// after the engaged view. This value will appear in RTB bid requests as
// SkippableBidRequestType::REQUIRE_SKIPPABLE.
// "NOT_SKIPPABLE" - This video ad is not skippable. This value will
// appear in RTB bid requests as
// SkippableBidRequestType::BLOCK_SKIPPABLE.
// "ANY" - This video ad can be skipped after 5 seconds or
// not-skippable. This value will appear in RTB bid requests as
// SkippableBidRequestType::ALLOW_SKIPPABLE.
SkippableAdType string `json:"skippableAdType,omitempty"`
// ForceSendFields is a list of field names (e.g. "CreativeFormat") 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. "CreativeFormat") 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 *CreativeRequirements) MarshalJSON() ([]byte, error) {
type NoMethod CreativeRequirements
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// CriteriaTargeting: Generic targeting used for targeting dimensions
// that contains a list of included and excluded numeric IDs. This
// cannot be filtered using list filter syntax.
type CriteriaTargeting struct {
// ExcludedCriteriaIds: A list of numeric IDs to be excluded.
ExcludedCriteriaIds googleapi.Int64s `json:"excludedCriteriaIds,omitempty"`
// TargetedCriteriaIds: A list of numeric IDs to be included.
TargetedCriteriaIds googleapi.Int64s `json:"targetedCriteriaIds,omitempty"`
// ForceSendFields is a list of field names (e.g. "ExcludedCriteriaIds")
// 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. "ExcludedCriteriaIds") 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 *CriteriaTargeting) MarshalJSON() ([]byte, error) {
type NoMethod CriteriaTargeting
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// DayPart: Defines targeting for a period of time on a specific week
// day.
type DayPart struct {
// DayOfWeek: Day of week for the period.
//
// Possible values:
// "DAY_OF_WEEK_UNSPECIFIED" - The day of the week is unspecified.
// "MONDAY" - Monday
// "TUESDAY" - Tuesday
// "WEDNESDAY" - Wednesday
// "THURSDAY" - Thursday
// "FRIDAY" - Friday
// "SATURDAY" - Saturday
// "SUNDAY" - Sunday
DayOfWeek string `json:"dayOfWeek,omitempty"`
// EndTime: Hours in 24 hour time between 0 and 24, inclusive. Note: 24
// is logically equivalent to 0, but is supported since in some cases
// there may need to be differentiation made between midnight on one day
// and midnight on the next day. Accepted values for minutes are [0, 15,
// 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds
// and nanos are ignored.
EndTime *TimeOfDay `json:"endTime,omitempty"`
// StartTime: Hours in 24 hour time between 0 and 24, inclusive. Note:
// 24 is logically equivalent to 0, but is supported since in some cases
// there may need to be differentiation made between midnight on one day
// and midnight on the next day. Accepted values for minutes are [0, 15,
// 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds
// and nanos are ignored.
StartTime *TimeOfDay `json:"startTime,omitempty"`
// ForceSendFields is a list of field names (e.g. "DayOfWeek") 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. "DayOfWeek") 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 *DayPart) MarshalJSON() ([]byte, error) {
type NoMethod DayPart
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// DayPartTargeting: Represents Daypart targeting.
type DayPartTargeting struct {
// DayParts: The targeted weekdays and times
DayParts []*DayPart `json:"dayParts,omitempty"`
// TimeZoneType: The time zone type of the day parts
//
// Possible values:
// "TIME_ZONE_TYPE_UNSPECIFIED" - Default value. This field is unused.
// "SELLER" - The publisher's time zone
// "USER" - The user's time zone
TimeZoneType string `json:"timeZoneType,omitempty"`
// ForceSendFields is a list of field names (e.g. "DayParts") 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. "DayParts") 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 *DayPartTargeting) MarshalJSON() ([]byte, error) {
type NoMethod DayPartTargeting
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// DeactivateClientRequest: Request message for disabling a client.
type DeactivateClientRequest struct {
}
// DeactivateClientUserRequest: Request message for deactivating a
// client user.
type DeactivateClientUserRequest struct {
}
// Deal: A deal represents a segment of inventory for displaying ads
// that contains the terms and targeting information that is used for
// serving as well as the deal stats and status. Note: A proposal may
// contain multiple deals.
type Deal struct {
// BilledBuyer: Output only. When the client field is populated, this
// field refers to the buyer who creates and manages the client buyer
// and gets billed on behalf of the client buyer; when the buyer field
// is populated, this field is the same value as buyer. Format :
// `buyers/{buyerAccountId}`
BilledBuyer string `json:"billedBuyer,omitempty"`
// Buyer: Output only. Refers to a buyer in The Realtime-bidding API.
// Format: `buyers/{buyerAccountId}`
Buyer string `json:"buyer,omitempty"`
// Client: Output only. Refers to a Client. Format:
// `buyers/{buyerAccountId}/clients/{clientAccountid}`
Client string `json:"client,omitempty"`
// CreateTime: Output only. The time of the deal creation.
CreateTime string `json:"createTime,omitempty"`
// CreativeRequirements: Output only. Metadata about the creatives of
// this deal.
CreativeRequirements *CreativeRequirements `json:"creativeRequirements,omitempty"`
// DealType: Output only. Type of deal.
//
// Possible values:
// "DEAL_TYPE_UNSPECIFIED" - Default, unspecified deal type.
// "PREFERRED_DEAL" - Preferred deals.
// "PRIVATE_AUCTION" - Private auction deals.
// "PROGRAMMATIC_GUARANTEED" - Programmatic guaranteed deals.
DealType string `json:"dealType,omitempty"`
// DeliveryControl: Output only. Specifies the pacing set by the
// publisher.
DeliveryControl *DeliveryControl `json:"deliveryControl,omitempty"`
// Description: Output only. Free text description for the deal terms.
Description string `json:"description,omitempty"`
// DisplayName: Output only. The name of the deal. Maximum length of 255
// unicode characters is allowed. Control characters are not allowed.
// Buyers cannot update this field. Note: Not to be confused with name,
// which is a unique identifier of the deal.
DisplayName string `json:"displayName,omitempty"`
// EstimatedGrossSpend: Specified by buyers in request for proposal
// (RFP) to notify publisher the total estimated spend for the proposal.
// Publishers will receive this information and send back proposed deals
// accordingly.
EstimatedGrossSpend *Money `json:"estimatedGrossSpend,omitempty"`
// FlightEndTime: Proposed flight end time of the deal. This will
// generally be stored in a granularity of a second. A value is not
// necessary for Private Auction deals.
FlightEndTime string `json:"flightEndTime,omitempty"`
// FlightStartTime: Proposed flight start time of the deal. This will
// generally be stored in the granularity of one second since deal
// serving starts at seconds boundary. Any time specified with more
// granularity (for example, in milliseconds) will be truncated towards
// the start of time in seconds.
FlightStartTime string `json:"flightStartTime,omitempty"`
// Name: Immutable. The unique identifier of the deal. Auto-generated by
// the server when a deal is created. Format:
// buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
Name string `json:"name,omitempty"`
// PreferredDealTerms: The terms for preferred deals.
PreferredDealTerms *PreferredDealTerms `json:"preferredDealTerms,omitempty"`
// PrivateAuctionTerms: The terms for private auction deals.
PrivateAuctionTerms *PrivateAuctionTerms `json:"privateAuctionTerms,omitempty"`