@maxim_mazurok/gapi.client.adexchangebuyer2-v2beta1 0.0.20220811

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/index.d.ts ADDED
@@ -0,0 +1,4209 @@
1
+ /* Type definitions for non-npm package Ad Exchange Buyer API II v2beta1 0.0 */
2
+ // Project: https://developers.google.com/authorized-buyers/apis/reference/rest/
3
+ // Definitions by: Maxim Mazurok <https://github.com/Maxim-Mazurok>
4
+ // Nick Amoscato <https://github.com/namoscato>
5
+ // Declan Vong <https://github.com/declanvong>
6
+ // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
7
+ // TypeScript Version: 2.8
8
+
9
+ // IMPORTANT
10
+ // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
11
+ // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
12
+ // Generated from: https://adexchangebuyer.googleapis.com/$discovery/rest?version=v2beta1
13
+ // Revision: 20220811
14
+
15
+ /// <reference types="gapi.client" />
16
+
17
+ declare namespace gapi.client {
18
+ /** Load Ad Exchange Buyer API II v2beta1 */
19
+ function load(urlOrObject: "https://adexchangebuyer.googleapis.com/$discovery/rest?version=v2beta1"): Promise<void>;
20
+ /** @deprecated Please load APIs with discovery documents. */
21
+ function load(name: "adexchangebuyer2", version: "v2beta1"): Promise<void>;
22
+ /** @deprecated Please load APIs with discovery documents. */
23
+ function load(name: "adexchangebuyer2", version: "v2beta1", callback: () => any): void;
24
+
25
+ namespace adexchangebuyer2 {
26
+ interface AbsoluteDateRange {
27
+ /** The end date of the range (inclusive). Must be within the 30 days leading up to current date, and must be equal to or after start_date. */
28
+ endDate?: Date;
29
+ /** The start date of the range (inclusive). Must be within the 30 days leading up to current date, and must be equal to or before end_date. */
30
+ startDate?: Date;
31
+ }
32
+ interface AcceptProposalRequest {
33
+ /** The last known client revision number of the proposal. */
34
+ proposalRevision?: string;
35
+ }
36
+ interface AddDealAssociationRequest {
37
+ /** The association between a creative and a deal that should be added. */
38
+ association?: CreativeDealAssociation;
39
+ }
40
+ interface AddNoteRequest {
41
+ /** Details of the note to add. */
42
+ note?: Note;
43
+ }
44
+ interface AdSize {
45
+ /** The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`. */
46
+ height?: string;
47
+ /** The size type of the ad slot. */
48
+ sizeType?: string;
49
+ /** The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`. */
50
+ width?: string;
51
+ }
52
+ interface AdTechnologyProviders {
53
+ /**
54
+ * The detected ad technology provider IDs for this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/providers.csv for mapping of provider ID to provided name, a
55
+ * privacy policy URL, and a list of domains which can be attributed to the provider. If the creative contains provider IDs that are outside of those listed in the
56
+ * `BidRequest.adslot.consented_providers_settings.consented_providers` field on the (Google bid
57
+ * protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto] and the `BidRequest.user.ext.consented_providers_settings.consented_providers` field
58
+ * on the (OpenRTB protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto], and a bid is submitted with that creative for an impression that will
59
+ * serve to an EEA user, the bid will be filtered before the auction.
60
+ */
61
+ detectedProviderIds?: string[];
62
+ /**
63
+ * Whether the creative contains an unidentified ad technology provider. If true for a given creative, any bid submitted with that creative for an impression that will serve to an EEA
64
+ * user will be filtered before the auction.
65
+ */
66
+ hasUnidentifiedProvider?: boolean;
67
+ }
68
+ interface AppContext {
69
+ /** The app types this restriction applies to. */
70
+ appTypes?: string[];
71
+ }
72
+ interface AuctionContext {
73
+ /** The auction types this restriction applies to. */
74
+ auctionTypes?: string[];
75
+ }
76
+ interface BidMetricsRow {
77
+ /** The number of bids that Ad Exchange received from the buyer. */
78
+ bids?: MetricValue;
79
+ /** The number of bids that were permitted to compete in the auction. */
80
+ bidsInAuction?: MetricValue;
81
+ /** The number of bids for which the buyer was billed. */
82
+ billedImpressions?: MetricValue;
83
+ /** The number of bids that won the auction. */
84
+ impressionsWon?: MetricValue;
85
+ /** The number of bids for which the corresponding impression was measurable for viewability (as defined by Active View). */
86
+ measurableImpressions?: MetricValue;
87
+ /** The number of bids that won the auction and also won the mediation waterfall (if any). */
88
+ reachedQueries?: MetricValue;
89
+ /** The values of all dimensions associated with metric values in this row. */
90
+ rowDimensions?: RowDimensions;
91
+ /** The number of bids for which the corresponding impression was viewable (as defined by Active View). */
92
+ viewableImpressions?: MetricValue;
93
+ }
94
+ interface BidResponseWithoutBidsStatusRow {
95
+ /** The number of impressions for which there was a bid response with the specified status. */
96
+ impressionCount?: MetricValue;
97
+ /** The values of all dimensions associated with metric values in this row. */
98
+ rowDimensions?: RowDimensions;
99
+ /** The status specifying why the bid responses were considered to have no applicable bids. */
100
+ status?: string;
101
+ }
102
+ interface Buyer {
103
+ /** Authorized Buyers account ID of the buyer. */
104
+ accountId?: string;
105
+ }
106
+ interface CalloutStatusRow {
107
+ /** The ID of the callout status. See [callout-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/callout-status-codes). */
108
+ calloutStatusId?: number;
109
+ /** The number of impressions for which there was a bid request or bid response with the specified callout status. */
110
+ impressionCount?: MetricValue;
111
+ /** The values of all dimensions associated with metric values in this row. */
112
+ rowDimensions?: RowDimensions;
113
+ }
114
+ // tslint:disable-next-line:no-empty-interface
115
+ interface CancelNegotiationRequest {
116
+ }
117
+ interface Client {
118
+ /** The globally-unique numerical ID of the client. The value of this field is ignored in create and update operations. */
119
+ clientAccountId?: string;
120
+ /**
121
+ * Name used to represent this client to publishers. You may have multiple clients that map to the same entity, but for each client the combination of `clientName` and entity must be
122
+ * unique. You can specify this field as empty. Maximum length of 255 characters is allowed.
123
+ */
124
+ clientName?: string;
125
+ /**
126
+ * Numerical identifier of the client entity. The entity can be an advertiser, a brand, or an agency. This identifier is unique among all the entities with the same type. The value of
127
+ * this field is ignored if the entity type is not provided. A list of all known advertisers with their identifiers is available in the
128
+ * [advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt) file. A list of all known brands with their identifiers is available in the
129
+ * [brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt) file. A list of all known agencies with their identifiers is available in the
130
+ * [agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt) file.
131
+ */
132
+ entityId?: string;
133
+ /** The name of the entity. This field is automatically fetched based on the type and ID. The value of this field is ignored in create and update operations. */
134
+ entityName?: string;
135
+ /** An optional field for specifying the type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`. */
136
+ entityType?: string;
137
+ /**
138
+ * Optional arbitrary unique identifier of this client buyer from the standpoint of its Ad Exchange sponsor buyer. This field can be used to associate a client buyer with the
139
+ * identifier in the namespace of its sponsor buyer, lookup client buyers by that identifier and verify whether an Ad Exchange counterpart of a given client buyer already exists. If
140
+ * present, must be unique among all the client buyers for its Ad Exchange sponsor buyer.
141
+ */
142
+ partnerClientId?: string;
143
+ /**
144
+ * The role which is assigned to the client buyer. Each role implies a set of permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`, `CLIENT_DEAL_NEGOTIATOR` or
145
+ * `CLIENT_DEAL_APPROVER`.
146
+ */
147
+ role?: string;
148
+ /** The status of the client buyer. */
149
+ status?: string;
150
+ /** Whether the client buyer will be visible to sellers. */
151
+ visibleToSeller?: boolean;
152
+ }
153
+ interface ClientUser {
154
+ /**
155
+ * Numerical account ID of the client buyer with which the user is associated; the buyer must be a client of the current sponsor buyer. The value of this field is ignored in an update
156
+ * operation.
157
+ */
158
+ clientAccountId?: string;
159
+ /** User's email address. The value of this field is ignored in an update operation. */
160
+ email?: string;
161
+ /** The status of the client user. */
162
+ status?: string;
163
+ /** The unique numerical ID of the client user that has accepted an invitation. The value of this field is ignored in an update operation. */
164
+ userId?: string;
165
+ }
166
+ interface ClientUserInvitation {
167
+ /** Numerical account ID of the client buyer that the invited user is associated with. The value of this field is ignored in create operations. */
168
+ clientAccountId?: string;
169
+ /** The email address to which the invitation is sent. Email addresses should be unique among all client users under each sponsor buyer. */
170
+ email?: string;
171
+ /** The unique numerical ID of the invitation that is sent to the user. The value of this field is ignored in create operations. */
172
+ invitationId?: string;
173
+ }
174
+ // tslint:disable-next-line:no-empty-interface
175
+ interface CompleteSetupRequest {
176
+ }
177
+ interface ContactInformation {
178
+ /** Email address for the contact. */
179
+ email?: string;
180
+ /** The name of the contact. */
181
+ name?: string;
182
+ }
183
+ interface Correction {
184
+ /** The contexts for the correction. */
185
+ contexts?: ServingContext[];
186
+ /** Additional details about what was corrected. */
187
+ details?: string[];
188
+ /** The type of correction that was applied to the creative. */
189
+ type?: string;
190
+ }
191
+ interface Creative {
192
+ /** The account that this creative belongs to. Can be used to filter the response of the creatives.list method. */
193
+ accountId?: string;
194
+ /** The link to AdChoices destination page. */
195
+ adChoicesDestinationUrl?: string;
196
+ /** Output only. The detected ad technology providers. */
197
+ adTechnologyProviders?: AdTechnologyProviders;
198
+ /** The name of the company being advertised in the creative. */
199
+ advertiserName?: string;
200
+ /** The agency ID for this creative. */
201
+ agencyId?: string;
202
+ /** Output only. The last update timestamp of the creative via API. */
203
+ apiUpdateTime?: string;
204
+ /** All attributes for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method. */
205
+ attributes?: string[];
206
+ /** The set of destination URLs for the creative. */
207
+ clickThroughUrls?: string[];
208
+ /** Output only. Shows any corrections that were applied to this creative. */
209
+ corrections?: Correction[];
210
+ /** The buyer-defined creative ID of this creative. Can be used to filter the response of the creatives.list method. */
211
+ creativeId?: string;
212
+ /**
213
+ * Output only. The top-level deals status of this creative. If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in serving_restrictions will also exist. Note that this
214
+ * may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the
215
+ * creatives.list method.
216
+ */
217
+ dealsStatus?: string;
218
+ /** The set of declared destination URLs for the creative. */
219
+ declaredClickThroughUrls?: string[];
220
+ /** Output only. Detected advertiser IDs, if any. */
221
+ detectedAdvertiserIds?: string[];
222
+ /** Output only. The detected domains for this creative. */
223
+ detectedDomains?: string[];
224
+ /**
225
+ * Output only. The detected languages for this creative. The order is arbitrary. The codes are 2 or 5 characters and are documented at
226
+ * https://developers.google.com/adwords/api/docs/appendix/languagecodes.
227
+ */
228
+ detectedLanguages?: string[];
229
+ /** Output only. Detected product categories, if any. See the ad-product-categories.txt file in the technical documentation for a list of IDs. */
230
+ detectedProductCategories?: number[];
231
+ /**
232
+ * Output only. Detected sensitive categories, if any. See the ad-sensitive-categories.txt file in the technical documentation for a list of IDs. You should use these IDs along with
233
+ * the excluded-sensitive-category field in the bid request to filter your bids.
234
+ */
235
+ detectedSensitiveCategories?: number[];
236
+ /** An HTML creative. */
237
+ html?: HtmlContent;
238
+ /** The set of URLs to be called to record an impression. */
239
+ impressionTrackingUrls?: string[];
240
+ /** A native creative. */
241
+ native?: NativeContent;
242
+ /**
243
+ * Output only. The top-level open auction status of this creative. If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in serving_restrictions will also exist. Note
244
+ * that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of
245
+ * the creatives.list method.
246
+ */
247
+ openAuctionStatus?: string;
248
+ /** All restricted categories for the ads that may be shown from this creative. */
249
+ restrictedCategories?: string[];
250
+ /**
251
+ * Output only. The granular status of this ad in specific contexts. A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS
252
+ * vs HTTP request, or the type of auction).
253
+ */
254
+ servingRestrictions?: ServingRestriction[];
255
+ /** All vendor IDs for the ads that may be shown from this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for possible values. */
256
+ vendorIds?: number[];
257
+ /** Output only. The version of this creative. */
258
+ version?: number;
259
+ /** A video creative. */
260
+ video?: VideoContent;
261
+ }
262
+ interface CreativeDealAssociation {
263
+ /** The account the creative belongs to. */
264
+ accountId?: string;
265
+ /** The ID of the creative associated with the deal. */
266
+ creativeId?: string;
267
+ /** The externalDealId for the deal associated with the creative. */
268
+ dealsId?: string;
269
+ }
270
+ interface CreativeRestrictions {
271
+ /** The format of the environment that the creatives will be displayed in. */
272
+ creativeFormat?: string;
273
+ creativeSpecifications?: CreativeSpecification[];
274
+ /** Skippable video ads allow viewers to skip ads after 5 seconds. */
275
+ skippableAdType?: string;
276
+ }
277
+ interface CreativeSize {
278
+ /**
279
+ * What formats are allowed by the publisher. If this repeated field is empty then all formats are allowed. For example, if this field contains AllowedFormatType.AUDIO then the
280
+ * publisher only allows an audio ad (without any video).
281
+ */
282
+ allowedFormats?: string[];
283
+ /** For video creatives specifies the sizes of companion ads (if present). Companion sizes may be filled in only when creative_size_type = VIDEO */
284
+ companionSizes?: Size[];
285
+ /** The creative size type. */
286
+ creativeSizeType?: string;
287
+ /** Output only. The native template for this creative. It will have a value only if creative_size_type = CreativeSizeType.NATIVE. */
288
+ nativeTemplate?: string;
289
+ /** For regular or video creative size type, specifies the size of the creative */
290
+ size?: Size;
291
+ /** The type of skippable ad for this creative. It will have a value only if creative_size_type = CreativeSizeType.VIDEO. */
292
+ skippableAdType?: string;
293
+ }
294
+ interface CreativeSpecification {
295
+ /** Companion sizes may be filled in only when this is a video creative. */
296
+ creativeCompanionSizes?: AdSize[];
297
+ /** The size of the creative. */
298
+ creativeSize?: AdSize;
299
+ }
300
+ interface CreativeStatusRow {
301
+ /** The number of bids with the specified status. */
302
+ bidCount?: MetricValue;
303
+ /** The ID of the creative status. See [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes). */
304
+ creativeStatusId?: number;
305
+ /** The values of all dimensions associated with metric values in this row. */
306
+ rowDimensions?: RowDimensions;
307
+ }
308
+ interface CriteriaTargeting {
309
+ /** A list of numeric IDs to be excluded. */
310
+ excludedCriteriaIds?: string[];
311
+ /** A list of numeric IDs to be included. */
312
+ targetedCriteriaIds?: string[];
313
+ }
314
+ interface Date {
315
+ /** 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. */
316
+ day?: number;
317
+ /** Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. */
318
+ month?: number;
319
+ /** Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. */
320
+ year?: number;
321
+ }
322
+ interface DayPart {
323
+ /** The day of the week to target. If unspecified, applicable to all days. */
324
+ dayOfWeek?: string;
325
+ /** The ending time of the day for the ad to show (minute level granularity). The end time is exclusive. This field is not available for filtering in PQL queries. */
326
+ endTime?: TimeOfDay;
327
+ /** The starting time of day for the ad to show (minute level granularity). The start time is inclusive. This field is not available for filtering in PQL queries. */
328
+ startTime?: TimeOfDay;
329
+ }
330
+ interface DayPartTargeting {
331
+ /** A list of day part targeting criterion. */
332
+ dayParts?: DayPart[];
333
+ /** The timezone to use for interpreting the day part targeting. */
334
+ timeZoneType?: string;
335
+ }
336
+ interface Deal {
337
+ /** Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not required for Private Auction deals or Preferred Deals. */
338
+ availableEndTime?: string;
339
+ /**
340
+ * Optional. 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
341
+ * with more granularity (e.g., in milliseconds) will be truncated towards the start of time in seconds.
342
+ */
343
+ availableStartTime?: string;
344
+ /** Buyer private data (hidden from seller). */
345
+ buyerPrivateData?: PrivateData;
346
+ /**
347
+ * The product ID from which this deal was created. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an
348
+ * error.
349
+ */
350
+ createProductId?: string;
351
+ /**
352
+ * Optional. Revision number of the product that the deal was created from. If present on create, and the server `product_revision` has advanced since the passed-in
353
+ * `create_product_revision`, an `ABORTED` error will be returned. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will
354
+ * result in an error.
355
+ */
356
+ createProductRevision?: string;
357
+ /** Output only. The time of the deal creation. */
358
+ createTime?: string;
359
+ /** Output only. Specifies the creative pre-approval policy. */
360
+ creativePreApprovalPolicy?: string;
361
+ /** Output only. Restricitions about the creatives associated with the deal (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager. */
362
+ creativeRestrictions?: CreativeRestrictions;
363
+ /** Output only. Specifies whether the creative is safeFrame compatible. */
364
+ creativeSafeFrameCompatibility?: string;
365
+ /** Output only. A unique deal ID for the deal (server-assigned). */
366
+ dealId?: string;
367
+ /** Output only. Metadata about the serving status of this deal. */
368
+ dealServingMetadata?: DealServingMetadata;
369
+ /** The negotiable terms of the deal. */
370
+ dealTerms?: DealTerms;
371
+ /** The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. */
372
+ deliveryControl?: DeliveryControl;
373
+ /** Description for the deal terms. */
374
+ description?: string;
375
+ /** The name of the deal. */
376
+ displayName?: string;
377
+ /** Output only. The external deal ID assigned to this deal once the deal is finalized. This is the deal ID that shows up in serving/reporting etc. */
378
+ externalDealId?: string;
379
+ /** Output only. True, if the buyside inventory setup is complete for this deal. */
380
+ isSetupComplete?: boolean;
381
+ /** Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by buyer. */
382
+ programmaticCreativeSource?: string;
383
+ /** Output only. ID of the proposal that this deal is part of. */
384
+ proposalId?: string;
385
+ /** Output only. Seller contact information for the deal. */
386
+ sellerContacts?: ContactInformation[];
387
+ /**
388
+ * The syndication product associated with the deal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an
389
+ * error.
390
+ */
391
+ syndicationProduct?: string;
392
+ /** Output only. Specifies the subset of inventory targeted by the deal. */
393
+ targeting?: MarketplaceTargeting;
394
+ /** The shared targeting visible to buyers and sellers. Each shared targeting entity is AND'd together. */
395
+ targetingCriterion?: TargetingCriteria[];
396
+ /** Output only. The time when the deal was last updated. */
397
+ updateTime?: string;
398
+ /** The web property code for the seller copied over from the product. */
399
+ webPropertyCode?: string;
400
+ }
401
+ interface DealPauseStatus {
402
+ /** The buyer's reason for pausing, if the buyer paused the deal. */
403
+ buyerPauseReason?: string;
404
+ /** The role of the person who first paused this deal. */
405
+ firstPausedBy?: string;
406
+ /** True, if the buyer has paused the deal unilaterally. */
407
+ hasBuyerPaused?: boolean;
408
+ /** True, if the seller has paused the deal unilaterally. */
409
+ hasSellerPaused?: boolean;
410
+ /** The seller's reason for pausing, if the seller paused the deal. */
411
+ sellerPauseReason?: string;
412
+ }
413
+ interface DealServingMetadata {
414
+ /** Output only. Tracks which parties (if any) have paused a deal. */
415
+ dealPauseStatus?: DealPauseStatus;
416
+ }
417
+ interface DealTerms {
418
+ /** Visibility of the URL in bid requests. (default: BRANDED) */
419
+ brandingType?: string;
420
+ /** Publisher provided description for the terms. */
421
+ description?: string;
422
+ /** Non-binding estimate of the estimated gross spend for this deal. Can be set by buyer or seller. */
423
+ estimatedGrossSpend?: Price;
424
+ /** Non-binding estimate of the impressions served per day. Can be set by buyer or seller. */
425
+ estimatedImpressionsPerDay?: string;
426
+ /** The terms for guaranteed fixed price deals. */
427
+ guaranteedFixedPriceTerms?: GuaranteedFixedPriceTerms;
428
+ /** The terms for non-guaranteed auction deals. */
429
+ nonGuaranteedAuctionTerms?: NonGuaranteedAuctionTerms;
430
+ /** The terms for non-guaranteed fixed price deals. */
431
+ nonGuaranteedFixedPriceTerms?: NonGuaranteedFixedPriceTerms;
432
+ /**
433
+ * The time zone name. For deals with Cost Per Day billing, defines the time zone used to mark the boundaries of a day. It should be an IANA TZ name, such as "America/Los_Angeles". For
434
+ * more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.
435
+ */
436
+ sellerTimeZone?: string;
437
+ }
438
+ interface DeliveryControl {
439
+ /** Output only. Specified the creative blocking levels to be applied. */
440
+ creativeBlockingLevel?: string;
441
+ /** Output only. Specifies how the impression delivery will be paced. */
442
+ deliveryRateType?: string;
443
+ /** Output only. Specifies any frequency caps. */
444
+ frequencyCaps?: FrequencyCap[];
445
+ }
446
+ interface Disapproval {
447
+ /** Additional details about the reason for disapproval. */
448
+ details?: string[];
449
+ /** The categorized reason for disapproval. */
450
+ reason?: string;
451
+ }
452
+ // tslint:disable-next-line:no-empty-interface
453
+ interface Empty {
454
+ }
455
+ interface FilteredBidCreativeRow {
456
+ /** The number of bids with the specified creative. */
457
+ bidCount?: MetricValue;
458
+ /** The ID of the creative. */
459
+ creativeId?: string;
460
+ /** The values of all dimensions associated with metric values in this row. */
461
+ rowDimensions?: RowDimensions;
462
+ }
463
+ interface FilteredBidDetailRow {
464
+ /** The number of bids with the specified detail. */
465
+ bidCount?: MetricValue;
466
+ /** The ID of the detail, can be numeric or text. The associated value can be looked up in the dictionary file corresponding to the DetailType in the response message. */
467
+ detail?: string;
468
+ /**
469
+ * Note: this field will be deprecated, use "detail" field instead. When "detail" field represents an integer value, this field is populated as the same integer value "detail" field
470
+ * represents, otherwise this field will be 0. The ID of the detail. The associated value can be looked up in the dictionary file corresponding to the DetailType in the response
471
+ * message.
472
+ */
473
+ detailId?: number;
474
+ /** The values of all dimensions associated with metric values in this row. */
475
+ rowDimensions?: RowDimensions;
476
+ }
477
+ interface FilterSet {
478
+ /** An absolute date range, defined by a start date and an end date. Interpreted relative to Pacific time zone. */
479
+ absoluteDateRange?: AbsoluteDateRange;
480
+ /**
481
+ * The set of dimensions along which to break down the response; may be empty. If multiple dimensions are requested, the breakdown is along the Cartesian product of the requested
482
+ * dimensions.
483
+ */
484
+ breakdownDimensions?: string[];
485
+ /**
486
+ * The ID of the creative on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, i.e., one whose name matches the
487
+ * `bidders/*‍/accounts/*‍/filterSets/*` pattern.
488
+ */
489
+ creativeId?: string;
490
+ /**
491
+ * The ID of the deal on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, i.e., one whose name matches the
492
+ * `bidders/*‍/accounts/*‍/filterSets/*` pattern.
493
+ */
494
+ dealId?: string;
495
+ /** The environment on which to filter; optional. */
496
+ environment?: string;
497
+ /** Creative format bidded on or allowed to bid on, can be empty. */
498
+ format?: string;
499
+ /**
500
+ * Creative formats bidded on or allowed to bid on, can be empty. Although this field is a list, it can only be populated with a single item. A HTTP 400 bad request error will be
501
+ * returned in the response if you specify multiple items.
502
+ */
503
+ formats?: string[];
504
+ /**
505
+ * A user-defined name of the filter set. Filter set names must be unique globally and match one of the patterns: - `bidders/*‍/filterSets/*` (for accessing bidder-level
506
+ * troubleshooting data) - `bidders/*‍/accounts/*‍/filterSets/*` (for accessing account-level troubleshooting data) This field is required in create operations.
507
+ */
508
+ name?: string;
509
+ /**
510
+ * The list of platforms on which to filter; may be empty. The filters represented by multiple platforms are ORed together (i.e., if non-empty, results must match any one of the
511
+ * platforms).
512
+ */
513
+ platforms?: string[];
514
+ /** For Open Bidding partners only. The list of publisher identifiers on which to filter; may be empty. The filters represented by multiple publisher identifiers are ORed together. */
515
+ publisherIdentifiers?: string[];
516
+ /** An open-ended realtime time range, defined by the aggregation start timestamp. */
517
+ realtimeTimeRange?: RealtimeTimeRange;
518
+ /** A relative date range, defined by an offset from today and a duration. Interpreted relative to Pacific time zone. */
519
+ relativeDateRange?: RelativeDateRange;
520
+ /**
521
+ * For Authorized Buyers only. The list of IDs of the seller (publisher) networks on which to filter; may be empty. The filters represented by multiple seller network IDs are ORed
522
+ * together (i.e., if non-empty, results must match any one of the publisher networks). See
523
+ * [seller-network-ids](https://developers.google.com/authorized-buyers/rtb/downloads/seller-network-ids) file for the set of existing seller network IDs.
524
+ */
525
+ sellerNetworkIds?: number[];
526
+ /** The granularity of time intervals if a time series breakdown is desired; optional. */
527
+ timeSeriesGranularity?: string;
528
+ }
529
+ interface FirstPartyMobileApplicationTargeting {
530
+ /** A list of application IDs to be excluded. */
531
+ excludedAppIds?: string[];
532
+ /** A list of application IDs to be included. */
533
+ targetedAppIds?: string[];
534
+ }
535
+ interface FrequencyCap {
536
+ /** The maximum number of impressions that can be served to a user within the specified time period. */
537
+ maxImpressions?: number;
538
+ /** The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped. */
539
+ numTimeUnits?: number;
540
+ /** The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped. */
541
+ timeUnitType?: string;
542
+ }
543
+ interface GuaranteedFixedPriceTerms {
544
+ /** Fixed price for the specified buyer. */
545
+ fixedPrices?: PricePerBuyer[];
546
+ /** Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy. */
547
+ guaranteedImpressions?: string;
548
+ /** Count of guaranteed looks. Required for deal, optional for product. */
549
+ guaranteedLooks?: string;
550
+ /** The lifetime impression cap for CPM sponsorship deals. The deal will stop serving when the cap is reached. */
551
+ impressionCap?: string;
552
+ /** Daily minimum looks for CPD deal types. */
553
+ minimumDailyLooks?: string;
554
+ /** For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. */
555
+ percentShareOfVoice?: string;
556
+ /**
557
+ * The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the
558
+ * default reservation type is STANDARD.
559
+ */
560
+ reservationType?: string;
561
+ }
562
+ interface HtmlContent {
563
+ /** The height of the HTML snippet in pixels. */
564
+ height?: number;
565
+ /** The HTML snippet that displays the ad when inserted in the web page. */
566
+ snippet?: string;
567
+ /** The width of the HTML snippet in pixels. */
568
+ width?: number;
569
+ }
570
+ interface Image {
571
+ /** Image height in pixels. */
572
+ height?: number;
573
+ /** The URL of the image. */
574
+ url?: string;
575
+ /** Image width in pixels. */
576
+ width?: number;
577
+ }
578
+ interface ImpressionMetricsRow {
579
+ /** The number of impressions available to the buyer on Ad Exchange. In some cases this value may be unavailable. */
580
+ availableImpressions?: MetricValue;
581
+ /** The number of impressions for which Ad Exchange sent the buyer a bid request. */
582
+ bidRequests?: MetricValue;
583
+ /** The number of impressions that match the buyer's inventory pretargeting. */
584
+ inventoryMatches?: MetricValue;
585
+ /** The number of impressions for which Ad Exchange received a response from the buyer that contained at least one applicable bid. */
586
+ responsesWithBids?: MetricValue;
587
+ /** The values of all dimensions associated with metric values in this row. */
588
+ rowDimensions?: RowDimensions;
589
+ /** The number of impressions for which the buyer successfully sent a response to Ad Exchange. */
590
+ successfulResponses?: MetricValue;
591
+ }
592
+ interface InventorySizeTargeting {
593
+ /** A list of inventory sizes to be excluded. */
594
+ excludedInventorySizes?: AdSize[];
595
+ /** A list of inventory sizes to be included. */
596
+ targetedInventorySizes?: AdSize[];
597
+ }
598
+ interface ListBidMetricsResponse {
599
+ /** List of rows, each containing a set of bid metrics. */
600
+ bidMetricsRows?: BidMetricsRow[];
601
+ /**
602
+ * A token to retrieve the next page of results. Pass this value in the ListBidMetricsRequest.pageToken field in the subsequent call to the bidMetrics.list method to retrieve the next
603
+ * page of results.
604
+ */
605
+ nextPageToken?: string;
606
+ }
607
+ interface ListBidResponseErrorsResponse {
608
+ /** List of rows, with counts of bid responses aggregated by callout status. */
609
+ calloutStatusRows?: CalloutStatusRow[];
610
+ /**
611
+ * A token to retrieve the next page of results. Pass this value in the ListBidResponseErrorsRequest.pageToken field in the subsequent call to the bidResponseErrors.list method to
612
+ * retrieve the next page of results.
613
+ */
614
+ nextPageToken?: string;
615
+ }
616
+ interface ListBidResponsesWithoutBidsResponse {
617
+ /** List of rows, with counts of bid responses without bids aggregated by status. */
618
+ bidResponseWithoutBidsStatusRows?: BidResponseWithoutBidsStatusRow[];
619
+ /**
620
+ * A token to retrieve the next page of results. Pass this value in the ListBidResponsesWithoutBidsRequest.pageToken field in the subsequent call to the bidResponsesWithoutBids.list
621
+ * method to retrieve the next page of results.
622
+ */
623
+ nextPageToken?: string;
624
+ }
625
+ interface ListClientsResponse {
626
+ /** The returned list of clients. */
627
+ clients?: Client[];
628
+ /**
629
+ * A token to retrieve the next page of results. Pass this value in the ListClientsRequest.pageToken field in the subsequent call to the accounts.clients.list method to retrieve the
630
+ * next page of results.
631
+ */
632
+ nextPageToken?: string;
633
+ }
634
+ interface ListClientUserInvitationsResponse {
635
+ /** The returned list of client users. */
636
+ invitations?: ClientUserInvitation[];
637
+ /**
638
+ * A token to retrieve the next page of results. Pass this value in the ListClientUserInvitationsRequest.pageToken field in the subsequent call to the clients.invitations.list method
639
+ * to retrieve the next page of results.
640
+ */
641
+ nextPageToken?: string;
642
+ }
643
+ interface ListClientUsersResponse {
644
+ /**
645
+ * A token to retrieve the next page of results. Pass this value in the ListClientUsersRequest.pageToken field in the subsequent call to the clients.invitations.list method to retrieve
646
+ * the next page of results.
647
+ */
648
+ nextPageToken?: string;
649
+ /** The returned list of client users. */
650
+ users?: ClientUser[];
651
+ }
652
+ interface ListCreativesResponse {
653
+ /** The list of creatives. */
654
+ creatives?: Creative[];
655
+ /**
656
+ * A token to retrieve the next page of results. Pass this value in the ListCreativesRequest.page_token field in the subsequent call to `ListCreatives` method to retrieve the next page
657
+ * of results.
658
+ */
659
+ nextPageToken?: string;
660
+ }
661
+ interface ListCreativeStatusBreakdownByCreativeResponse {
662
+ /** List of rows, with counts of bids with a given creative status aggregated by creative. */
663
+ filteredBidCreativeRows?: FilteredBidCreativeRow[];
664
+ /**
665
+ * A token to retrieve the next page of results. Pass this value in the ListCreativeStatusBreakdownByCreativeRequest.pageToken field in the subsequent call to the
666
+ * filteredBids.creatives.list method to retrieve the next page of results.
667
+ */
668
+ nextPageToken?: string;
669
+ }
670
+ interface ListCreativeStatusBreakdownByDetailResponse {
671
+ /** The type of detail that the detail IDs represent. */
672
+ detailType?: string;
673
+ /** List of rows, with counts of bids with a given creative status aggregated by detail. */
674
+ filteredBidDetailRows?: FilteredBidDetailRow[];
675
+ /**
676
+ * A token to retrieve the next page of results. Pass this value in the ListCreativeStatusBreakdownByDetailRequest.pageToken field in the subsequent call to the
677
+ * filteredBids.details.list method to retrieve the next page of results.
678
+ */
679
+ nextPageToken?: string;
680
+ }
681
+ interface ListDealAssociationsResponse {
682
+ /** The list of associations. */
683
+ associations?: CreativeDealAssociation[];
684
+ /**
685
+ * A token to retrieve the next page of results. Pass this value in the ListDealAssociationsRequest.page_token field in the subsequent call to 'ListDealAssociation' method to retrieve
686
+ * the next page of results.
687
+ */
688
+ nextPageToken?: string;
689
+ }
690
+ interface ListFilteredBidRequestsResponse {
691
+ /** List of rows, with counts of filtered bid requests aggregated by callout status. */
692
+ calloutStatusRows?: CalloutStatusRow[];
693
+ /**
694
+ * A token to retrieve the next page of results. Pass this value in the ListFilteredBidRequestsRequest.pageToken field in the subsequent call to the filteredBidRequests.list method to
695
+ * retrieve the next page of results.
696
+ */
697
+ nextPageToken?: string;
698
+ }
699
+ interface ListFilteredBidsResponse {
700
+ /** List of rows, with counts of filtered bids aggregated by filtering reason (i.e. creative status). */
701
+ creativeStatusRows?: CreativeStatusRow[];
702
+ /**
703
+ * A token to retrieve the next page of results. Pass this value in the ListFilteredBidsRequest.pageToken field in the subsequent call to the filteredBids.list method to retrieve the
704
+ * next page of results.
705
+ */
706
+ nextPageToken?: string;
707
+ }
708
+ interface ListFilterSetsResponse {
709
+ /** The filter sets belonging to the buyer. */
710
+ filterSets?: FilterSet[];
711
+ /**
712
+ * A token to retrieve the next page of results. Pass this value in the ListFilterSetsRequest.pageToken field in the subsequent call to the accounts.filterSets.list method to retrieve
713
+ * the next page of results.
714
+ */
715
+ nextPageToken?: string;
716
+ }
717
+ interface ListImpressionMetricsResponse {
718
+ /** List of rows, each containing a set of impression metrics. */
719
+ impressionMetricsRows?: ImpressionMetricsRow[];
720
+ /**
721
+ * A token to retrieve the next page of results. Pass this value in the ListImpressionMetricsRequest.pageToken field in the subsequent call to the impressionMetrics.list method to
722
+ * retrieve the next page of results.
723
+ */
724
+ nextPageToken?: string;
725
+ }
726
+ interface ListLosingBidsResponse {
727
+ /** List of rows, with counts of losing bids aggregated by loss reason (i.e. creative status). */
728
+ creativeStatusRows?: CreativeStatusRow[];
729
+ /**
730
+ * A token to retrieve the next page of results. Pass this value in the ListLosingBidsRequest.pageToken field in the subsequent call to the losingBids.list method to retrieve the next
731
+ * page of results.
732
+ */
733
+ nextPageToken?: string;
734
+ }
735
+ interface ListNonBillableWinningBidsResponse {
736
+ /**
737
+ * A token to retrieve the next page of results. Pass this value in the ListNonBillableWinningBidsRequest.pageToken field in the subsequent call to the nonBillableWinningBids.list
738
+ * method to retrieve the next page of results.
739
+ */
740
+ nextPageToken?: string;
741
+ /** List of rows, with counts of bids not billed aggregated by reason. */
742
+ nonBillableWinningBidStatusRows?: NonBillableWinningBidStatusRow[];
743
+ }
744
+ interface ListProductsResponse {
745
+ /** List pagination support. */
746
+ nextPageToken?: string;
747
+ /** The list of matching products at their head revision number. */
748
+ products?: Product[];
749
+ }
750
+ interface ListProposalsResponse {
751
+ /** Continuation token for fetching the next page of results. */
752
+ nextPageToken?: string;
753
+ /** The list of proposals. */
754
+ proposals?: Proposal[];
755
+ }
756
+ interface ListPublisherProfilesResponse {
757
+ /** List pagination support */
758
+ nextPageToken?: string;
759
+ /** The list of matching publisher profiles. */
760
+ publisherProfiles?: PublisherProfile[];
761
+ }
762
+ interface LocationContext {
763
+ /**
764
+ * IDs representing the geo location for this context. Please refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo
765
+ * criteria IDs.
766
+ */
767
+ geoCriteriaIds?: number[];
768
+ }
769
+ interface MarketplaceTargeting {
770
+ /** Geo criteria IDs to be included/excluded. */
771
+ geoTargeting?: CriteriaTargeting;
772
+ /** Inventory sizes to be included/excluded. */
773
+ inventorySizeTargeting?: InventorySizeTargeting;
774
+ /** Placement targeting information, e.g., URL, mobile applications. */
775
+ placementTargeting?: PlacementTargeting;
776
+ /** Technology targeting information, e.g., operating system, device category. */
777
+ technologyTargeting?: TechnologyTargeting;
778
+ /** Video targeting information. */
779
+ videoTargeting?: VideoTargeting;
780
+ }
781
+ interface MetricValue {
782
+ /** The expected value of the metric. */
783
+ value?: string;
784
+ /**
785
+ * The variance (i.e. square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using
786
+ * the following formula, where Z is the standard constant that depends on the desired size of the confidence interval (e.g. for 90% confidence interval, use Z = 1.645): marginOfError
787
+ * = 100 * Z * sqrt(variance) / value
788
+ */
789
+ variance?: string;
790
+ }
791
+ interface MobileApplicationTargeting {
792
+ /** Publisher owned apps to be targeted or excluded by the publisher to display the ads in. */
793
+ firstPartyTargeting?: FirstPartyMobileApplicationTargeting;
794
+ }
795
+ interface Money {
796
+ /** The three-letter currency code defined in ISO 4217. */
797
+ currencyCode?: string;
798
+ /**
799
+ * Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units`
800
+ * is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and
801
+ * `nanos`=-750,000,000.
802
+ */
803
+ nanos?: number;
804
+ /** The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. */
805
+ units?: string;
806
+ }
807
+ interface NativeContent {
808
+ /** The name of the advertiser or sponsor, to be displayed in the ad creative. */
809
+ advertiserName?: string;
810
+ /** The app icon, for app download ads. */
811
+ appIcon?: Image;
812
+ /** A long description of the ad. */
813
+ body?: string;
814
+ /** A label for the button that the user is supposed to click. */
815
+ callToAction?: string;
816
+ /** The URL that the browser/SDK will load when the user clicks the ad. */
817
+ clickLinkUrl?: string;
818
+ /** The URL to use for click tracking. */
819
+ clickTrackingUrl?: string;
820
+ /** A short title for the ad. */
821
+ headline?: string;
822
+ /** A large image. */
823
+ image?: Image;
824
+ /** A smaller image, for the advertiser's logo. */
825
+ logo?: Image;
826
+ /** The price of the promoted app including currency info. */
827
+ priceDisplayText?: string;
828
+ /** The app rating in the app store. Must be in the range [0-5]. */
829
+ starRating?: number;
830
+ /** The URL to the app store to purchase/download the promoted app. */
831
+ storeUrl?: string;
832
+ /** The URL to fetch a native video ad. */
833
+ videoUrl?: string;
834
+ }
835
+ interface NonBillableWinningBidStatusRow {
836
+ /** The number of bids with the specified status. */
837
+ bidCount?: MetricValue;
838
+ /** The values of all dimensions associated with metric values in this row. */
839
+ rowDimensions?: RowDimensions;
840
+ /** The status specifying why the winning bids were not billed. */
841
+ status?: string;
842
+ }
843
+ interface NonGuaranteedAuctionTerms {
844
+ /** True if open auction buyers are allowed to compete with invited buyers in this private auction. */
845
+ autoOptimizePrivateAuction?: boolean;
846
+ /** Reserve price for the specified buyer. */
847
+ reservePricesPerBuyer?: PricePerBuyer[];
848
+ }
849
+ interface NonGuaranteedFixedPriceTerms {
850
+ /** Fixed price for the specified buyer. */
851
+ fixedPrices?: PricePerBuyer[];
852
+ }
853
+ interface Note {
854
+ /** Output only. The timestamp for when this note was created. */
855
+ createTime?: string;
856
+ /** Output only. The role of the person (buyer/seller) creating the note. */
857
+ creatorRole?: string;
858
+ /**
859
+ * The actual note to attach. (max-length: 1024 unicode code units) Note: This field may be set only when creating the resource. Modifying this field while updating the resource will
860
+ * result in an error.
861
+ */
862
+ note?: string;
863
+ /** Output only. The unique ID for the note. */
864
+ noteId?: string;
865
+ /** Output only. The revision number of the proposal when the note is created. */
866
+ proposalRevision?: string;
867
+ }
868
+ interface OperatingSystemTargeting {
869
+ /** IDs of operating systems to be included/excluded. */
870
+ operatingSystemCriteria?: CriteriaTargeting;
871
+ /** IDs of operating system versions to be included/excluded. */
872
+ operatingSystemVersionCriteria?: CriteriaTargeting;
873
+ }
874
+ interface PauseProposalDealsRequest {
875
+ /** The external_deal_id's of the deals to be paused. If empty, all the deals in the proposal will be paused. */
876
+ externalDealIds?: string[];
877
+ /** The reason why the deals are being paused. This human readable message will be displayed in the seller's UI. (Max length: 1000 unicode code units.) */
878
+ reason?: string;
879
+ }
880
+ interface PauseProposalRequest {
881
+ /** The reason why the proposal is being paused. This human readable message will be displayed in the seller's UI. (Max length: 1000 unicode code units.) */
882
+ reason?: string;
883
+ }
884
+ interface PlacementTargeting {
885
+ /** Mobile application targeting information in a deal. This doesn't apply to Auction Packages. */
886
+ mobileApplicationTargeting?: MobileApplicationTargeting;
887
+ /** URLs to be included/excluded. */
888
+ urlTargeting?: UrlTargeting;
889
+ }
890
+ interface PlatformContext {
891
+ /** The platforms this restriction applies to. */
892
+ platforms?: string[];
893
+ }
894
+ interface Price {
895
+ /** The actual price with currency specified. */
896
+ amount?: Money;
897
+ /** The pricing type for the deal/product. (default: CPM) */
898
+ pricingType?: string;
899
+ }
900
+ interface PricePerBuyer {
901
+ /** The list of advertisers for this price when associated with this buyer. If empty, all advertisers with this buyer pay this price. */
902
+ advertiserIds?: string[];
903
+ /** The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer). */
904
+ buyer?: Buyer;
905
+ /** The specified price. */
906
+ price?: Price;
907
+ }
908
+ interface PrivateData {
909
+ /** A buyer or seller specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). */
910
+ referenceId?: string;
911
+ }
912
+ interface Product {
913
+ /** The proposed end time for the deal. The field will be truncated to the order of seconds during serving. */
914
+ availableEndTime?: string;
915
+ /**
916
+ * Inventory availability dates. The start time will be truncated to seconds during serving. Thus, a field specified as 3:23:34.456 (HH:mm:ss.SSS) will be truncated to 3:23:34 when
917
+ * serving.
918
+ */
919
+ availableStartTime?: string;
920
+ /** Creation time. */
921
+ createTime?: string;
922
+ /** Optional contact information for the creator of this product. */
923
+ creatorContacts?: ContactInformation[];
924
+ /** The display name for this product as set by the seller. */
925
+ displayName?: string;
926
+ /**
927
+ * If the creator has already signed off on the product, then the buyer can finalize the deal by accepting the product as is. When copying to a proposal, if any of the terms are
928
+ * changed, then auto_finalize is automatically set to false.
929
+ */
930
+ hasCreatorSignedOff?: boolean;
931
+ /** The unique ID for the product. */
932
+ productId?: string;
933
+ /** The revision number of the product (auto-assigned by Marketplace). */
934
+ productRevision?: string;
935
+ /** An ID which can be used by the Publisher Profile API to get more information about the seller that created this product. */
936
+ publisherProfileId?: string;
937
+ /** Information about the seller that created this product. */
938
+ seller?: Seller;
939
+ /** The syndication product associated with the deal. */
940
+ syndicationProduct?: string;
941
+ /** Targeting that is shared between the buyer and the seller. Each targeting criterion has a specified key and for each key there is a list of inclusion value or exclusion values. */
942
+ targetingCriterion?: TargetingCriteria[];
943
+ /** The negotiable terms of the deal. */
944
+ terms?: DealTerms;
945
+ /** Time of last update. */
946
+ updateTime?: string;
947
+ /** The web-property code for the seller. This needs to be copied as is when adding a new deal to a proposal. */
948
+ webPropertyCode?: string;
949
+ }
950
+ interface Proposal {
951
+ /** Output only. Reference to the buyer that will get billed for this proposal. */
952
+ billedBuyer?: Buyer;
953
+ /** Reference to the buyer on the proposal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. */
954
+ buyer?: Buyer;
955
+ /** Contact information for the buyer. */
956
+ buyerContacts?: ContactInformation[];
957
+ /** Private data for buyer. (hidden from seller). */
958
+ buyerPrivateData?: PrivateData;
959
+ /** The deals associated with this proposal. For Private Auction proposals (whose deals have NonGuaranteedAuctionTerms), there will only be one deal. */
960
+ deals?: Deal[];
961
+ /** The name for the proposal. */
962
+ displayName?: string;
963
+ /** Output only. True if the proposal is being renegotiated. */
964
+ isRenegotiating?: boolean;
965
+ /** Output only. True, if the buyside inventory setup is complete for this proposal. */
966
+ isSetupComplete?: boolean;
967
+ /** Output only. The role of the last user that either updated the proposal or left a comment. */
968
+ lastUpdaterOrCommentorRole?: string;
969
+ /** Output only. The notes associated with this proposal. */
970
+ notes?: Note[];
971
+ /** Output only. Indicates whether the buyer/seller created the proposal. */
972
+ originatorRole?: string;
973
+ /** Output only. Private auction ID if this proposal is a private auction proposal. */
974
+ privateAuctionId?: string;
975
+ /** Output only. The unique ID of the proposal. */
976
+ proposalId?: string;
977
+ /**
978
+ * Output only. The revision number for the proposal. Each update to the proposal or the deal causes the proposal revision number to auto-increment. The buyer keeps track of the last
979
+ * revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the
980
+ * update operation to let the buyer know that a subsequent update was made.
981
+ */
982
+ proposalRevision?: string;
983
+ /** Output only. The current state of the proposal. */
984
+ proposalState?: string;
985
+ /** Reference to the seller on the proposal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. */
986
+ seller?: Seller;
987
+ /** Output only. Contact information for the seller. */
988
+ sellerContacts?: ContactInformation[];
989
+ /** Output only. The terms and conditions set by the publisher for this proposal. */
990
+ termsAndConditions?: string;
991
+ /** Output only. The time when the proposal was last revised. */
992
+ updateTime?: string;
993
+ }
994
+ interface PublisherProfile {
995
+ /** Description on the publisher's audience. */
996
+ audienceDescription?: string;
997
+ /** Statement explaining what's unique about publisher's business, and why buyers should partner with the publisher. */
998
+ buyerPitchStatement?: string;
999
+ /** Contact information for direct reservation deals. This is free text entered by the publisher and may include information like names, phone numbers and email addresses. */
1000
+ directDealsContact?: string;
1001
+ /** Name of the publisher profile. */
1002
+ displayName?: string;
1003
+ /**
1004
+ * The list of domains represented in this publisher profile. Empty if this is a parent profile. These are top private domains, meaning that these will not contain a string like
1005
+ * "photos.google.co.uk/123", but will instead contain "google.co.uk".
1006
+ */
1007
+ domains?: string[];
1008
+ /** URL to publisher's Google+ page. */
1009
+ googlePlusUrl?: string;
1010
+ /**
1011
+ * Indicates if this profile is the parent profile of the seller. A parent profile represents all the inventory from the seller, as opposed to child profile that is created to brand a
1012
+ * portion of inventory. One seller should have only one parent publisher profile, and can have multiple child profiles. Publisher profiles for the same seller will have same value of
1013
+ * field google.ads.adexchange.buyer.v2beta1.PublisherProfile.seller. See https://support.google.com/admanager/answer/6035806 for details.
1014
+ */
1015
+ isParent?: boolean;
1016
+ /** A Google public URL to the logo for this publisher profile. The logo is stored as a PNG, JPG, or GIF image. */
1017
+ logoUrl?: string;
1018
+ /** URL to additional marketing and sales materials. */
1019
+ mediaKitUrl?: string;
1020
+ /** The list of apps represented in this publisher profile. Empty if this is a parent profile. */
1021
+ mobileApps?: PublisherProfileMobileApplication[];
1022
+ /** Overview of the publisher. */
1023
+ overview?: string;
1024
+ /** Contact information for programmatic deals. This is free text entered by the publisher and may include information like names, phone numbers and email addresses. */
1025
+ programmaticDealsContact?: string;
1026
+ /** Unique ID for publisher profile. */
1027
+ publisherProfileId?: string;
1028
+ /** URL to a publisher rate card. */
1029
+ rateCardInfoUrl?: string;
1030
+ /** URL to a sample content page. */
1031
+ samplePageUrl?: string;
1032
+ /** Seller of the publisher profile. */
1033
+ seller?: Seller;
1034
+ /** Up to three key metrics and rankings. Max 100 characters each. For example "#1 Mobile News Site for 20 Straight Months". */
1035
+ topHeadlines?: string[];
1036
+ }
1037
+ interface PublisherProfileMobileApplication {
1038
+ /** The app store the app belongs to. */
1039
+ appStore?: string;
1040
+ /** The external ID for the app from its app store. */
1041
+ externalAppId?: string;
1042
+ /** The name of the app. */
1043
+ name?: string;
1044
+ }
1045
+ interface RealtimeTimeRange {
1046
+ /** The start timestamp of the real-time RTB metrics aggregation. */
1047
+ startTimestamp?: string;
1048
+ }
1049
+ interface RelativeDateRange {
1050
+ /** The number of days in the requested date range, e.g., for a range spanning today: 1. For a range spanning the last 7 days: 7. */
1051
+ durationDays?: number;
1052
+ /** The end date of the filter set, specified as the number of days before today, e.g., for a range where the last date is today: 0. */
1053
+ offsetDays?: number;
1054
+ }
1055
+ interface RemoveDealAssociationRequest {
1056
+ /** The association between a creative and a deal that should be removed. */
1057
+ association?: CreativeDealAssociation;
1058
+ }
1059
+ interface ResumeProposalDealsRequest {
1060
+ /** The external_deal_id's of the deals to resume. If empty, all the deals in the proposal will be resumed. */
1061
+ externalDealIds?: string[];
1062
+ }
1063
+ // tslint:disable-next-line:no-empty-interface
1064
+ interface ResumeProposalRequest {
1065
+ }
1066
+ interface RowDimensions {
1067
+ /**
1068
+ * The publisher identifier for this row, if a breakdown by
1069
+ * [BreakdownDimension.PUBLISHER_IDENTIFIER](https://developers.google.com/authorized-buyers/apis/reference/rest/v2beta1/bidders.accounts.filterSets#FilterSet.BreakdownDimension) was
1070
+ * requested.
1071
+ */
1072
+ publisherIdentifier?: string;
1073
+ /** The time interval that this row represents. */
1074
+ timeInterval?: TimeInterval;
1075
+ }
1076
+ interface SecurityContext {
1077
+ /** The security types in this context. */
1078
+ securities?: string[];
1079
+ }
1080
+ interface Seller {
1081
+ /** The unique ID for the seller. The seller fills in this field. The seller account ID is then available to buyer in the product. */
1082
+ accountId?: string;
1083
+ /** Output only. Ad manager network code for the seller. */
1084
+ subAccountId?: string;
1085
+ }
1086
+ interface ServingContext {
1087
+ /** Matches all contexts. */
1088
+ all?: string;
1089
+ /** Matches impressions for a particular app type. */
1090
+ appType?: AppContext;
1091
+ /** Matches impressions for a particular auction type. */
1092
+ auctionType?: AuctionContext;
1093
+ /** Matches impressions coming from users *or* publishers in a specific location. */
1094
+ location?: LocationContext;
1095
+ /** Matches impressions coming from a particular platform. */
1096
+ platform?: PlatformContext;
1097
+ /** Matches impressions for a particular security type. */
1098
+ securityType?: SecurityContext;
1099
+ }
1100
+ interface ServingRestriction {
1101
+ /** The contexts for the restriction. */
1102
+ contexts?: ServingContext[];
1103
+ /** Disapproval bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method. */
1104
+ disapproval?: Disapproval;
1105
+ /**
1106
+ * Any disapprovals bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method. Deprecated; please use disapproval
1107
+ * field instead.
1108
+ */
1109
+ disapprovalReasons?: Disapproval[];
1110
+ /** The status of the creative in this context (for example, it has been explicitly disapproved or is pending review). */
1111
+ status?: string;
1112
+ }
1113
+ interface Size {
1114
+ /** The height of the creative. */
1115
+ height?: number;
1116
+ /** The width of the creative */
1117
+ width?: number;
1118
+ }
1119
+ // tslint:disable-next-line:no-empty-interface
1120
+ interface StopWatchingCreativeRequest {
1121
+ }
1122
+ interface TargetingCriteria {
1123
+ /** The list of values to exclude from targeting. Each value is AND'd together. */
1124
+ exclusions?: TargetingValue[];
1125
+ /** The list of value to include as part of the targeting. Each value is OR'd together. */
1126
+ inclusions?: TargetingValue[];
1127
+ /**
1128
+ * The key representing the shared targeting criterion. Targeting criteria defined by Google ad servers will begin with GOOG_. Third parties may define their own keys. A list of
1129
+ * permissible keys along with the acceptable values will be provided as part of the external documentation.
1130
+ */
1131
+ key?: string;
1132
+ }
1133
+ interface TargetingValue {
1134
+ /** The creative size value to include/exclude. Filled in when key = GOOG_CREATIVE_SIZE */
1135
+ creativeSizeValue?: CreativeSize;
1136
+ /** The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING. The definition of this targeting is derived from the structure used by Ad Manager. */
1137
+ dayPartTargetingValue?: DayPartTargeting;
1138
+ /** The long value to include/exclude. */
1139
+ longValue?: string;
1140
+ /** The string value to include/exclude. */
1141
+ stringValue?: string;
1142
+ }
1143
+ interface TechnologyTargeting {
1144
+ /** IDs of device capabilities to be included/excluded. */
1145
+ deviceCapabilityTargeting?: CriteriaTargeting;
1146
+ /** IDs of device categories to be included/excluded. */
1147
+ deviceCategoryTargeting?: CriteriaTargeting;
1148
+ /** Operating system related targeting information. */
1149
+ operatingSystemTargeting?: OperatingSystemTargeting;
1150
+ }
1151
+ interface TimeInterval {
1152
+ /** The timestamp marking the end of the range (exclusive) for which data is included. */
1153
+ endTime?: string;
1154
+ /** The timestamp marking the start of the range (inclusive) for which data is included. */
1155
+ startTime?: string;
1156
+ }
1157
+ interface TimeOfDay {
1158
+ /** Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. */
1159
+ hours?: number;
1160
+ /** Minutes of hour of day. Must be from 0 to 59. */
1161
+ minutes?: number;
1162
+ /** Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. */
1163
+ nanos?: number;
1164
+ /** Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. */
1165
+ seconds?: number;
1166
+ }
1167
+ interface UrlTargeting {
1168
+ /** A list of URLs to be excluded. */
1169
+ excludedUrls?: string[];
1170
+ /** A list of URLs to be included. */
1171
+ targetedUrls?: string[];
1172
+ }
1173
+ interface VideoContent {
1174
+ /** The URL to fetch a video ad. */
1175
+ videoUrl?: string;
1176
+ /** The contents of a VAST document for a video ad. This document should conform to the VAST 2.0 or 3.0 standard. */
1177
+ videoVastXml?: string;
1178
+ }
1179
+ interface VideoTargeting {
1180
+ /** A list of video positions to be excluded. Position types can either be included or excluded (XOR). */
1181
+ excludedPositionTypes?: string[];
1182
+ /** A list of video positions to be included. When the included list is present, the excluded list must be empty. When the excluded list is present, the included list must be empty. */
1183
+ targetedPositionTypes?: string[];
1184
+ }
1185
+ interface WatchCreativeRequest {
1186
+ /**
1187
+ * The Pub/Sub topic to publish notifications to. This topic must already exist and must give permission to ad-exchange-buyside-reports@google.com to write to the topic. This should be
1188
+ * the full resource name in "projects/{project_id}/topics/{topic_id}" format.
1189
+ */
1190
+ topic?: string;
1191
+ }
1192
+ interface InvitationsResource {
1193
+ /** Creates and sends out an email invitation to access an Ad Exchange client buyer account. */
1194
+ create(request: {
1195
+ /** V1 error format. */
1196
+ "$.xgafv"?: string;
1197
+ /** OAuth access token. */
1198
+ access_token?: string;
1199
+ /** Numerical account ID of the client's sponsor buyer. (required) */
1200
+ accountId: string;
1201
+ /** Data format for response. */
1202
+ alt?: string;
1203
+ /** JSONP */
1204
+ callback?: string;
1205
+ /** Numerical account ID of the client buyer that the user should be associated with. (required) */
1206
+ clientAccountId: string;
1207
+ /** Selector specifying which fields to include in a partial response. */
1208
+ fields?: string;
1209
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1210
+ key?: string;
1211
+ /** OAuth 2.0 token for the current user. */
1212
+ oauth_token?: string;
1213
+ /** Returns response with indentations and line breaks. */
1214
+ prettyPrint?: boolean;
1215
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1216
+ quotaUser?: string;
1217
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1218
+ upload_protocol?: string;
1219
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1220
+ uploadType?: string;
1221
+ /** Request body */
1222
+ resource: ClientUserInvitation;
1223
+ }): Request<ClientUserInvitation>;
1224
+ create(request: {
1225
+ /** V1 error format. */
1226
+ "$.xgafv"?: string;
1227
+ /** OAuth access token. */
1228
+ access_token?: string;
1229
+ /** Numerical account ID of the client's sponsor buyer. (required) */
1230
+ accountId: string;
1231
+ /** Data format for response. */
1232
+ alt?: string;
1233
+ /** JSONP */
1234
+ callback?: string;
1235
+ /** Numerical account ID of the client buyer that the user should be associated with. (required) */
1236
+ clientAccountId: string;
1237
+ /** Selector specifying which fields to include in a partial response. */
1238
+ fields?: string;
1239
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1240
+ key?: string;
1241
+ /** OAuth 2.0 token for the current user. */
1242
+ oauth_token?: string;
1243
+ /** Returns response with indentations and line breaks. */
1244
+ prettyPrint?: boolean;
1245
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1246
+ quotaUser?: string;
1247
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1248
+ upload_protocol?: string;
1249
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1250
+ uploadType?: string;
1251
+ },
1252
+ body: ClientUserInvitation): Request<ClientUserInvitation>;
1253
+ /** Retrieves an existing client user invitation. */
1254
+ get(request?: {
1255
+ /** V1 error format. */
1256
+ "$.xgafv"?: string;
1257
+ /** OAuth access token. */
1258
+ access_token?: string;
1259
+ /** Numerical account ID of the client's sponsor buyer. (required) */
1260
+ accountId: string;
1261
+ /** Data format for response. */
1262
+ alt?: string;
1263
+ /** JSONP */
1264
+ callback?: string;
1265
+ /** Numerical account ID of the client buyer that the user invitation to be retrieved is associated with. (required) */
1266
+ clientAccountId: string;
1267
+ /** Selector specifying which fields to include in a partial response. */
1268
+ fields?: string;
1269
+ /** Numerical identifier of the user invitation to retrieve. (required) */
1270
+ invitationId: string;
1271
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1272
+ key?: string;
1273
+ /** OAuth 2.0 token for the current user. */
1274
+ oauth_token?: string;
1275
+ /** Returns response with indentations and line breaks. */
1276
+ prettyPrint?: boolean;
1277
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1278
+ quotaUser?: string;
1279
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1280
+ upload_protocol?: string;
1281
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1282
+ uploadType?: string;
1283
+ }): Request<ClientUserInvitation>;
1284
+ /** Lists all the client users invitations for a client with a given account ID. */
1285
+ list(request?: {
1286
+ /** V1 error format. */
1287
+ "$.xgafv"?: string;
1288
+ /** OAuth access token. */
1289
+ access_token?: string;
1290
+ /** Numerical account ID of the client's sponsor buyer. (required) */
1291
+ accountId: string;
1292
+ /** Data format for response. */
1293
+ alt?: string;
1294
+ /** JSONP */
1295
+ callback?: string;
1296
+ /**
1297
+ * Numerical account ID of the client buyer to list invitations for. (required) You must either specify a string representation of a numerical account identifier or the `-`
1298
+ * character to list all the invitations for all the clients of a given sponsor buyer.
1299
+ */
1300
+ clientAccountId: string;
1301
+ /** Selector specifying which fields to include in a partial response. */
1302
+ fields?: string;
1303
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1304
+ key?: string;
1305
+ /** OAuth 2.0 token for the current user. */
1306
+ oauth_token?: string;
1307
+ /** Requested page size. Server may return fewer clients than requested. If unspecified, server will pick an appropriate default. */
1308
+ pageSize?: number;
1309
+ /**
1310
+ * A token identifying a page of results the server should return. Typically, this is the value of ListClientUserInvitationsResponse.nextPageToken returned from the previous call
1311
+ * to the clients.invitations.list method.
1312
+ */
1313
+ pageToken?: string;
1314
+ /** Returns response with indentations and line breaks. */
1315
+ prettyPrint?: boolean;
1316
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1317
+ quotaUser?: string;
1318
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1319
+ upload_protocol?: string;
1320
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1321
+ uploadType?: string;
1322
+ }): Request<ListClientUserInvitationsResponse>;
1323
+ }
1324
+ interface UsersResource {
1325
+ /** Retrieves an existing client user. */
1326
+ get(request?: {
1327
+ /** V1 error format. */
1328
+ "$.xgafv"?: string;
1329
+ /** OAuth access token. */
1330
+ access_token?: string;
1331
+ /** Numerical account ID of the client's sponsor buyer. (required) */
1332
+ accountId: string;
1333
+ /** Data format for response. */
1334
+ alt?: string;
1335
+ /** JSONP */
1336
+ callback?: string;
1337
+ /** Numerical account ID of the client buyer that the user to be retrieved is associated with. (required) */
1338
+ clientAccountId: string;
1339
+ /** Selector specifying which fields to include in a partial response. */
1340
+ fields?: string;
1341
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1342
+ key?: string;
1343
+ /** OAuth 2.0 token for the current user. */
1344
+ oauth_token?: string;
1345
+ /** Returns response with indentations and line breaks. */
1346
+ prettyPrint?: boolean;
1347
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1348
+ quotaUser?: string;
1349
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1350
+ upload_protocol?: string;
1351
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1352
+ uploadType?: string;
1353
+ /** Numerical identifier of the user to retrieve. (required) */
1354
+ userId: string;
1355
+ }): Request<ClientUser>;
1356
+ /** Lists all the known client users for a specified sponsor buyer account ID. */
1357
+ list(request?: {
1358
+ /** V1 error format. */
1359
+ "$.xgafv"?: string;
1360
+ /** OAuth access token. */
1361
+ access_token?: string;
1362
+ /** Numerical account ID of the sponsor buyer of the client to list users for. (required) */
1363
+ accountId: string;
1364
+ /** Data format for response. */
1365
+ alt?: string;
1366
+ /** JSONP */
1367
+ callback?: string;
1368
+ /**
1369
+ * The account ID of the client buyer to list users for. (required) You must specify either a string representation of a numerical account identifier or the `-` character to list
1370
+ * all the client users for all the clients of a given sponsor buyer.
1371
+ */
1372
+ clientAccountId: string;
1373
+ /** Selector specifying which fields to include in a partial response. */
1374
+ fields?: string;
1375
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1376
+ key?: string;
1377
+ /** OAuth 2.0 token for the current user. */
1378
+ oauth_token?: string;
1379
+ /** Requested page size. The server may return fewer clients than requested. If unspecified, the server will pick an appropriate default. */
1380
+ pageSize?: number;
1381
+ /**
1382
+ * A token identifying a page of results the server should return. Typically, this is the value of ListClientUsersResponse.nextPageToken returned from the previous call to the
1383
+ * accounts.clients.users.list method.
1384
+ */
1385
+ pageToken?: string;
1386
+ /** Returns response with indentations and line breaks. */
1387
+ prettyPrint?: boolean;
1388
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1389
+ quotaUser?: string;
1390
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1391
+ upload_protocol?: string;
1392
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1393
+ uploadType?: string;
1394
+ }): Request<ListClientUsersResponse>;
1395
+ /** Updates an existing client user. Only the user status can be changed on update. */
1396
+ update(request: {
1397
+ /** V1 error format. */
1398
+ "$.xgafv"?: string;
1399
+ /** OAuth access token. */
1400
+ access_token?: string;
1401
+ /** Numerical account ID of the client's sponsor buyer. (required) */
1402
+ accountId: string;
1403
+ /** Data format for response. */
1404
+ alt?: string;
1405
+ /** JSONP */
1406
+ callback?: string;
1407
+ /** Numerical account ID of the client buyer that the user to be retrieved is associated with. (required) */
1408
+ clientAccountId: string;
1409
+ /** Selector specifying which fields to include in a partial response. */
1410
+ fields?: string;
1411
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1412
+ key?: string;
1413
+ /** OAuth 2.0 token for the current user. */
1414
+ oauth_token?: string;
1415
+ /** Returns response with indentations and line breaks. */
1416
+ prettyPrint?: boolean;
1417
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1418
+ quotaUser?: string;
1419
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1420
+ upload_protocol?: string;
1421
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1422
+ uploadType?: string;
1423
+ /** Numerical identifier of the user to retrieve. (required) */
1424
+ userId: string;
1425
+ /** Request body */
1426
+ resource: ClientUser;
1427
+ }): Request<ClientUser>;
1428
+ update(request: {
1429
+ /** V1 error format. */
1430
+ "$.xgafv"?: string;
1431
+ /** OAuth access token. */
1432
+ access_token?: string;
1433
+ /** Numerical account ID of the client's sponsor buyer. (required) */
1434
+ accountId: string;
1435
+ /** Data format for response. */
1436
+ alt?: string;
1437
+ /** JSONP */
1438
+ callback?: string;
1439
+ /** Numerical account ID of the client buyer that the user to be retrieved is associated with. (required) */
1440
+ clientAccountId: string;
1441
+ /** Selector specifying which fields to include in a partial response. */
1442
+ fields?: string;
1443
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1444
+ key?: string;
1445
+ /** OAuth 2.0 token for the current user. */
1446
+ oauth_token?: string;
1447
+ /** Returns response with indentations and line breaks. */
1448
+ prettyPrint?: boolean;
1449
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1450
+ quotaUser?: string;
1451
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1452
+ upload_protocol?: string;
1453
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1454
+ uploadType?: string;
1455
+ /** Numerical identifier of the user to retrieve. (required) */
1456
+ userId: string;
1457
+ },
1458
+ body: ClientUser): Request<ClientUser>;
1459
+ }
1460
+ interface ClientsResource {
1461
+ /** Creates a new client buyer. */
1462
+ create(request: {
1463
+ /** V1 error format. */
1464
+ "$.xgafv"?: string;
1465
+ /** OAuth access token. */
1466
+ access_token?: string;
1467
+ /** Unique numerical account ID for the buyer of which the client buyer is a customer; the sponsor buyer to create a client for. (required) */
1468
+ accountId: string;
1469
+ /** Data format for response. */
1470
+ alt?: string;
1471
+ /** JSONP */
1472
+ callback?: string;
1473
+ /** Selector specifying which fields to include in a partial response. */
1474
+ fields?: string;
1475
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1476
+ key?: string;
1477
+ /** OAuth 2.0 token for the current user. */
1478
+ oauth_token?: string;
1479
+ /** Returns response with indentations and line breaks. */
1480
+ prettyPrint?: boolean;
1481
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1482
+ quotaUser?: string;
1483
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1484
+ upload_protocol?: string;
1485
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1486
+ uploadType?: string;
1487
+ /** Request body */
1488
+ resource: Client;
1489
+ }): Request<Client>;
1490
+ create(request: {
1491
+ /** V1 error format. */
1492
+ "$.xgafv"?: string;
1493
+ /** OAuth access token. */
1494
+ access_token?: string;
1495
+ /** Unique numerical account ID for the buyer of which the client buyer is a customer; the sponsor buyer to create a client for. (required) */
1496
+ accountId: string;
1497
+ /** Data format for response. */
1498
+ alt?: string;
1499
+ /** JSONP */
1500
+ callback?: string;
1501
+ /** Selector specifying which fields to include in a partial response. */
1502
+ fields?: string;
1503
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1504
+ key?: string;
1505
+ /** OAuth 2.0 token for the current user. */
1506
+ oauth_token?: string;
1507
+ /** Returns response with indentations and line breaks. */
1508
+ prettyPrint?: boolean;
1509
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1510
+ quotaUser?: string;
1511
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1512
+ upload_protocol?: string;
1513
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1514
+ uploadType?: string;
1515
+ },
1516
+ body: Client): Request<Client>;
1517
+ /** Gets a client buyer with a given client account ID. */
1518
+ get(request?: {
1519
+ /** V1 error format. */
1520
+ "$.xgafv"?: string;
1521
+ /** OAuth access token. */
1522
+ access_token?: string;
1523
+ /** Numerical account ID of the client's sponsor buyer. (required) */
1524
+ accountId: string;
1525
+ /** Data format for response. */
1526
+ alt?: string;
1527
+ /** JSONP */
1528
+ callback?: string;
1529
+ /** Numerical account ID of the client buyer to retrieve. (required) */
1530
+ clientAccountId: string;
1531
+ /** Selector specifying which fields to include in a partial response. */
1532
+ fields?: string;
1533
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1534
+ key?: string;
1535
+ /** OAuth 2.0 token for the current user. */
1536
+ oauth_token?: string;
1537
+ /** Returns response with indentations and line breaks. */
1538
+ prettyPrint?: boolean;
1539
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1540
+ quotaUser?: string;
1541
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1542
+ upload_protocol?: string;
1543
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1544
+ uploadType?: string;
1545
+ }): Request<Client>;
1546
+ /** Lists all the clients for the current sponsor buyer. */
1547
+ list(request?: {
1548
+ /** V1 error format. */
1549
+ "$.xgafv"?: string;
1550
+ /** OAuth access token. */
1551
+ access_token?: string;
1552
+ /** Unique numerical account ID of the sponsor buyer to list the clients for. */
1553
+ accountId: string;
1554
+ /** Data format for response. */
1555
+ alt?: string;
1556
+ /** JSONP */
1557
+ callback?: string;
1558
+ /** Selector specifying which fields to include in a partial response. */
1559
+ fields?: string;
1560
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1561
+ key?: string;
1562
+ /** OAuth 2.0 token for the current user. */
1563
+ oauth_token?: string;
1564
+ /** Requested page size. The server may return fewer clients than requested. If unspecified, the server will pick an appropriate default. */
1565
+ pageSize?: number;
1566
+ /**
1567
+ * A token identifying a page of results the server should return. Typically, this is the value of ListClientsResponse.nextPageToken returned from the previous call to the
1568
+ * accounts.clients.list method.
1569
+ */
1570
+ pageToken?: string;
1571
+ /**
1572
+ * Optional unique identifier (from the standpoint of an Ad Exchange sponsor buyer partner) of the client to return. If specified, at most one client will be returned in the
1573
+ * response.
1574
+ */
1575
+ partnerClientId?: string;
1576
+ /** Returns response with indentations and line breaks. */
1577
+ prettyPrint?: boolean;
1578
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1579
+ quotaUser?: string;
1580
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1581
+ upload_protocol?: string;
1582
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1583
+ uploadType?: string;
1584
+ }): Request<ListClientsResponse>;
1585
+ /** Updates an existing client buyer. */
1586
+ update(request: {
1587
+ /** V1 error format. */
1588
+ "$.xgafv"?: string;
1589
+ /** OAuth access token. */
1590
+ access_token?: string;
1591
+ /** Unique numerical account ID for the buyer of which the client buyer is a customer; the sponsor buyer to update a client for. (required) */
1592
+ accountId: string;
1593
+ /** Data format for response. */
1594
+ alt?: string;
1595
+ /** JSONP */
1596
+ callback?: string;
1597
+ /** Unique numerical account ID of the client to update. (required) */
1598
+ clientAccountId: string;
1599
+ /** Selector specifying which fields to include in a partial response. */
1600
+ fields?: string;
1601
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1602
+ key?: string;
1603
+ /** OAuth 2.0 token for the current user. */
1604
+ oauth_token?: string;
1605
+ /** Returns response with indentations and line breaks. */
1606
+ prettyPrint?: boolean;
1607
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1608
+ quotaUser?: string;
1609
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1610
+ upload_protocol?: string;
1611
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1612
+ uploadType?: string;
1613
+ /** Request body */
1614
+ resource: Client;
1615
+ }): Request<Client>;
1616
+ update(request: {
1617
+ /** V1 error format. */
1618
+ "$.xgafv"?: string;
1619
+ /** OAuth access token. */
1620
+ access_token?: string;
1621
+ /** Unique numerical account ID for the buyer of which the client buyer is a customer; the sponsor buyer to update a client for. (required) */
1622
+ accountId: string;
1623
+ /** Data format for response. */
1624
+ alt?: string;
1625
+ /** JSONP */
1626
+ callback?: string;
1627
+ /** Unique numerical account ID of the client to update. (required) */
1628
+ clientAccountId: string;
1629
+ /** Selector specifying which fields to include in a partial response. */
1630
+ fields?: string;
1631
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1632
+ key?: string;
1633
+ /** OAuth 2.0 token for the current user. */
1634
+ oauth_token?: string;
1635
+ /** Returns response with indentations and line breaks. */
1636
+ prettyPrint?: boolean;
1637
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1638
+ quotaUser?: string;
1639
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1640
+ upload_protocol?: string;
1641
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1642
+ uploadType?: string;
1643
+ },
1644
+ body: Client): Request<Client>;
1645
+ invitations: InvitationsResource;
1646
+ users: UsersResource;
1647
+ }
1648
+ interface DealAssociationsResource {
1649
+ /** Associate an existing deal with a creative. */
1650
+ add(request: {
1651
+ /** V1 error format. */
1652
+ "$.xgafv"?: string;
1653
+ /** OAuth access token. */
1654
+ access_token?: string;
1655
+ /** The account the creative belongs to. */
1656
+ accountId: string;
1657
+ /** Data format for response. */
1658
+ alt?: string;
1659
+ /** JSONP */
1660
+ callback?: string;
1661
+ /** The ID of the creative associated with the deal. */
1662
+ creativeId: string;
1663
+ /** Selector specifying which fields to include in a partial response. */
1664
+ fields?: string;
1665
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1666
+ key?: string;
1667
+ /** OAuth 2.0 token for the current user. */
1668
+ oauth_token?: string;
1669
+ /** Returns response with indentations and line breaks. */
1670
+ prettyPrint?: boolean;
1671
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1672
+ quotaUser?: string;
1673
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1674
+ upload_protocol?: string;
1675
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1676
+ uploadType?: string;
1677
+ /** Request body */
1678
+ resource: AddDealAssociationRequest;
1679
+ }): Request<{}>;
1680
+ add(request: {
1681
+ /** V1 error format. */
1682
+ "$.xgafv"?: string;
1683
+ /** OAuth access token. */
1684
+ access_token?: string;
1685
+ /** The account the creative belongs to. */
1686
+ accountId: string;
1687
+ /** Data format for response. */
1688
+ alt?: string;
1689
+ /** JSONP */
1690
+ callback?: string;
1691
+ /** The ID of the creative associated with the deal. */
1692
+ creativeId: string;
1693
+ /** Selector specifying which fields to include in a partial response. */
1694
+ fields?: string;
1695
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1696
+ key?: string;
1697
+ /** OAuth 2.0 token for the current user. */
1698
+ oauth_token?: string;
1699
+ /** Returns response with indentations and line breaks. */
1700
+ prettyPrint?: boolean;
1701
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1702
+ quotaUser?: string;
1703
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1704
+ upload_protocol?: string;
1705
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1706
+ uploadType?: string;
1707
+ },
1708
+ body: AddDealAssociationRequest): Request<{}>;
1709
+ /** List all creative-deal associations. */
1710
+ list(request?: {
1711
+ /** V1 error format. */
1712
+ "$.xgafv"?: string;
1713
+ /** OAuth access token. */
1714
+ access_token?: string;
1715
+ /** The account to list the associations from. Specify "-" to list all creatives the current user has access to. */
1716
+ accountId: string;
1717
+ /** Data format for response. */
1718
+ alt?: string;
1719
+ /** JSONP */
1720
+ callback?: string;
1721
+ /** The creative ID to list the associations from. Specify "-" to list all creatives under the above account. */
1722
+ creativeId: string;
1723
+ /** Selector specifying which fields to include in a partial response. */
1724
+ fields?: string;
1725
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1726
+ key?: string;
1727
+ /** OAuth 2.0 token for the current user. */
1728
+ oauth_token?: string;
1729
+ /** Requested page size. Server may return fewer associations than requested. If unspecified, server will pick an appropriate default. */
1730
+ pageSize?: number;
1731
+ /**
1732
+ * A token identifying a page of results the server should return. Typically, this is the value of ListDealAssociationsResponse.next_page_token returned from the previous call to
1733
+ * 'ListDealAssociations' method.
1734
+ */
1735
+ pageToken?: string;
1736
+ /** Returns response with indentations and line breaks. */
1737
+ prettyPrint?: boolean;
1738
+ /**
1739
+ * An optional query string to filter deal associations. If no filter is specified, all associations will be returned. Supported queries are: - accountId=*account_id_string* -
1740
+ * creativeId=*creative_id_string* - dealsId=*deals_id_string* - dealsStatus:{approved, conditionally_approved, disapproved, not_checked} - openAuctionStatus:{approved,
1741
+ * conditionally_approved, disapproved, not_checked} Example: 'dealsId=12345 AND dealsStatus:disapproved'
1742
+ */
1743
+ query?: string;
1744
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1745
+ quotaUser?: string;
1746
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1747
+ upload_protocol?: string;
1748
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1749
+ uploadType?: string;
1750
+ }): Request<ListDealAssociationsResponse>;
1751
+ /** Remove the association between a deal and a creative. */
1752
+ remove(request: {
1753
+ /** V1 error format. */
1754
+ "$.xgafv"?: string;
1755
+ /** OAuth access token. */
1756
+ access_token?: string;
1757
+ /** The account the creative belongs to. */
1758
+ accountId: string;
1759
+ /** Data format for response. */
1760
+ alt?: string;
1761
+ /** JSONP */
1762
+ callback?: string;
1763
+ /** The ID of the creative associated with the deal. */
1764
+ creativeId: string;
1765
+ /** Selector specifying which fields to include in a partial response. */
1766
+ fields?: string;
1767
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1768
+ key?: string;
1769
+ /** OAuth 2.0 token for the current user. */
1770
+ oauth_token?: string;
1771
+ /** Returns response with indentations and line breaks. */
1772
+ prettyPrint?: boolean;
1773
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1774
+ quotaUser?: string;
1775
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1776
+ upload_protocol?: string;
1777
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1778
+ uploadType?: string;
1779
+ /** Request body */
1780
+ resource: RemoveDealAssociationRequest;
1781
+ }): Request<{}>;
1782
+ remove(request: {
1783
+ /** V1 error format. */
1784
+ "$.xgafv"?: string;
1785
+ /** OAuth access token. */
1786
+ access_token?: string;
1787
+ /** The account the creative belongs to. */
1788
+ accountId: string;
1789
+ /** Data format for response. */
1790
+ alt?: string;
1791
+ /** JSONP */
1792
+ callback?: string;
1793
+ /** The ID of the creative associated with the deal. */
1794
+ creativeId: string;
1795
+ /** Selector specifying which fields to include in a partial response. */
1796
+ fields?: string;
1797
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1798
+ key?: string;
1799
+ /** OAuth 2.0 token for the current user. */
1800
+ oauth_token?: string;
1801
+ /** Returns response with indentations and line breaks. */
1802
+ prettyPrint?: boolean;
1803
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1804
+ quotaUser?: string;
1805
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1806
+ upload_protocol?: string;
1807
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1808
+ uploadType?: string;
1809
+ },
1810
+ body: RemoveDealAssociationRequest): Request<{}>;
1811
+ }
1812
+ interface CreativesResource {
1813
+ /** Creates a creative. */
1814
+ create(request: {
1815
+ /** V1 error format. */
1816
+ "$.xgafv"?: string;
1817
+ /** OAuth access token. */
1818
+ access_token?: string;
1819
+ /** The account that this creative belongs to. Can be used to filter the response of the creatives.list method. */
1820
+ accountId: string;
1821
+ /** Data format for response. */
1822
+ alt?: string;
1823
+ /** JSONP */
1824
+ callback?: string;
1825
+ /** Indicates if multiple creatives can share an ID or not. Default is NO_DUPLICATES (one ID per creative). */
1826
+ duplicateIdMode?: string;
1827
+ /** Selector specifying which fields to include in a partial response. */
1828
+ fields?: string;
1829
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1830
+ key?: string;
1831
+ /** OAuth 2.0 token for the current user. */
1832
+ oauth_token?: string;
1833
+ /** Returns response with indentations and line breaks. */
1834
+ prettyPrint?: boolean;
1835
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1836
+ quotaUser?: string;
1837
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1838
+ upload_protocol?: string;
1839
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1840
+ uploadType?: string;
1841
+ /** Request body */
1842
+ resource: Creative;
1843
+ }): Request<Creative>;
1844
+ create(request: {
1845
+ /** V1 error format. */
1846
+ "$.xgafv"?: string;
1847
+ /** OAuth access token. */
1848
+ access_token?: string;
1849
+ /** The account that this creative belongs to. Can be used to filter the response of the creatives.list method. */
1850
+ accountId: string;
1851
+ /** Data format for response. */
1852
+ alt?: string;
1853
+ /** JSONP */
1854
+ callback?: string;
1855
+ /** Indicates if multiple creatives can share an ID or not. Default is NO_DUPLICATES (one ID per creative). */
1856
+ duplicateIdMode?: string;
1857
+ /** Selector specifying which fields to include in a partial response. */
1858
+ fields?: string;
1859
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1860
+ key?: string;
1861
+ /** OAuth 2.0 token for the current user. */
1862
+ oauth_token?: string;
1863
+ /** Returns response with indentations and line breaks. */
1864
+ prettyPrint?: boolean;
1865
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1866
+ quotaUser?: string;
1867
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1868
+ upload_protocol?: string;
1869
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1870
+ uploadType?: string;
1871
+ },
1872
+ body: Creative): Request<Creative>;
1873
+ /** Gets a creative. */
1874
+ get(request?: {
1875
+ /** V1 error format. */
1876
+ "$.xgafv"?: string;
1877
+ /** OAuth access token. */
1878
+ access_token?: string;
1879
+ /** The account the creative belongs to. */
1880
+ accountId: string;
1881
+ /** Data format for response. */
1882
+ alt?: string;
1883
+ /** JSONP */
1884
+ callback?: string;
1885
+ /** The ID of the creative to retrieve. */
1886
+ creativeId: string;
1887
+ /** Selector specifying which fields to include in a partial response. */
1888
+ fields?: string;
1889
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1890
+ key?: string;
1891
+ /** OAuth 2.0 token for the current user. */
1892
+ oauth_token?: string;
1893
+ /** Returns response with indentations and line breaks. */
1894
+ prettyPrint?: boolean;
1895
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1896
+ quotaUser?: string;
1897
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1898
+ upload_protocol?: string;
1899
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1900
+ uploadType?: string;
1901
+ }): Request<Creative>;
1902
+ /** Lists creatives. */
1903
+ list(request?: {
1904
+ /** V1 error format. */
1905
+ "$.xgafv"?: string;
1906
+ /** OAuth access token. */
1907
+ access_token?: string;
1908
+ /** The account to list the creatives from. Specify "-" to list all creatives the current user has access to. */
1909
+ accountId: string;
1910
+ /** Data format for response. */
1911
+ alt?: string;
1912
+ /** JSONP */
1913
+ callback?: string;
1914
+ /** Selector specifying which fields to include in a partial response. */
1915
+ fields?: string;
1916
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1917
+ key?: string;
1918
+ /** OAuth 2.0 token for the current user. */
1919
+ oauth_token?: string;
1920
+ /**
1921
+ * Requested page size. The server may return fewer creatives than requested (due to timeout constraint) even if more are available via another call. If unspecified, server will
1922
+ * pick an appropriate default. Acceptable values are 1 to 1000, inclusive.
1923
+ */
1924
+ pageSize?: number;
1925
+ /**
1926
+ * A token identifying a page of results the server should return. Typically, this is the value of ListCreativesResponse.next_page_token returned from the previous call to
1927
+ * 'ListCreatives' method.
1928
+ */
1929
+ pageToken?: string;
1930
+ /** Returns response with indentations and line breaks. */
1931
+ prettyPrint?: boolean;
1932
+ /**
1933
+ * An optional query string to filter creatives. If no filter is specified, all active creatives will be returned. Supported queries are: - accountId=*account_id_string* -
1934
+ * creativeId=*creative_id_string* - dealsStatus: {approved, conditionally_approved, disapproved, not_checked} - openAuctionStatus: {approved, conditionally_approved, disapproved,
1935
+ * not_checked} - attribute: {a numeric attribute from the list of attributes} - disapprovalReason: {a reason from DisapprovalReason} Example: 'accountId=12345 AND
1936
+ * (dealsStatus:disapproved AND disapprovalReason:unacceptable_content) OR attribute:47'
1937
+ */
1938
+ query?: string;
1939
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1940
+ quotaUser?: string;
1941
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1942
+ upload_protocol?: string;
1943
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1944
+ uploadType?: string;
1945
+ }): Request<ListCreativesResponse>;
1946
+ /** Stops watching a creative. Will stop push notifications being sent to the topics when the creative changes status. */
1947
+ stopWatching(request: {
1948
+ /** V1 error format. */
1949
+ "$.xgafv"?: string;
1950
+ /** OAuth access token. */
1951
+ access_token?: string;
1952
+ /** The account of the creative to stop notifications for. */
1953
+ accountId: string;
1954
+ /** Data format for response. */
1955
+ alt?: string;
1956
+ /** JSONP */
1957
+ callback?: string;
1958
+ /** The creative ID of the creative to stop notifications for. Specify "-" to specify stopping account level notifications. */
1959
+ creativeId: string;
1960
+ /** Selector specifying which fields to include in a partial response. */
1961
+ fields?: string;
1962
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1963
+ key?: string;
1964
+ /** OAuth 2.0 token for the current user. */
1965
+ oauth_token?: string;
1966
+ /** Returns response with indentations and line breaks. */
1967
+ prettyPrint?: boolean;
1968
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1969
+ quotaUser?: string;
1970
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1971
+ upload_protocol?: string;
1972
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1973
+ uploadType?: string;
1974
+ /** Request body */
1975
+ resource: StopWatchingCreativeRequest;
1976
+ }): Request<{}>;
1977
+ stopWatching(request: {
1978
+ /** V1 error format. */
1979
+ "$.xgafv"?: string;
1980
+ /** OAuth access token. */
1981
+ access_token?: string;
1982
+ /** The account of the creative to stop notifications for. */
1983
+ accountId: string;
1984
+ /** Data format for response. */
1985
+ alt?: string;
1986
+ /** JSONP */
1987
+ callback?: string;
1988
+ /** The creative ID of the creative to stop notifications for. Specify "-" to specify stopping account level notifications. */
1989
+ creativeId: string;
1990
+ /** Selector specifying which fields to include in a partial response. */
1991
+ fields?: string;
1992
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1993
+ key?: string;
1994
+ /** OAuth 2.0 token for the current user. */
1995
+ oauth_token?: string;
1996
+ /** Returns response with indentations and line breaks. */
1997
+ prettyPrint?: boolean;
1998
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1999
+ quotaUser?: string;
2000
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2001
+ upload_protocol?: string;
2002
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2003
+ uploadType?: string;
2004
+ },
2005
+ body: StopWatchingCreativeRequest): Request<{}>;
2006
+ /** Updates a creative. */
2007
+ update(request: {
2008
+ /** V1 error format. */
2009
+ "$.xgafv"?: string;
2010
+ /** OAuth access token. */
2011
+ access_token?: string;
2012
+ /** The account that this creative belongs to. Can be used to filter the response of the creatives.list method. */
2013
+ accountId: string;
2014
+ /** Data format for response. */
2015
+ alt?: string;
2016
+ /** JSONP */
2017
+ callback?: string;
2018
+ /** The buyer-defined creative ID of this creative. Can be used to filter the response of the creatives.list method. */
2019
+ creativeId: string;
2020
+ /** Selector specifying which fields to include in a partial response. */
2021
+ fields?: string;
2022
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2023
+ key?: string;
2024
+ /** OAuth 2.0 token for the current user. */
2025
+ oauth_token?: string;
2026
+ /** Returns response with indentations and line breaks. */
2027
+ prettyPrint?: boolean;
2028
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2029
+ quotaUser?: string;
2030
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2031
+ upload_protocol?: string;
2032
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2033
+ uploadType?: string;
2034
+ /** Request body */
2035
+ resource: Creative;
2036
+ }): Request<Creative>;
2037
+ update(request: {
2038
+ /** V1 error format. */
2039
+ "$.xgafv"?: string;
2040
+ /** OAuth access token. */
2041
+ access_token?: string;
2042
+ /** The account that this creative belongs to. Can be used to filter the response of the creatives.list method. */
2043
+ accountId: string;
2044
+ /** Data format for response. */
2045
+ alt?: string;
2046
+ /** JSONP */
2047
+ callback?: string;
2048
+ /** The buyer-defined creative ID of this creative. Can be used to filter the response of the creatives.list method. */
2049
+ creativeId: string;
2050
+ /** Selector specifying which fields to include in a partial response. */
2051
+ fields?: string;
2052
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2053
+ key?: string;
2054
+ /** OAuth 2.0 token for the current user. */
2055
+ oauth_token?: string;
2056
+ /** Returns response with indentations and line breaks. */
2057
+ prettyPrint?: boolean;
2058
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2059
+ quotaUser?: string;
2060
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2061
+ upload_protocol?: string;
2062
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2063
+ uploadType?: string;
2064
+ },
2065
+ body: Creative): Request<Creative>;
2066
+ /** Watches a creative. Will result in push notifications being sent to the topic when the creative changes status. */
2067
+ watch(request: {
2068
+ /** V1 error format. */
2069
+ "$.xgafv"?: string;
2070
+ /** OAuth access token. */
2071
+ access_token?: string;
2072
+ /** The account of the creative to watch. */
2073
+ accountId: string;
2074
+ /** Data format for response. */
2075
+ alt?: string;
2076
+ /** JSONP */
2077
+ callback?: string;
2078
+ /**
2079
+ * The creative ID to watch for status changes. Specify "-" to watch all creatives under the above account. If both creative-level and account-level notifications are sent, only a
2080
+ * single notification will be sent to the creative-level notification topic.
2081
+ */
2082
+ creativeId: string;
2083
+ /** Selector specifying which fields to include in a partial response. */
2084
+ fields?: string;
2085
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2086
+ key?: string;
2087
+ /** OAuth 2.0 token for the current user. */
2088
+ oauth_token?: string;
2089
+ /** Returns response with indentations and line breaks. */
2090
+ prettyPrint?: boolean;
2091
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2092
+ quotaUser?: string;
2093
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2094
+ upload_protocol?: string;
2095
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2096
+ uploadType?: string;
2097
+ /** Request body */
2098
+ resource: WatchCreativeRequest;
2099
+ }): Request<{}>;
2100
+ watch(request: {
2101
+ /** V1 error format. */
2102
+ "$.xgafv"?: string;
2103
+ /** OAuth access token. */
2104
+ access_token?: string;
2105
+ /** The account of the creative to watch. */
2106
+ accountId: string;
2107
+ /** Data format for response. */
2108
+ alt?: string;
2109
+ /** JSONP */
2110
+ callback?: string;
2111
+ /**
2112
+ * The creative ID to watch for status changes. Specify "-" to watch all creatives under the above account. If both creative-level and account-level notifications are sent, only a
2113
+ * single notification will be sent to the creative-level notification topic.
2114
+ */
2115
+ creativeId: string;
2116
+ /** Selector specifying which fields to include in a partial response. */
2117
+ fields?: string;
2118
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2119
+ key?: string;
2120
+ /** OAuth 2.0 token for the current user. */
2121
+ oauth_token?: string;
2122
+ /** Returns response with indentations and line breaks. */
2123
+ prettyPrint?: boolean;
2124
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2125
+ quotaUser?: string;
2126
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2127
+ upload_protocol?: string;
2128
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2129
+ uploadType?: string;
2130
+ },
2131
+ body: WatchCreativeRequest): Request<{}>;
2132
+ dealAssociations: DealAssociationsResource;
2133
+ }
2134
+ interface FinalizedProposalsResource {
2135
+ /** List finalized proposals, regardless if a proposal is being renegotiated. A filter expression (PQL query) may be specified to filter the results. The notes will not be returned. */
2136
+ list(request?: {
2137
+ /** V1 error format. */
2138
+ "$.xgafv"?: string;
2139
+ /** OAuth access token. */
2140
+ access_token?: string;
2141
+ /** Account ID of the buyer. */
2142
+ accountId: string;
2143
+ /** Data format for response. */
2144
+ alt?: string;
2145
+ /** JSONP */
2146
+ callback?: string;
2147
+ /** Selector specifying which fields to include in a partial response. */
2148
+ fields?: string;
2149
+ /** An optional PQL filter query used to query for proposals. Nested repeated fields, such as proposal.deals.targetingCriterion, cannot be filtered. */
2150
+ filter?: string;
2151
+ /** Syntax the filter is written in. Current implementation defaults to PQL but in the future it will be LIST_FILTER. */
2152
+ filterSyntax?: string;
2153
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2154
+ key?: string;
2155
+ /** OAuth 2.0 token for the current user. */
2156
+ oauth_token?: string;
2157
+ /** Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. */
2158
+ pageSize?: number;
2159
+ /** The page token as returned from ListProposalsResponse. */
2160
+ pageToken?: string;
2161
+ /** Returns response with indentations and line breaks. */
2162
+ prettyPrint?: boolean;
2163
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2164
+ quotaUser?: string;
2165
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2166
+ upload_protocol?: string;
2167
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2168
+ uploadType?: string;
2169
+ }): Request<ListProposalsResponse>;
2170
+ /**
2171
+ * Update given deals to pause serving. This method will set the `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to true for all listed deals in the request. Currently, this
2172
+ * method only applies to PG and PD deals. For PA deals, please call accounts.proposals.pause endpoint. It is a no-op to pause already-paused deals. It is an error to call
2173
+ * PauseProposalDeals for deals which are not part of the proposal of proposal_id or which are not finalized or renegotiating.
2174
+ */
2175
+ pause(request: {
2176
+ /** V1 error format. */
2177
+ "$.xgafv"?: string;
2178
+ /** OAuth access token. */
2179
+ access_token?: string;
2180
+ /** Account ID of the buyer. */
2181
+ accountId: string;
2182
+ /** Data format for response. */
2183
+ alt?: string;
2184
+ /** JSONP */
2185
+ callback?: string;
2186
+ /** Selector specifying which fields to include in a partial response. */
2187
+ fields?: string;
2188
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2189
+ key?: string;
2190
+ /** OAuth 2.0 token for the current user. */
2191
+ oauth_token?: string;
2192
+ /** Returns response with indentations and line breaks. */
2193
+ prettyPrint?: boolean;
2194
+ /** The proposal_id of the proposal containing the deals. */
2195
+ proposalId: string;
2196
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2197
+ quotaUser?: string;
2198
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2199
+ upload_protocol?: string;
2200
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2201
+ uploadType?: string;
2202
+ /** Request body */
2203
+ resource: PauseProposalDealsRequest;
2204
+ }): Request<Proposal>;
2205
+ pause(request: {
2206
+ /** V1 error format. */
2207
+ "$.xgafv"?: string;
2208
+ /** OAuth access token. */
2209
+ access_token?: string;
2210
+ /** Account ID of the buyer. */
2211
+ accountId: string;
2212
+ /** Data format for response. */
2213
+ alt?: string;
2214
+ /** JSONP */
2215
+ callback?: string;
2216
+ /** Selector specifying which fields to include in a partial response. */
2217
+ fields?: string;
2218
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2219
+ key?: string;
2220
+ /** OAuth 2.0 token for the current user. */
2221
+ oauth_token?: string;
2222
+ /** Returns response with indentations and line breaks. */
2223
+ prettyPrint?: boolean;
2224
+ /** The proposal_id of the proposal containing the deals. */
2225
+ proposalId: string;
2226
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2227
+ quotaUser?: string;
2228
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2229
+ upload_protocol?: string;
2230
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2231
+ uploadType?: string;
2232
+ },
2233
+ body: PauseProposalDealsRequest): Request<Proposal>;
2234
+ /**
2235
+ * Update given deals to resume serving. This method will set the `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to false for all listed deals in the request. Currently,
2236
+ * this method only applies to PG and PD deals. For PA deals, please call accounts.proposals.resume endpoint. It is a no-op to resume running deals or deals paused by the other party.
2237
+ * It is an error to call ResumeProposalDeals for deals which are not part of the proposal of proposal_id or which are not finalized or renegotiating.
2238
+ */
2239
+ resume(request: {
2240
+ /** V1 error format. */
2241
+ "$.xgafv"?: string;
2242
+ /** OAuth access token. */
2243
+ access_token?: string;
2244
+ /** Account ID of the buyer. */
2245
+ accountId: string;
2246
+ /** Data format for response. */
2247
+ alt?: string;
2248
+ /** JSONP */
2249
+ callback?: string;
2250
+ /** Selector specifying which fields to include in a partial response. */
2251
+ fields?: string;
2252
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2253
+ key?: string;
2254
+ /** OAuth 2.0 token for the current user. */
2255
+ oauth_token?: string;
2256
+ /** Returns response with indentations and line breaks. */
2257
+ prettyPrint?: boolean;
2258
+ /** The proposal_id of the proposal containing the deals. */
2259
+ proposalId: string;
2260
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2261
+ quotaUser?: string;
2262
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2263
+ upload_protocol?: string;
2264
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2265
+ uploadType?: string;
2266
+ /** Request body */
2267
+ resource: ResumeProposalDealsRequest;
2268
+ }): Request<Proposal>;
2269
+ resume(request: {
2270
+ /** V1 error format. */
2271
+ "$.xgafv"?: string;
2272
+ /** OAuth access token. */
2273
+ access_token?: string;
2274
+ /** Account ID of the buyer. */
2275
+ accountId: string;
2276
+ /** Data format for response. */
2277
+ alt?: string;
2278
+ /** JSONP */
2279
+ callback?: string;
2280
+ /** Selector specifying which fields to include in a partial response. */
2281
+ fields?: string;
2282
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2283
+ key?: string;
2284
+ /** OAuth 2.0 token for the current user. */
2285
+ oauth_token?: string;
2286
+ /** Returns response with indentations and line breaks. */
2287
+ prettyPrint?: boolean;
2288
+ /** The proposal_id of the proposal containing the deals. */
2289
+ proposalId: string;
2290
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2291
+ quotaUser?: string;
2292
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2293
+ upload_protocol?: string;
2294
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2295
+ uploadType?: string;
2296
+ },
2297
+ body: ResumeProposalDealsRequest): Request<Proposal>;
2298
+ }
2299
+ interface ProductsResource {
2300
+ /** Gets the requested product by ID. */
2301
+ get(request?: {
2302
+ /** V1 error format. */
2303
+ "$.xgafv"?: string;
2304
+ /** OAuth access token. */
2305
+ access_token?: string;
2306
+ /** Account ID of the buyer. */
2307
+ accountId: string;
2308
+ /** Data format for response. */
2309
+ alt?: string;
2310
+ /** JSONP */
2311
+ callback?: string;
2312
+ /** Selector specifying which fields to include in a partial response. */
2313
+ fields?: string;
2314
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2315
+ key?: string;
2316
+ /** OAuth 2.0 token for the current user. */
2317
+ oauth_token?: string;
2318
+ /** Returns response with indentations and line breaks. */
2319
+ prettyPrint?: boolean;
2320
+ /** The ID for the product to get the head revision for. */
2321
+ productId: string;
2322
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2323
+ quotaUser?: string;
2324
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2325
+ upload_protocol?: string;
2326
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2327
+ uploadType?: string;
2328
+ }): Request<Product>;
2329
+ /** List all products visible to the buyer (optionally filtered by the specified PQL query). */
2330
+ list(request?: {
2331
+ /** V1 error format. */
2332
+ "$.xgafv"?: string;
2333
+ /** OAuth access token. */
2334
+ access_token?: string;
2335
+ /** Account ID of the buyer. */
2336
+ accountId: string;
2337
+ /** Data format for response. */
2338
+ alt?: string;
2339
+ /** JSONP */
2340
+ callback?: string;
2341
+ /** Selector specifying which fields to include in a partial response. */
2342
+ fields?: string;
2343
+ /**
2344
+ * An optional PQL query used to query for products. See https://developers.google.com/ad-manager/docs/pqlreference for documentation about PQL and examples. Nested repeated
2345
+ * fields, such as product.targetingCriterion.inclusions, cannot be filtered.
2346
+ */
2347
+ filter?: string;
2348
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2349
+ key?: string;
2350
+ /** OAuth 2.0 token for the current user. */
2351
+ oauth_token?: string;
2352
+ /** Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. */
2353
+ pageSize?: number;
2354
+ /** The page token as returned from ListProductsResponse. */
2355
+ pageToken?: string;
2356
+ /** Returns response with indentations and line breaks. */
2357
+ prettyPrint?: boolean;
2358
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2359
+ quotaUser?: string;
2360
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2361
+ upload_protocol?: string;
2362
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2363
+ uploadType?: string;
2364
+ }): Request<ListProductsResponse>;
2365
+ }
2366
+ interface ProposalsResource {
2367
+ /**
2368
+ * Mark the proposal as accepted at the given revision number. If the number does not match the server's revision number an `ABORTED` error message will be returned. This call updates
2369
+ * the proposal_state from `PROPOSED` to `BUYER_ACCEPTED`, or from `SELLER_ACCEPTED` to `FINALIZED`. Upon calling this endpoint, the buyer implicitly agrees to the terms and conditions
2370
+ * optionally set within the proposal by the publisher.
2371
+ */
2372
+ accept(request: {
2373
+ /** V1 error format. */
2374
+ "$.xgafv"?: string;
2375
+ /** OAuth access token. */
2376
+ access_token?: string;
2377
+ /** Account ID of the buyer. */
2378
+ accountId: string;
2379
+ /** Data format for response. */
2380
+ alt?: string;
2381
+ /** JSONP */
2382
+ callback?: string;
2383
+ /** Selector specifying which fields to include in a partial response. */
2384
+ fields?: string;
2385
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2386
+ key?: string;
2387
+ /** OAuth 2.0 token for the current user. */
2388
+ oauth_token?: string;
2389
+ /** Returns response with indentations and line breaks. */
2390
+ prettyPrint?: boolean;
2391
+ /** The ID of the proposal to accept. */
2392
+ proposalId: string;
2393
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2394
+ quotaUser?: string;
2395
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2396
+ upload_protocol?: string;
2397
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2398
+ uploadType?: string;
2399
+ /** Request body */
2400
+ resource: AcceptProposalRequest;
2401
+ }): Request<Proposal>;
2402
+ accept(request: {
2403
+ /** V1 error format. */
2404
+ "$.xgafv"?: string;
2405
+ /** OAuth access token. */
2406
+ access_token?: string;
2407
+ /** Account ID of the buyer. */
2408
+ accountId: string;
2409
+ /** Data format for response. */
2410
+ alt?: string;
2411
+ /** JSONP */
2412
+ callback?: string;
2413
+ /** Selector specifying which fields to include in a partial response. */
2414
+ fields?: string;
2415
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2416
+ key?: string;
2417
+ /** OAuth 2.0 token for the current user. */
2418
+ oauth_token?: string;
2419
+ /** Returns response with indentations and line breaks. */
2420
+ prettyPrint?: boolean;
2421
+ /** The ID of the proposal to accept. */
2422
+ proposalId: string;
2423
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2424
+ quotaUser?: string;
2425
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2426
+ upload_protocol?: string;
2427
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2428
+ uploadType?: string;
2429
+ },
2430
+ body: AcceptProposalRequest): Request<Proposal>;
2431
+ /** Create a new note and attach it to the proposal. The note is assigned a unique ID by the server. The proposal revision number will not increase when associated with a new note. */
2432
+ addNote(request: {
2433
+ /** V1 error format. */
2434
+ "$.xgafv"?: string;
2435
+ /** OAuth access token. */
2436
+ access_token?: string;
2437
+ /** Account ID of the buyer. */
2438
+ accountId: string;
2439
+ /** Data format for response. */
2440
+ alt?: string;
2441
+ /** JSONP */
2442
+ callback?: string;
2443
+ /** Selector specifying which fields to include in a partial response. */
2444
+ fields?: string;
2445
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2446
+ key?: string;
2447
+ /** OAuth 2.0 token for the current user. */
2448
+ oauth_token?: string;
2449
+ /** Returns response with indentations and line breaks. */
2450
+ prettyPrint?: boolean;
2451
+ /** The ID of the proposal to attach the note to. */
2452
+ proposalId: string;
2453
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2454
+ quotaUser?: string;
2455
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2456
+ upload_protocol?: string;
2457
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2458
+ uploadType?: string;
2459
+ /** Request body */
2460
+ resource: AddNoteRequest;
2461
+ }): Request<Note>;
2462
+ addNote(request: {
2463
+ /** V1 error format. */
2464
+ "$.xgafv"?: string;
2465
+ /** OAuth access token. */
2466
+ access_token?: string;
2467
+ /** Account ID of the buyer. */
2468
+ accountId: string;
2469
+ /** Data format for response. */
2470
+ alt?: string;
2471
+ /** JSONP */
2472
+ callback?: string;
2473
+ /** Selector specifying which fields to include in a partial response. */
2474
+ fields?: string;
2475
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2476
+ key?: string;
2477
+ /** OAuth 2.0 token for the current user. */
2478
+ oauth_token?: string;
2479
+ /** Returns response with indentations and line breaks. */
2480
+ prettyPrint?: boolean;
2481
+ /** The ID of the proposal to attach the note to. */
2482
+ proposalId: string;
2483
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2484
+ quotaUser?: string;
2485
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2486
+ upload_protocol?: string;
2487
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2488
+ uploadType?: string;
2489
+ },
2490
+ body: AddNoteRequest): Request<Note>;
2491
+ /** Cancel an ongoing negotiation on a proposal. This does not cancel or end serving for the deals if the proposal has been finalized, but only cancels a negotiation unilaterally. */
2492
+ cancelNegotiation(request: {
2493
+ /** V1 error format. */
2494
+ "$.xgafv"?: string;
2495
+ /** OAuth access token. */
2496
+ access_token?: string;
2497
+ /** Account ID of the buyer. */
2498
+ accountId: string;
2499
+ /** Data format for response. */
2500
+ alt?: string;
2501
+ /** JSONP */
2502
+ callback?: string;
2503
+ /** Selector specifying which fields to include in a partial response. */
2504
+ fields?: string;
2505
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2506
+ key?: string;
2507
+ /** OAuth 2.0 token for the current user. */
2508
+ oauth_token?: string;
2509
+ /** Returns response with indentations and line breaks. */
2510
+ prettyPrint?: boolean;
2511
+ /** The ID of the proposal to cancel negotiation for. */
2512
+ proposalId: string;
2513
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2514
+ quotaUser?: string;
2515
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2516
+ upload_protocol?: string;
2517
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2518
+ uploadType?: string;
2519
+ /** Request body */
2520
+ resource: CancelNegotiationRequest;
2521
+ }): Request<Proposal>;
2522
+ cancelNegotiation(request: {
2523
+ /** V1 error format. */
2524
+ "$.xgafv"?: string;
2525
+ /** OAuth access token. */
2526
+ access_token?: string;
2527
+ /** Account ID of the buyer. */
2528
+ accountId: string;
2529
+ /** Data format for response. */
2530
+ alt?: string;
2531
+ /** JSONP */
2532
+ callback?: string;
2533
+ /** Selector specifying which fields to include in a partial response. */
2534
+ fields?: string;
2535
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2536
+ key?: string;
2537
+ /** OAuth 2.0 token for the current user. */
2538
+ oauth_token?: string;
2539
+ /** Returns response with indentations and line breaks. */
2540
+ prettyPrint?: boolean;
2541
+ /** The ID of the proposal to cancel negotiation for. */
2542
+ proposalId: string;
2543
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2544
+ quotaUser?: string;
2545
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2546
+ upload_protocol?: string;
2547
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2548
+ uploadType?: string;
2549
+ },
2550
+ body: CancelNegotiationRequest): Request<Proposal>;
2551
+ /**
2552
+ * You can opt-in to manually update proposals to indicate that setup is complete. By default, proposal setup is automatically completed after their deals are finalized. Contact your
2553
+ * Technical Account Manager to opt in. Buyers can call this method when the proposal has been finalized, and all the required creatives have been uploaded using the Creatives API.
2554
+ * This call updates the `is_setup_completed` field on the deals in the proposal, and notifies the seller. The server then advances the revision number of the most recent proposal. To
2555
+ * mark an individual deal as ready to serve, call `buyers.finalizedDeals.setReadyToServe` in the Marketplace API.
2556
+ */
2557
+ completeSetup(request: {
2558
+ /** V1 error format. */
2559
+ "$.xgafv"?: string;
2560
+ /** OAuth access token. */
2561
+ access_token?: string;
2562
+ /** Account ID of the buyer. */
2563
+ accountId: string;
2564
+ /** Data format for response. */
2565
+ alt?: string;
2566
+ /** JSONP */
2567
+ callback?: string;
2568
+ /** Selector specifying which fields to include in a partial response. */
2569
+ fields?: string;
2570
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2571
+ key?: string;
2572
+ /** OAuth 2.0 token for the current user. */
2573
+ oauth_token?: string;
2574
+ /** Returns response with indentations and line breaks. */
2575
+ prettyPrint?: boolean;
2576
+ /** The ID of the proposal to mark as setup completed. */
2577
+ proposalId: string;
2578
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2579
+ quotaUser?: string;
2580
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2581
+ upload_protocol?: string;
2582
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2583
+ uploadType?: string;
2584
+ /** Request body */
2585
+ resource: CompleteSetupRequest;
2586
+ }): Request<Proposal>;
2587
+ completeSetup(request: {
2588
+ /** V1 error format. */
2589
+ "$.xgafv"?: string;
2590
+ /** OAuth access token. */
2591
+ access_token?: string;
2592
+ /** Account ID of the buyer. */
2593
+ accountId: string;
2594
+ /** Data format for response. */
2595
+ alt?: string;
2596
+ /** JSONP */
2597
+ callback?: string;
2598
+ /** Selector specifying which fields to include in a partial response. */
2599
+ fields?: string;
2600
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2601
+ key?: string;
2602
+ /** OAuth 2.0 token for the current user. */
2603
+ oauth_token?: string;
2604
+ /** Returns response with indentations and line breaks. */
2605
+ prettyPrint?: boolean;
2606
+ /** The ID of the proposal to mark as setup completed. */
2607
+ proposalId: string;
2608
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2609
+ quotaUser?: string;
2610
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2611
+ upload_protocol?: string;
2612
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2613
+ uploadType?: string;
2614
+ },
2615
+ body: CompleteSetupRequest): Request<Proposal>;
2616
+ /** Create the given proposal. Each created proposal and any deals it contains are assigned a unique ID by the server. */
2617
+ create(request: {
2618
+ /** V1 error format. */
2619
+ "$.xgafv"?: string;
2620
+ /** OAuth access token. */
2621
+ access_token?: string;
2622
+ /** Account ID of the buyer. */
2623
+ accountId: string;
2624
+ /** Data format for response. */
2625
+ alt?: string;
2626
+ /** JSONP */
2627
+ callback?: string;
2628
+ /** Selector specifying which fields to include in a partial response. */
2629
+ fields?: string;
2630
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2631
+ key?: string;
2632
+ /** OAuth 2.0 token for the current user. */
2633
+ oauth_token?: string;
2634
+ /** Returns response with indentations and line breaks. */
2635
+ prettyPrint?: boolean;
2636
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2637
+ quotaUser?: string;
2638
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2639
+ upload_protocol?: string;
2640
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2641
+ uploadType?: string;
2642
+ /** Request body */
2643
+ resource: Proposal;
2644
+ }): Request<Proposal>;
2645
+ create(request: {
2646
+ /** V1 error format. */
2647
+ "$.xgafv"?: string;
2648
+ /** OAuth access token. */
2649
+ access_token?: string;
2650
+ /** Account ID of the buyer. */
2651
+ accountId: string;
2652
+ /** Data format for response. */
2653
+ alt?: string;
2654
+ /** JSONP */
2655
+ callback?: string;
2656
+ /** Selector specifying which fields to include in a partial response. */
2657
+ fields?: string;
2658
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2659
+ key?: string;
2660
+ /** OAuth 2.0 token for the current user. */
2661
+ oauth_token?: string;
2662
+ /** Returns response with indentations and line breaks. */
2663
+ prettyPrint?: boolean;
2664
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2665
+ quotaUser?: string;
2666
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2667
+ upload_protocol?: string;
2668
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2669
+ uploadType?: string;
2670
+ },
2671
+ body: Proposal): Request<Proposal>;
2672
+ /** Gets a proposal given its ID. The proposal is returned at its head revision. */
2673
+ get(request?: {
2674
+ /** V1 error format. */
2675
+ "$.xgafv"?: string;
2676
+ /** OAuth access token. */
2677
+ access_token?: string;
2678
+ /** Account ID of the buyer. */
2679
+ accountId: string;
2680
+ /** Data format for response. */
2681
+ alt?: string;
2682
+ /** JSONP */
2683
+ callback?: string;
2684
+ /** Selector specifying which fields to include in a partial response. */
2685
+ fields?: string;
2686
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2687
+ key?: string;
2688
+ /** OAuth 2.0 token for the current user. */
2689
+ oauth_token?: string;
2690
+ /** Returns response with indentations and line breaks. */
2691
+ prettyPrint?: boolean;
2692
+ /** The unique ID of the proposal */
2693
+ proposalId: string;
2694
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2695
+ quotaUser?: string;
2696
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2697
+ upload_protocol?: string;
2698
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2699
+ uploadType?: string;
2700
+ }): Request<Proposal>;
2701
+ /**
2702
+ * List proposals. A filter expression (PQL query) may be specified to filter the results. To retrieve all finalized proposals, regardless if a proposal is being renegotiated, see the
2703
+ * FinalizedProposals resource. Note that Bidder/ChildSeat relationships differ from the usual behavior. A Bidder account can only see its child seats' proposals by specifying the
2704
+ * ChildSeat's accountId in the request path.
2705
+ */
2706
+ list(request?: {
2707
+ /** V1 error format. */
2708
+ "$.xgafv"?: string;
2709
+ /** OAuth access token. */
2710
+ access_token?: string;
2711
+ /** Account ID of the buyer. */
2712
+ accountId: string;
2713
+ /** Data format for response. */
2714
+ alt?: string;
2715
+ /** JSONP */
2716
+ callback?: string;
2717
+ /** Selector specifying which fields to include in a partial response. */
2718
+ fields?: string;
2719
+ /** An optional PQL filter query used to query for proposals. Nested repeated fields, such as proposal.deals.targetingCriterion, cannot be filtered. */
2720
+ filter?: string;
2721
+ /** Syntax the filter is written in. Current implementation defaults to PQL but in the future it will be LIST_FILTER. */
2722
+ filterSyntax?: string;
2723
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2724
+ key?: string;
2725
+ /** OAuth 2.0 token for the current user. */
2726
+ oauth_token?: string;
2727
+ /** Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. */
2728
+ pageSize?: number;
2729
+ /** The page token as returned from ListProposalsResponse. */
2730
+ pageToken?: string;
2731
+ /** Returns response with indentations and line breaks. */
2732
+ prettyPrint?: boolean;
2733
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2734
+ quotaUser?: string;
2735
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2736
+ upload_protocol?: string;
2737
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2738
+ uploadType?: string;
2739
+ }): Request<ListProposalsResponse>;
2740
+ /**
2741
+ * Update the given proposal to pause serving. This method will set the `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to true for all deals in the proposal. It is a no-op
2742
+ * to pause an already-paused proposal. It is an error to call PauseProposal for a proposal that is not finalized or renegotiating.
2743
+ */
2744
+ pause(request: {
2745
+ /** V1 error format. */
2746
+ "$.xgafv"?: string;
2747
+ /** OAuth access token. */
2748
+ access_token?: string;
2749
+ /** Account ID of the buyer. */
2750
+ accountId: string;
2751
+ /** Data format for response. */
2752
+ alt?: string;
2753
+ /** JSONP */
2754
+ callback?: string;
2755
+ /** Selector specifying which fields to include in a partial response. */
2756
+ fields?: string;
2757
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2758
+ key?: string;
2759
+ /** OAuth 2.0 token for the current user. */
2760
+ oauth_token?: string;
2761
+ /** Returns response with indentations and line breaks. */
2762
+ prettyPrint?: boolean;
2763
+ /** The ID of the proposal to pause. */
2764
+ proposalId: string;
2765
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2766
+ quotaUser?: string;
2767
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2768
+ upload_protocol?: string;
2769
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2770
+ uploadType?: string;
2771
+ /** Request body */
2772
+ resource: PauseProposalRequest;
2773
+ }): Request<Proposal>;
2774
+ pause(request: {
2775
+ /** V1 error format. */
2776
+ "$.xgafv"?: string;
2777
+ /** OAuth access token. */
2778
+ access_token?: string;
2779
+ /** Account ID of the buyer. */
2780
+ accountId: string;
2781
+ /** Data format for response. */
2782
+ alt?: string;
2783
+ /** JSONP */
2784
+ callback?: string;
2785
+ /** Selector specifying which fields to include in a partial response. */
2786
+ fields?: string;
2787
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2788
+ key?: string;
2789
+ /** OAuth 2.0 token for the current user. */
2790
+ oauth_token?: string;
2791
+ /** Returns response with indentations and line breaks. */
2792
+ prettyPrint?: boolean;
2793
+ /** The ID of the proposal to pause. */
2794
+ proposalId: string;
2795
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2796
+ quotaUser?: string;
2797
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2798
+ upload_protocol?: string;
2799
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2800
+ uploadType?: string;
2801
+ },
2802
+ body: PauseProposalRequest): Request<Proposal>;
2803
+ /**
2804
+ * Update the given proposal to resume serving. This method will set the `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to false for all deals in the proposal. Note that if
2805
+ * the `has_seller_paused` bit is also set, serving will not resume until the seller also resumes. It is a no-op to resume an already-running proposal. It is an error to call
2806
+ * ResumeProposal for a proposal that is not finalized or renegotiating.
2807
+ */
2808
+ resume(request: {
2809
+ /** V1 error format. */
2810
+ "$.xgafv"?: string;
2811
+ /** OAuth access token. */
2812
+ access_token?: string;
2813
+ /** Account ID of the buyer. */
2814
+ accountId: string;
2815
+ /** Data format for response. */
2816
+ alt?: string;
2817
+ /** JSONP */
2818
+ callback?: string;
2819
+ /** Selector specifying which fields to include in a partial response. */
2820
+ fields?: string;
2821
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2822
+ key?: string;
2823
+ /** OAuth 2.0 token for the current user. */
2824
+ oauth_token?: string;
2825
+ /** Returns response with indentations and line breaks. */
2826
+ prettyPrint?: boolean;
2827
+ /** The ID of the proposal to resume. */
2828
+ proposalId: string;
2829
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2830
+ quotaUser?: string;
2831
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2832
+ upload_protocol?: string;
2833
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2834
+ uploadType?: string;
2835
+ /** Request body */
2836
+ resource: ResumeProposalRequest;
2837
+ }): Request<Proposal>;
2838
+ resume(request: {
2839
+ /** V1 error format. */
2840
+ "$.xgafv"?: string;
2841
+ /** OAuth access token. */
2842
+ access_token?: string;
2843
+ /** Account ID of the buyer. */
2844
+ accountId: string;
2845
+ /** Data format for response. */
2846
+ alt?: string;
2847
+ /** JSONP */
2848
+ callback?: string;
2849
+ /** Selector specifying which fields to include in a partial response. */
2850
+ fields?: string;
2851
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2852
+ key?: string;
2853
+ /** OAuth 2.0 token for the current user. */
2854
+ oauth_token?: string;
2855
+ /** Returns response with indentations and line breaks. */
2856
+ prettyPrint?: boolean;
2857
+ /** The ID of the proposal to resume. */
2858
+ proposalId: string;
2859
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2860
+ quotaUser?: string;
2861
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2862
+ upload_protocol?: string;
2863
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2864
+ uploadType?: string;
2865
+ },
2866
+ body: ResumeProposalRequest): Request<Proposal>;
2867
+ /**
2868
+ * Update the given proposal at the client known revision number. If the server revision has advanced since the passed-in `proposal.proposal_revision`, an `ABORTED` error message will
2869
+ * be returned. Only the buyer-modifiable fields of the proposal will be updated. Note that the deals in the proposal will be updated to match the passed-in copy. If a passed-in deal
2870
+ * does not have a `deal_id`, the server will assign a new unique ID and create the deal. If passed-in deal has a `deal_id`, it will be updated to match the passed-in copy. Any
2871
+ * existing deals not present in the passed-in proposal will be deleted. It is an error to pass in a deal with a `deal_id` not present at head.
2872
+ */
2873
+ update(request: {
2874
+ /** V1 error format. */
2875
+ "$.xgafv"?: string;
2876
+ /** OAuth access token. */
2877
+ access_token?: string;
2878
+ /** Account ID of the buyer. */
2879
+ accountId: string;
2880
+ /** Data format for response. */
2881
+ alt?: string;
2882
+ /** JSONP */
2883
+ callback?: string;
2884
+ /** Selector specifying which fields to include in a partial response. */
2885
+ fields?: string;
2886
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2887
+ key?: string;
2888
+ /** OAuth 2.0 token for the current user. */
2889
+ oauth_token?: string;
2890
+ /** Returns response with indentations and line breaks. */
2891
+ prettyPrint?: boolean;
2892
+ /** The unique ID of the proposal. */
2893
+ proposalId: string;
2894
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2895
+ quotaUser?: string;
2896
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2897
+ upload_protocol?: string;
2898
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2899
+ uploadType?: string;
2900
+ /** Request body */
2901
+ resource: Proposal;
2902
+ }): Request<Proposal>;
2903
+ update(request: {
2904
+ /** V1 error format. */
2905
+ "$.xgafv"?: string;
2906
+ /** OAuth access token. */
2907
+ access_token?: string;
2908
+ /** Account ID of the buyer. */
2909
+ accountId: string;
2910
+ /** Data format for response. */
2911
+ alt?: string;
2912
+ /** JSONP */
2913
+ callback?: string;
2914
+ /** Selector specifying which fields to include in a partial response. */
2915
+ fields?: string;
2916
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2917
+ key?: string;
2918
+ /** OAuth 2.0 token for the current user. */
2919
+ oauth_token?: string;
2920
+ /** Returns response with indentations and line breaks. */
2921
+ prettyPrint?: boolean;
2922
+ /** The unique ID of the proposal. */
2923
+ proposalId: string;
2924
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2925
+ quotaUser?: string;
2926
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2927
+ upload_protocol?: string;
2928
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2929
+ uploadType?: string;
2930
+ },
2931
+ body: Proposal): Request<Proposal>;
2932
+ }
2933
+ interface PublisherProfilesResource {
2934
+ /** Gets the requested publisher profile by id. */
2935
+ get(request?: {
2936
+ /** V1 error format. */
2937
+ "$.xgafv"?: string;
2938
+ /** OAuth access token. */
2939
+ access_token?: string;
2940
+ /** Account ID of the buyer. */
2941
+ accountId: string;
2942
+ /** Data format for response. */
2943
+ alt?: string;
2944
+ /** JSONP */
2945
+ callback?: string;
2946
+ /** Selector specifying which fields to include in a partial response. */
2947
+ fields?: string;
2948
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2949
+ key?: string;
2950
+ /** OAuth 2.0 token for the current user. */
2951
+ oauth_token?: string;
2952
+ /** Returns response with indentations and line breaks. */
2953
+ prettyPrint?: boolean;
2954
+ /** The id for the publisher profile to get. */
2955
+ publisherProfileId: string;
2956
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2957
+ quotaUser?: string;
2958
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2959
+ upload_protocol?: string;
2960
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2961
+ uploadType?: string;
2962
+ }): Request<PublisherProfile>;
2963
+ /** List all publisher profiles visible to the buyer */
2964
+ list(request?: {
2965
+ /** V1 error format. */
2966
+ "$.xgafv"?: string;
2967
+ /** OAuth access token. */
2968
+ access_token?: string;
2969
+ /** Account ID of the buyer. */
2970
+ accountId: string;
2971
+ /** Data format for response. */
2972
+ alt?: string;
2973
+ /** JSONP */
2974
+ callback?: string;
2975
+ /** Selector specifying which fields to include in a partial response. */
2976
+ fields?: string;
2977
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2978
+ key?: string;
2979
+ /** OAuth 2.0 token for the current user. */
2980
+ oauth_token?: string;
2981
+ /** Specify the number of results to include per page. */
2982
+ pageSize?: number;
2983
+ /** The page token as return from ListPublisherProfilesResponse. */
2984
+ pageToken?: string;
2985
+ /** Returns response with indentations and line breaks. */
2986
+ prettyPrint?: boolean;
2987
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2988
+ quotaUser?: string;
2989
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2990
+ upload_protocol?: string;
2991
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2992
+ uploadType?: string;
2993
+ }): Request<ListPublisherProfilesResponse>;
2994
+ }
2995
+ interface AccountsResource {
2996
+ clients: ClientsResource;
2997
+ creatives: CreativesResource;
2998
+ finalizedProposals: FinalizedProposalsResource;
2999
+ products: ProductsResource;
3000
+ proposals: ProposalsResource;
3001
+ publisherProfiles: PublisherProfilesResource;
3002
+ }
3003
+ interface BidMetricsResource {
3004
+ /** Lists all metrics that are measured in terms of number of bids. */
3005
+ list(request?: {
3006
+ /** V1 error format. */
3007
+ "$.xgafv"?: string;
3008
+ /** OAuth access token. */
3009
+ access_token?: string;
3010
+ /** Data format for response. */
3011
+ alt?: string;
3012
+ /** JSONP */
3013
+ callback?: string;
3014
+ /** Selector specifying which fields to include in a partial response. */
3015
+ fields?: string;
3016
+ /**
3017
+ * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an
3018
+ * account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer
3019
+ * account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
3020
+ */
3021
+ filterSetName: string;
3022
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
3023
+ key?: string;
3024
+ /** OAuth 2.0 token for the current user. */
3025
+ oauth_token?: string;
3026
+ /** Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. */
3027
+ pageSize?: number;
3028
+ /**
3029
+ * A token identifying a page of results the server should return. Typically, this is the value of ListBidMetricsResponse.nextPageToken returned from the previous call to the
3030
+ * bidMetrics.list method.
3031
+ */
3032
+ pageToken?: string;
3033
+ /** Returns response with indentations and line breaks. */
3034
+ prettyPrint?: boolean;
3035
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3036
+ quotaUser?: string;
3037
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3038
+ upload_protocol?: string;
3039
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3040
+ uploadType?: string;
3041
+ }): Request<ListBidMetricsResponse>;
3042
+ }
3043
+ interface BidResponseErrorsResource {
3044
+ /** List all errors that occurred in bid responses, with the number of bid responses affected for each reason. */
3045
+ list(request?: {
3046
+ /** V1 error format. */
3047
+ "$.xgafv"?: string;
3048
+ /** OAuth access token. */
3049
+ access_token?: string;
3050
+ /** Data format for response. */
3051
+ alt?: string;
3052
+ /** JSONP */
3053
+ callback?: string;
3054
+ /** Selector specifying which fields to include in a partial response. */
3055
+ fields?: string;
3056
+ /**
3057
+ * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an
3058
+ * account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer
3059
+ * account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
3060
+ */
3061
+ filterSetName: string;
3062
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
3063
+ key?: string;
3064
+ /** OAuth 2.0 token for the current user. */
3065
+ oauth_token?: string;
3066
+ /** Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. */
3067
+ pageSize?: number;
3068
+ /**
3069
+ * A token identifying a page of results the server should return. Typically, this is the value of ListBidResponseErrorsResponse.nextPageToken returned from the previous call to
3070
+ * the bidResponseErrors.list method.
3071
+ */
3072
+ pageToken?: string;
3073
+ /** Returns response with indentations and line breaks. */
3074
+ prettyPrint?: boolean;
3075
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3076
+ quotaUser?: string;
3077
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3078
+ upload_protocol?: string;
3079
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3080
+ uploadType?: string;
3081
+ }): Request<ListBidResponseErrorsResponse>;
3082
+ }
3083
+ interface BidResponsesWithoutBidsResource {
3084
+ /** List all reasons for which bid responses were considered to have no applicable bids, with the number of bid responses affected for each reason. */
3085
+ list(request?: {
3086
+ /** V1 error format. */
3087
+ "$.xgafv"?: string;
3088
+ /** OAuth access token. */
3089
+ access_token?: string;
3090
+ /** Data format for response. */
3091
+ alt?: string;
3092
+ /** JSONP */
3093
+ callback?: string;
3094
+ /** Selector specifying which fields to include in a partial response. */
3095
+ fields?: string;
3096
+ /**
3097
+ * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an
3098
+ * account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer
3099
+ * account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
3100
+ */
3101
+ filterSetName: string;
3102
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
3103
+ key?: string;
3104
+ /** OAuth 2.0 token for the current user. */
3105
+ oauth_token?: string;
3106
+ /** Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. */
3107
+ pageSize?: number;
3108
+ /**
3109
+ * A token identifying a page of results the server should return. Typically, this is the value of ListBidResponsesWithoutBidsResponse.nextPageToken returned from the previous call
3110
+ * to the bidResponsesWithoutBids.list method.
3111
+ */
3112
+ pageToken?: string;
3113
+ /** Returns response with indentations and line breaks. */
3114
+ prettyPrint?: boolean;
3115
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3116
+ quotaUser?: string;
3117
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3118
+ upload_protocol?: string;
3119
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3120
+ uploadType?: string;
3121
+ }): Request<ListBidResponsesWithoutBidsResponse>;
3122
+ }
3123
+ interface FilteredBidRequestsResource {
3124
+ /** List all reasons that caused a bid request not to be sent for an impression, with the number of bid requests not sent for each reason. */
3125
+ list(request?: {
3126
+ /** V1 error format. */
3127
+ "$.xgafv"?: string;
3128
+ /** OAuth access token. */
3129
+ access_token?: string;
3130
+ /** Data format for response. */
3131
+ alt?: string;
3132
+ /** JSONP */
3133
+ callback?: string;
3134
+ /** Selector specifying which fields to include in a partial response. */
3135
+ fields?: string;
3136
+ /**
3137
+ * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an
3138
+ * account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer
3139
+ * account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
3140
+ */
3141
+ filterSetName: string;
3142
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
3143
+ key?: string;
3144
+ /** OAuth 2.0 token for the current user. */
3145
+ oauth_token?: string;
3146
+ /** Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. */
3147
+ pageSize?: number;
3148
+ /**
3149
+ * A token identifying a page of results the server should return. Typically, this is the value of ListFilteredBidRequestsResponse.nextPageToken returned from the previous call to
3150
+ * the filteredBidRequests.list method.
3151
+ */
3152
+ pageToken?: string;
3153
+ /** Returns response with indentations and line breaks. */
3154
+ prettyPrint?: boolean;
3155
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3156
+ quotaUser?: string;
3157
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3158
+ upload_protocol?: string;
3159
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3160
+ uploadType?: string;
3161
+ }): Request<ListFilteredBidRequestsResponse>;
3162
+ }
3163
+ interface CreativesResource {
3164
+ /** List all creatives associated with a specific reason for which bids were filtered, with the number of bids filtered for each creative. */
3165
+ list(request?: {
3166
+ /** V1 error format. */
3167
+ "$.xgafv"?: string;
3168
+ /** OAuth access token. */
3169
+ access_token?: string;
3170
+ /** Data format for response. */
3171
+ alt?: string;
3172
+ /** JSONP */
3173
+ callback?: string;
3174
+ /**
3175
+ * The ID of the creative status for which to retrieve a breakdown by creative. See
3176
+ * [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes).
3177
+ */
3178
+ creativeStatusId: number;
3179
+ /** Selector specifying which fields to include in a partial response. */
3180
+ fields?: string;
3181
+ /**
3182
+ * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an
3183
+ * account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer
3184
+ * account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
3185
+ */
3186
+ filterSetName: string;
3187
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
3188
+ key?: string;
3189
+ /** OAuth 2.0 token for the current user. */
3190
+ oauth_token?: string;
3191
+ /** Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. */
3192
+ pageSize?: number;
3193
+ /**
3194
+ * A token identifying a page of results the server should return. Typically, this is the value of ListCreativeStatusBreakdownByCreativeResponse.nextPageToken returned from the
3195
+ * previous call to the filteredBids.creatives.list method.
3196
+ */
3197
+ pageToken?: string;
3198
+ /** Returns response with indentations and line breaks. */
3199
+ prettyPrint?: boolean;
3200
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3201
+ quotaUser?: string;
3202
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3203
+ upload_protocol?: string;
3204
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3205
+ uploadType?: string;
3206
+ }): Request<ListCreativeStatusBreakdownByCreativeResponse>;
3207
+ }
3208
+ interface DetailsResource {
3209
+ /** List all details associated with a specific reason for which bids were filtered, with the number of bids filtered for each detail. */
3210
+ list(request?: {
3211
+ /** V1 error format. */
3212
+ "$.xgafv"?: string;
3213
+ /** OAuth access token. */
3214
+ access_token?: string;
3215
+ /** Data format for response. */
3216
+ alt?: string;
3217
+ /** JSONP */
3218
+ callback?: string;
3219
+ /**
3220
+ * The ID of the creative status for which to retrieve a breakdown by detail. See
3221
+ * [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes). Details are only available for statuses 10, 14, 15, 17, 18, 19, 86,
3222
+ * and 87.
3223
+ */
3224
+ creativeStatusId: number;
3225
+ /** Selector specifying which fields to include in a partial response. */
3226
+ fields?: string;
3227
+ /**
3228
+ * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an
3229
+ * account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer
3230
+ * account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
3231
+ */
3232
+ filterSetName: string;
3233
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
3234
+ key?: string;
3235
+ /** OAuth 2.0 token for the current user. */
3236
+ oauth_token?: string;
3237
+ /** Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. */
3238
+ pageSize?: number;
3239
+ /**
3240
+ * A token identifying a page of results the server should return. Typically, this is the value of ListCreativeStatusBreakdownByDetailResponse.nextPageToken returned from the
3241
+ * previous call to the filteredBids.details.list method.
3242
+ */
3243
+ pageToken?: string;
3244
+ /** Returns response with indentations and line breaks. */
3245
+ prettyPrint?: boolean;
3246
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3247
+ quotaUser?: string;
3248
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3249
+ upload_protocol?: string;
3250
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3251
+ uploadType?: string;
3252
+ }): Request<ListCreativeStatusBreakdownByDetailResponse>;
3253
+ }
3254
+ interface FilteredBidsResource {
3255
+ /** List all reasons for which bids were filtered, with the number of bids filtered for each reason. */
3256
+ list(request?: {
3257
+ /** V1 error format. */
3258
+ "$.xgafv"?: string;
3259
+ /** OAuth access token. */
3260
+ access_token?: string;
3261
+ /** Data format for response. */
3262
+ alt?: string;
3263
+ /** JSONP */
3264
+ callback?: string;
3265
+ /** Selector specifying which fields to include in a partial response. */
3266
+ fields?: string;
3267
+ /**
3268
+ * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an
3269
+ * account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer
3270
+ * account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
3271
+ */
3272
+ filterSetName: string;
3273
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
3274
+ key?: string;
3275
+ /** OAuth 2.0 token for the current user. */
3276
+ oauth_token?: string;
3277
+ /** Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. */
3278
+ pageSize?: number;
3279
+ /**
3280
+ * A token identifying a page of results the server should return. Typically, this is the value of ListFilteredBidsResponse.nextPageToken returned from the previous call to the
3281
+ * filteredBids.list method.
3282
+ */
3283
+ pageToken?: string;
3284
+ /** Returns response with indentations and line breaks. */
3285
+ prettyPrint?: boolean;
3286
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3287
+ quotaUser?: string;
3288
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3289
+ upload_protocol?: string;
3290
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3291
+ uploadType?: string;
3292
+ }): Request<ListFilteredBidsResponse>;
3293
+ creatives: CreativesResource;
3294
+ details: DetailsResource;
3295
+ }
3296
+ interface ImpressionMetricsResource {
3297
+ /** Lists all metrics that are measured in terms of number of impressions. */
3298
+ list(request?: {
3299
+ /** V1 error format. */
3300
+ "$.xgafv"?: string;
3301
+ /** OAuth access token. */
3302
+ access_token?: string;
3303
+ /** Data format for response. */
3304
+ alt?: string;
3305
+ /** JSONP */
3306
+ callback?: string;
3307
+ /** Selector specifying which fields to include in a partial response. */
3308
+ fields?: string;
3309
+ /**
3310
+ * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an
3311
+ * account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer
3312
+ * account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
3313
+ */
3314
+ filterSetName: string;
3315
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
3316
+ key?: string;
3317
+ /** OAuth 2.0 token for the current user. */
3318
+ oauth_token?: string;
3319
+ /** Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. */
3320
+ pageSize?: number;
3321
+ /**
3322
+ * A token identifying a page of results the server should return. Typically, this is the value of ListImpressionMetricsResponse.nextPageToken returned from the previous call to
3323
+ * the impressionMetrics.list method.
3324
+ */
3325
+ pageToken?: string;
3326
+ /** Returns response with indentations and line breaks. */
3327
+ prettyPrint?: boolean;
3328
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3329
+ quotaUser?: string;
3330
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3331
+ upload_protocol?: string;
3332
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3333
+ uploadType?: string;
3334
+ }): Request<ListImpressionMetricsResponse>;
3335
+ }
3336
+ interface LosingBidsResource {
3337
+ /** List all reasons for which bids lost in the auction, with the number of bids that lost for each reason. */
3338
+ list(request?: {
3339
+ /** V1 error format. */
3340
+ "$.xgafv"?: string;
3341
+ /** OAuth access token. */
3342
+ access_token?: string;
3343
+ /** Data format for response. */
3344
+ alt?: string;
3345
+ /** JSONP */
3346
+ callback?: string;
3347
+ /** Selector specifying which fields to include in a partial response. */
3348
+ fields?: string;
3349
+ /**
3350
+ * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an
3351
+ * account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer
3352
+ * account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
3353
+ */
3354
+ filterSetName: string;
3355
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
3356
+ key?: string;
3357
+ /** OAuth 2.0 token for the current user. */
3358
+ oauth_token?: string;
3359
+ /** Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. */
3360
+ pageSize?: number;
3361
+ /**
3362
+ * A token identifying a page of results the server should return. Typically, this is the value of ListLosingBidsResponse.nextPageToken returned from the previous call to the
3363
+ * losingBids.list method.
3364
+ */
3365
+ pageToken?: string;
3366
+ /** Returns response with indentations and line breaks. */
3367
+ prettyPrint?: boolean;
3368
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3369
+ quotaUser?: string;
3370
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3371
+ upload_protocol?: string;
3372
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3373
+ uploadType?: string;
3374
+ }): Request<ListLosingBidsResponse>;
3375
+ }
3376
+ interface NonBillableWinningBidsResource {
3377
+ /** List all reasons for which winning bids were not billable, with the number of bids not billed for each reason. */
3378
+ list(request?: {
3379
+ /** V1 error format. */
3380
+ "$.xgafv"?: string;
3381
+ /** OAuth access token. */
3382
+ access_token?: string;
3383
+ /** Data format for response. */
3384
+ alt?: string;
3385
+ /** JSONP */
3386
+ callback?: string;
3387
+ /** Selector specifying which fields to include in a partial response. */
3388
+ fields?: string;
3389
+ /**
3390
+ * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an
3391
+ * account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer
3392
+ * account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
3393
+ */
3394
+ filterSetName: string;
3395
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
3396
+ key?: string;
3397
+ /** OAuth 2.0 token for the current user. */
3398
+ oauth_token?: string;
3399
+ /** Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. */
3400
+ pageSize?: number;
3401
+ /**
3402
+ * A token identifying a page of results the server should return. Typically, this is the value of ListNonBillableWinningBidsResponse.nextPageToken returned from the previous call
3403
+ * to the nonBillableWinningBids.list method.
3404
+ */
3405
+ pageToken?: string;
3406
+ /** Returns response with indentations and line breaks. */
3407
+ prettyPrint?: boolean;
3408
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3409
+ quotaUser?: string;
3410
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3411
+ upload_protocol?: string;
3412
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3413
+ uploadType?: string;
3414
+ }): Request<ListNonBillableWinningBidsResponse>;
3415
+ }
3416
+ interface FilterSetsResource {
3417
+ /** Creates the specified filter set for the account with the given account ID. */
3418
+ create(request: {
3419
+ /** V1 error format. */
3420
+ "$.xgafv"?: string;
3421
+ /** OAuth access token. */
3422
+ access_token?: string;
3423
+ /** Data format for response. */
3424
+ alt?: string;
3425
+ /** JSONP */
3426
+ callback?: string;
3427
+ /** Selector specifying which fields to include in a partial response. */
3428
+ fields?: string;
3429
+ /**
3430
+ * Whether the filter set is transient, or should be persisted indefinitely. By default, filter sets are not transient. If transient, it will be available for at least 1 hour after
3431
+ * creation.
3432
+ */
3433
+ isTransient?: boolean;
3434
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
3435
+ key?: string;
3436
+ /** OAuth 2.0 token for the current user. */
3437
+ oauth_token?: string;
3438
+ /**
3439
+ * Name of the owner (bidder or account) of the filter set to be created. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter
3440
+ * set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123:
3441
+ * `bidders/123/accounts/456`
3442
+ */
3443
+ ownerName: string;
3444
+ /** Returns response with indentations and line breaks. */
3445
+ prettyPrint?: boolean;
3446
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3447
+ quotaUser?: string;
3448
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3449
+ upload_protocol?: string;
3450
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3451
+ uploadType?: string;
3452
+ /** Request body */
3453
+ resource: FilterSet;
3454
+ }): Request<FilterSet>;
3455
+ create(request: {
3456
+ /** V1 error format. */
3457
+ "$.xgafv"?: string;
3458
+ /** OAuth access token. */
3459
+ access_token?: string;
3460
+ /** Data format for response. */
3461
+ alt?: string;
3462
+ /** JSONP */
3463
+ callback?: string;
3464
+ /** Selector specifying which fields to include in a partial response. */
3465
+ fields?: string;
3466
+ /**
3467
+ * Whether the filter set is transient, or should be persisted indefinitely. By default, filter sets are not transient. If transient, it will be available for at least 1 hour after
3468
+ * creation.
3469
+ */
3470
+ isTransient?: boolean;
3471
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
3472
+ key?: string;
3473
+ /** OAuth 2.0 token for the current user. */
3474
+ oauth_token?: string;
3475
+ /**
3476
+ * Name of the owner (bidder or account) of the filter set to be created. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter
3477
+ * set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123:
3478
+ * `bidders/123/accounts/456`
3479
+ */
3480
+ ownerName: string;
3481
+ /** Returns response with indentations and line breaks. */
3482
+ prettyPrint?: boolean;
3483
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3484
+ quotaUser?: string;
3485
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3486
+ upload_protocol?: string;
3487
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3488
+ uploadType?: string;
3489
+ },
3490
+ body: FilterSet): Request<FilterSet>;
3491
+ /** Deletes the requested filter set from the account with the given account ID. */
3492
+ delete(request?: {
3493
+ /** V1 error format. */
3494
+ "$.xgafv"?: string;
3495
+ /** OAuth access token. */
3496
+ access_token?: string;
3497
+ /** Data format for response. */
3498
+ alt?: string;
3499
+ /** JSONP */
3500
+ callback?: string;
3501
+ /** Selector specifying which fields to include in a partial response. */
3502
+ fields?: string;
3503
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
3504
+ key?: string;
3505
+ /**
3506
+ * Full name of the resource to delete. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer
3507
+ * account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123:
3508
+ * `bidders/123/accounts/456/filterSets/abc`
3509
+ */
3510
+ name: string;
3511
+ /** OAuth 2.0 token for the current user. */
3512
+ oauth_token?: string;
3513
+ /** Returns response with indentations and line breaks. */
3514
+ prettyPrint?: boolean;
3515
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3516
+ quotaUser?: string;
3517
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3518
+ upload_protocol?: string;
3519
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3520
+ uploadType?: string;
3521
+ }): Request<{}>;
3522
+ /** Retrieves the requested filter set for the account with the given account ID. */
3523
+ get(request?: {
3524
+ /** V1 error format. */
3525
+ "$.xgafv"?: string;
3526
+ /** OAuth access token. */
3527
+ access_token?: string;
3528
+ /** Data format for response. */
3529
+ alt?: string;
3530
+ /** JSONP */
3531
+ callback?: string;
3532
+ /** Selector specifying which fields to include in a partial response. */
3533
+ fields?: string;
3534
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
3535
+ key?: string;
3536
+ /**
3537
+ * Full name of the resource being requested. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the
3538
+ * buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123:
3539
+ * `bidders/123/accounts/456/filterSets/abc`
3540
+ */
3541
+ name: string;
3542
+ /** OAuth 2.0 token for the current user. */
3543
+ oauth_token?: string;
3544
+ /** Returns response with indentations and line breaks. */
3545
+ prettyPrint?: boolean;
3546
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3547
+ quotaUser?: string;
3548
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3549
+ upload_protocol?: string;
3550
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3551
+ uploadType?: string;
3552
+ }): Request<FilterSet>;
3553
+ /** Lists all filter sets for the account with the given account ID. */
3554
+ list(request?: {
3555
+ /** V1 error format. */
3556
+ "$.xgafv"?: string;
3557
+ /** OAuth access token. */
3558
+ access_token?: string;
3559
+ /** Data format for response. */
3560
+ alt?: string;
3561
+ /** JSONP */
3562
+ callback?: string;
3563
+ /** Selector specifying which fields to include in a partial response. */
3564
+ fields?: string;
3565
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
3566
+ key?: string;
3567
+ /** OAuth 2.0 token for the current user. */
3568
+ oauth_token?: string;
3569
+ /**
3570
+ * Name of the owner (bidder or account) of the filter sets to be listed. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter
3571
+ * set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123:
3572
+ * `bidders/123/accounts/456`
3573
+ */
3574
+ ownerName: string;
3575
+ /** Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. */
3576
+ pageSize?: number;
3577
+ /**
3578
+ * A token identifying a page of results the server should return. Typically, this is the value of ListFilterSetsResponse.nextPageToken returned from the previous call to the
3579
+ * accounts.filterSets.list method.
3580
+ */
3581
+ pageToken?: string;
3582
+ /** Returns response with indentations and line breaks. */
3583
+ prettyPrint?: boolean;
3584
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3585
+ quotaUser?: string;
3586
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3587
+ upload_protocol?: string;
3588
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3589
+ uploadType?: string;
3590
+ }): Request<ListFilterSetsResponse>;
3591
+ bidMetrics: BidMetricsResource;
3592
+ bidResponseErrors: BidResponseErrorsResource;
3593
+ bidResponsesWithoutBids: BidResponsesWithoutBidsResource;
3594
+ filteredBidRequests: FilteredBidRequestsResource;
3595
+ filteredBids: FilteredBidsResource;
3596
+ impressionMetrics: ImpressionMetricsResource;
3597
+ losingBids: LosingBidsResource;
3598
+ nonBillableWinningBids: NonBillableWinningBidsResource;
3599
+ }
3600
+ interface AccountsResource {
3601
+ filterSets: FilterSetsResource;
3602
+ }
3603
+ interface BidMetricsResource {
3604
+ /** Lists all metrics that are measured in terms of number of bids. */
3605
+ list(request?: {
3606
+ /** V1 error format. */
3607
+ "$.xgafv"?: string;
3608
+ /** OAuth access token. */
3609
+ access_token?: string;
3610
+ /** Data format for response. */
3611
+ alt?: string;
3612
+ /** JSONP */
3613
+ callback?: string;
3614
+ /** Selector specifying which fields to include in a partial response. */
3615
+ fields?: string;
3616
+ /**
3617
+ * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an
3618
+ * account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer
3619
+ * account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
3620
+ */
3621
+ filterSetName: string;
3622
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
3623
+ key?: string;
3624
+ /** OAuth 2.0 token for the current user. */
3625
+ oauth_token?: string;
3626
+ /** Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. */
3627
+ pageSize?: number;
3628
+ /**
3629
+ * A token identifying a page of results the server should return. Typically, this is the value of ListBidMetricsResponse.nextPageToken returned from the previous call to the
3630
+ * bidMetrics.list method.
3631
+ */
3632
+ pageToken?: string;
3633
+ /** Returns response with indentations and line breaks. */
3634
+ prettyPrint?: boolean;
3635
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3636
+ quotaUser?: string;
3637
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3638
+ upload_protocol?: string;
3639
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3640
+ uploadType?: string;
3641
+ }): Request<ListBidMetricsResponse>;
3642
+ }
3643
+ interface BidResponseErrorsResource {
3644
+ /** List all errors that occurred in bid responses, with the number of bid responses affected for each reason. */
3645
+ list(request?: {
3646
+ /** V1 error format. */
3647
+ "$.xgafv"?: string;
3648
+ /** OAuth access token. */
3649
+ access_token?: string;
3650
+ /** Data format for response. */
3651
+ alt?: string;
3652
+ /** JSONP */
3653
+ callback?: string;
3654
+ /** Selector specifying which fields to include in a partial response. */
3655
+ fields?: string;
3656
+ /**
3657
+ * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an
3658
+ * account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer
3659
+ * account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
3660
+ */
3661
+ filterSetName: string;
3662
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
3663
+ key?: string;
3664
+ /** OAuth 2.0 token for the current user. */
3665
+ oauth_token?: string;
3666
+ /** Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. */
3667
+ pageSize?: number;
3668
+ /**
3669
+ * A token identifying a page of results the server should return. Typically, this is the value of ListBidResponseErrorsResponse.nextPageToken returned from the previous call to
3670
+ * the bidResponseErrors.list method.
3671
+ */
3672
+ pageToken?: string;
3673
+ /** Returns response with indentations and line breaks. */
3674
+ prettyPrint?: boolean;
3675
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3676
+ quotaUser?: string;
3677
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3678
+ upload_protocol?: string;
3679
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3680
+ uploadType?: string;
3681
+ }): Request<ListBidResponseErrorsResponse>;
3682
+ }
3683
+ interface BidResponsesWithoutBidsResource {
3684
+ /** List all reasons for which bid responses were considered to have no applicable bids, with the number of bid responses affected for each reason. */
3685
+ list(request?: {
3686
+ /** V1 error format. */
3687
+ "$.xgafv"?: string;
3688
+ /** OAuth access token. */
3689
+ access_token?: string;
3690
+ /** Data format for response. */
3691
+ alt?: string;
3692
+ /** JSONP */
3693
+ callback?: string;
3694
+ /** Selector specifying which fields to include in a partial response. */
3695
+ fields?: string;
3696
+ /**
3697
+ * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an
3698
+ * account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer
3699
+ * account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
3700
+ */
3701
+ filterSetName: string;
3702
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
3703
+ key?: string;
3704
+ /** OAuth 2.0 token for the current user. */
3705
+ oauth_token?: string;
3706
+ /** Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. */
3707
+ pageSize?: number;
3708
+ /**
3709
+ * A token identifying a page of results the server should return. Typically, this is the value of ListBidResponsesWithoutBidsResponse.nextPageToken returned from the previous call
3710
+ * to the bidResponsesWithoutBids.list method.
3711
+ */
3712
+ pageToken?: string;
3713
+ /** Returns response with indentations and line breaks. */
3714
+ prettyPrint?: boolean;
3715
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3716
+ quotaUser?: string;
3717
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3718
+ upload_protocol?: string;
3719
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3720
+ uploadType?: string;
3721
+ }): Request<ListBidResponsesWithoutBidsResponse>;
3722
+ }
3723
+ interface FilteredBidRequestsResource {
3724
+ /** List all reasons that caused a bid request not to be sent for an impression, with the number of bid requests not sent for each reason. */
3725
+ list(request?: {
3726
+ /** V1 error format. */
3727
+ "$.xgafv"?: string;
3728
+ /** OAuth access token. */
3729
+ access_token?: string;
3730
+ /** Data format for response. */
3731
+ alt?: string;
3732
+ /** JSONP */
3733
+ callback?: string;
3734
+ /** Selector specifying which fields to include in a partial response. */
3735
+ fields?: string;
3736
+ /**
3737
+ * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an
3738
+ * account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer
3739
+ * account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
3740
+ */
3741
+ filterSetName: string;
3742
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
3743
+ key?: string;
3744
+ /** OAuth 2.0 token for the current user. */
3745
+ oauth_token?: string;
3746
+ /** Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. */
3747
+ pageSize?: number;
3748
+ /**
3749
+ * A token identifying a page of results the server should return. Typically, this is the value of ListFilteredBidRequestsResponse.nextPageToken returned from the previous call to
3750
+ * the filteredBidRequests.list method.
3751
+ */
3752
+ pageToken?: string;
3753
+ /** Returns response with indentations and line breaks. */
3754
+ prettyPrint?: boolean;
3755
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3756
+ quotaUser?: string;
3757
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3758
+ upload_protocol?: string;
3759
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3760
+ uploadType?: string;
3761
+ }): Request<ListFilteredBidRequestsResponse>;
3762
+ }
3763
+ interface CreativesResource {
3764
+ /** List all creatives associated with a specific reason for which bids were filtered, with the number of bids filtered for each creative. */
3765
+ list(request?: {
3766
+ /** V1 error format. */
3767
+ "$.xgafv"?: string;
3768
+ /** OAuth access token. */
3769
+ access_token?: string;
3770
+ /** Data format for response. */
3771
+ alt?: string;
3772
+ /** JSONP */
3773
+ callback?: string;
3774
+ /**
3775
+ * The ID of the creative status for which to retrieve a breakdown by creative. See
3776
+ * [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes).
3777
+ */
3778
+ creativeStatusId: number;
3779
+ /** Selector specifying which fields to include in a partial response. */
3780
+ fields?: string;
3781
+ /**
3782
+ * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an
3783
+ * account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer
3784
+ * account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
3785
+ */
3786
+ filterSetName: string;
3787
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
3788
+ key?: string;
3789
+ /** OAuth 2.0 token for the current user. */
3790
+ oauth_token?: string;
3791
+ /** Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. */
3792
+ pageSize?: number;
3793
+ /**
3794
+ * A token identifying a page of results the server should return. Typically, this is the value of ListCreativeStatusBreakdownByCreativeResponse.nextPageToken returned from the
3795
+ * previous call to the filteredBids.creatives.list method.
3796
+ */
3797
+ pageToken?: string;
3798
+ /** Returns response with indentations and line breaks. */
3799
+ prettyPrint?: boolean;
3800
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3801
+ quotaUser?: string;
3802
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3803
+ upload_protocol?: string;
3804
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3805
+ uploadType?: string;
3806
+ }): Request<ListCreativeStatusBreakdownByCreativeResponse>;
3807
+ }
3808
+ interface DetailsResource {
3809
+ /** List all details associated with a specific reason for which bids were filtered, with the number of bids filtered for each detail. */
3810
+ list(request?: {
3811
+ /** V1 error format. */
3812
+ "$.xgafv"?: string;
3813
+ /** OAuth access token. */
3814
+ access_token?: string;
3815
+ /** Data format for response. */
3816
+ alt?: string;
3817
+ /** JSONP */
3818
+ callback?: string;
3819
+ /**
3820
+ * The ID of the creative status for which to retrieve a breakdown by detail. See
3821
+ * [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes). Details are only available for statuses 10, 14, 15, 17, 18, 19, 86,
3822
+ * and 87.
3823
+ */
3824
+ creativeStatusId: number;
3825
+ /** Selector specifying which fields to include in a partial response. */
3826
+ fields?: string;
3827
+ /**
3828
+ * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an
3829
+ * account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer
3830
+ * account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
3831
+ */
3832
+ filterSetName: string;
3833
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
3834
+ key?: string;
3835
+ /** OAuth 2.0 token for the current user. */
3836
+ oauth_token?: string;
3837
+ /** Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. */
3838
+ pageSize?: number;
3839
+ /**
3840
+ * A token identifying a page of results the server should return. Typically, this is the value of ListCreativeStatusBreakdownByDetailResponse.nextPageToken returned from the
3841
+ * previous call to the filteredBids.details.list method.
3842
+ */
3843
+ pageToken?: string;
3844
+ /** Returns response with indentations and line breaks. */
3845
+ prettyPrint?: boolean;
3846
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3847
+ quotaUser?: string;
3848
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3849
+ upload_protocol?: string;
3850
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3851
+ uploadType?: string;
3852
+ }): Request<ListCreativeStatusBreakdownByDetailResponse>;
3853
+ }
3854
+ interface FilteredBidsResource {
3855
+ /** List all reasons for which bids were filtered, with the number of bids filtered for each reason. */
3856
+ list(request?: {
3857
+ /** V1 error format. */
3858
+ "$.xgafv"?: string;
3859
+ /** OAuth access token. */
3860
+ access_token?: string;
3861
+ /** Data format for response. */
3862
+ alt?: string;
3863
+ /** JSONP */
3864
+ callback?: string;
3865
+ /** Selector specifying which fields to include in a partial response. */
3866
+ fields?: string;
3867
+ /**
3868
+ * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an
3869
+ * account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer
3870
+ * account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
3871
+ */
3872
+ filterSetName: string;
3873
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
3874
+ key?: string;
3875
+ /** OAuth 2.0 token for the current user. */
3876
+ oauth_token?: string;
3877
+ /** Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. */
3878
+ pageSize?: number;
3879
+ /**
3880
+ * A token identifying a page of results the server should return. Typically, this is the value of ListFilteredBidsResponse.nextPageToken returned from the previous call to the
3881
+ * filteredBids.list method.
3882
+ */
3883
+ pageToken?: string;
3884
+ /** Returns response with indentations and line breaks. */
3885
+ prettyPrint?: boolean;
3886
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3887
+ quotaUser?: string;
3888
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3889
+ upload_protocol?: string;
3890
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3891
+ uploadType?: string;
3892
+ }): Request<ListFilteredBidsResponse>;
3893
+ creatives: CreativesResource;
3894
+ details: DetailsResource;
3895
+ }
3896
+ interface ImpressionMetricsResource {
3897
+ /** Lists all metrics that are measured in terms of number of impressions. */
3898
+ list(request?: {
3899
+ /** V1 error format. */
3900
+ "$.xgafv"?: string;
3901
+ /** OAuth access token. */
3902
+ access_token?: string;
3903
+ /** Data format for response. */
3904
+ alt?: string;
3905
+ /** JSONP */
3906
+ callback?: string;
3907
+ /** Selector specifying which fields to include in a partial response. */
3908
+ fields?: string;
3909
+ /**
3910
+ * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an
3911
+ * account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer
3912
+ * account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
3913
+ */
3914
+ filterSetName: string;
3915
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
3916
+ key?: string;
3917
+ /** OAuth 2.0 token for the current user. */
3918
+ oauth_token?: string;
3919
+ /** Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. */
3920
+ pageSize?: number;
3921
+ /**
3922
+ * A token identifying a page of results the server should return. Typically, this is the value of ListImpressionMetricsResponse.nextPageToken returned from the previous call to
3923
+ * the impressionMetrics.list method.
3924
+ */
3925
+ pageToken?: string;
3926
+ /** Returns response with indentations and line breaks. */
3927
+ prettyPrint?: boolean;
3928
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3929
+ quotaUser?: string;
3930
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3931
+ upload_protocol?: string;
3932
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3933
+ uploadType?: string;
3934
+ }): Request<ListImpressionMetricsResponse>;
3935
+ }
3936
+ interface LosingBidsResource {
3937
+ /** List all reasons for which bids lost in the auction, with the number of bids that lost for each reason. */
3938
+ list(request?: {
3939
+ /** V1 error format. */
3940
+ "$.xgafv"?: string;
3941
+ /** OAuth access token. */
3942
+ access_token?: string;
3943
+ /** Data format for response. */
3944
+ alt?: string;
3945
+ /** JSONP */
3946
+ callback?: string;
3947
+ /** Selector specifying which fields to include in a partial response. */
3948
+ fields?: string;
3949
+ /**
3950
+ * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an
3951
+ * account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer
3952
+ * account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
3953
+ */
3954
+ filterSetName: string;
3955
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
3956
+ key?: string;
3957
+ /** OAuth 2.0 token for the current user. */
3958
+ oauth_token?: string;
3959
+ /** Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. */
3960
+ pageSize?: number;
3961
+ /**
3962
+ * A token identifying a page of results the server should return. Typically, this is the value of ListLosingBidsResponse.nextPageToken returned from the previous call to the
3963
+ * losingBids.list method.
3964
+ */
3965
+ pageToken?: string;
3966
+ /** Returns response with indentations and line breaks. */
3967
+ prettyPrint?: boolean;
3968
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3969
+ quotaUser?: string;
3970
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3971
+ upload_protocol?: string;
3972
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3973
+ uploadType?: string;
3974
+ }): Request<ListLosingBidsResponse>;
3975
+ }
3976
+ interface NonBillableWinningBidsResource {
3977
+ /** List all reasons for which winning bids were not billable, with the number of bids not billed for each reason. */
3978
+ list(request?: {
3979
+ /** V1 error format. */
3980
+ "$.xgafv"?: string;
3981
+ /** OAuth access token. */
3982
+ access_token?: string;
3983
+ /** Data format for response. */
3984
+ alt?: string;
3985
+ /** JSONP */
3986
+ callback?: string;
3987
+ /** Selector specifying which fields to include in a partial response. */
3988
+ fields?: string;
3989
+ /**
3990
+ * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an
3991
+ * account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer
3992
+ * account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
3993
+ */
3994
+ filterSetName: string;
3995
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
3996
+ key?: string;
3997
+ /** OAuth 2.0 token for the current user. */
3998
+ oauth_token?: string;
3999
+ /** Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. */
4000
+ pageSize?: number;
4001
+ /**
4002
+ * A token identifying a page of results the server should return. Typically, this is the value of ListNonBillableWinningBidsResponse.nextPageToken returned from the previous call
4003
+ * to the nonBillableWinningBids.list method.
4004
+ */
4005
+ pageToken?: string;
4006
+ /** Returns response with indentations and line breaks. */
4007
+ prettyPrint?: boolean;
4008
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
4009
+ quotaUser?: string;
4010
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
4011
+ upload_protocol?: string;
4012
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4013
+ uploadType?: string;
4014
+ }): Request<ListNonBillableWinningBidsResponse>;
4015
+ }
4016
+ interface FilterSetsResource {
4017
+ /** Creates the specified filter set for the account with the given account ID. */
4018
+ create(request: {
4019
+ /** V1 error format. */
4020
+ "$.xgafv"?: string;
4021
+ /** OAuth access token. */
4022
+ access_token?: string;
4023
+ /** Data format for response. */
4024
+ alt?: string;
4025
+ /** JSONP */
4026
+ callback?: string;
4027
+ /** Selector specifying which fields to include in a partial response. */
4028
+ fields?: string;
4029
+ /**
4030
+ * Whether the filter set is transient, or should be persisted indefinitely. By default, filter sets are not transient. If transient, it will be available for at least 1 hour after
4031
+ * creation.
4032
+ */
4033
+ isTransient?: boolean;
4034
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
4035
+ key?: string;
4036
+ /** OAuth 2.0 token for the current user. */
4037
+ oauth_token?: string;
4038
+ /**
4039
+ * Name of the owner (bidder or account) of the filter set to be created. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter
4040
+ * set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123:
4041
+ * `bidders/123/accounts/456`
4042
+ */
4043
+ ownerName: string;
4044
+ /** Returns response with indentations and line breaks. */
4045
+ prettyPrint?: boolean;
4046
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
4047
+ quotaUser?: string;
4048
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
4049
+ upload_protocol?: string;
4050
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4051
+ uploadType?: string;
4052
+ /** Request body */
4053
+ resource: FilterSet;
4054
+ }): Request<FilterSet>;
4055
+ create(request: {
4056
+ /** V1 error format. */
4057
+ "$.xgafv"?: string;
4058
+ /** OAuth access token. */
4059
+ access_token?: string;
4060
+ /** Data format for response. */
4061
+ alt?: string;
4062
+ /** JSONP */
4063
+ callback?: string;
4064
+ /** Selector specifying which fields to include in a partial response. */
4065
+ fields?: string;
4066
+ /**
4067
+ * Whether the filter set is transient, or should be persisted indefinitely. By default, filter sets are not transient. If transient, it will be available for at least 1 hour after
4068
+ * creation.
4069
+ */
4070
+ isTransient?: boolean;
4071
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
4072
+ key?: string;
4073
+ /** OAuth 2.0 token for the current user. */
4074
+ oauth_token?: string;
4075
+ /**
4076
+ * Name of the owner (bidder or account) of the filter set to be created. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter
4077
+ * set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123:
4078
+ * `bidders/123/accounts/456`
4079
+ */
4080
+ ownerName: string;
4081
+ /** Returns response with indentations and line breaks. */
4082
+ prettyPrint?: boolean;
4083
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
4084
+ quotaUser?: string;
4085
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
4086
+ upload_protocol?: string;
4087
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4088
+ uploadType?: string;
4089
+ },
4090
+ body: FilterSet): Request<FilterSet>;
4091
+ /** Deletes the requested filter set from the account with the given account ID. */
4092
+ delete(request?: {
4093
+ /** V1 error format. */
4094
+ "$.xgafv"?: string;
4095
+ /** OAuth access token. */
4096
+ access_token?: string;
4097
+ /** Data format for response. */
4098
+ alt?: string;
4099
+ /** JSONP */
4100
+ callback?: string;
4101
+ /** Selector specifying which fields to include in a partial response. */
4102
+ fields?: string;
4103
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
4104
+ key?: string;
4105
+ /**
4106
+ * Full name of the resource to delete. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer
4107
+ * account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123:
4108
+ * `bidders/123/accounts/456/filterSets/abc`
4109
+ */
4110
+ name: string;
4111
+ /** OAuth 2.0 token for the current user. */
4112
+ oauth_token?: string;
4113
+ /** Returns response with indentations and line breaks. */
4114
+ prettyPrint?: boolean;
4115
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
4116
+ quotaUser?: string;
4117
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
4118
+ upload_protocol?: string;
4119
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4120
+ uploadType?: string;
4121
+ }): Request<{}>;
4122
+ /** Retrieves the requested filter set for the account with the given account ID. */
4123
+ get(request?: {
4124
+ /** V1 error format. */
4125
+ "$.xgafv"?: string;
4126
+ /** OAuth access token. */
4127
+ access_token?: string;
4128
+ /** Data format for response. */
4129
+ alt?: string;
4130
+ /** JSONP */
4131
+ callback?: string;
4132
+ /** Selector specifying which fields to include in a partial response. */
4133
+ fields?: string;
4134
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
4135
+ key?: string;
4136
+ /**
4137
+ * Full name of the resource being requested. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the
4138
+ * buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123:
4139
+ * `bidders/123/accounts/456/filterSets/abc`
4140
+ */
4141
+ name: string;
4142
+ /** OAuth 2.0 token for the current user. */
4143
+ oauth_token?: string;
4144
+ /** Returns response with indentations and line breaks. */
4145
+ prettyPrint?: boolean;
4146
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
4147
+ quotaUser?: string;
4148
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
4149
+ upload_protocol?: string;
4150
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4151
+ uploadType?: string;
4152
+ }): Request<FilterSet>;
4153
+ /** Lists all filter sets for the account with the given account ID. */
4154
+ list(request?: {
4155
+ /** V1 error format. */
4156
+ "$.xgafv"?: string;
4157
+ /** OAuth access token. */
4158
+ access_token?: string;
4159
+ /** Data format for response. */
4160
+ alt?: string;
4161
+ /** JSONP */
4162
+ callback?: string;
4163
+ /** Selector specifying which fields to include in a partial response. */
4164
+ fields?: string;
4165
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
4166
+ key?: string;
4167
+ /** OAuth 2.0 token for the current user. */
4168
+ oauth_token?: string;
4169
+ /**
4170
+ * Name of the owner (bidder or account) of the filter sets to be listed. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter
4171
+ * set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123:
4172
+ * `bidders/123/accounts/456`
4173
+ */
4174
+ ownerName: string;
4175
+ /** Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. */
4176
+ pageSize?: number;
4177
+ /**
4178
+ * A token identifying a page of results the server should return. Typically, this is the value of ListFilterSetsResponse.nextPageToken returned from the previous call to the
4179
+ * accounts.filterSets.list method.
4180
+ */
4181
+ pageToken?: string;
4182
+ /** Returns response with indentations and line breaks. */
4183
+ prettyPrint?: boolean;
4184
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
4185
+ quotaUser?: string;
4186
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
4187
+ upload_protocol?: string;
4188
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4189
+ uploadType?: string;
4190
+ }): Request<ListFilterSetsResponse>;
4191
+ bidMetrics: BidMetricsResource;
4192
+ bidResponseErrors: BidResponseErrorsResource;
4193
+ bidResponsesWithoutBids: BidResponsesWithoutBidsResource;
4194
+ filteredBidRequests: FilteredBidRequestsResource;
4195
+ filteredBids: FilteredBidsResource;
4196
+ impressionMetrics: ImpressionMetricsResource;
4197
+ losingBids: LosingBidsResource;
4198
+ nonBillableWinningBids: NonBillableWinningBidsResource;
4199
+ }
4200
+ interface BiddersResource {
4201
+ accounts: AccountsResource;
4202
+ filterSets: FilterSetsResource;
4203
+ }
4204
+
4205
+ const accounts: AccountsResource;
4206
+
4207
+ const bidders: BiddersResource;
4208
+ }
4209
+ }