@maxim_mazurok/gapi.client.curationpartners-v1 0.0.0 → 0.0.20260901
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 +1569 -1
- package/package.json +16 -3
- package/readme.md +95 -0
- package/README.md +0 -3
package/index.d.ts
CHANGED
|
@@ -1 +1,1569 @@
|
|
|
1
|
-
|
|
1
|
+
/* Type definitions for non-npm package Curation Partners API v1 0.0 */
|
|
2
|
+
// Project: https://developers.google.com/authorized-buyers/curation/apis/guides/curationpartners/overview
|
|
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
|
+
|
|
8
|
+
// IMPORTANT
|
|
9
|
+
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
|
+
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
|
+
// Generated from: https://curationpartners.googleapis.com/$discovery/rest?version=v1
|
|
12
|
+
// Revision: 20260901
|
|
13
|
+
|
|
14
|
+
/// <reference types="gapi.client" />
|
|
15
|
+
|
|
16
|
+
declare namespace gapi.client {
|
|
17
|
+
/** Load Curation Partners API v1 */
|
|
18
|
+
function load(
|
|
19
|
+
urlOrObject: 'https://curationpartners.googleapis.com/$discovery/rest?version=v1',
|
|
20
|
+
): Promise<void>;
|
|
21
|
+
/** @deprecated Please load APIs with discovery documents. */
|
|
22
|
+
function load(name: 'curationpartners', version: 'v1'): Promise<void>;
|
|
23
|
+
/** @deprecated Please load APIs with discovery documents. */
|
|
24
|
+
function load(
|
|
25
|
+
name: 'curationpartners',
|
|
26
|
+
version: 'v1',
|
|
27
|
+
callback: () => any,
|
|
28
|
+
): void;
|
|
29
|
+
|
|
30
|
+
namespace curationpartners {
|
|
31
|
+
interface AccessControlSettings {
|
|
32
|
+
/** Required. Immutable. The list of media planners that are explicitly granted access to the curated package. Eligible media planners can be found in the mediaPlanners.list method. Only a single media planner may be allowlisted at this time. Format: `mediaPlanners/{mediaPlannerAccountId}` */
|
|
33
|
+
allowlistedMediaPlanners?: string[];
|
|
34
|
+
}
|
|
35
|
+
interface ActivateCuratedPackageRequest {}
|
|
36
|
+
interface ActivateDataSegmentRequest {}
|
|
37
|
+
interface AdSize {
|
|
38
|
+
/** The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`. */
|
|
39
|
+
height?: string;
|
|
40
|
+
/** The type of the ad slot size. */
|
|
41
|
+
type?: 'TYPE_UNSPECIFIED' | 'PIXEL' | 'INTERSTITIAL' | 'NATIVE' | 'FLUID';
|
|
42
|
+
/** The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`. */
|
|
43
|
+
width?: string;
|
|
44
|
+
}
|
|
45
|
+
interface CriteriaTargeting {
|
|
46
|
+
/** A list of numeric IDs to be excluded. */
|
|
47
|
+
excludedCriteriaIds?: string[];
|
|
48
|
+
/** A list of numeric IDs to be included. */
|
|
49
|
+
targetedCriteriaIds?: string[];
|
|
50
|
+
}
|
|
51
|
+
interface CuratedPackage {
|
|
52
|
+
/** Required. Settings for controlling access to the curated package. Access to this curated package is limited to the allowlisted media planners and the creator. Buyers and bidders can not be allowlisted for or have direct access to this resource. */
|
|
53
|
+
accessSettings?: AccessControlSettings;
|
|
54
|
+
/** Output only. The timestamp when the curated package was created. Can be used to filter the response of the curatedPackages.list method. */
|
|
55
|
+
createTime?: string;
|
|
56
|
+
/** Optional. Immutable. The visibility of the combined curation package fee and data segment fees (the total curation fee). */
|
|
57
|
+
curationFeeVisibility?:
|
|
58
|
+
'CURATION_FEE_VISIBILITY_UNSPECIFIED' | 'DISCLOSED' | 'NON_DISCLOSED';
|
|
59
|
+
/** Optional. A description of the curated package, provided by the curator. */
|
|
60
|
+
description?: string;
|
|
61
|
+
/** Required. The display name assigned to the curated package by the curator. Can be used to filter the response of the curatedPackages.list method. */
|
|
62
|
+
displayName?: string;
|
|
63
|
+
/** Optional. The CPM fee charged by the curator to buyers using this curated package. Can be used to filter the response of the curatedPackages.list method. */
|
|
64
|
+
feeCpm?: Money;
|
|
65
|
+
/** Optional. The minimum CPM a buyer has to bid to participate in auctions for inventory in this curated package. Can be used to filter the response of the curatedPackages.list method. */
|
|
66
|
+
floorPriceCpm?: Money;
|
|
67
|
+
/** Optional. The fee will be charged as a percentage of the impression cost, represented in millipercent. For example, 1% is represented as 1000. */
|
|
68
|
+
millipercentOfMediaFee?: string;
|
|
69
|
+
/** Identifier. The unique resource name for the curated package. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}` */
|
|
70
|
+
name?: string;
|
|
71
|
+
/** Output only. The state of the curated package. Can be used to filter the response of the curatedPackages.list method. */
|
|
72
|
+
state?: 'STATE_UNSPECIFIED' | 'ACTIVE' | 'INACTIVE';
|
|
73
|
+
/** Optional. Targeting criteria for the curated package. */
|
|
74
|
+
targeting?: PackageTargeting;
|
|
75
|
+
/** Output only. The timestamp when the curated package was last updated. Can be used to filter the response of the curatedPackages.list method. */
|
|
76
|
+
updateTime?: string;
|
|
77
|
+
}
|
|
78
|
+
interface DataSegment {
|
|
79
|
+
/** Optional. A fixed fee charged per thousand impressions. Once set, the currency code cannot be changed. */
|
|
80
|
+
cpmFee?: Money;
|
|
81
|
+
/** Output only. Time the data segment was created. */
|
|
82
|
+
createTime?: string;
|
|
83
|
+
/** Optional. The fee will be charged as a percentage of the impression cost, represented in millipercent. For example, 1% is represented as 1000. */
|
|
84
|
+
millipercentOfMediaFee?: string;
|
|
85
|
+
/** Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. Format: `curators/{curatorAccountId}/dataSegments/{curatorDataSegmentId}` */
|
|
86
|
+
name?: string;
|
|
87
|
+
/** Output only. The state of the data segment. */
|
|
88
|
+
state?: 'STATE_UNSPECIFIED' | 'ACTIVE' | 'INACTIVE' | 'SUSPENDED';
|
|
89
|
+
/** Output only. Time the data segment was last updated. */
|
|
90
|
+
updateTime?: string;
|
|
91
|
+
/** Optional. Immutable. The ID of the User List wrapped by this Data Segment. Curators with a linked Data Partner account can create a data segment that wraps a user list owned by the linked Data Partner account. User lists can be uploaded and managed using the [Data Manager API](https://developers.google.com/data-manager/api/data-partners/audiences). Linking a user list to a data segment lets you define a segment of inventory that is based on an audience you create. */
|
|
92
|
+
userListId?: string;
|
|
93
|
+
}
|
|
94
|
+
interface Date {
|
|
95
|
+
/** 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. */
|
|
96
|
+
day?: number;
|
|
97
|
+
/** Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. */
|
|
98
|
+
month?: number;
|
|
99
|
+
/** Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. */
|
|
100
|
+
year?: number;
|
|
101
|
+
}
|
|
102
|
+
interface DateRange {
|
|
103
|
+
/** A fixed date range. */
|
|
104
|
+
fixed?: FixedDateRange;
|
|
105
|
+
/** A relative date range. */
|
|
106
|
+
relative?:
|
|
107
|
+
| 'RELATIVE_DATE_RANGE_UNSPECIFIED'
|
|
108
|
+
| 'TODAY'
|
|
109
|
+
| 'YESTERDAY'
|
|
110
|
+
| 'THIS_WEEK_TO_DATE'
|
|
111
|
+
| 'THIS_WEEK_TO_YESTERDAY'
|
|
112
|
+
| 'THIS_MONTH_TO_DATE'
|
|
113
|
+
| 'THIS_MONTH_TO_YESTERDAY'
|
|
114
|
+
| 'THIS_QUARTER_TO_DATE'
|
|
115
|
+
| 'THIS_QUARTER_TO_YESTERDAY'
|
|
116
|
+
| 'THIS_YEAR_TO_DATE'
|
|
117
|
+
| 'THIS_YEAR_TO_YESTERDAY'
|
|
118
|
+
| 'LAST_WEEK'
|
|
119
|
+
| 'LAST_WEEK_STARTING_SUNDAY'
|
|
120
|
+
| 'LAST_MONTH'
|
|
121
|
+
| 'LAST_QUARTER'
|
|
122
|
+
| 'LAST_YEAR'
|
|
123
|
+
| 'LAST_7_DAYS'
|
|
124
|
+
| 'LAST_30_DAYS'
|
|
125
|
+
| 'LAST_60_DAYS'
|
|
126
|
+
| 'LAST_90_DAYS'
|
|
127
|
+
| 'LAST_93_DAYS'
|
|
128
|
+
| 'LAST_180_DAYS'
|
|
129
|
+
| 'LAST_360_DAYS'
|
|
130
|
+
| 'LAST_365_DAYS'
|
|
131
|
+
| 'LAST_3_MONTHS'
|
|
132
|
+
| 'LAST_6_MONTHS'
|
|
133
|
+
| 'LAST_12_MONTHS'
|
|
134
|
+
| 'ALL_AVAILABLE';
|
|
135
|
+
}
|
|
136
|
+
interface DeactivateCuratedPackageRequest {}
|
|
137
|
+
interface DeactivateDataSegmentRequest {}
|
|
138
|
+
interface DoubleList {
|
|
139
|
+
/** The values */
|
|
140
|
+
values?: number[];
|
|
141
|
+
}
|
|
142
|
+
interface Empty {}
|
|
143
|
+
interface FetchReportResultRowsResponse {
|
|
144
|
+
/** The computed fixed date ranges this report includes. Only returned with the first page of results (when page_token is not included in the request). */
|
|
145
|
+
dateRanges?: FixedDateRange[];
|
|
146
|
+
/** A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
|
|
147
|
+
nextPageToken?: string;
|
|
148
|
+
/** Up to `page_size` rows of report data. */
|
|
149
|
+
rows?: Row[];
|
|
150
|
+
/** The time at which the report was scheduled to run. For non-scheduled reports, this is the time at which the report was requested to be run. */
|
|
151
|
+
runTime?: string;
|
|
152
|
+
/** The total number of rows available from this report. Useful for pagination. Only returned with the first page of results (when page_token is not included in the request). */
|
|
153
|
+
totalRowCount?: number;
|
|
154
|
+
}
|
|
155
|
+
interface Field {
|
|
156
|
+
/** The dimension this field represents. */
|
|
157
|
+
dimension?:
|
|
158
|
+
| 'DIMENSION_UNSPECIFIED'
|
|
159
|
+
| 'ADVERTISER_DOMAIN'
|
|
160
|
+
| 'COUNTRY'
|
|
161
|
+
| 'CURATION_DATA_SEGMENT_ID'
|
|
162
|
+
| 'CURATION_DATA_SEGMENT_RESPONSE_STATUS'
|
|
163
|
+
| 'CURATION_DATA_SEGMENT_RESPONSE_STATUS_NAME'
|
|
164
|
+
| 'CURATOR_FEE_TYPE'
|
|
165
|
+
| 'DATE'
|
|
166
|
+
| 'DEAL_ID'
|
|
167
|
+
| 'DEAL_NAME'
|
|
168
|
+
| 'DETECTED_ADVERTISER_NAME'
|
|
169
|
+
| 'DSP_NAME'
|
|
170
|
+
| 'DSP_SEAT_ID'
|
|
171
|
+
| 'ENVIRONMENT'
|
|
172
|
+
| 'ENVIRONMENT_NAME'
|
|
173
|
+
| 'HOLDING_COMPANY_NAME'
|
|
174
|
+
| 'HOUR'
|
|
175
|
+
| 'MOBILE_APP_ID'
|
|
176
|
+
| 'MOBILE_APP_NAME'
|
|
177
|
+
| 'MOBILE_OS'
|
|
178
|
+
| 'MONTH'
|
|
179
|
+
| 'PACKAGE_FEE_VISIBILITY'
|
|
180
|
+
| 'PLATFORM'
|
|
181
|
+
| 'PUBLISHER_DOMAIN'
|
|
182
|
+
| 'PUBLISHER_ID'
|
|
183
|
+
| 'PUBLISHER_NAME'
|
|
184
|
+
| 'WEEK';
|
|
185
|
+
/** The metric this field represents. */
|
|
186
|
+
metric?:
|
|
187
|
+
| 'METRIC_UNSPECIFIED'
|
|
188
|
+
| 'ACTIVE_VIEW_MEASURABILITY_RATE'
|
|
189
|
+
| 'ACTIVE_VIEW_MEASURABLE'
|
|
190
|
+
| 'ACTIVE_VIEW_VIEWABILITY_RATE'
|
|
191
|
+
| 'ACTIVE_VIEW_VIEWABLE'
|
|
192
|
+
| 'AUCTIONS_WON'
|
|
193
|
+
| 'BIDS'
|
|
194
|
+
| 'BIDS_IN_AUCTION'
|
|
195
|
+
| 'BID_REQUESTS'
|
|
196
|
+
| 'CLICKS'
|
|
197
|
+
| 'CURATION_PARTNER_FEE'
|
|
198
|
+
| 'DATA_SEGMENT_REQUESTS'
|
|
199
|
+
| 'IMPRESSIONS'
|
|
200
|
+
| 'SPEND';
|
|
201
|
+
}
|
|
202
|
+
interface FieldFilter {
|
|
203
|
+
/** Required. The field to filter on. */
|
|
204
|
+
field?: Field;
|
|
205
|
+
/** Required. The operation of this filter. */
|
|
206
|
+
operation?:
|
|
207
|
+
| 'IN'
|
|
208
|
+
| 'NOT_IN'
|
|
209
|
+
| 'CONTAINS'
|
|
210
|
+
| 'NOT_CONTAINS'
|
|
211
|
+
| 'LESS_THAN'
|
|
212
|
+
| 'LESS_THAN_EQUALS'
|
|
213
|
+
| 'GREATER_THAN'
|
|
214
|
+
| 'GREATER_THAN_EQUALS'
|
|
215
|
+
| 'BETWEEN'
|
|
216
|
+
| 'MATCHES'
|
|
217
|
+
| 'NOT_MATCHES';
|
|
218
|
+
/** Required. Values to filter to. */
|
|
219
|
+
values?: ReportValue[];
|
|
220
|
+
}
|
|
221
|
+
interface Filter {
|
|
222
|
+
/** A list of filters whose results are AND-ed. */
|
|
223
|
+
andFilter?: FilterList;
|
|
224
|
+
/** A filter on a single field. */
|
|
225
|
+
fieldFilter?: FieldFilter;
|
|
226
|
+
/** A filter whose result is negated. */
|
|
227
|
+
notFilter?: Filter;
|
|
228
|
+
/** A list of filters whose results are OR-ed. */
|
|
229
|
+
orFilter?: FilterList;
|
|
230
|
+
}
|
|
231
|
+
interface FilterList {
|
|
232
|
+
/** Required. A list of filters. */
|
|
233
|
+
filters?: Filter[];
|
|
234
|
+
}
|
|
235
|
+
interface FixedDateRange {
|
|
236
|
+
/** Required. The end date (inclusive) of this date range. */
|
|
237
|
+
endDate?: Date;
|
|
238
|
+
/** Required. The start date of this date range. */
|
|
239
|
+
startDate?: Date;
|
|
240
|
+
}
|
|
241
|
+
interface IntList {
|
|
242
|
+
/** The values */
|
|
243
|
+
values?: string[];
|
|
244
|
+
}
|
|
245
|
+
interface ListCuratedPackagesResponse {
|
|
246
|
+
/** The list of curated packages. */
|
|
247
|
+
curatedPackages?: CuratedPackage[];
|
|
248
|
+
/** A token to retrieve the next page of results. Pass this value in the ListCuratedPackagesRequest.pageToken field in the subsequent call to `ListCuratedPackages` method to retrieve the next page of results. If empty, then there are no more results. */
|
|
249
|
+
nextPageToken?: string;
|
|
250
|
+
}
|
|
251
|
+
interface ListDataSegmentsResponse {
|
|
252
|
+
/** The list of data segments. */
|
|
253
|
+
dataSegments?: DataSegment[];
|
|
254
|
+
/** Continuation token for fetching the next page of results. Pass this value in the ListDataSegmentsRequest.pageToken field in the subsequent call to the `ListDataSegments` method to retrieve the next page of results. */
|
|
255
|
+
nextPageToken?: string;
|
|
256
|
+
}
|
|
257
|
+
interface ListMediaPlannersResponse {
|
|
258
|
+
/** List of media planners. */
|
|
259
|
+
mediaPlanners?: MediaPlanner[];
|
|
260
|
+
/** A token which can be passed to a subsequent call to the ListMediaPlanners method to retrieve the next page of results in ListMediaPlannersRequest.page_token. */
|
|
261
|
+
nextPageToken?: string;
|
|
262
|
+
}
|
|
263
|
+
interface ListReportsResponse {
|
|
264
|
+
/** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
|
|
265
|
+
nextPageToken?: string;
|
|
266
|
+
/** The `Report` objects from the specified network. */
|
|
267
|
+
reports?: Report[];
|
|
268
|
+
/** Total number of `Report` objects. If a filter was included in the request, this reflects the total number after the filtering is applied. `total_size` won't be calculated in the response unless it has been included in a response field mask. The response field mask can be provided to the method by using the URL parameter `$fields` or `fields`, or by using the HTTP/gRPC header `X-Goog-FieldMask`. For more information, see https://developers.google.com/ad-manager/api/beta/field-masks */
|
|
269
|
+
totalSize?: number;
|
|
270
|
+
}
|
|
271
|
+
interface MediaPlanner {
|
|
272
|
+
/** Output only. Account ID of the media planner. */
|
|
273
|
+
accountId?: string;
|
|
274
|
+
/** Output only. The ancestor names of the media planner. Format: `mediaPlanners/{mediaPlannerAccountId}`. Can be used to filter the response of the mediaPlanners.list method. */
|
|
275
|
+
ancestorNames?: string[];
|
|
276
|
+
/** Output only. The display name of the media planner. Can be used to filter the response of the mediaPlanners.list method. */
|
|
277
|
+
displayName?: string;
|
|
278
|
+
/** Identifier. The unique resource name of the media planner. Format: `mediaPlanners/{mediaPlannerAccountId}`. Can be used to filter the response of the mediaPlanners.list method. */
|
|
279
|
+
name?: string;
|
|
280
|
+
}
|
|
281
|
+
interface MetricValueGroup {
|
|
282
|
+
/** Data for the PRIMARY MetricValueType. */
|
|
283
|
+
primaryValues?: ReportValue[];
|
|
284
|
+
}
|
|
285
|
+
interface Money {
|
|
286
|
+
/** The three-letter currency code defined in ISO 4217. */
|
|
287
|
+
currencyCode?: string;
|
|
288
|
+
/** 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` 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 `nanos`=-750,000,000. */
|
|
289
|
+
nanos?: number;
|
|
290
|
+
/** The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. */
|
|
291
|
+
units?: string;
|
|
292
|
+
}
|
|
293
|
+
interface Operation {
|
|
294
|
+
/** If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */
|
|
295
|
+
done?: boolean;
|
|
296
|
+
/** The error result of the operation in case of failure or cancellation. */
|
|
297
|
+
error?: Status;
|
|
298
|
+
/** Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */
|
|
299
|
+
metadata?: {[P in string]: any};
|
|
300
|
+
/** The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */
|
|
301
|
+
name?: string;
|
|
302
|
+
/** The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */
|
|
303
|
+
response?: {[P in string]: any};
|
|
304
|
+
}
|
|
305
|
+
interface PackagePlacementTargeting {
|
|
306
|
+
/** Optional. The list of targeted mobile app categories. */
|
|
307
|
+
includedMobileAppCategoryTargeting?: string[];
|
|
308
|
+
/** Optional. The list of targeted or excluded mobile application IDs that publishers own. Currently, only Android and Apple apps are supported. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. */
|
|
309
|
+
mobileAppTargeting?: StringTargetingDimension;
|
|
310
|
+
/** Optional. The list of targeted or excluded URLs. The domains should have the http/https stripped (for example, google.com), and can contain a max of 5 paths per url. */
|
|
311
|
+
uriTargeting?: StringTargetingDimension;
|
|
312
|
+
}
|
|
313
|
+
interface PackagePublisherProvidedSignalsTargeting {
|
|
314
|
+
/** Optional. The list of targeted or excluded audience IDs. Based off of IAB Audience Taxonomy version 1.1 (https://github.com/InteractiveAdvertisingBureau/Taxonomies/blob/main/Audience%20Taxonomies/Audience%20Taxonomy%201.1.tsv) */
|
|
315
|
+
audienceTargeting?: TaxonomyTargeting;
|
|
316
|
+
/** Optional. The list of targeted or excluded content IDs. Based off of IAB Content Taxonomy version 2.2 (https://github.com/InteractiveAdvertisingBureau/Taxonomies/blob/main/Content%20Taxonomies/Content%20Taxonomy%202.2.tsv) */
|
|
317
|
+
contentTargeting?: TaxonomyTargeting;
|
|
318
|
+
/** Optional. The list of targeted and excluded video and audio signals IDs. These are additional signals supported by publisher provided signals. */
|
|
319
|
+
videoAndAudioSignalsTargeting?: StringTargetingDimension;
|
|
320
|
+
}
|
|
321
|
+
interface PackageTargeting {
|
|
322
|
+
/** Optional. The geo criteria IDs to be included or excluded as defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv. If unset, inventory will be targeted regardless of geo. */
|
|
323
|
+
geoTargeting?: CriteriaTargeting;
|
|
324
|
+
/** Optional. The targeted accelerated mobile page type. If unset, inventory will be targeted regardless of AMP status. */
|
|
325
|
+
includedAcceleratedMobilePageType?:
|
|
326
|
+
| 'ACCELERATED_MOBILE_PAGE_TYPE_UNSPECIFIED'
|
|
327
|
+
| 'ACCELERATED_MOBILE_PAGE_TYPE_NON_AMP'
|
|
328
|
+
| 'ACCELERATED_MOBILE_PAGE_TYPE_AMP'
|
|
329
|
+
| 'ACCELERATED_MOBILE_PAGE_TYPE_AMP_STORY';
|
|
330
|
+
/** Optional. The list of ad sizes to target. If unset, inventory will be targeted regardless of ad size. Curated packages supports `PIXEL` and `INTERSTITIAL` ad sizes. */
|
|
331
|
+
includedAdSizes?: AdSize[];
|
|
332
|
+
/** Optional. The included list of targeted authorized seller statuses. If empty, inventory will be targeted regardless of seller status. */
|
|
333
|
+
includedAuthorizedSellerStatuses?:
|
|
334
|
+
| 'AUTHORIZED_SELLER_STATUS_UNSPECIFIED'
|
|
335
|
+
| 'AUTHORIZED_SELLER_STATUS_DIRECT'
|
|
336
|
+
| 'AUTHORIZED_SELLER_STATUS_RESELLER'[];
|
|
337
|
+
/** Optional. The creative format to target. If unset, all creative markup types are targeted. */
|
|
338
|
+
includedCreativeFormat?:
|
|
339
|
+
| 'CREATIVE_FORMAT_UNSPECIFIED'
|
|
340
|
+
| 'CREATIVE_FORMAT_DISPLAY'
|
|
341
|
+
| 'CREATIVE_FORMAT_VIDEO'
|
|
342
|
+
| 'CREATIVE_FORMAT_AUDIO';
|
|
343
|
+
/** Optional. The active data segments to be targeted. If unset, inventory will be targeted regardless of data segments. Format: `curators/{account_id}/dataSegments/{data_segment_id}` */
|
|
344
|
+
includedDataSegments?: string[];
|
|
345
|
+
/** Optional. The list of included device types to target. If empty, all device types are targeted. */
|
|
346
|
+
includedDeviceTypes?:
|
|
347
|
+
| 'DEVICE_TYPE_UNSPECIFIED'
|
|
348
|
+
| 'DEVICE_TYPE_PERSONAL_COMPUTER'
|
|
349
|
+
| 'DEVICE_TYPE_CONNECTED_TV'
|
|
350
|
+
| 'DEVICE_TYPE_PHONE'
|
|
351
|
+
| 'DEVICE_TYPE_TABLET'[];
|
|
352
|
+
/** Optional. The environment to target. If unspecified, all environments are targeted. */
|
|
353
|
+
includedEnvironment?:
|
|
354
|
+
'ENVIRONMENT_UNSPECIFIED' | 'ENVIRONMENT_SITE' | 'ENVIRONMENT_APP';
|
|
355
|
+
/** Optional. The targeted native inventory types. If empty, inventory will be targeted regardless of native inventory type. */
|
|
356
|
+
includedNativeInventoryTypes?:
|
|
357
|
+
| 'NATIVE_INVENTORY_TYPE_UNSPECIFIED'
|
|
358
|
+
| 'NATIVE_INVENTORY_TYPE_NATIVE_ONLY'
|
|
359
|
+
| 'NATIVE_INVENTORY_TYPE_NATIVE_OR_BANNER'[];
|
|
360
|
+
/** Optional. The list of targeted open measurement types. If empty, inventory will be targeted regardless of Open Measurement support. */
|
|
361
|
+
includedOpenMeasurementTypes?:
|
|
362
|
+
'OPEN_MEASUREMENT_TYPE_UNSPECIFIED' | 'OPEN_MEASUREMENT_TYPE_OMID_V1'[];
|
|
363
|
+
/** Optional. The list of targeted restricted categories. If empty, inventory will be targeted regardless of restricted categories. */
|
|
364
|
+
includedRestrictedCategories?:
|
|
365
|
+
| 'RESTRICTED_CATEGORY_UNSPECIFIED'
|
|
366
|
+
| 'RESTRICTED_CATEGORY_ALCOHOL'
|
|
367
|
+
| 'RESTRICTED_CATEGORY_GAMBLING'[];
|
|
368
|
+
/** Optional. The targeted rewarded type. If unset, inventory will be targeted regardless of rewarded type. */
|
|
369
|
+
includedRewardedType?:
|
|
370
|
+
| 'REWARDED_TYPE_UNSPECIFIED'
|
|
371
|
+
| 'REWARDED_TYPE_NON_REWARDED'
|
|
372
|
+
| 'REWARDED_TYPE_REWARDED';
|
|
373
|
+
/** Optional. The languages to target. If unset, inventory will be targeted regardless of language. See https://developers.google.com/google-ads/api/data/codes-formats#languages for the list of supported language codes. */
|
|
374
|
+
languageTargeting?: StringTargetingDimension;
|
|
375
|
+
/** Optional. The targeted minimum predicted click through rate, ranging in values [10, 10000] (0.01% - 10%). A value of 50 means that the configuration will only match adslots for which we predict at least 0.05% click through rate. An unset value indicates inventory will be targeted regardless of predicted click through rate. */
|
|
376
|
+
minimumPredictedClickThroughRatePercentageMillis?: string;
|
|
377
|
+
/** Optional. The targeted minimum predicted viewability percentage. This value must be a multiple of 10 between 10 and 90 (inclusive). For example, 10 is valid, but 0, 15, and 100 are not. A value of 10 means that the configuration will only match adslots for which we predict at least 10% viewability. An unset value indicates inventory will be targeted regardless of predicted viewability. */
|
|
378
|
+
minimumPredictedViewabilityPercentage?: string;
|
|
379
|
+
/** Optional. Placement targeting information, for example, URL, mobile applications. */
|
|
380
|
+
placementTargeting?: PackagePlacementTargeting;
|
|
381
|
+
/** Optional. The publisher provided signals to target. If unset, inventory will be targeted regardless of publisher provided signals. */
|
|
382
|
+
publisherProvidedSignalsTargeting?: PackagePublisherProvidedSignalsTargeting;
|
|
383
|
+
/** Optional. The targeted publishers. If unset, inventory will be targeted regardless of publisher. Publishers are identified by their publisher ID from ads.txt / app-ads.txt. See https://iabtechlab.com/ads-txt/ and https://iabtechlab.com/app-ads-txt/ for more details. */
|
|
384
|
+
publisherTargeting?: StringTargetingDimension;
|
|
385
|
+
/** Optional. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals. If unset, inventory will be targeted regardless of vertical. */
|
|
386
|
+
verticalTargeting?: CriteriaTargeting;
|
|
387
|
+
/** Optional. Video specific targeting criteria. */
|
|
388
|
+
videoTargeting?: PackageVideoTargeting;
|
|
389
|
+
}
|
|
390
|
+
interface PackageVideoTargeting {
|
|
391
|
+
/** Optional. The targeted video delivery method. If unset, inventory will be targeted regardless of video delivery method. */
|
|
392
|
+
includedContentDeliveryMethod?:
|
|
393
|
+
| 'CONTENT_DELIVERY_METHOD_UNSPECIFIED'
|
|
394
|
+
| 'CONTENT_DELIVERY_METHOD_STREAMING'
|
|
395
|
+
| 'CONTENT_DELIVERY_METHOD_PROGRESSIVE';
|
|
396
|
+
/** Optional. The targeted maximum video ad duration. If unset, inventory will be targeted regardless of maximum video ad duration. */
|
|
397
|
+
includedMaximumAdDurationTargeting?:
|
|
398
|
+
| 'MAXIMUM_VIDEO_AD_DURATION_UNSPECIFIED'
|
|
399
|
+
| 'MAXIMUM_VIDEO_AD_DURATION_FIFTEEN_SECONDS'
|
|
400
|
+
| 'MAXIMUM_VIDEO_AD_DURATION_TWENTY_SECONDS'
|
|
401
|
+
| 'MAXIMUM_VIDEO_AD_DURATION_THIRTY_SECONDS'
|
|
402
|
+
| 'MAXIMUM_VIDEO_AD_DURATION_SIXTY_SECONDS'
|
|
403
|
+
| 'MAXIMUM_VIDEO_AD_DURATION_NINETY_SECONDS'
|
|
404
|
+
| 'MAXIMUM_VIDEO_AD_DURATION_ONE_HUNDRED_TWENTY_SECONDS';
|
|
405
|
+
/** Optional. The list of targeted video mime types using the IANA published MIME type strings (https://www.iana.org/assignments/media-types/media-types.xhtml). If empty, inventory will be targeted regardless of video mime type. */
|
|
406
|
+
includedMimeTypes?:
|
|
407
|
+
| 'VIDEO_MIME_TYPE_UNSPECIFIED'
|
|
408
|
+
| 'VIDEO_MIME_TYPE_THREEGPP'
|
|
409
|
+
| 'VIDEO_MIME_TYPE_APPLICATION_MPEGURL'
|
|
410
|
+
| 'VIDEO_MIME_TYPE_MP4'
|
|
411
|
+
| 'VIDEO_MIME_TYPE_APPLICATION_MPEGDASH'
|
|
412
|
+
| 'VIDEO_MIME_TYPE_APPLICATION_JAVASCRIPT'
|
|
413
|
+
| 'VIDEO_MIME_TYPE_WEBM'[];
|
|
414
|
+
/** Optional. The list of targeted video playback methods. If empty, inventory will be targeted regardless of video playback method. */
|
|
415
|
+
includedPlaybackMethods?:
|
|
416
|
+
| 'PLAYBACK_METHOD_UNSPECIFIED'
|
|
417
|
+
| 'PLAYBACK_METHOD_AUTO_PLAY_SOUND_ON'
|
|
418
|
+
| 'PLAYBACK_METHOD_AUTO_PLAY_SOUND_OFF'
|
|
419
|
+
| 'PLAYBACK_METHOD_CLICK_TO_PLAY'[];
|
|
420
|
+
/** Optional. The targeted video player size. If unset, inventory will be targeted regardless of video player size. */
|
|
421
|
+
includedPlayerSizeTargeting?: VideoPlayerSizeTargeting;
|
|
422
|
+
/** Optional. The targeted video ad position types. If empty, inventory will be targeted regardless of video ad position type. */
|
|
423
|
+
includedPositionTypes?:
|
|
424
|
+
| 'POSITION_TYPE_UNSPECIFIED'
|
|
425
|
+
| 'POSITION_TYPE_MIDROLL'
|
|
426
|
+
| 'POSITION_TYPE_POSTROLL'
|
|
427
|
+
| 'POSITION_TYPE_PREROLL'[];
|
|
428
|
+
/** Optional. The targeted minimum predicted completion rate percentage. This value must be a multiple of 10 between 10 and 90 (inclusive). For example, 10 is valid, but 0, 15, and 100 are not. A value of 10 means that the configuration will only match adslots for which we predict at least 10% completion rate. An unset value indicates inventory will be targeted regardless of predicted completion rate. */
|
|
429
|
+
minimumPredictedCompletionRatePercentage?: string;
|
|
430
|
+
/** Optional. The targeted video plcmt types. If unset, inventory will be targeted regardless of video plcmt type. */
|
|
431
|
+
plcmtTargeting?: VideoPlcmtTargeting;
|
|
432
|
+
}
|
|
433
|
+
interface Report {
|
|
434
|
+
/** Output only. The instant this report was created. */
|
|
435
|
+
createTime?: string;
|
|
436
|
+
/** Optional. Display name for the report. */
|
|
437
|
+
displayName?: string;
|
|
438
|
+
/** Output only. The locale of this report. Locale is set from the user's locale at the time of the request. Locale can't be modified. */
|
|
439
|
+
locale?: string;
|
|
440
|
+
/** Identifier. The resource name of the report. Report resource name have the form: `curators/{account_id}/reports/{report_id}` */
|
|
441
|
+
name?: string;
|
|
442
|
+
/** Required. The report definition of the report. */
|
|
443
|
+
reportDefinition?: ReportDefinition;
|
|
444
|
+
/** Output only. Report ID. */
|
|
445
|
+
reportId?: string;
|
|
446
|
+
/** Output only. The instant this report was last modified. */
|
|
447
|
+
updateTime?: string;
|
|
448
|
+
}
|
|
449
|
+
interface ReportDefinition {
|
|
450
|
+
/** Optional. The ISO 4217 currency code for this report. Defaults to account currency code if not specified. */
|
|
451
|
+
currencyCode?: string;
|
|
452
|
+
/** Required. The primary date range of this report. */
|
|
453
|
+
dateRange?: DateRange;
|
|
454
|
+
/** Required. The list of dimensions to report on. If empty, the report will have no dimensions, and any metrics will be totals. */
|
|
455
|
+
dimensions?:
|
|
456
|
+
| 'DIMENSION_UNSPECIFIED'
|
|
457
|
+
| 'ADVERTISER_DOMAIN'
|
|
458
|
+
| 'COUNTRY'
|
|
459
|
+
| 'CURATION_DATA_SEGMENT_ID'
|
|
460
|
+
| 'CURATION_DATA_SEGMENT_RESPONSE_STATUS'
|
|
461
|
+
| 'CURATION_DATA_SEGMENT_RESPONSE_STATUS_NAME'
|
|
462
|
+
| 'CURATOR_FEE_TYPE'
|
|
463
|
+
| 'DATE'
|
|
464
|
+
| 'DEAL_ID'
|
|
465
|
+
| 'DEAL_NAME'
|
|
466
|
+
| 'DETECTED_ADVERTISER_NAME'
|
|
467
|
+
| 'DSP_NAME'
|
|
468
|
+
| 'DSP_SEAT_ID'
|
|
469
|
+
| 'ENVIRONMENT'
|
|
470
|
+
| 'ENVIRONMENT_NAME'
|
|
471
|
+
| 'HOLDING_COMPANY_NAME'
|
|
472
|
+
| 'HOUR'
|
|
473
|
+
| 'MOBILE_APP_ID'
|
|
474
|
+
| 'MOBILE_APP_NAME'
|
|
475
|
+
| 'MOBILE_OS'
|
|
476
|
+
| 'MONTH'
|
|
477
|
+
| 'PACKAGE_FEE_VISIBILITY'
|
|
478
|
+
| 'PLATFORM'
|
|
479
|
+
| 'PUBLISHER_DOMAIN'
|
|
480
|
+
| 'PUBLISHER_ID'
|
|
481
|
+
| 'PUBLISHER_NAME'
|
|
482
|
+
| 'WEEK'[];
|
|
483
|
+
/** Optional. The filters for this report. */
|
|
484
|
+
filters?: Filter[];
|
|
485
|
+
/** Required. The list of metrics to report on. If empty, the report will have no metrics. */
|
|
486
|
+
metrics?:
|
|
487
|
+
| 'METRIC_UNSPECIFIED'
|
|
488
|
+
| 'ACTIVE_VIEW_MEASURABILITY_RATE'
|
|
489
|
+
| 'ACTIVE_VIEW_MEASURABLE'
|
|
490
|
+
| 'ACTIVE_VIEW_VIEWABILITY_RATE'
|
|
491
|
+
| 'ACTIVE_VIEW_VIEWABLE'
|
|
492
|
+
| 'AUCTIONS_WON'
|
|
493
|
+
| 'BIDS'
|
|
494
|
+
| 'BIDS_IN_AUCTION'
|
|
495
|
+
| 'BID_REQUESTS'
|
|
496
|
+
| 'CLICKS'
|
|
497
|
+
| 'CURATION_PARTNER_FEE'
|
|
498
|
+
| 'DATA_SEGMENT_REQUESTS'
|
|
499
|
+
| 'IMPRESSIONS'
|
|
500
|
+
| 'SPEND'[];
|
|
501
|
+
/** Optional. Default sorts to apply to this report. */
|
|
502
|
+
sorts?: Sort[];
|
|
503
|
+
/** Optional. If time_zone_source is PROVIDED, this is the time zone to use for this report. Leave empty for any other time zone source. Time zone in IANA format. For example, "America/New_York". */
|
|
504
|
+
timeZone?: string;
|
|
505
|
+
/** Optional. Where to get the time zone for this report. Defaults to using the Pacific time zone (PT). If source is PROVIDED, the time_zone field in the report definition must also set a time zone. */
|
|
506
|
+
timeZoneSource?:
|
|
507
|
+
'TIME_ZONE_SOURCE_UNSPECIFIED' | 'AD_EXCHANGE' | 'UTC' | 'PROVIDED';
|
|
508
|
+
}
|
|
509
|
+
interface ReportValue {
|
|
510
|
+
/** For boolean values. */
|
|
511
|
+
boolValue?: boolean;
|
|
512
|
+
/** For bytes values. */
|
|
513
|
+
bytesValue?: string;
|
|
514
|
+
/** For lists of double values. */
|
|
515
|
+
doubleListValue?: DoubleList;
|
|
516
|
+
/** For double values. */
|
|
517
|
+
doubleValue?: number;
|
|
518
|
+
/** For lists of integer values. */
|
|
519
|
+
intListValue?: IntList;
|
|
520
|
+
/** For integer values. */
|
|
521
|
+
intValue?: string;
|
|
522
|
+
/** For lists of string values. */
|
|
523
|
+
stringListValue?: StringList;
|
|
524
|
+
/** For string values. */
|
|
525
|
+
stringValue?: string;
|
|
526
|
+
}
|
|
527
|
+
interface Row {
|
|
528
|
+
/** The order of the dimension values is the same as the order of the dimensions specified in the request. */
|
|
529
|
+
dimensionValues?: ReportValue[];
|
|
530
|
+
/** The length of the metric_value_groups field will be equal to the length of the date_ranges field in the fetch response. The metric_value_groups field is ordered such that each index corresponds to the date_range at the same index. For example, given date_ranges [x, y], metric_value_groups will have a length of two. The first entry in metric_value_groups represents the metrics for date x and the second entry in metric_value_groups represents the metrics for date y. */
|
|
531
|
+
metricValueGroups?: MetricValueGroup[];
|
|
532
|
+
}
|
|
533
|
+
interface RunReportMetadata {
|
|
534
|
+
/** An estimate of how close this report is to being completed. Will always be 100 for failed and completed reports. */
|
|
535
|
+
percentComplete?: number;
|
|
536
|
+
/** The result's parent report. */
|
|
537
|
+
report?: string;
|
|
538
|
+
}
|
|
539
|
+
interface RunReportRequest {}
|
|
540
|
+
interface RunReportResponse {
|
|
541
|
+
/** The unique name of the generated result. Use with `FetchReportResultRows` to retrieve data. */
|
|
542
|
+
reportResult?: string;
|
|
543
|
+
}
|
|
544
|
+
interface Sort {
|
|
545
|
+
/** Optional. The sort order. If true the sort will be descending. */
|
|
546
|
+
descending?: boolean;
|
|
547
|
+
/** Required. A field (dimension or metric) to sort by. */
|
|
548
|
+
field?: Field;
|
|
549
|
+
}
|
|
550
|
+
interface Status {
|
|
551
|
+
/** The status code, which should be an enum value of google.rpc.Code. */
|
|
552
|
+
code?: number;
|
|
553
|
+
/** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
|
|
554
|
+
details?: {[P in string]: any}[];
|
|
555
|
+
/** A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */
|
|
556
|
+
message?: string;
|
|
557
|
+
}
|
|
558
|
+
interface StringList {
|
|
559
|
+
/** The values */
|
|
560
|
+
values?: string[];
|
|
561
|
+
}
|
|
562
|
+
interface StringTargetingDimension {
|
|
563
|
+
/** Required. How the items in this list should be targeted. */
|
|
564
|
+
selectionType?:
|
|
565
|
+
| 'SELECTION_TYPE_UNSPECIFIED'
|
|
566
|
+
| 'SELECTION_TYPE_INCLUDE'
|
|
567
|
+
| 'SELECTION_TYPE_EXCLUDE';
|
|
568
|
+
/** Required. The values specified. */
|
|
569
|
+
values?: string[];
|
|
570
|
+
}
|
|
571
|
+
interface TaxonomyTargeting {
|
|
572
|
+
/** Optional. The list of excluded content taxonomy IDs. */
|
|
573
|
+
excludedTaxonomyIds?: string[];
|
|
574
|
+
/** Optional. The list of targeted content taxonomy IDs. */
|
|
575
|
+
targetedTaxonomyIds?: string[];
|
|
576
|
+
}
|
|
577
|
+
interface VideoPlayerSizeTargeting {
|
|
578
|
+
/** Required. The minimum height of the video player in pixels. */
|
|
579
|
+
minimumHeight?: string;
|
|
580
|
+
/** Required. The minimum width of the video player in pixels. */
|
|
581
|
+
minimumWidth?: string;
|
|
582
|
+
}
|
|
583
|
+
interface VideoPlcmtTargeting {
|
|
584
|
+
/** Required. The selection type for the list of video plcmts. */
|
|
585
|
+
selectionType?:
|
|
586
|
+
| 'SELECTION_TYPE_UNSPECIFIED'
|
|
587
|
+
| 'SELECTION_TYPE_INCLUDE'
|
|
588
|
+
| 'SELECTION_TYPE_EXCLUDE';
|
|
589
|
+
/** Required. The list of targeted video plcmts types. If empty, inventory will be targeted regardless of video plcmt type. */
|
|
590
|
+
videoPlcmtTypes?:
|
|
591
|
+
| 'VIDEO_PLCMT_TYPE_UNSPECIFIED'
|
|
592
|
+
| 'INSTREAM'
|
|
593
|
+
| 'ACCOMPANYING_CONTENT'
|
|
594
|
+
| 'INTERSTITIAL'
|
|
595
|
+
| 'NO_CONTENT'[];
|
|
596
|
+
}
|
|
597
|
+
interface CuratedPackagesResource {
|
|
598
|
+
/** Activates an existing curated package. */
|
|
599
|
+
activate(request: {
|
|
600
|
+
/** V1 error format. */
|
|
601
|
+
'$.xgafv'?: '1' | '2';
|
|
602
|
+
/** OAuth access token. */
|
|
603
|
+
access_token?: string;
|
|
604
|
+
/** Data format for response. */
|
|
605
|
+
alt?: 'json' | 'media' | 'proto';
|
|
606
|
+
/** JSONP */
|
|
607
|
+
callback?: string;
|
|
608
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
609
|
+
fields?: string;
|
|
610
|
+
/** 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. */
|
|
611
|
+
key?: string;
|
|
612
|
+
/** Required. The name of the curated package to activate. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}` */
|
|
613
|
+
name: string;
|
|
614
|
+
/** OAuth 2.0 token for the current user. */
|
|
615
|
+
oauth_token?: string;
|
|
616
|
+
/** Returns response with indentations and line breaks. */
|
|
617
|
+
prettyPrint?: boolean;
|
|
618
|
+
/** 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. */
|
|
619
|
+
quotaUser?: string;
|
|
620
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
621
|
+
upload_protocol?: string;
|
|
622
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
623
|
+
uploadType?: string;
|
|
624
|
+
/** Request body */
|
|
625
|
+
resource: ActivateCuratedPackageRequest;
|
|
626
|
+
}): Request<CuratedPackage>;
|
|
627
|
+
activate(
|
|
628
|
+
request: {
|
|
629
|
+
/** V1 error format. */
|
|
630
|
+
'$.xgafv'?: '1' | '2';
|
|
631
|
+
/** OAuth access token. */
|
|
632
|
+
access_token?: string;
|
|
633
|
+
/** Data format for response. */
|
|
634
|
+
alt?: 'json' | 'media' | 'proto';
|
|
635
|
+
/** JSONP */
|
|
636
|
+
callback?: string;
|
|
637
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
638
|
+
fields?: string;
|
|
639
|
+
/** 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. */
|
|
640
|
+
key?: string;
|
|
641
|
+
/** Required. The name of the curated package to activate. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}` */
|
|
642
|
+
name: string;
|
|
643
|
+
/** OAuth 2.0 token for the current user. */
|
|
644
|
+
oauth_token?: string;
|
|
645
|
+
/** Returns response with indentations and line breaks. */
|
|
646
|
+
prettyPrint?: boolean;
|
|
647
|
+
/** 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. */
|
|
648
|
+
quotaUser?: string;
|
|
649
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
650
|
+
upload_protocol?: string;
|
|
651
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
652
|
+
uploadType?: string;
|
|
653
|
+
},
|
|
654
|
+
body: ActivateCuratedPackageRequest,
|
|
655
|
+
): Request<CuratedPackage>;
|
|
656
|
+
/** Creates a new curated package. */
|
|
657
|
+
create(request: {
|
|
658
|
+
/** V1 error format. */
|
|
659
|
+
'$.xgafv'?: '1' | '2';
|
|
660
|
+
/** OAuth access token. */
|
|
661
|
+
access_token?: string;
|
|
662
|
+
/** Data format for response. */
|
|
663
|
+
alt?: 'json' | 'media' | 'proto';
|
|
664
|
+
/** JSONP */
|
|
665
|
+
callback?: string;
|
|
666
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
667
|
+
fields?: string;
|
|
668
|
+
/** 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. */
|
|
669
|
+
key?: string;
|
|
670
|
+
/** OAuth 2.0 token for the current user. */
|
|
671
|
+
oauth_token?: string;
|
|
672
|
+
/** Required. The parent curator account where this curated package will be created. Format: `curators/{accountId}` */
|
|
673
|
+
parent: string;
|
|
674
|
+
/** Returns response with indentations and line breaks. */
|
|
675
|
+
prettyPrint?: boolean;
|
|
676
|
+
/** 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. */
|
|
677
|
+
quotaUser?: string;
|
|
678
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
679
|
+
upload_protocol?: string;
|
|
680
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
681
|
+
uploadType?: string;
|
|
682
|
+
/** Request body */
|
|
683
|
+
resource: CuratedPackage;
|
|
684
|
+
}): Request<CuratedPackage>;
|
|
685
|
+
create(
|
|
686
|
+
request: {
|
|
687
|
+
/** V1 error format. */
|
|
688
|
+
'$.xgafv'?: '1' | '2';
|
|
689
|
+
/** OAuth access token. */
|
|
690
|
+
access_token?: string;
|
|
691
|
+
/** Data format for response. */
|
|
692
|
+
alt?: 'json' | 'media' | 'proto';
|
|
693
|
+
/** JSONP */
|
|
694
|
+
callback?: string;
|
|
695
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
696
|
+
fields?: string;
|
|
697
|
+
/** 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. */
|
|
698
|
+
key?: string;
|
|
699
|
+
/** OAuth 2.0 token for the current user. */
|
|
700
|
+
oauth_token?: string;
|
|
701
|
+
/** Required. The parent curator account where this curated package will be created. Format: `curators/{accountId}` */
|
|
702
|
+
parent: string;
|
|
703
|
+
/** Returns response with indentations and line breaks. */
|
|
704
|
+
prettyPrint?: boolean;
|
|
705
|
+
/** 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. */
|
|
706
|
+
quotaUser?: string;
|
|
707
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
708
|
+
upload_protocol?: string;
|
|
709
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
710
|
+
uploadType?: string;
|
|
711
|
+
},
|
|
712
|
+
body: CuratedPackage,
|
|
713
|
+
): Request<CuratedPackage>;
|
|
714
|
+
/** Deactivates an existing curated package. */
|
|
715
|
+
deactivate(request: {
|
|
716
|
+
/** V1 error format. */
|
|
717
|
+
'$.xgafv'?: '1' | '2';
|
|
718
|
+
/** OAuth access token. */
|
|
719
|
+
access_token?: string;
|
|
720
|
+
/** Data format for response. */
|
|
721
|
+
alt?: 'json' | 'media' | 'proto';
|
|
722
|
+
/** JSONP */
|
|
723
|
+
callback?: string;
|
|
724
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
725
|
+
fields?: string;
|
|
726
|
+
/** 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. */
|
|
727
|
+
key?: string;
|
|
728
|
+
/** Required. The name of the curated package to deactivate. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}` */
|
|
729
|
+
name: string;
|
|
730
|
+
/** OAuth 2.0 token for the current user. */
|
|
731
|
+
oauth_token?: string;
|
|
732
|
+
/** Returns response with indentations and line breaks. */
|
|
733
|
+
prettyPrint?: boolean;
|
|
734
|
+
/** 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. */
|
|
735
|
+
quotaUser?: string;
|
|
736
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
737
|
+
upload_protocol?: string;
|
|
738
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
739
|
+
uploadType?: string;
|
|
740
|
+
/** Request body */
|
|
741
|
+
resource: DeactivateCuratedPackageRequest;
|
|
742
|
+
}): Request<CuratedPackage>;
|
|
743
|
+
deactivate(
|
|
744
|
+
request: {
|
|
745
|
+
/** V1 error format. */
|
|
746
|
+
'$.xgafv'?: '1' | '2';
|
|
747
|
+
/** OAuth access token. */
|
|
748
|
+
access_token?: string;
|
|
749
|
+
/** Data format for response. */
|
|
750
|
+
alt?: 'json' | 'media' | 'proto';
|
|
751
|
+
/** JSONP */
|
|
752
|
+
callback?: string;
|
|
753
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
754
|
+
fields?: string;
|
|
755
|
+
/** 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. */
|
|
756
|
+
key?: string;
|
|
757
|
+
/** Required. The name of the curated package to deactivate. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}` */
|
|
758
|
+
name: string;
|
|
759
|
+
/** OAuth 2.0 token for the current user. */
|
|
760
|
+
oauth_token?: string;
|
|
761
|
+
/** Returns response with indentations and line breaks. */
|
|
762
|
+
prettyPrint?: boolean;
|
|
763
|
+
/** 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. */
|
|
764
|
+
quotaUser?: string;
|
|
765
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
766
|
+
upload_protocol?: string;
|
|
767
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
768
|
+
uploadType?: string;
|
|
769
|
+
},
|
|
770
|
+
body: DeactivateCuratedPackageRequest,
|
|
771
|
+
): Request<CuratedPackage>;
|
|
772
|
+
/** Gets a curated package given its resource name. */
|
|
773
|
+
get(request?: {
|
|
774
|
+
/** V1 error format. */
|
|
775
|
+
'$.xgafv'?: '1' | '2';
|
|
776
|
+
/** OAuth access token. */
|
|
777
|
+
access_token?: string;
|
|
778
|
+
/** Data format for response. */
|
|
779
|
+
alt?: 'json' | 'media' | 'proto';
|
|
780
|
+
/** JSONP */
|
|
781
|
+
callback?: string;
|
|
782
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
783
|
+
fields?: string;
|
|
784
|
+
/** 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. */
|
|
785
|
+
key?: string;
|
|
786
|
+
/** Required. The name of the curated package to retrieve. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}` */
|
|
787
|
+
name: string;
|
|
788
|
+
/** OAuth 2.0 token for the current user. */
|
|
789
|
+
oauth_token?: string;
|
|
790
|
+
/** Returns response with indentations and line breaks. */
|
|
791
|
+
prettyPrint?: boolean;
|
|
792
|
+
/** 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. */
|
|
793
|
+
quotaUser?: string;
|
|
794
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
795
|
+
upload_protocol?: string;
|
|
796
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
797
|
+
uploadType?: string;
|
|
798
|
+
}): Request<CuratedPackage>;
|
|
799
|
+
/** Lists curated packages owned by the specified curator. */
|
|
800
|
+
list(request?: {
|
|
801
|
+
/** V1 error format. */
|
|
802
|
+
'$.xgafv'?: '1' | '2';
|
|
803
|
+
/** OAuth access token. */
|
|
804
|
+
access_token?: string;
|
|
805
|
+
/** Data format for response. */
|
|
806
|
+
alt?: 'json' | 'media' | 'proto';
|
|
807
|
+
/** JSONP */
|
|
808
|
+
callback?: string;
|
|
809
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
810
|
+
fields?: string;
|
|
811
|
+
/** Optional. Optional query string using the [Cloud API list filtering syntax](/authorized-buyers/apis/guides/list-filters). Supported columns for filtering are: * displayName * createTime * updateTime * state * feeCpm.currencyCode * feeCpm.units * feeCpm.nanos * floorPriceCpm.currencyCode * floorPriceCpm.units * floorPriceCpm.nanos */
|
|
812
|
+
filter?: string;
|
|
813
|
+
/** 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. */
|
|
814
|
+
key?: string;
|
|
815
|
+
/** OAuth 2.0 token for the current user. */
|
|
816
|
+
oauth_token?: string;
|
|
817
|
+
/** Optional. Requested page size. The server may return fewer results than requested. Max allowed page size is 500. If unspecified, the server will default to 500. */
|
|
818
|
+
pageSize?: number;
|
|
819
|
+
/** Optional. A page token, received from a previous `ListCuratedPackages` call. Provide this to retrieve the subsequent page. */
|
|
820
|
+
pageToken?: string;
|
|
821
|
+
/** Required. The parent curator account which owns this collection of curated packages. Format: `curators/{accountId}` */
|
|
822
|
+
parent: string;
|
|
823
|
+
/** Returns response with indentations and line breaks. */
|
|
824
|
+
prettyPrint?: boolean;
|
|
825
|
+
/** 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. */
|
|
826
|
+
quotaUser?: string;
|
|
827
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
828
|
+
upload_protocol?: string;
|
|
829
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
830
|
+
uploadType?: string;
|
|
831
|
+
}): Request<ListCuratedPackagesResponse>;
|
|
832
|
+
/** Updates an existing curated package. */
|
|
833
|
+
patch(request: {
|
|
834
|
+
/** V1 error format. */
|
|
835
|
+
'$.xgafv'?: '1' | '2';
|
|
836
|
+
/** OAuth access token. */
|
|
837
|
+
access_token?: string;
|
|
838
|
+
/** Data format for response. */
|
|
839
|
+
alt?: 'json' | 'media' | 'proto';
|
|
840
|
+
/** JSONP */
|
|
841
|
+
callback?: string;
|
|
842
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
843
|
+
fields?: string;
|
|
844
|
+
/** 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. */
|
|
845
|
+
key?: string;
|
|
846
|
+
/** Identifier. The unique resource name for the curated package. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}` */
|
|
847
|
+
name: string;
|
|
848
|
+
/** OAuth 2.0 token for the current user. */
|
|
849
|
+
oauth_token?: string;
|
|
850
|
+
/** Returns response with indentations and line breaks. */
|
|
851
|
+
prettyPrint?: boolean;
|
|
852
|
+
/** 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. */
|
|
853
|
+
quotaUser?: string;
|
|
854
|
+
/** Optional. List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path "*" can be used to indicate full replacement (the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask. */
|
|
855
|
+
updateMask?: string;
|
|
856
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
857
|
+
upload_protocol?: string;
|
|
858
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
859
|
+
uploadType?: string;
|
|
860
|
+
/** Request body */
|
|
861
|
+
resource: CuratedPackage;
|
|
862
|
+
}): Request<CuratedPackage>;
|
|
863
|
+
patch(
|
|
864
|
+
request: {
|
|
865
|
+
/** V1 error format. */
|
|
866
|
+
'$.xgafv'?: '1' | '2';
|
|
867
|
+
/** OAuth access token. */
|
|
868
|
+
access_token?: string;
|
|
869
|
+
/** Data format for response. */
|
|
870
|
+
alt?: 'json' | 'media' | 'proto';
|
|
871
|
+
/** JSONP */
|
|
872
|
+
callback?: string;
|
|
873
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
874
|
+
fields?: string;
|
|
875
|
+
/** 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. */
|
|
876
|
+
key?: string;
|
|
877
|
+
/** Identifier. The unique resource name for the curated package. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}` */
|
|
878
|
+
name: string;
|
|
879
|
+
/** OAuth 2.0 token for the current user. */
|
|
880
|
+
oauth_token?: string;
|
|
881
|
+
/** Returns response with indentations and line breaks. */
|
|
882
|
+
prettyPrint?: boolean;
|
|
883
|
+
/** 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. */
|
|
884
|
+
quotaUser?: string;
|
|
885
|
+
/** Optional. List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path "*" can be used to indicate full replacement (the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask. */
|
|
886
|
+
updateMask?: string;
|
|
887
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
888
|
+
upload_protocol?: string;
|
|
889
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
890
|
+
uploadType?: string;
|
|
891
|
+
},
|
|
892
|
+
body: CuratedPackage,
|
|
893
|
+
): Request<CuratedPackage>;
|
|
894
|
+
}
|
|
895
|
+
interface DataSegmentsResource {
|
|
896
|
+
/** Activates a data segment. */
|
|
897
|
+
activate(request: {
|
|
898
|
+
/** V1 error format. */
|
|
899
|
+
'$.xgafv'?: '1' | '2';
|
|
900
|
+
/** OAuth access token. */
|
|
901
|
+
access_token?: string;
|
|
902
|
+
/** Data format for response. */
|
|
903
|
+
alt?: 'json' | 'media' | 'proto';
|
|
904
|
+
/** JSONP */
|
|
905
|
+
callback?: string;
|
|
906
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
907
|
+
fields?: string;
|
|
908
|
+
/** 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. */
|
|
909
|
+
key?: string;
|
|
910
|
+
/** Required. Name of data segment to activate. Format: `curators/{accountId}/dataSegments/{curatorDataSegmentId}` */
|
|
911
|
+
name: string;
|
|
912
|
+
/** OAuth 2.0 token for the current user. */
|
|
913
|
+
oauth_token?: string;
|
|
914
|
+
/** Returns response with indentations and line breaks. */
|
|
915
|
+
prettyPrint?: boolean;
|
|
916
|
+
/** 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. */
|
|
917
|
+
quotaUser?: string;
|
|
918
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
919
|
+
upload_protocol?: string;
|
|
920
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
921
|
+
uploadType?: string;
|
|
922
|
+
/** Request body */
|
|
923
|
+
resource: ActivateDataSegmentRequest;
|
|
924
|
+
}): Request<DataSegment>;
|
|
925
|
+
activate(
|
|
926
|
+
request: {
|
|
927
|
+
/** V1 error format. */
|
|
928
|
+
'$.xgafv'?: '1' | '2';
|
|
929
|
+
/** OAuth access token. */
|
|
930
|
+
access_token?: string;
|
|
931
|
+
/** Data format for response. */
|
|
932
|
+
alt?: 'json' | 'media' | 'proto';
|
|
933
|
+
/** JSONP */
|
|
934
|
+
callback?: string;
|
|
935
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
936
|
+
fields?: string;
|
|
937
|
+
/** 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. */
|
|
938
|
+
key?: string;
|
|
939
|
+
/** Required. Name of data segment to activate. Format: `curators/{accountId}/dataSegments/{curatorDataSegmentId}` */
|
|
940
|
+
name: string;
|
|
941
|
+
/** OAuth 2.0 token for the current user. */
|
|
942
|
+
oauth_token?: string;
|
|
943
|
+
/** Returns response with indentations and line breaks. */
|
|
944
|
+
prettyPrint?: boolean;
|
|
945
|
+
/** 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. */
|
|
946
|
+
quotaUser?: string;
|
|
947
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
948
|
+
upload_protocol?: string;
|
|
949
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
950
|
+
uploadType?: string;
|
|
951
|
+
},
|
|
952
|
+
body: ActivateDataSegmentRequest,
|
|
953
|
+
): Request<DataSegment>;
|
|
954
|
+
/** Creates a data segment owned by the listed curator. The data segment will be created in the `ACTIVE` state, meaning it will be immediately available for buyers to use in preferred deals, private auction deals, and auction packages. */
|
|
955
|
+
create(request: {
|
|
956
|
+
/** V1 error format. */
|
|
957
|
+
'$.xgafv'?: '1' | '2';
|
|
958
|
+
/** OAuth access token. */
|
|
959
|
+
access_token?: string;
|
|
960
|
+
/** Data format for response. */
|
|
961
|
+
alt?: 'json' | 'media' | 'proto';
|
|
962
|
+
/** JSONP */
|
|
963
|
+
callback?: string;
|
|
964
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
965
|
+
fields?: string;
|
|
966
|
+
/** 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. */
|
|
967
|
+
key?: string;
|
|
968
|
+
/** OAuth 2.0 token for the current user. */
|
|
969
|
+
oauth_token?: string;
|
|
970
|
+
/** Required. The parent resource where this data segment will be created. Format: `curators/{accountId}` */
|
|
971
|
+
parent: string;
|
|
972
|
+
/** Returns response with indentations and line breaks. */
|
|
973
|
+
prettyPrint?: boolean;
|
|
974
|
+
/** 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. */
|
|
975
|
+
quotaUser?: string;
|
|
976
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
977
|
+
upload_protocol?: string;
|
|
978
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
979
|
+
uploadType?: string;
|
|
980
|
+
/** Request body */
|
|
981
|
+
resource: DataSegment;
|
|
982
|
+
}): Request<DataSegment>;
|
|
983
|
+
create(
|
|
984
|
+
request: {
|
|
985
|
+
/** V1 error format. */
|
|
986
|
+
'$.xgafv'?: '1' | '2';
|
|
987
|
+
/** OAuth access token. */
|
|
988
|
+
access_token?: string;
|
|
989
|
+
/** Data format for response. */
|
|
990
|
+
alt?: 'json' | 'media' | 'proto';
|
|
991
|
+
/** JSONP */
|
|
992
|
+
callback?: string;
|
|
993
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
994
|
+
fields?: string;
|
|
995
|
+
/** 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. */
|
|
996
|
+
key?: string;
|
|
997
|
+
/** OAuth 2.0 token for the current user. */
|
|
998
|
+
oauth_token?: string;
|
|
999
|
+
/** Required. The parent resource where this data segment will be created. Format: `curators/{accountId}` */
|
|
1000
|
+
parent: string;
|
|
1001
|
+
/** Returns response with indentations and line breaks. */
|
|
1002
|
+
prettyPrint?: boolean;
|
|
1003
|
+
/** 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. */
|
|
1004
|
+
quotaUser?: string;
|
|
1005
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1006
|
+
upload_protocol?: string;
|
|
1007
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1008
|
+
uploadType?: string;
|
|
1009
|
+
},
|
|
1010
|
+
body: DataSegment,
|
|
1011
|
+
): Request<DataSegment>;
|
|
1012
|
+
/** Deactivates a data segment. */
|
|
1013
|
+
deactivate(request: {
|
|
1014
|
+
/** V1 error format. */
|
|
1015
|
+
'$.xgafv'?: '1' | '2';
|
|
1016
|
+
/** OAuth access token. */
|
|
1017
|
+
access_token?: string;
|
|
1018
|
+
/** Data format for response. */
|
|
1019
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1020
|
+
/** JSONP */
|
|
1021
|
+
callback?: string;
|
|
1022
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1023
|
+
fields?: string;
|
|
1024
|
+
/** 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. */
|
|
1025
|
+
key?: string;
|
|
1026
|
+
/** Required. Name of data segment to deactivate. Format: `curators/{accountId}/dataSegments/{curatorDataSegmentId}` */
|
|
1027
|
+
name: string;
|
|
1028
|
+
/** OAuth 2.0 token for the current user. */
|
|
1029
|
+
oauth_token?: string;
|
|
1030
|
+
/** Returns response with indentations and line breaks. */
|
|
1031
|
+
prettyPrint?: boolean;
|
|
1032
|
+
/** 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. */
|
|
1033
|
+
quotaUser?: string;
|
|
1034
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1035
|
+
upload_protocol?: string;
|
|
1036
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1037
|
+
uploadType?: string;
|
|
1038
|
+
/** Request body */
|
|
1039
|
+
resource: DeactivateDataSegmentRequest;
|
|
1040
|
+
}): Request<DataSegment>;
|
|
1041
|
+
deactivate(
|
|
1042
|
+
request: {
|
|
1043
|
+
/** V1 error format. */
|
|
1044
|
+
'$.xgafv'?: '1' | '2';
|
|
1045
|
+
/** OAuth access token. */
|
|
1046
|
+
access_token?: string;
|
|
1047
|
+
/** Data format for response. */
|
|
1048
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1049
|
+
/** JSONP */
|
|
1050
|
+
callback?: string;
|
|
1051
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1052
|
+
fields?: string;
|
|
1053
|
+
/** 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. */
|
|
1054
|
+
key?: string;
|
|
1055
|
+
/** Required. Name of data segment to deactivate. Format: `curators/{accountId}/dataSegments/{curatorDataSegmentId}` */
|
|
1056
|
+
name: string;
|
|
1057
|
+
/** OAuth 2.0 token for the current user. */
|
|
1058
|
+
oauth_token?: string;
|
|
1059
|
+
/** Returns response with indentations and line breaks. */
|
|
1060
|
+
prettyPrint?: boolean;
|
|
1061
|
+
/** 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. */
|
|
1062
|
+
quotaUser?: string;
|
|
1063
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1064
|
+
upload_protocol?: string;
|
|
1065
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1066
|
+
uploadType?: string;
|
|
1067
|
+
},
|
|
1068
|
+
body: DeactivateDataSegmentRequest,
|
|
1069
|
+
): Request<DataSegment>;
|
|
1070
|
+
/** Gets a data segment given its name. */
|
|
1071
|
+
get(request?: {
|
|
1072
|
+
/** V1 error format. */
|
|
1073
|
+
'$.xgafv'?: '1' | '2';
|
|
1074
|
+
/** OAuth access token. */
|
|
1075
|
+
access_token?: string;
|
|
1076
|
+
/** Data format for response. */
|
|
1077
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1078
|
+
/** JSONP */
|
|
1079
|
+
callback?: string;
|
|
1080
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1081
|
+
fields?: string;
|
|
1082
|
+
/** 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. */
|
|
1083
|
+
key?: string;
|
|
1084
|
+
/** Required. Name of data segment to get. Format: `curators/{accountId}/dataSegments/{curatorDataSegmentId}` */
|
|
1085
|
+
name: string;
|
|
1086
|
+
/** OAuth 2.0 token for the current user. */
|
|
1087
|
+
oauth_token?: string;
|
|
1088
|
+
/** Returns response with indentations and line breaks. */
|
|
1089
|
+
prettyPrint?: boolean;
|
|
1090
|
+
/** 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. */
|
|
1091
|
+
quotaUser?: string;
|
|
1092
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1093
|
+
upload_protocol?: string;
|
|
1094
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1095
|
+
uploadType?: string;
|
|
1096
|
+
}): Request<DataSegment>;
|
|
1097
|
+
/** List the data segments owned by a curator. */
|
|
1098
|
+
list(request?: {
|
|
1099
|
+
/** V1 error format. */
|
|
1100
|
+
'$.xgafv'?: '1' | '2';
|
|
1101
|
+
/** OAuth access token. */
|
|
1102
|
+
access_token?: string;
|
|
1103
|
+
/** Data format for response. */
|
|
1104
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1105
|
+
/** JSONP */
|
|
1106
|
+
callback?: string;
|
|
1107
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1108
|
+
fields?: string;
|
|
1109
|
+
/** 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. */
|
|
1110
|
+
key?: string;
|
|
1111
|
+
/** OAuth 2.0 token for the current user. */
|
|
1112
|
+
oauth_token?: string;
|
|
1113
|
+
/** Optional. Requested page size. The server may return fewer results than requested. Max allowed page size is 500. If unspecified, the server will default to 500. */
|
|
1114
|
+
pageSize?: number;
|
|
1115
|
+
/** Optional. The page token as returned. ListDataSegmentsResponse.nextPageToken */
|
|
1116
|
+
pageToken?: string;
|
|
1117
|
+
/** Required. Name of the parent curator that can access the data segment. Format: `curators/{accountId}` */
|
|
1118
|
+
parent: string;
|
|
1119
|
+
/** Returns response with indentations and line breaks. */
|
|
1120
|
+
prettyPrint?: boolean;
|
|
1121
|
+
/** 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. */
|
|
1122
|
+
quotaUser?: string;
|
|
1123
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1124
|
+
upload_protocol?: string;
|
|
1125
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1126
|
+
uploadType?: string;
|
|
1127
|
+
}): Request<ListDataSegmentsResponse>;
|
|
1128
|
+
/** Updates a data segment. */
|
|
1129
|
+
patch(request: {
|
|
1130
|
+
/** V1 error format. */
|
|
1131
|
+
'$.xgafv'?: '1' | '2';
|
|
1132
|
+
/** OAuth access token. */
|
|
1133
|
+
access_token?: string;
|
|
1134
|
+
/** Data format for response. */
|
|
1135
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1136
|
+
/** JSONP */
|
|
1137
|
+
callback?: string;
|
|
1138
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1139
|
+
fields?: string;
|
|
1140
|
+
/** 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. */
|
|
1141
|
+
key?: string;
|
|
1142
|
+
/** Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. Format: `curators/{curatorAccountId}/dataSegments/{curatorDataSegmentId}` */
|
|
1143
|
+
name: string;
|
|
1144
|
+
/** OAuth 2.0 token for the current user. */
|
|
1145
|
+
oauth_token?: string;
|
|
1146
|
+
/** Returns response with indentations and line breaks. */
|
|
1147
|
+
prettyPrint?: boolean;
|
|
1148
|
+
/** 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. */
|
|
1149
|
+
quotaUser?: string;
|
|
1150
|
+
/** Optional. List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path "*" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask. */
|
|
1151
|
+
updateMask?: string;
|
|
1152
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1153
|
+
upload_protocol?: string;
|
|
1154
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1155
|
+
uploadType?: string;
|
|
1156
|
+
/** Request body */
|
|
1157
|
+
resource: DataSegment;
|
|
1158
|
+
}): Request<DataSegment>;
|
|
1159
|
+
patch(
|
|
1160
|
+
request: {
|
|
1161
|
+
/** V1 error format. */
|
|
1162
|
+
'$.xgafv'?: '1' | '2';
|
|
1163
|
+
/** OAuth access token. */
|
|
1164
|
+
access_token?: string;
|
|
1165
|
+
/** Data format for response. */
|
|
1166
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1167
|
+
/** JSONP */
|
|
1168
|
+
callback?: string;
|
|
1169
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1170
|
+
fields?: string;
|
|
1171
|
+
/** 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. */
|
|
1172
|
+
key?: string;
|
|
1173
|
+
/** Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. Format: `curators/{curatorAccountId}/dataSegments/{curatorDataSegmentId}` */
|
|
1174
|
+
name: string;
|
|
1175
|
+
/** OAuth 2.0 token for the current user. */
|
|
1176
|
+
oauth_token?: string;
|
|
1177
|
+
/** Returns response with indentations and line breaks. */
|
|
1178
|
+
prettyPrint?: boolean;
|
|
1179
|
+
/** 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. */
|
|
1180
|
+
quotaUser?: string;
|
|
1181
|
+
/** Optional. List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path "*" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask. */
|
|
1182
|
+
updateMask?: string;
|
|
1183
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1184
|
+
upload_protocol?: string;
|
|
1185
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1186
|
+
uploadType?: string;
|
|
1187
|
+
},
|
|
1188
|
+
body: DataSegment,
|
|
1189
|
+
): Request<DataSegment>;
|
|
1190
|
+
}
|
|
1191
|
+
interface OperationsResource {
|
|
1192
|
+
/** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
|
|
1193
|
+
get(request?: {
|
|
1194
|
+
/** V1 error format. */
|
|
1195
|
+
'$.xgafv'?: '1' | '2';
|
|
1196
|
+
/** OAuth access token. */
|
|
1197
|
+
access_token?: string;
|
|
1198
|
+
/** Data format for response. */
|
|
1199
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1200
|
+
/** JSONP */
|
|
1201
|
+
callback?: string;
|
|
1202
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1203
|
+
fields?: string;
|
|
1204
|
+
/** 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. */
|
|
1205
|
+
key?: string;
|
|
1206
|
+
/** The name of the operation resource. */
|
|
1207
|
+
name: string;
|
|
1208
|
+
/** OAuth 2.0 token for the current user. */
|
|
1209
|
+
oauth_token?: string;
|
|
1210
|
+
/** Returns response with indentations and line breaks. */
|
|
1211
|
+
prettyPrint?: boolean;
|
|
1212
|
+
/** 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. */
|
|
1213
|
+
quotaUser?: string;
|
|
1214
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1215
|
+
upload_protocol?: string;
|
|
1216
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1217
|
+
uploadType?: string;
|
|
1218
|
+
}): Request<Operation>;
|
|
1219
|
+
}
|
|
1220
|
+
interface ResultsResource {
|
|
1221
|
+
/** Returns the result rows from a completed report. The caller must have previously called `RunReport` and waited for that operation to complete. The rows will be returned according to the order specified by the `sorts` member of the report definition. */
|
|
1222
|
+
fetchRows(request?: {
|
|
1223
|
+
/** V1 error format. */
|
|
1224
|
+
'$.xgafv'?: '1' | '2';
|
|
1225
|
+
/** OAuth access token. */
|
|
1226
|
+
access_token?: string;
|
|
1227
|
+
/** Data format for response. */
|
|
1228
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1229
|
+
/** JSONP */
|
|
1230
|
+
callback?: string;
|
|
1231
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1232
|
+
fields?: string;
|
|
1233
|
+
/** 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. */
|
|
1234
|
+
key?: string;
|
|
1235
|
+
/** The report result being fetched. Format: `curators/{account_id}/reports/{report_id}/results/{report_result_id}` */
|
|
1236
|
+
name: string;
|
|
1237
|
+
/** OAuth 2.0 token for the current user. */
|
|
1238
|
+
oauth_token?: string;
|
|
1239
|
+
/** Optional. The maximum number of rows to return. The service may return fewer than this value. If unspecified, at most 1,000 rows will be returned. The maximum value is 10,000; values greater than 10,000 will be reduced to 10,000. */
|
|
1240
|
+
pageSize?: number;
|
|
1241
|
+
/** Optional. A page token, received from a previous `FetchReportResultRows` call. Provide this to retrieve the second and subsequent batches of rows. */
|
|
1242
|
+
pageToken?: 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
|
+
}): Request<FetchReportResultRowsResponse>;
|
|
1252
|
+
}
|
|
1253
|
+
interface ReportsResource {
|
|
1254
|
+
/** Creates a `Report` object. */
|
|
1255
|
+
create(request: {
|
|
1256
|
+
/** V1 error format. */
|
|
1257
|
+
'$.xgafv'?: '1' | '2';
|
|
1258
|
+
/** OAuth access token. */
|
|
1259
|
+
access_token?: string;
|
|
1260
|
+
/** Data format for response. */
|
|
1261
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1262
|
+
/** JSONP */
|
|
1263
|
+
callback?: string;
|
|
1264
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1265
|
+
fields?: string;
|
|
1266
|
+
/** 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. */
|
|
1267
|
+
key?: string;
|
|
1268
|
+
/** OAuth 2.0 token for the current user. */
|
|
1269
|
+
oauth_token?: string;
|
|
1270
|
+
/** Required. The parent resource where this `Report` will be created. Format: `curators/{account_id}` */
|
|
1271
|
+
parent: string;
|
|
1272
|
+
/** Returns response with indentations and line breaks. */
|
|
1273
|
+
prettyPrint?: boolean;
|
|
1274
|
+
/** 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. */
|
|
1275
|
+
quotaUser?: string;
|
|
1276
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1277
|
+
upload_protocol?: string;
|
|
1278
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1279
|
+
uploadType?: string;
|
|
1280
|
+
/** Request body */
|
|
1281
|
+
resource: Report;
|
|
1282
|
+
}): Request<Report>;
|
|
1283
|
+
create(
|
|
1284
|
+
request: {
|
|
1285
|
+
/** V1 error format. */
|
|
1286
|
+
'$.xgafv'?: '1' | '2';
|
|
1287
|
+
/** OAuth access token. */
|
|
1288
|
+
access_token?: string;
|
|
1289
|
+
/** Data format for response. */
|
|
1290
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1291
|
+
/** JSONP */
|
|
1292
|
+
callback?: string;
|
|
1293
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1294
|
+
fields?: string;
|
|
1295
|
+
/** 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. */
|
|
1296
|
+
key?: string;
|
|
1297
|
+
/** OAuth 2.0 token for the current user. */
|
|
1298
|
+
oauth_token?: string;
|
|
1299
|
+
/** Required. The parent resource where this `Report` will be created. Format: `curators/{account_id}` */
|
|
1300
|
+
parent: string;
|
|
1301
|
+
/** Returns response with indentations and line breaks. */
|
|
1302
|
+
prettyPrint?: boolean;
|
|
1303
|
+
/** 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. */
|
|
1304
|
+
quotaUser?: string;
|
|
1305
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1306
|
+
upload_protocol?: string;
|
|
1307
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1308
|
+
uploadType?: string;
|
|
1309
|
+
},
|
|
1310
|
+
body: Report,
|
|
1311
|
+
): Request<Report>;
|
|
1312
|
+
/** Deletes a `Report` object. */
|
|
1313
|
+
delete(request?: {
|
|
1314
|
+
/** V1 error format. */
|
|
1315
|
+
'$.xgafv'?: '1' | '2';
|
|
1316
|
+
/** OAuth access token. */
|
|
1317
|
+
access_token?: string;
|
|
1318
|
+
/** Data format for response. */
|
|
1319
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1320
|
+
/** JSONP */
|
|
1321
|
+
callback?: string;
|
|
1322
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1323
|
+
fields?: string;
|
|
1324
|
+
/** 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. */
|
|
1325
|
+
key?: string;
|
|
1326
|
+
/** Required. Resource name of the report to delete. Format: `curators/{account_id}/reports/{report_id}` */
|
|
1327
|
+
name: string;
|
|
1328
|
+
/** OAuth 2.0 token for the current user. */
|
|
1329
|
+
oauth_token?: string;
|
|
1330
|
+
/** Returns response with indentations and line breaks. */
|
|
1331
|
+
prettyPrint?: boolean;
|
|
1332
|
+
/** 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. */
|
|
1333
|
+
quotaUser?: string;
|
|
1334
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1335
|
+
upload_protocol?: string;
|
|
1336
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1337
|
+
uploadType?: string;
|
|
1338
|
+
}): Request<{}>;
|
|
1339
|
+
/** Retrieves a `Report` object. */
|
|
1340
|
+
get(request?: {
|
|
1341
|
+
/** V1 error format. */
|
|
1342
|
+
'$.xgafv'?: '1' | '2';
|
|
1343
|
+
/** OAuth access token. */
|
|
1344
|
+
access_token?: string;
|
|
1345
|
+
/** Data format for response. */
|
|
1346
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1347
|
+
/** JSONP */
|
|
1348
|
+
callback?: string;
|
|
1349
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1350
|
+
fields?: string;
|
|
1351
|
+
/** 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. */
|
|
1352
|
+
key?: string;
|
|
1353
|
+
/** Required. The resource name of the report. Format: `curators/{account_id}/reports/{report_id}` */
|
|
1354
|
+
name: string;
|
|
1355
|
+
/** OAuth 2.0 token for the current user. */
|
|
1356
|
+
oauth_token?: string;
|
|
1357
|
+
/** Returns response with indentations and line breaks. */
|
|
1358
|
+
prettyPrint?: boolean;
|
|
1359
|
+
/** 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. */
|
|
1360
|
+
quotaUser?: string;
|
|
1361
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1362
|
+
upload_protocol?: string;
|
|
1363
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1364
|
+
uploadType?: string;
|
|
1365
|
+
}): Request<Report>;
|
|
1366
|
+
/** Lists `Report` objects. */
|
|
1367
|
+
list(request?: {
|
|
1368
|
+
/** V1 error format. */
|
|
1369
|
+
'$.xgafv'?: '1' | '2';
|
|
1370
|
+
/** OAuth access token. */
|
|
1371
|
+
access_token?: string;
|
|
1372
|
+
/** Data format for response. */
|
|
1373
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1374
|
+
/** JSONP */
|
|
1375
|
+
callback?: string;
|
|
1376
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1377
|
+
fields?: string;
|
|
1378
|
+
/** Optional. Expression to filter the response. See syntax details at https://developers.google.com/ad-manager/api/beta/filters */
|
|
1379
|
+
filter?: string;
|
|
1380
|
+
/** 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. */
|
|
1381
|
+
key?: string;
|
|
1382
|
+
/** OAuth 2.0 token for the current user. */
|
|
1383
|
+
oauth_token?: string;
|
|
1384
|
+
/** Optional. Expression to specify sorting order. See syntax details at https://developers.google.com/ad-manager/api/beta/filters#order */
|
|
1385
|
+
orderBy?: string;
|
|
1386
|
+
/** Optional. The maximum number of `Reports` to return. The service may return fewer than this value. If unspecified, at most 50 `Reports` will be returned. The maximum value is 1000; values greater than 1000 will be coerced to 1000. */
|
|
1387
|
+
pageSize?: number;
|
|
1388
|
+
/** Optional. A page token, received from a previous `ListReports` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReports` must match the call that provided the page token. */
|
|
1389
|
+
pageToken?: string;
|
|
1390
|
+
/** Required. The parent, which owns this collection of reports. Format: `curators/{account_id}` */
|
|
1391
|
+
parent: string;
|
|
1392
|
+
/** Returns response with indentations and line breaks. */
|
|
1393
|
+
prettyPrint?: boolean;
|
|
1394
|
+
/** 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. */
|
|
1395
|
+
quotaUser?: string;
|
|
1396
|
+
/** Optional. Number of individual resources to skip while paginating. */
|
|
1397
|
+
skip?: number;
|
|
1398
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1399
|
+
upload_protocol?: string;
|
|
1400
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1401
|
+
uploadType?: string;
|
|
1402
|
+
}): Request<ListReportsResponse>;
|
|
1403
|
+
/** Updates a `Report` object. */
|
|
1404
|
+
patch(request: {
|
|
1405
|
+
/** V1 error format. */
|
|
1406
|
+
'$.xgafv'?: '1' | '2';
|
|
1407
|
+
/** OAuth access token. */
|
|
1408
|
+
access_token?: string;
|
|
1409
|
+
/** Data format for response. */
|
|
1410
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1411
|
+
/** JSONP */
|
|
1412
|
+
callback?: string;
|
|
1413
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1414
|
+
fields?: string;
|
|
1415
|
+
/** 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. */
|
|
1416
|
+
key?: string;
|
|
1417
|
+
/** Identifier. The resource name of the report. Report resource name have the form: `curators/{account_id}/reports/{report_id}` */
|
|
1418
|
+
name: string;
|
|
1419
|
+
/** OAuth 2.0 token for the current user. */
|
|
1420
|
+
oauth_token?: string;
|
|
1421
|
+
/** Returns response with indentations and line breaks. */
|
|
1422
|
+
prettyPrint?: boolean;
|
|
1423
|
+
/** 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. */
|
|
1424
|
+
quotaUser?: string;
|
|
1425
|
+
/** Optional. The list of fields to update. */
|
|
1426
|
+
updateMask?: string;
|
|
1427
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1428
|
+
upload_protocol?: string;
|
|
1429
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1430
|
+
uploadType?: string;
|
|
1431
|
+
/** Request body */
|
|
1432
|
+
resource: Report;
|
|
1433
|
+
}): Request<Report>;
|
|
1434
|
+
patch(
|
|
1435
|
+
request: {
|
|
1436
|
+
/** V1 error format. */
|
|
1437
|
+
'$.xgafv'?: '1' | '2';
|
|
1438
|
+
/** OAuth access token. */
|
|
1439
|
+
access_token?: string;
|
|
1440
|
+
/** Data format for response. */
|
|
1441
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1442
|
+
/** JSONP */
|
|
1443
|
+
callback?: string;
|
|
1444
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1445
|
+
fields?: string;
|
|
1446
|
+
/** 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. */
|
|
1447
|
+
key?: string;
|
|
1448
|
+
/** Identifier. The resource name of the report. Report resource name have the form: `curators/{account_id}/reports/{report_id}` */
|
|
1449
|
+
name: string;
|
|
1450
|
+
/** OAuth 2.0 token for the current user. */
|
|
1451
|
+
oauth_token?: string;
|
|
1452
|
+
/** Returns response with indentations and line breaks. */
|
|
1453
|
+
prettyPrint?: boolean;
|
|
1454
|
+
/** 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. */
|
|
1455
|
+
quotaUser?: string;
|
|
1456
|
+
/** Optional. The list of fields to update. */
|
|
1457
|
+
updateMask?: string;
|
|
1458
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1459
|
+
upload_protocol?: string;
|
|
1460
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1461
|
+
uploadType?: string;
|
|
1462
|
+
},
|
|
1463
|
+
body: Report,
|
|
1464
|
+
): Request<Report>;
|
|
1465
|
+
/** Initiates the execution of an existing report asynchronously. Users can get the report by polling this operation using `OperationsService.GetOperation`. Poll every 5 seconds initially, with an exponential backoff. Once a report is complete, the operation will contain a `RunReportResponse` in its response field containing a report_result that can be passed to the `FetchReportResultRows` method to retrieve the report data. */
|
|
1466
|
+
run(request: {
|
|
1467
|
+
/** V1 error format. */
|
|
1468
|
+
'$.xgafv'?: '1' | '2';
|
|
1469
|
+
/** OAuth access token. */
|
|
1470
|
+
access_token?: string;
|
|
1471
|
+
/** Data format for response. */
|
|
1472
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1473
|
+
/** JSONP */
|
|
1474
|
+
callback?: string;
|
|
1475
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1476
|
+
fields?: string;
|
|
1477
|
+
/** 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. */
|
|
1478
|
+
key?: string;
|
|
1479
|
+
/** Required. The report to run. Format: `curators/{account_id}/reports/{report_id}` */
|
|
1480
|
+
name: string;
|
|
1481
|
+
/** OAuth 2.0 token for the current user. */
|
|
1482
|
+
oauth_token?: string;
|
|
1483
|
+
/** Returns response with indentations and line breaks. */
|
|
1484
|
+
prettyPrint?: boolean;
|
|
1485
|
+
/** 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. */
|
|
1486
|
+
quotaUser?: string;
|
|
1487
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1488
|
+
upload_protocol?: string;
|
|
1489
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1490
|
+
uploadType?: string;
|
|
1491
|
+
/** Request body */
|
|
1492
|
+
resource: RunReportRequest;
|
|
1493
|
+
}): Request<Operation>;
|
|
1494
|
+
run(
|
|
1495
|
+
request: {
|
|
1496
|
+
/** V1 error format. */
|
|
1497
|
+
'$.xgafv'?: '1' | '2';
|
|
1498
|
+
/** OAuth access token. */
|
|
1499
|
+
access_token?: string;
|
|
1500
|
+
/** Data format for response. */
|
|
1501
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1502
|
+
/** JSONP */
|
|
1503
|
+
callback?: string;
|
|
1504
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1505
|
+
fields?: string;
|
|
1506
|
+
/** 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. */
|
|
1507
|
+
key?: string;
|
|
1508
|
+
/** Required. The report to run. Format: `curators/{account_id}/reports/{report_id}` */
|
|
1509
|
+
name: string;
|
|
1510
|
+
/** OAuth 2.0 token for the current user. */
|
|
1511
|
+
oauth_token?: string;
|
|
1512
|
+
/** Returns response with indentations and line breaks. */
|
|
1513
|
+
prettyPrint?: boolean;
|
|
1514
|
+
/** 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. */
|
|
1515
|
+
quotaUser?: string;
|
|
1516
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1517
|
+
upload_protocol?: string;
|
|
1518
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1519
|
+
uploadType?: string;
|
|
1520
|
+
},
|
|
1521
|
+
body: RunReportRequest,
|
|
1522
|
+
): Request<Operation>;
|
|
1523
|
+
operations: OperationsResource;
|
|
1524
|
+
results: ResultsResource;
|
|
1525
|
+
}
|
|
1526
|
+
interface CuratorsResource {
|
|
1527
|
+
curatedPackages: CuratedPackagesResource;
|
|
1528
|
+
dataSegments: DataSegmentsResource;
|
|
1529
|
+
reports: ReportsResource;
|
|
1530
|
+
}
|
|
1531
|
+
interface MediaPlannersResource {
|
|
1532
|
+
/** Lists all media planner accounts that the caller has access to. For curators, this will return all media planners that have accepted curator terms. For other accounts, attempting to list media planners will return an error. */
|
|
1533
|
+
list(request?: {
|
|
1534
|
+
/** V1 error format. */
|
|
1535
|
+
'$.xgafv'?: '1' | '2';
|
|
1536
|
+
/** OAuth access token. */
|
|
1537
|
+
access_token?: string;
|
|
1538
|
+
/** Data format for response. */
|
|
1539
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1540
|
+
/** JSONP */
|
|
1541
|
+
callback?: string;
|
|
1542
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1543
|
+
fields?: string;
|
|
1544
|
+
/** Optional query string using the [Cloud API list filtering syntax](/authorized-buyers/apis/guides/list-filters). Supported columns for filtering are: * `name` * `displayName` * `ancestorNames` */
|
|
1545
|
+
filter?: string;
|
|
1546
|
+
/** 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. */
|
|
1547
|
+
key?: string;
|
|
1548
|
+
/** OAuth 2.0 token for the current user. */
|
|
1549
|
+
oauth_token?: string;
|
|
1550
|
+
/** The maximum number of media planners to return. If unspecified, at most 100 media planners will be returned. The maximum value is 500; values above 500 will be coerced to 500. */
|
|
1551
|
+
pageSize?: number;
|
|
1552
|
+
/** Optional. A token identifying a page of results the server should return.This value is received from a previous `ListMediaPlanners` call in ListMediaPlannersResponse.nextPageToken. */
|
|
1553
|
+
pageToken?: string;
|
|
1554
|
+
/** Returns response with indentations and line breaks. */
|
|
1555
|
+
prettyPrint?: boolean;
|
|
1556
|
+
/** 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. */
|
|
1557
|
+
quotaUser?: string;
|
|
1558
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1559
|
+
upload_protocol?: string;
|
|
1560
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1561
|
+
uploadType?: string;
|
|
1562
|
+
}): Request<ListMediaPlannersResponse>;
|
|
1563
|
+
}
|
|
1564
|
+
|
|
1565
|
+
const curators: CuratorsResource;
|
|
1566
|
+
|
|
1567
|
+
const mediaPlanners: MediaPlannersResource;
|
|
1568
|
+
}
|
|
1569
|
+
}
|