@maxim_mazurok/gapi.client.adsense-v2 0.0.20220811
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.ts +1221 -0
- package/package.json +20 -0
- package/readme.md +86 -0
- package/tests.ts +211 -0
- package/tsconfig.json +18 -0
- package/tslint.json +6 -0
package/index.d.ts
ADDED
|
@@ -0,0 +1,1221 @@
|
|
|
1
|
+
/* Type definitions for non-npm package AdSense Management API v2 0.0 */
|
|
2
|
+
// Project: https://developers.google.com/adsense/management/
|
|
3
|
+
// Definitions by: Maxim Mazurok <https://github.com/Maxim-Mazurok>
|
|
4
|
+
// Nick Amoscato <https://github.com/namoscato>
|
|
5
|
+
// Declan Vong <https://github.com/declanvong>
|
|
6
|
+
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
7
|
+
// TypeScript Version: 2.8
|
|
8
|
+
|
|
9
|
+
// IMPORTANT
|
|
10
|
+
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
11
|
+
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
12
|
+
// Generated from: https://adsense.googleapis.com/$discovery/rest?version=v2
|
|
13
|
+
// Revision: 20220811
|
|
14
|
+
|
|
15
|
+
/// <reference types="gapi.client" />
|
|
16
|
+
|
|
17
|
+
declare namespace gapi.client {
|
|
18
|
+
/** Load AdSense Management API v2 */
|
|
19
|
+
function load(urlOrObject: "https://adsense.googleapis.com/$discovery/rest?version=v2"): Promise<void>;
|
|
20
|
+
/** @deprecated Please load APIs with discovery documents. */
|
|
21
|
+
function load(name: "adsense", version: "v2"): Promise<void>;
|
|
22
|
+
/** @deprecated Please load APIs with discovery documents. */
|
|
23
|
+
function load(name: "adsense", version: "v2", callback: () => any): void;
|
|
24
|
+
|
|
25
|
+
namespace adsense {
|
|
26
|
+
interface Account {
|
|
27
|
+
/** Output only. Creation time of the account. */
|
|
28
|
+
createTime?: string;
|
|
29
|
+
/** Output only. Display name of this account. */
|
|
30
|
+
displayName?: string;
|
|
31
|
+
/** Output only. Resource name of the account. Format: accounts/pub-[0-9]+ */
|
|
32
|
+
name?: string;
|
|
33
|
+
/** Output only. Outstanding tasks that need to be completed as part of the sign-up process for a new account. e.g. "billing-profile-creation", "phone-pin-verification". */
|
|
34
|
+
pendingTasks?: string[];
|
|
35
|
+
/** Output only. Whether this account is premium. */
|
|
36
|
+
premium?: boolean;
|
|
37
|
+
/** Output only. State of the account. */
|
|
38
|
+
state?: string;
|
|
39
|
+
/** The account time zone, as used by reporting. For more information, see [changing the time zone of your reports](https://support.google.com/adsense/answer/9830725). */
|
|
40
|
+
timeZone?: TimeZone;
|
|
41
|
+
}
|
|
42
|
+
interface AdClient {
|
|
43
|
+
/** Output only. Resource name of the ad client. Format: accounts/{account}/adclients/{adclient} */
|
|
44
|
+
name?: string;
|
|
45
|
+
/**
|
|
46
|
+
* Output only. Reporting product code of the ad client. For example, "AFC" for AdSense for Content. Corresponds to the `PRODUCT_CODE` dimension, and present only if the ad client
|
|
47
|
+
* supports reporting.
|
|
48
|
+
*/
|
|
49
|
+
productCode?: string;
|
|
50
|
+
/** Output only. Unique ID of the ad client as used in the `AD_CLIENT_ID` reporting dimension. Present only if the ad client supports reporting. */
|
|
51
|
+
reportingDimensionId?: string;
|
|
52
|
+
/** Output only. State of the ad client. */
|
|
53
|
+
state?: string;
|
|
54
|
+
}
|
|
55
|
+
interface AdClientAdCode {
|
|
56
|
+
/** Output only. The AdSense code snippet to add to the head of an HTML page. */
|
|
57
|
+
adCode?: string;
|
|
58
|
+
/** Output only. The AdSense code snippet to add to the body of an AMP page. */
|
|
59
|
+
ampBody?: string;
|
|
60
|
+
/** Output only. The AdSense code snippet to add to the head of an AMP page. */
|
|
61
|
+
ampHead?: string;
|
|
62
|
+
}
|
|
63
|
+
interface AdUnit {
|
|
64
|
+
/** Required. Settings specific to content ads (AFC). */
|
|
65
|
+
contentAdsSettings?: ContentAdsSettings;
|
|
66
|
+
/** Required. Display name of the ad unit, as provided when the ad unit was created. */
|
|
67
|
+
displayName?: string;
|
|
68
|
+
/** Output only. Resource name of the ad unit. Format: accounts/{account}/adclients/{adclient}/adunits/{adunit} */
|
|
69
|
+
name?: string;
|
|
70
|
+
/** Output only. Unique ID of the ad unit as used in the `AD_UNIT_ID` reporting dimension. */
|
|
71
|
+
reportingDimensionId?: string;
|
|
72
|
+
/** State of the ad unit. */
|
|
73
|
+
state?: string;
|
|
74
|
+
}
|
|
75
|
+
interface AdUnitAdCode {
|
|
76
|
+
/** Output only. The code snippet to add to the body of an HTML page. */
|
|
77
|
+
adCode?: string;
|
|
78
|
+
}
|
|
79
|
+
interface Alert {
|
|
80
|
+
/** Output only. The localized alert message. This may contain HTML markup, such as phrase elements or links. */
|
|
81
|
+
message?: string;
|
|
82
|
+
/** Output only. Resource name of the alert. Format: accounts/{account}/alerts/{alert} */
|
|
83
|
+
name?: string;
|
|
84
|
+
/** Output only. Severity of this alert. */
|
|
85
|
+
severity?: string;
|
|
86
|
+
/** Output only. Type of alert. This identifies the broad type of this alert, and provides a stable machine-readable identifier that will not be translated. For example, "payment-hold". */
|
|
87
|
+
type?: string;
|
|
88
|
+
}
|
|
89
|
+
interface Cell {
|
|
90
|
+
/** Value in the cell. The dimension cells contain strings, and the metric cells contain numbers. */
|
|
91
|
+
value?: string;
|
|
92
|
+
}
|
|
93
|
+
interface ContentAdsSettings {
|
|
94
|
+
/** Required. Size of the ad unit. e.g. "728x90", "1x3" (for responsive ad units). */
|
|
95
|
+
size?: string;
|
|
96
|
+
/** Required. Type of the ad unit. */
|
|
97
|
+
type?: string;
|
|
98
|
+
}
|
|
99
|
+
interface CustomChannel {
|
|
100
|
+
/** Required. Display name of the custom channel. */
|
|
101
|
+
displayName?: string;
|
|
102
|
+
/** Output only. Resource name of the custom channel. Format: accounts/{account}/adclients/{adclient}/customchannels/{customchannel} */
|
|
103
|
+
name?: string;
|
|
104
|
+
/** Output only. Unique ID of the custom channel as used in the `CUSTOM_CHANNEL_ID` reporting dimension. */
|
|
105
|
+
reportingDimensionId?: string;
|
|
106
|
+
}
|
|
107
|
+
interface Date {
|
|
108
|
+
/** 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. */
|
|
109
|
+
day?: number;
|
|
110
|
+
/** Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. */
|
|
111
|
+
month?: number;
|
|
112
|
+
/** Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. */
|
|
113
|
+
year?: number;
|
|
114
|
+
}
|
|
115
|
+
interface Header {
|
|
116
|
+
/** The [ISO-4217 currency code](https://en.wikipedia.org/wiki/ISO_4217) of this column. Only present if the header type is METRIC_CURRENCY. */
|
|
117
|
+
currencyCode?: string;
|
|
118
|
+
/** Required. Name of the header. */
|
|
119
|
+
name?: string;
|
|
120
|
+
/** Required. Type of the header. */
|
|
121
|
+
type?: string;
|
|
122
|
+
}
|
|
123
|
+
interface HttpBody {
|
|
124
|
+
/** The HTTP Content-Type header value specifying the content type of the body. */
|
|
125
|
+
contentType?: string;
|
|
126
|
+
/** The HTTP request/response body as raw binary. */
|
|
127
|
+
data?: string;
|
|
128
|
+
/** Application specific response metadata. Must be set in the first response for streaming APIs. */
|
|
129
|
+
extensions?: Array<{ [P in string]: any }>;
|
|
130
|
+
}
|
|
131
|
+
interface ListAccountsResponse {
|
|
132
|
+
/** The accounts returned in this list response. */
|
|
133
|
+
accounts?: Account[];
|
|
134
|
+
/** Continuation token used to page through accounts. To retrieve the next page of the results, set the next request's "page_token" value to this. */
|
|
135
|
+
nextPageToken?: string;
|
|
136
|
+
}
|
|
137
|
+
interface ListAdClientsResponse {
|
|
138
|
+
/** The ad clients returned in this list response. */
|
|
139
|
+
adClients?: AdClient[];
|
|
140
|
+
/** Continuation token used to page through ad clients. To retrieve the next page of the results, set the next request's "page_token" value to this. */
|
|
141
|
+
nextPageToken?: string;
|
|
142
|
+
}
|
|
143
|
+
interface ListAdUnitsResponse {
|
|
144
|
+
/** The ad units returned in the list response. */
|
|
145
|
+
adUnits?: AdUnit[];
|
|
146
|
+
/** Continuation token used to page through ad units. To retrieve the next page of the results, set the next request's "page_token" value to this. */
|
|
147
|
+
nextPageToken?: string;
|
|
148
|
+
}
|
|
149
|
+
interface ListAlertsResponse {
|
|
150
|
+
/** The alerts returned in this list response. */
|
|
151
|
+
alerts?: Alert[];
|
|
152
|
+
}
|
|
153
|
+
interface ListChildAccountsResponse {
|
|
154
|
+
/** The accounts returned in this list response. */
|
|
155
|
+
accounts?: Account[];
|
|
156
|
+
/** Continuation token used to page through accounts. To retrieve the next page of the results, set the next request's "page_token" value to this. */
|
|
157
|
+
nextPageToken?: string;
|
|
158
|
+
}
|
|
159
|
+
interface ListCustomChannelsResponse {
|
|
160
|
+
/** The custom channels returned in this list response. */
|
|
161
|
+
customChannels?: CustomChannel[];
|
|
162
|
+
/** Continuation token used to page through alerts. To retrieve the next page of the results, set the next request's "page_token" value to this. */
|
|
163
|
+
nextPageToken?: string;
|
|
164
|
+
}
|
|
165
|
+
interface ListLinkedAdUnitsResponse {
|
|
166
|
+
/** The ad units returned in the list response. */
|
|
167
|
+
adUnits?: AdUnit[];
|
|
168
|
+
/** Continuation token used to page through ad units. To retrieve the next page of the results, set the next request's "page_token" value to this. */
|
|
169
|
+
nextPageToken?: string;
|
|
170
|
+
}
|
|
171
|
+
interface ListLinkedCustomChannelsResponse {
|
|
172
|
+
/** The custom channels returned in this list response. */
|
|
173
|
+
customChannels?: CustomChannel[];
|
|
174
|
+
/** Continuation token used to page through alerts. To retrieve the next page of the results, set the next request's "page_token" value to this. */
|
|
175
|
+
nextPageToken?: string;
|
|
176
|
+
}
|
|
177
|
+
interface ListPaymentsResponse {
|
|
178
|
+
/** The payments returned in this list response. */
|
|
179
|
+
payments?: Payment[];
|
|
180
|
+
}
|
|
181
|
+
interface ListSavedReportsResponse {
|
|
182
|
+
/** Continuation token used to page through reports. To retrieve the next page of the results, set the next request's "page_token" value to this. */
|
|
183
|
+
nextPageToken?: string;
|
|
184
|
+
/** The reports returned in this list response. */
|
|
185
|
+
savedReports?: SavedReport[];
|
|
186
|
+
}
|
|
187
|
+
interface ListSitesResponse {
|
|
188
|
+
/** Continuation token used to page through sites. To retrieve the next page of the results, set the next request's "page_token" value to this. */
|
|
189
|
+
nextPageToken?: string;
|
|
190
|
+
/** The sites returned in this list response. */
|
|
191
|
+
sites?: Site[];
|
|
192
|
+
}
|
|
193
|
+
interface ListUrlChannelsResponse {
|
|
194
|
+
/** Continuation token used to page through url channels. To retrieve the next page of the results, set the next request's "page_token" value to this. */
|
|
195
|
+
nextPageToken?: string;
|
|
196
|
+
/** The url channels returned in this list response. */
|
|
197
|
+
urlChannels?: UrlChannel[];
|
|
198
|
+
}
|
|
199
|
+
interface Payment {
|
|
200
|
+
/** Output only. The amount of unpaid or paid earnings, as a formatted string, including the currency. E.g. "¥1,235 JPY", "$1,234.57", "£87.65". */
|
|
201
|
+
amount?: string;
|
|
202
|
+
/**
|
|
203
|
+
* Output only. For paid earnings, the date that the payment was credited. For unpaid earnings, this field is empty. Payment dates are always returned in the billing timezone
|
|
204
|
+
* (America/Los_Angeles).
|
|
205
|
+
*/
|
|
206
|
+
date?: Date;
|
|
207
|
+
/**
|
|
208
|
+
* Output only. Resource name of the payment. Format: - accounts/{account}/payments/unpaid for unpaid (current) AdSense earnings. - accounts/{account}/payments/youtube-unpaid for
|
|
209
|
+
* unpaid (current) YouTube earnings. - accounts/{account}/payments/yyyy-MM-dd for paid AdSense earnings. - accounts/{account}/payments/youtube-yyyy-MM-dd for paid YouTube earnings.
|
|
210
|
+
*/
|
|
211
|
+
name?: string;
|
|
212
|
+
}
|
|
213
|
+
interface ReportResult {
|
|
214
|
+
/** The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty. */
|
|
215
|
+
averages?: Row;
|
|
216
|
+
/** Required. End date of the range (inclusive). */
|
|
217
|
+
endDate?: Date;
|
|
218
|
+
/** The header information; one for each dimension in the request, followed by one for each metric in the request. */
|
|
219
|
+
headers?: Header[];
|
|
220
|
+
/** The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request. */
|
|
221
|
+
rows?: Row[];
|
|
222
|
+
/** Required. Start date of the range (inclusive). */
|
|
223
|
+
startDate?: Date;
|
|
224
|
+
/** The total number of rows matched by the report request. */
|
|
225
|
+
totalMatchedRows?: string;
|
|
226
|
+
/** The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty. */
|
|
227
|
+
totals?: Row;
|
|
228
|
+
/** Any warnings associated with generation of the report. These warnings are always returned in English. */
|
|
229
|
+
warnings?: string[];
|
|
230
|
+
}
|
|
231
|
+
interface Row {
|
|
232
|
+
/** Cells in the row. */
|
|
233
|
+
cells?: Cell[];
|
|
234
|
+
}
|
|
235
|
+
interface SavedReport {
|
|
236
|
+
/** Output only. Resource name of the report. Format: accounts/{account}/reports/{report} */
|
|
237
|
+
name?: string;
|
|
238
|
+
/** Report title as specified by publisher. */
|
|
239
|
+
title?: string;
|
|
240
|
+
}
|
|
241
|
+
interface Site {
|
|
242
|
+
/** Whether auto ads is turned on for the site. */
|
|
243
|
+
autoAdsEnabled?: boolean;
|
|
244
|
+
/** Domain (or subdomain) of the site, e.g. "example.com" or "www.example.com". This is used in the `OWNED_SITE_DOMAIN_NAME` reporting dimension. */
|
|
245
|
+
domain?: string;
|
|
246
|
+
/** Output only. Resource name of a site. Format: accounts/{account}/sites/{site} */
|
|
247
|
+
name?: string;
|
|
248
|
+
/** Output only. Unique ID of the site as used in the `OWNED_SITE_ID` reporting dimension. */
|
|
249
|
+
reportingDimensionId?: string;
|
|
250
|
+
/** Output only. State of a site. */
|
|
251
|
+
state?: string;
|
|
252
|
+
}
|
|
253
|
+
interface TimeZone {
|
|
254
|
+
/** IANA Time Zone Database time zone, e.g. "America/New_York". */
|
|
255
|
+
id?: string;
|
|
256
|
+
/** Optional. IANA Time Zone Database version number, e.g. "2019a". */
|
|
257
|
+
version?: string;
|
|
258
|
+
}
|
|
259
|
+
interface UrlChannel {
|
|
260
|
+
/** Output only. Resource name of the URL channel. Format: accounts/{account}/adclients/{adclient}/urlchannels/{urlchannel} */
|
|
261
|
+
name?: string;
|
|
262
|
+
/** Output only. Unique ID of the custom channel as used in the `URL_CHANNEL_ID` reporting dimension. */
|
|
263
|
+
reportingDimensionId?: string;
|
|
264
|
+
/** URI pattern of the channel. Does not include "http://" or "https://". Example: www.example.com/home */
|
|
265
|
+
uriPattern?: string;
|
|
266
|
+
}
|
|
267
|
+
interface AdunitsResource {
|
|
268
|
+
/** Gets an ad unit from a specified account and ad client. */
|
|
269
|
+
get(request?: {
|
|
270
|
+
/** V1 error format. */
|
|
271
|
+
"$.xgafv"?: string;
|
|
272
|
+
/** OAuth access token. */
|
|
273
|
+
access_token?: string;
|
|
274
|
+
/** Data format for response. */
|
|
275
|
+
alt?: string;
|
|
276
|
+
/** JSONP */
|
|
277
|
+
callback?: string;
|
|
278
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
279
|
+
fields?: string;
|
|
280
|
+
/** 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. */
|
|
281
|
+
key?: string;
|
|
282
|
+
/** Required. AdUnit to get information about. Format: accounts/{account}/adclients/{adclient}/adunits/{adunit} */
|
|
283
|
+
name: string;
|
|
284
|
+
/** OAuth 2.0 token for the current user. */
|
|
285
|
+
oauth_token?: string;
|
|
286
|
+
/** Returns response with indentations and line breaks. */
|
|
287
|
+
prettyPrint?: boolean;
|
|
288
|
+
/** 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. */
|
|
289
|
+
quotaUser?: string;
|
|
290
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
291
|
+
upload_protocol?: string;
|
|
292
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
293
|
+
uploadType?: string;
|
|
294
|
+
}): Request<AdUnit>;
|
|
295
|
+
/**
|
|
296
|
+
* Gets the ad unit code for a given ad unit. For more information, see [About the AdSense code](https://support.google.com/adsense/answer/9274634) and [Where to place the ad code in
|
|
297
|
+
* your HTML](https://support.google.com/adsense/answer/9190028).
|
|
298
|
+
*/
|
|
299
|
+
getAdcode(request?: {
|
|
300
|
+
/** V1 error format. */
|
|
301
|
+
"$.xgafv"?: string;
|
|
302
|
+
/** OAuth access token. */
|
|
303
|
+
access_token?: string;
|
|
304
|
+
/** Data format for response. */
|
|
305
|
+
alt?: string;
|
|
306
|
+
/** JSONP */
|
|
307
|
+
callback?: string;
|
|
308
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
309
|
+
fields?: string;
|
|
310
|
+
/** 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. */
|
|
311
|
+
key?: string;
|
|
312
|
+
/** Required. Name of the adunit for which to get the adcode. Format: accounts/{account}/adclients/{adclient}/adunits/{adunit} */
|
|
313
|
+
name: string;
|
|
314
|
+
/** OAuth 2.0 token for the current user. */
|
|
315
|
+
oauth_token?: string;
|
|
316
|
+
/** Returns response with indentations and line breaks. */
|
|
317
|
+
prettyPrint?: boolean;
|
|
318
|
+
/** 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. */
|
|
319
|
+
quotaUser?: string;
|
|
320
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
321
|
+
upload_protocol?: string;
|
|
322
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
323
|
+
uploadType?: string;
|
|
324
|
+
}): Request<AdUnitAdCode>;
|
|
325
|
+
/** Lists all ad units under a specified account and ad client. */
|
|
326
|
+
list(request?: {
|
|
327
|
+
/** V1 error format. */
|
|
328
|
+
"$.xgafv"?: string;
|
|
329
|
+
/** OAuth access token. */
|
|
330
|
+
access_token?: string;
|
|
331
|
+
/** Data format for response. */
|
|
332
|
+
alt?: string;
|
|
333
|
+
/** JSONP */
|
|
334
|
+
callback?: string;
|
|
335
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
336
|
+
fields?: string;
|
|
337
|
+
/** 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. */
|
|
338
|
+
key?: string;
|
|
339
|
+
/** OAuth 2.0 token for the current user. */
|
|
340
|
+
oauth_token?: string;
|
|
341
|
+
/**
|
|
342
|
+
* The maximum number of ad units to include in the response, used for paging. If unspecified, at most 10000 ad units will be returned. The maximum value is 10000; values above
|
|
343
|
+
* 10000 will be coerced to 10000.
|
|
344
|
+
*/
|
|
345
|
+
pageSize?: number;
|
|
346
|
+
/**
|
|
347
|
+
* A page token, received from a previous `ListAdUnits` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAdUnits` must
|
|
348
|
+
* match the call that provided the page token.
|
|
349
|
+
*/
|
|
350
|
+
pageToken?: string;
|
|
351
|
+
/** Required. The ad client which owns the collection of ad units. Format: accounts/{account}/adclients/{adclient} */
|
|
352
|
+
parent: string;
|
|
353
|
+
/** Returns response with indentations and line breaks. */
|
|
354
|
+
prettyPrint?: boolean;
|
|
355
|
+
/** 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. */
|
|
356
|
+
quotaUser?: string;
|
|
357
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
358
|
+
upload_protocol?: string;
|
|
359
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
360
|
+
uploadType?: string;
|
|
361
|
+
}): Request<ListAdUnitsResponse>;
|
|
362
|
+
/** Lists all the custom channels available for an ad unit. */
|
|
363
|
+
listLinkedCustomChannels(request?: {
|
|
364
|
+
/** V1 error format. */
|
|
365
|
+
"$.xgafv"?: string;
|
|
366
|
+
/** OAuth access token. */
|
|
367
|
+
access_token?: string;
|
|
368
|
+
/** Data format for response. */
|
|
369
|
+
alt?: string;
|
|
370
|
+
/** JSONP */
|
|
371
|
+
callback?: string;
|
|
372
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
373
|
+
fields?: string;
|
|
374
|
+
/** 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. */
|
|
375
|
+
key?: string;
|
|
376
|
+
/** OAuth 2.0 token for the current user. */
|
|
377
|
+
oauth_token?: string;
|
|
378
|
+
/**
|
|
379
|
+
* The maximum number of custom channels to include in the response, used for paging. If unspecified, at most 10000 custom channels will be returned. The maximum value is 10000;
|
|
380
|
+
* values above 10000 will be coerced to 10000.
|
|
381
|
+
*/
|
|
382
|
+
pageSize?: number;
|
|
383
|
+
/**
|
|
384
|
+
* A page token, received from a previous `ListLinkedCustomChannels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to
|
|
385
|
+
* `ListLinkedCustomChannels` must match the call that provided the page token.
|
|
386
|
+
*/
|
|
387
|
+
pageToken?: string;
|
|
388
|
+
/** Required. The ad unit which owns the collection of custom channels. Format: accounts/{account}/adclients/{adclient}/adunits/{adunit} */
|
|
389
|
+
parent: string;
|
|
390
|
+
/** Returns response with indentations and line breaks. */
|
|
391
|
+
prettyPrint?: boolean;
|
|
392
|
+
/** 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. */
|
|
393
|
+
quotaUser?: string;
|
|
394
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
395
|
+
upload_protocol?: string;
|
|
396
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
397
|
+
uploadType?: string;
|
|
398
|
+
}): Request<ListLinkedCustomChannelsResponse>;
|
|
399
|
+
}
|
|
400
|
+
interface CustomchannelsResource {
|
|
401
|
+
/** Gets information about the selected custom channel. */
|
|
402
|
+
get(request?: {
|
|
403
|
+
/** V1 error format. */
|
|
404
|
+
"$.xgafv"?: string;
|
|
405
|
+
/** OAuth access token. */
|
|
406
|
+
access_token?: string;
|
|
407
|
+
/** Data format for response. */
|
|
408
|
+
alt?: string;
|
|
409
|
+
/** JSONP */
|
|
410
|
+
callback?: string;
|
|
411
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
412
|
+
fields?: string;
|
|
413
|
+
/** 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. */
|
|
414
|
+
key?: string;
|
|
415
|
+
/** Required. Name of the custom channel. Format: accounts/{account}/adclients/{adclient}/customchannels/{customchannel} */
|
|
416
|
+
name: string;
|
|
417
|
+
/** OAuth 2.0 token for the current user. */
|
|
418
|
+
oauth_token?: string;
|
|
419
|
+
/** Returns response with indentations and line breaks. */
|
|
420
|
+
prettyPrint?: boolean;
|
|
421
|
+
/** 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. */
|
|
422
|
+
quotaUser?: string;
|
|
423
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
424
|
+
upload_protocol?: string;
|
|
425
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
426
|
+
uploadType?: string;
|
|
427
|
+
}): Request<CustomChannel>;
|
|
428
|
+
/** Lists all the custom channels available in an ad client. */
|
|
429
|
+
list(request?: {
|
|
430
|
+
/** V1 error format. */
|
|
431
|
+
"$.xgafv"?: string;
|
|
432
|
+
/** OAuth access token. */
|
|
433
|
+
access_token?: string;
|
|
434
|
+
/** Data format for response. */
|
|
435
|
+
alt?: string;
|
|
436
|
+
/** JSONP */
|
|
437
|
+
callback?: string;
|
|
438
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
439
|
+
fields?: string;
|
|
440
|
+
/** 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. */
|
|
441
|
+
key?: string;
|
|
442
|
+
/** OAuth 2.0 token for the current user. */
|
|
443
|
+
oauth_token?: string;
|
|
444
|
+
/**
|
|
445
|
+
* The maximum number of custom channels to include in the response, used for paging. If unspecified, at most 10000 custom channels will be returned. The maximum value is 10000;
|
|
446
|
+
* values above 10000 will be coerced to 10000.
|
|
447
|
+
*/
|
|
448
|
+
pageSize?: number;
|
|
449
|
+
/**
|
|
450
|
+
* A page token, received from a previous `ListCustomChannels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to
|
|
451
|
+
* `ListCustomChannels` must match the call that provided the page token.
|
|
452
|
+
*/
|
|
453
|
+
pageToken?: string;
|
|
454
|
+
/** Required. The ad client which owns the collection of custom channels. Format: accounts/{account}/adclients/{adclient} */
|
|
455
|
+
parent: string;
|
|
456
|
+
/** Returns response with indentations and line breaks. */
|
|
457
|
+
prettyPrint?: boolean;
|
|
458
|
+
/** 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. */
|
|
459
|
+
quotaUser?: string;
|
|
460
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
461
|
+
upload_protocol?: string;
|
|
462
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
463
|
+
uploadType?: string;
|
|
464
|
+
}): Request<ListCustomChannelsResponse>;
|
|
465
|
+
/** Lists all the ad units available for a custom channel. */
|
|
466
|
+
listLinkedAdUnits(request?: {
|
|
467
|
+
/** V1 error format. */
|
|
468
|
+
"$.xgafv"?: string;
|
|
469
|
+
/** OAuth access token. */
|
|
470
|
+
access_token?: string;
|
|
471
|
+
/** Data format for response. */
|
|
472
|
+
alt?: string;
|
|
473
|
+
/** JSONP */
|
|
474
|
+
callback?: string;
|
|
475
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
476
|
+
fields?: string;
|
|
477
|
+
/** 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. */
|
|
478
|
+
key?: string;
|
|
479
|
+
/** OAuth 2.0 token for the current user. */
|
|
480
|
+
oauth_token?: string;
|
|
481
|
+
/**
|
|
482
|
+
* The maximum number of ad units to include in the response, used for paging. If unspecified, at most 10000 ad units will be returned. The maximum value is 10000; values above
|
|
483
|
+
* 10000 will be coerced to 10000.
|
|
484
|
+
*/
|
|
485
|
+
pageSize?: number;
|
|
486
|
+
/**
|
|
487
|
+
* A page token, received from a previous `ListLinkedAdUnits` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to
|
|
488
|
+
* `ListLinkedAdUnits` must match the call that provided the page token.
|
|
489
|
+
*/
|
|
490
|
+
pageToken?: string;
|
|
491
|
+
/** Required. The custom channel which owns the collection of ad units. Format: accounts/{account}/adclients/{adclient}/customchannels/{customchannel} */
|
|
492
|
+
parent: string;
|
|
493
|
+
/** Returns response with indentations and line breaks. */
|
|
494
|
+
prettyPrint?: boolean;
|
|
495
|
+
/** 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. */
|
|
496
|
+
quotaUser?: string;
|
|
497
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
498
|
+
upload_protocol?: string;
|
|
499
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
500
|
+
uploadType?: string;
|
|
501
|
+
}): Request<ListLinkedAdUnitsResponse>;
|
|
502
|
+
}
|
|
503
|
+
interface UrlchannelsResource {
|
|
504
|
+
/** Gets information about the selected url channel. */
|
|
505
|
+
get(request?: {
|
|
506
|
+
/** V1 error format. */
|
|
507
|
+
"$.xgafv"?: string;
|
|
508
|
+
/** OAuth access token. */
|
|
509
|
+
access_token?: string;
|
|
510
|
+
/** Data format for response. */
|
|
511
|
+
alt?: string;
|
|
512
|
+
/** JSONP */
|
|
513
|
+
callback?: string;
|
|
514
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
515
|
+
fields?: string;
|
|
516
|
+
/** 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. */
|
|
517
|
+
key?: string;
|
|
518
|
+
/** Required. The name of the url channel to retrieve. Format: accounts/{account}/adclients/{adclient}/urlchannels/{urlchannel} */
|
|
519
|
+
name: string;
|
|
520
|
+
/** OAuth 2.0 token for the current user. */
|
|
521
|
+
oauth_token?: string;
|
|
522
|
+
/** Returns response with indentations and line breaks. */
|
|
523
|
+
prettyPrint?: boolean;
|
|
524
|
+
/** 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. */
|
|
525
|
+
quotaUser?: string;
|
|
526
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
527
|
+
upload_protocol?: string;
|
|
528
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
529
|
+
uploadType?: string;
|
|
530
|
+
}): Request<UrlChannel>;
|
|
531
|
+
/** Lists active url channels. */
|
|
532
|
+
list(request?: {
|
|
533
|
+
/** V1 error format. */
|
|
534
|
+
"$.xgafv"?: string;
|
|
535
|
+
/** OAuth access token. */
|
|
536
|
+
access_token?: string;
|
|
537
|
+
/** Data format for response. */
|
|
538
|
+
alt?: string;
|
|
539
|
+
/** JSONP */
|
|
540
|
+
callback?: string;
|
|
541
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
542
|
+
fields?: string;
|
|
543
|
+
/** 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. */
|
|
544
|
+
key?: string;
|
|
545
|
+
/** OAuth 2.0 token for the current user. */
|
|
546
|
+
oauth_token?: string;
|
|
547
|
+
/**
|
|
548
|
+
* The maximum number of url channels to include in the response, used for paging. If unspecified, at most 10000 url channels will be returned. The maximum value is 10000; values
|
|
549
|
+
* above 10000 will be coerced to 10000.
|
|
550
|
+
*/
|
|
551
|
+
pageSize?: number;
|
|
552
|
+
/**
|
|
553
|
+
* A page token, received from a previous `ListUrlChannels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUrlChannels`
|
|
554
|
+
* must match the call that provided the page token.
|
|
555
|
+
*/
|
|
556
|
+
pageToken?: string;
|
|
557
|
+
/** Required. The ad client which owns the collection of url channels. Format: accounts/{account}/adclients/{adclient} */
|
|
558
|
+
parent: string;
|
|
559
|
+
/** Returns response with indentations and line breaks. */
|
|
560
|
+
prettyPrint?: boolean;
|
|
561
|
+
/** 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. */
|
|
562
|
+
quotaUser?: string;
|
|
563
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
564
|
+
upload_protocol?: string;
|
|
565
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
566
|
+
uploadType?: string;
|
|
567
|
+
}): Request<ListUrlChannelsResponse>;
|
|
568
|
+
}
|
|
569
|
+
interface AdclientsResource {
|
|
570
|
+
/** Gets the ad client from the given resource name. */
|
|
571
|
+
get(request?: {
|
|
572
|
+
/** V1 error format. */
|
|
573
|
+
"$.xgafv"?: string;
|
|
574
|
+
/** OAuth access token. */
|
|
575
|
+
access_token?: string;
|
|
576
|
+
/** Data format for response. */
|
|
577
|
+
alt?: string;
|
|
578
|
+
/** JSONP */
|
|
579
|
+
callback?: string;
|
|
580
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
581
|
+
fields?: string;
|
|
582
|
+
/** 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. */
|
|
583
|
+
key?: string;
|
|
584
|
+
/** Required. The name of the ad client to retrieve. Format: accounts/{account}/adclients/{adclient} */
|
|
585
|
+
name: string;
|
|
586
|
+
/** OAuth 2.0 token for the current user. */
|
|
587
|
+
oauth_token?: string;
|
|
588
|
+
/** Returns response with indentations and line breaks. */
|
|
589
|
+
prettyPrint?: boolean;
|
|
590
|
+
/** 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. */
|
|
591
|
+
quotaUser?: string;
|
|
592
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
593
|
+
upload_protocol?: string;
|
|
594
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
595
|
+
uploadType?: string;
|
|
596
|
+
}): Request<AdClient>;
|
|
597
|
+
/**
|
|
598
|
+
* Gets the AdSense code for a given ad client. This returns what was previously known as the 'auto ad code'. This is only supported for ad clients with a product_code of AFC. For more
|
|
599
|
+
* information, see [About the AdSense code](https://support.google.com/adsense/answer/9274634).
|
|
600
|
+
*/
|
|
601
|
+
getAdcode(request?: {
|
|
602
|
+
/** V1 error format. */
|
|
603
|
+
"$.xgafv"?: string;
|
|
604
|
+
/** OAuth access token. */
|
|
605
|
+
access_token?: string;
|
|
606
|
+
/** Data format for response. */
|
|
607
|
+
alt?: string;
|
|
608
|
+
/** JSONP */
|
|
609
|
+
callback?: string;
|
|
610
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
611
|
+
fields?: string;
|
|
612
|
+
/** 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. */
|
|
613
|
+
key?: string;
|
|
614
|
+
/** Required. Name of the ad client for which to get the adcode. Format: accounts/{account}/adclients/{adclient} */
|
|
615
|
+
name: string;
|
|
616
|
+
/** OAuth 2.0 token for the current user. */
|
|
617
|
+
oauth_token?: string;
|
|
618
|
+
/** Returns response with indentations and line breaks. */
|
|
619
|
+
prettyPrint?: boolean;
|
|
620
|
+
/** 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. */
|
|
621
|
+
quotaUser?: string;
|
|
622
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
623
|
+
upload_protocol?: string;
|
|
624
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
625
|
+
uploadType?: string;
|
|
626
|
+
}): Request<AdClientAdCode>;
|
|
627
|
+
/** Lists all the ad clients available in an account. */
|
|
628
|
+
list(request?: {
|
|
629
|
+
/** V1 error format. */
|
|
630
|
+
"$.xgafv"?: string;
|
|
631
|
+
/** OAuth access token. */
|
|
632
|
+
access_token?: string;
|
|
633
|
+
/** Data format for response. */
|
|
634
|
+
alt?: string;
|
|
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
|
+
/** OAuth 2.0 token for the current user. */
|
|
642
|
+
oauth_token?: string;
|
|
643
|
+
/**
|
|
644
|
+
* The maximum number of ad clients to include in the response, used for paging. If unspecified, at most 10000 ad clients will be returned. The maximum value is 10000; values above
|
|
645
|
+
* 10000 will be coerced to 10000.
|
|
646
|
+
*/
|
|
647
|
+
pageSize?: number;
|
|
648
|
+
/**
|
|
649
|
+
* A page token, received from a previous `ListAdClients` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAdClients` must
|
|
650
|
+
* match the call that provided the page token.
|
|
651
|
+
*/
|
|
652
|
+
pageToken?: string;
|
|
653
|
+
/** Required. The account which owns the collection of ad clients. Format: accounts/{account} */
|
|
654
|
+
parent: string;
|
|
655
|
+
/** Returns response with indentations and line breaks. */
|
|
656
|
+
prettyPrint?: boolean;
|
|
657
|
+
/** 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. */
|
|
658
|
+
quotaUser?: string;
|
|
659
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
660
|
+
upload_protocol?: string;
|
|
661
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
662
|
+
uploadType?: string;
|
|
663
|
+
}): Request<ListAdClientsResponse>;
|
|
664
|
+
adunits: AdunitsResource;
|
|
665
|
+
customchannels: CustomchannelsResource;
|
|
666
|
+
urlchannels: UrlchannelsResource;
|
|
667
|
+
}
|
|
668
|
+
interface AlertsResource {
|
|
669
|
+
/** Lists all the alerts available in an account. */
|
|
670
|
+
list(request?: {
|
|
671
|
+
/** V1 error format. */
|
|
672
|
+
"$.xgafv"?: string;
|
|
673
|
+
/** OAuth access token. */
|
|
674
|
+
access_token?: string;
|
|
675
|
+
/** Data format for response. */
|
|
676
|
+
alt?: string;
|
|
677
|
+
/** JSONP */
|
|
678
|
+
callback?: string;
|
|
679
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
680
|
+
fields?: string;
|
|
681
|
+
/** 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. */
|
|
682
|
+
key?: string;
|
|
683
|
+
/**
|
|
684
|
+
* The language to use for translating alert messages. If unspecified, this defaults to the user's display language. If the given language is not supported, alerts will be returned
|
|
685
|
+
* in English. The language is specified as an [IETF BCP-47 language code](https://en.wikipedia.org/wiki/IETF_language_tag).
|
|
686
|
+
*/
|
|
687
|
+
languageCode?: string;
|
|
688
|
+
/** OAuth 2.0 token for the current user. */
|
|
689
|
+
oauth_token?: string;
|
|
690
|
+
/** Required. The account which owns the collection of alerts. Format: accounts/{account} */
|
|
691
|
+
parent: string;
|
|
692
|
+
/** Returns response with indentations and line breaks. */
|
|
693
|
+
prettyPrint?: boolean;
|
|
694
|
+
/** 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. */
|
|
695
|
+
quotaUser?: string;
|
|
696
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
697
|
+
upload_protocol?: string;
|
|
698
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
699
|
+
uploadType?: string;
|
|
700
|
+
}): Request<ListAlertsResponse>;
|
|
701
|
+
}
|
|
702
|
+
interface PaymentsResource {
|
|
703
|
+
/** Lists all the payments available for an account. */
|
|
704
|
+
list(request?: {
|
|
705
|
+
/** V1 error format. */
|
|
706
|
+
"$.xgafv"?: string;
|
|
707
|
+
/** OAuth access token. */
|
|
708
|
+
access_token?: string;
|
|
709
|
+
/** Data format for response. */
|
|
710
|
+
alt?: string;
|
|
711
|
+
/** JSONP */
|
|
712
|
+
callback?: string;
|
|
713
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
714
|
+
fields?: string;
|
|
715
|
+
/** 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. */
|
|
716
|
+
key?: string;
|
|
717
|
+
/** OAuth 2.0 token for the current user. */
|
|
718
|
+
oauth_token?: string;
|
|
719
|
+
/** Required. The account which owns the collection of payments. Format: accounts/{account} */
|
|
720
|
+
parent: string;
|
|
721
|
+
/** Returns response with indentations and line breaks. */
|
|
722
|
+
prettyPrint?: boolean;
|
|
723
|
+
/** 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. */
|
|
724
|
+
quotaUser?: string;
|
|
725
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
726
|
+
upload_protocol?: string;
|
|
727
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
728
|
+
uploadType?: string;
|
|
729
|
+
}): Request<ListPaymentsResponse>;
|
|
730
|
+
}
|
|
731
|
+
interface SavedResource {
|
|
732
|
+
/** Generates a saved report. */
|
|
733
|
+
generate(request?: {
|
|
734
|
+
/** V1 error format. */
|
|
735
|
+
"$.xgafv"?: string;
|
|
736
|
+
/** OAuth access token. */
|
|
737
|
+
access_token?: string;
|
|
738
|
+
/** Data format for response. */
|
|
739
|
+
alt?: string;
|
|
740
|
+
/** JSONP */
|
|
741
|
+
callback?: string;
|
|
742
|
+
/** The [ISO-4217 currency code](https://en.wikipedia.org/wiki/ISO_4217) to use when reporting on monetary metrics. Defaults to the account's currency if not set. */
|
|
743
|
+
currencyCode?: string;
|
|
744
|
+
/** Date range of the report, if unset the range will be considered CUSTOM. */
|
|
745
|
+
dateRange?: string;
|
|
746
|
+
/** 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. */
|
|
747
|
+
"endDate.day"?: number;
|
|
748
|
+
/** Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. */
|
|
749
|
+
"endDate.month"?: number;
|
|
750
|
+
/** Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. */
|
|
751
|
+
"endDate.year"?: number;
|
|
752
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
753
|
+
fields?: string;
|
|
754
|
+
/** 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. */
|
|
755
|
+
key?: string;
|
|
756
|
+
/**
|
|
757
|
+
* The language to use for translating report output. If unspecified, this defaults to English ("en"). If the given language is not supported, report output will be returned in
|
|
758
|
+
* English. The language is specified as an [IETF BCP-47 language code](https://en.wikipedia.org/wiki/IETF_language_tag).
|
|
759
|
+
*/
|
|
760
|
+
languageCode?: string;
|
|
761
|
+
/** Required. Name of the saved report. Format: accounts/{account}/reports/{report} */
|
|
762
|
+
name: string;
|
|
763
|
+
/** OAuth 2.0 token for the current user. */
|
|
764
|
+
oauth_token?: string;
|
|
765
|
+
/** Returns response with indentations and line breaks. */
|
|
766
|
+
prettyPrint?: boolean;
|
|
767
|
+
/** 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. */
|
|
768
|
+
quotaUser?: string;
|
|
769
|
+
/**
|
|
770
|
+
* Timezone in which to generate the report. If unspecified, this defaults to the account timezone. For more information, see [changing the time zone of your
|
|
771
|
+
* reports](https://support.google.com/adsense/answer/9830725).
|
|
772
|
+
*/
|
|
773
|
+
reportingTimeZone?: string;
|
|
774
|
+
/** 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. */
|
|
775
|
+
"startDate.day"?: number;
|
|
776
|
+
/** Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. */
|
|
777
|
+
"startDate.month"?: number;
|
|
778
|
+
/** Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. */
|
|
779
|
+
"startDate.year"?: number;
|
|
780
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
781
|
+
upload_protocol?: string;
|
|
782
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
783
|
+
uploadType?: string;
|
|
784
|
+
}): Request<ReportResult>;
|
|
785
|
+
/** Generates a csv formatted saved report. */
|
|
786
|
+
generateCsv(request?: {
|
|
787
|
+
/** V1 error format. */
|
|
788
|
+
"$.xgafv"?: string;
|
|
789
|
+
/** OAuth access token. */
|
|
790
|
+
access_token?: string;
|
|
791
|
+
/** Data format for response. */
|
|
792
|
+
alt?: string;
|
|
793
|
+
/** JSONP */
|
|
794
|
+
callback?: string;
|
|
795
|
+
/** The [ISO-4217 currency code](https://en.wikipedia.org/wiki/ISO_4217) to use when reporting on monetary metrics. Defaults to the account's currency if not set. */
|
|
796
|
+
currencyCode?: string;
|
|
797
|
+
/** Date range of the report, if unset the range will be considered CUSTOM. */
|
|
798
|
+
dateRange?: string;
|
|
799
|
+
/** 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. */
|
|
800
|
+
"endDate.day"?: number;
|
|
801
|
+
/** Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. */
|
|
802
|
+
"endDate.month"?: number;
|
|
803
|
+
/** Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. */
|
|
804
|
+
"endDate.year"?: number;
|
|
805
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
806
|
+
fields?: string;
|
|
807
|
+
/** 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. */
|
|
808
|
+
key?: string;
|
|
809
|
+
/**
|
|
810
|
+
* The language to use for translating report output. If unspecified, this defaults to English ("en"). If the given language is not supported, report output will be returned in
|
|
811
|
+
* English. The language is specified as an [IETF BCP-47 language code](https://en.wikipedia.org/wiki/IETF_language_tag).
|
|
812
|
+
*/
|
|
813
|
+
languageCode?: string;
|
|
814
|
+
/** Required. Name of the saved report. Format: accounts/{account}/reports/{report} */
|
|
815
|
+
name: string;
|
|
816
|
+
/** OAuth 2.0 token for the current user. */
|
|
817
|
+
oauth_token?: string;
|
|
818
|
+
/** Returns response with indentations and line breaks. */
|
|
819
|
+
prettyPrint?: boolean;
|
|
820
|
+
/** 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. */
|
|
821
|
+
quotaUser?: string;
|
|
822
|
+
/**
|
|
823
|
+
* Timezone in which to generate the report. If unspecified, this defaults to the account timezone. For more information, see [changing the time zone of your
|
|
824
|
+
* reports](https://support.google.com/adsense/answer/9830725).
|
|
825
|
+
*/
|
|
826
|
+
reportingTimeZone?: string;
|
|
827
|
+
/** 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. */
|
|
828
|
+
"startDate.day"?: number;
|
|
829
|
+
/** Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. */
|
|
830
|
+
"startDate.month"?: number;
|
|
831
|
+
/** Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. */
|
|
832
|
+
"startDate.year"?: number;
|
|
833
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
834
|
+
upload_protocol?: string;
|
|
835
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
836
|
+
uploadType?: string;
|
|
837
|
+
}): Request<HttpBody>;
|
|
838
|
+
/** Lists saved reports. */
|
|
839
|
+
list(request?: {
|
|
840
|
+
/** V1 error format. */
|
|
841
|
+
"$.xgafv"?: string;
|
|
842
|
+
/** OAuth access token. */
|
|
843
|
+
access_token?: string;
|
|
844
|
+
/** Data format for response. */
|
|
845
|
+
alt?: string;
|
|
846
|
+
/** JSONP */
|
|
847
|
+
callback?: string;
|
|
848
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
849
|
+
fields?: string;
|
|
850
|
+
/** 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. */
|
|
851
|
+
key?: string;
|
|
852
|
+
/** OAuth 2.0 token for the current user. */
|
|
853
|
+
oauth_token?: string;
|
|
854
|
+
/**
|
|
855
|
+
* The maximum number of reports to include in the response, used for paging. If unspecified, at most 10000 reports will be returned. The maximum value is 10000; values above 10000
|
|
856
|
+
* will be coerced to 10000.
|
|
857
|
+
*/
|
|
858
|
+
pageSize?: number;
|
|
859
|
+
/**
|
|
860
|
+
* A page token, received from a previous `ListPayments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPayments` must
|
|
861
|
+
* match the call that provided the page token.
|
|
862
|
+
*/
|
|
863
|
+
pageToken?: string;
|
|
864
|
+
/** Required. The account which owns the collection of reports. Format: accounts/{account} */
|
|
865
|
+
parent: string;
|
|
866
|
+
/** Returns response with indentations and line breaks. */
|
|
867
|
+
prettyPrint?: boolean;
|
|
868
|
+
/** 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. */
|
|
869
|
+
quotaUser?: string;
|
|
870
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
871
|
+
upload_protocol?: string;
|
|
872
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
873
|
+
uploadType?: string;
|
|
874
|
+
}): Request<ListSavedReportsResponse>;
|
|
875
|
+
}
|
|
876
|
+
interface ReportsResource {
|
|
877
|
+
/** Generates an ad hoc report. */
|
|
878
|
+
generate(request?: {
|
|
879
|
+
/** V1 error format. */
|
|
880
|
+
"$.xgafv"?: string;
|
|
881
|
+
/** OAuth access token. */
|
|
882
|
+
access_token?: string;
|
|
883
|
+
/** Required. The account which owns the collection of reports. Format: accounts/{account} */
|
|
884
|
+
account: string;
|
|
885
|
+
/** Data format for response. */
|
|
886
|
+
alt?: string;
|
|
887
|
+
/** JSONP */
|
|
888
|
+
callback?: string;
|
|
889
|
+
/** The [ISO-4217 currency code](https://en.wikipedia.org/wiki/ISO_4217) to use when reporting on monetary metrics. Defaults to the account's currency if not set. */
|
|
890
|
+
currencyCode?: string;
|
|
891
|
+
/** Date range of the report, if unset the range will be considered CUSTOM. */
|
|
892
|
+
dateRange?: string;
|
|
893
|
+
/** Dimensions to base the report on. */
|
|
894
|
+
dimensions?: string | string[];
|
|
895
|
+
/** 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. */
|
|
896
|
+
"endDate.day"?: number;
|
|
897
|
+
/** Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. */
|
|
898
|
+
"endDate.month"?: number;
|
|
899
|
+
/** Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. */
|
|
900
|
+
"endDate.year"?: number;
|
|
901
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
902
|
+
fields?: string;
|
|
903
|
+
/** Filters to be run on the report. */
|
|
904
|
+
filters?: string | string[];
|
|
905
|
+
/** 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. */
|
|
906
|
+
key?: string;
|
|
907
|
+
/**
|
|
908
|
+
* The language to use for translating report output. If unspecified, this defaults to English ("en"). If the given language is not supported, report output will be returned in
|
|
909
|
+
* English. The language is specified as an [IETF BCP-47 language code](https://en.wikipedia.org/wiki/IETF_language_tag).
|
|
910
|
+
*/
|
|
911
|
+
languageCode?: string;
|
|
912
|
+
/**
|
|
913
|
+
* The maximum number of rows of report data to return. Reports producing more rows than the requested limit will be truncated. If unset, this defaults to 100,000 rows for
|
|
914
|
+
* `Reports.GenerateReport` and 1,000,000 rows for `Reports.GenerateCsvReport`, which are also the maximum values permitted here. Report truncation can be identified (for
|
|
915
|
+
* `Reports.GenerateReport` only) by comparing the number of rows returned to the value returned in `total_matched_rows`.
|
|
916
|
+
*/
|
|
917
|
+
limit?: number;
|
|
918
|
+
/** Required. Reporting metrics. */
|
|
919
|
+
metrics?: string | string[];
|
|
920
|
+
/** OAuth 2.0 token for the current user. */
|
|
921
|
+
oauth_token?: string;
|
|
922
|
+
/**
|
|
923
|
+
* The name of a dimension or metric to sort the resulting report on, can be prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is
|
|
924
|
+
* sorted ascending.
|
|
925
|
+
*/
|
|
926
|
+
orderBy?: string | string[];
|
|
927
|
+
/** Returns response with indentations and line breaks. */
|
|
928
|
+
prettyPrint?: boolean;
|
|
929
|
+
/** 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. */
|
|
930
|
+
quotaUser?: string;
|
|
931
|
+
/**
|
|
932
|
+
* Timezone in which to generate the report. If unspecified, this defaults to the account timezone. For more information, see [changing the time zone of your
|
|
933
|
+
* reports](https://support.google.com/adsense/answer/9830725).
|
|
934
|
+
*/
|
|
935
|
+
reportingTimeZone?: string;
|
|
936
|
+
/** 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. */
|
|
937
|
+
"startDate.day"?: number;
|
|
938
|
+
/** Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. */
|
|
939
|
+
"startDate.month"?: number;
|
|
940
|
+
/** Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. */
|
|
941
|
+
"startDate.year"?: number;
|
|
942
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
943
|
+
upload_protocol?: string;
|
|
944
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
945
|
+
uploadType?: string;
|
|
946
|
+
}): Request<ReportResult>;
|
|
947
|
+
/** Generates a csv formatted ad hoc report. */
|
|
948
|
+
generateCsv(request?: {
|
|
949
|
+
/** V1 error format. */
|
|
950
|
+
"$.xgafv"?: string;
|
|
951
|
+
/** OAuth access token. */
|
|
952
|
+
access_token?: string;
|
|
953
|
+
/** Required. The account which owns the collection of reports. Format: accounts/{account} */
|
|
954
|
+
account: string;
|
|
955
|
+
/** Data format for response. */
|
|
956
|
+
alt?: string;
|
|
957
|
+
/** JSONP */
|
|
958
|
+
callback?: string;
|
|
959
|
+
/** The [ISO-4217 currency code](https://en.wikipedia.org/wiki/ISO_4217) to use when reporting on monetary metrics. Defaults to the account's currency if not set. */
|
|
960
|
+
currencyCode?: string;
|
|
961
|
+
/** Date range of the report, if unset the range will be considered CUSTOM. */
|
|
962
|
+
dateRange?: string;
|
|
963
|
+
/** Dimensions to base the report on. */
|
|
964
|
+
dimensions?: string | string[];
|
|
965
|
+
/** 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. */
|
|
966
|
+
"endDate.day"?: number;
|
|
967
|
+
/** Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. */
|
|
968
|
+
"endDate.month"?: number;
|
|
969
|
+
/** Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. */
|
|
970
|
+
"endDate.year"?: number;
|
|
971
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
972
|
+
fields?: string;
|
|
973
|
+
/** Filters to be run on the report. */
|
|
974
|
+
filters?: string | string[];
|
|
975
|
+
/** 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. */
|
|
976
|
+
key?: string;
|
|
977
|
+
/**
|
|
978
|
+
* The language to use for translating report output. If unspecified, this defaults to English ("en"). If the given language is not supported, report output will be returned in
|
|
979
|
+
* English. The language is specified as an [IETF BCP-47 language code](https://en.wikipedia.org/wiki/IETF_language_tag).
|
|
980
|
+
*/
|
|
981
|
+
languageCode?: string;
|
|
982
|
+
/**
|
|
983
|
+
* The maximum number of rows of report data to return. Reports producing more rows than the requested limit will be truncated. If unset, this defaults to 100,000 rows for
|
|
984
|
+
* `Reports.GenerateReport` and 1,000,000 rows for `Reports.GenerateCsvReport`, which are also the maximum values permitted here. Report truncation can be identified (for
|
|
985
|
+
* `Reports.GenerateReport` only) by comparing the number of rows returned to the value returned in `total_matched_rows`.
|
|
986
|
+
*/
|
|
987
|
+
limit?: number;
|
|
988
|
+
/** Required. Reporting metrics. */
|
|
989
|
+
metrics?: string | string[];
|
|
990
|
+
/** OAuth 2.0 token for the current user. */
|
|
991
|
+
oauth_token?: string;
|
|
992
|
+
/**
|
|
993
|
+
* The name of a dimension or metric to sort the resulting report on, can be prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is
|
|
994
|
+
* sorted ascending.
|
|
995
|
+
*/
|
|
996
|
+
orderBy?: string | string[];
|
|
997
|
+
/** Returns response with indentations and line breaks. */
|
|
998
|
+
prettyPrint?: boolean;
|
|
999
|
+
/** 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. */
|
|
1000
|
+
quotaUser?: string;
|
|
1001
|
+
/**
|
|
1002
|
+
* Timezone in which to generate the report. If unspecified, this defaults to the account timezone. For more information, see [changing the time zone of your
|
|
1003
|
+
* reports](https://support.google.com/adsense/answer/9830725).
|
|
1004
|
+
*/
|
|
1005
|
+
reportingTimeZone?: string;
|
|
1006
|
+
/** 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. */
|
|
1007
|
+
"startDate.day"?: number;
|
|
1008
|
+
/** Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. */
|
|
1009
|
+
"startDate.month"?: number;
|
|
1010
|
+
/** Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. */
|
|
1011
|
+
"startDate.year"?: number;
|
|
1012
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1013
|
+
upload_protocol?: string;
|
|
1014
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1015
|
+
uploadType?: string;
|
|
1016
|
+
}): Request<HttpBody>;
|
|
1017
|
+
/** Gets the saved report from the given resource name. */
|
|
1018
|
+
getSaved(request?: {
|
|
1019
|
+
/** V1 error format. */
|
|
1020
|
+
"$.xgafv"?: string;
|
|
1021
|
+
/** OAuth access token. */
|
|
1022
|
+
access_token?: string;
|
|
1023
|
+
/** Data format for response. */
|
|
1024
|
+
alt?: string;
|
|
1025
|
+
/** JSONP */
|
|
1026
|
+
callback?: string;
|
|
1027
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1028
|
+
fields?: string;
|
|
1029
|
+
/** 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. */
|
|
1030
|
+
key?: string;
|
|
1031
|
+
/** Required. The name of the saved report to retrieve. Format: accounts/{account}/reports/{report} */
|
|
1032
|
+
name: string;
|
|
1033
|
+
/** OAuth 2.0 token for the current user. */
|
|
1034
|
+
oauth_token?: string;
|
|
1035
|
+
/** Returns response with indentations and line breaks. */
|
|
1036
|
+
prettyPrint?: boolean;
|
|
1037
|
+
/** 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. */
|
|
1038
|
+
quotaUser?: string;
|
|
1039
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1040
|
+
upload_protocol?: string;
|
|
1041
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1042
|
+
uploadType?: string;
|
|
1043
|
+
}): Request<SavedReport>;
|
|
1044
|
+
saved: SavedResource;
|
|
1045
|
+
}
|
|
1046
|
+
interface SitesResource {
|
|
1047
|
+
/** Gets information about the selected site. */
|
|
1048
|
+
get(request?: {
|
|
1049
|
+
/** V1 error format. */
|
|
1050
|
+
"$.xgafv"?: string;
|
|
1051
|
+
/** OAuth access token. */
|
|
1052
|
+
access_token?: string;
|
|
1053
|
+
/** Data format for response. */
|
|
1054
|
+
alt?: string;
|
|
1055
|
+
/** JSONP */
|
|
1056
|
+
callback?: string;
|
|
1057
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1058
|
+
fields?: string;
|
|
1059
|
+
/** 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. */
|
|
1060
|
+
key?: string;
|
|
1061
|
+
/** Required. Name of the site. Format: accounts/{account}/sites/{site} */
|
|
1062
|
+
name: string;
|
|
1063
|
+
/** OAuth 2.0 token for the current user. */
|
|
1064
|
+
oauth_token?: string;
|
|
1065
|
+
/** Returns response with indentations and line breaks. */
|
|
1066
|
+
prettyPrint?: boolean;
|
|
1067
|
+
/** 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. */
|
|
1068
|
+
quotaUser?: string;
|
|
1069
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1070
|
+
upload_protocol?: string;
|
|
1071
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1072
|
+
uploadType?: string;
|
|
1073
|
+
}): Request<Site>;
|
|
1074
|
+
/** Lists all the sites available in an account. */
|
|
1075
|
+
list(request?: {
|
|
1076
|
+
/** V1 error format. */
|
|
1077
|
+
"$.xgafv"?: string;
|
|
1078
|
+
/** OAuth access token. */
|
|
1079
|
+
access_token?: string;
|
|
1080
|
+
/** Data format for response. */
|
|
1081
|
+
alt?: string;
|
|
1082
|
+
/** JSONP */
|
|
1083
|
+
callback?: string;
|
|
1084
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1085
|
+
fields?: string;
|
|
1086
|
+
/** 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. */
|
|
1087
|
+
key?: string;
|
|
1088
|
+
/** OAuth 2.0 token for the current user. */
|
|
1089
|
+
oauth_token?: string;
|
|
1090
|
+
/**
|
|
1091
|
+
* The maximum number of sites to include in the response, used for paging. If unspecified, at most 10000 sites will be returned. The maximum value is 10000; values above 10000
|
|
1092
|
+
* will be coerced to 10000.
|
|
1093
|
+
*/
|
|
1094
|
+
pageSize?: number;
|
|
1095
|
+
/**
|
|
1096
|
+
* A page token, received from a previous `ListSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSites` must match
|
|
1097
|
+
* the call that provided the page token.
|
|
1098
|
+
*/
|
|
1099
|
+
pageToken?: string;
|
|
1100
|
+
/** Required. The account which owns the collection of sites. Format: accounts/{account} */
|
|
1101
|
+
parent: string;
|
|
1102
|
+
/** Returns response with indentations and line breaks. */
|
|
1103
|
+
prettyPrint?: boolean;
|
|
1104
|
+
/** 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. */
|
|
1105
|
+
quotaUser?: string;
|
|
1106
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1107
|
+
upload_protocol?: string;
|
|
1108
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1109
|
+
uploadType?: string;
|
|
1110
|
+
}): Request<ListSitesResponse>;
|
|
1111
|
+
}
|
|
1112
|
+
interface AccountsResource {
|
|
1113
|
+
/** Gets information about the selected AdSense account. */
|
|
1114
|
+
get(request?: {
|
|
1115
|
+
/** V1 error format. */
|
|
1116
|
+
"$.xgafv"?: string;
|
|
1117
|
+
/** OAuth access token. */
|
|
1118
|
+
access_token?: string;
|
|
1119
|
+
/** Data format for response. */
|
|
1120
|
+
alt?: string;
|
|
1121
|
+
/** JSONP */
|
|
1122
|
+
callback?: string;
|
|
1123
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1124
|
+
fields?: string;
|
|
1125
|
+
/** 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. */
|
|
1126
|
+
key?: string;
|
|
1127
|
+
/** Required. Account to get information about. Format: accounts/{account} */
|
|
1128
|
+
name: string;
|
|
1129
|
+
/** OAuth 2.0 token for the current user. */
|
|
1130
|
+
oauth_token?: string;
|
|
1131
|
+
/** Returns response with indentations and line breaks. */
|
|
1132
|
+
prettyPrint?: boolean;
|
|
1133
|
+
/** 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. */
|
|
1134
|
+
quotaUser?: string;
|
|
1135
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1136
|
+
upload_protocol?: string;
|
|
1137
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1138
|
+
uploadType?: string;
|
|
1139
|
+
}): Request<Account>;
|
|
1140
|
+
/** Lists all accounts available to this user. */
|
|
1141
|
+
list(request?: {
|
|
1142
|
+
/** V1 error format. */
|
|
1143
|
+
"$.xgafv"?: string;
|
|
1144
|
+
/** OAuth access token. */
|
|
1145
|
+
access_token?: string;
|
|
1146
|
+
/** Data format for response. */
|
|
1147
|
+
alt?: string;
|
|
1148
|
+
/** JSONP */
|
|
1149
|
+
callback?: string;
|
|
1150
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1151
|
+
fields?: string;
|
|
1152
|
+
/** 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. */
|
|
1153
|
+
key?: string;
|
|
1154
|
+
/** OAuth 2.0 token for the current user. */
|
|
1155
|
+
oauth_token?: string;
|
|
1156
|
+
/**
|
|
1157
|
+
* The maximum number of accounts to include in the response, used for paging. If unspecified, at most 10000 accounts will be returned. The maximum value is 10000; values above
|
|
1158
|
+
* 10000 will be coerced to 10000.
|
|
1159
|
+
*/
|
|
1160
|
+
pageSize?: number;
|
|
1161
|
+
/**
|
|
1162
|
+
* A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must
|
|
1163
|
+
* match the call that provided the page token.
|
|
1164
|
+
*/
|
|
1165
|
+
pageToken?: string;
|
|
1166
|
+
/** Returns response with indentations and line breaks. */
|
|
1167
|
+
prettyPrint?: boolean;
|
|
1168
|
+
/** 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. */
|
|
1169
|
+
quotaUser?: string;
|
|
1170
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1171
|
+
upload_protocol?: string;
|
|
1172
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1173
|
+
uploadType?: string;
|
|
1174
|
+
}): Request<ListAccountsResponse>;
|
|
1175
|
+
/** Lists all accounts directly managed by the given AdSense account. */
|
|
1176
|
+
listChildAccounts(request?: {
|
|
1177
|
+
/** V1 error format. */
|
|
1178
|
+
"$.xgafv"?: string;
|
|
1179
|
+
/** OAuth access token. */
|
|
1180
|
+
access_token?: string;
|
|
1181
|
+
/** Data format for response. */
|
|
1182
|
+
alt?: string;
|
|
1183
|
+
/** JSONP */
|
|
1184
|
+
callback?: string;
|
|
1185
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1186
|
+
fields?: string;
|
|
1187
|
+
/** 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. */
|
|
1188
|
+
key?: string;
|
|
1189
|
+
/** OAuth 2.0 token for the current user. */
|
|
1190
|
+
oauth_token?: string;
|
|
1191
|
+
/**
|
|
1192
|
+
* The maximum number of accounts to include in the response, used for paging. If unspecified, at most 10000 accounts will be returned. The maximum value is 10000; values above
|
|
1193
|
+
* 10000 will be coerced to 10000.
|
|
1194
|
+
*/
|
|
1195
|
+
pageSize?: number;
|
|
1196
|
+
/**
|
|
1197
|
+
* A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must
|
|
1198
|
+
* match the call that provided the page token.
|
|
1199
|
+
*/
|
|
1200
|
+
pageToken?: string;
|
|
1201
|
+
/** Required. The parent account, which owns the child accounts. Format: accounts/{account} */
|
|
1202
|
+
parent: string;
|
|
1203
|
+
/** Returns response with indentations and line breaks. */
|
|
1204
|
+
prettyPrint?: boolean;
|
|
1205
|
+
/** 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. */
|
|
1206
|
+
quotaUser?: string;
|
|
1207
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1208
|
+
upload_protocol?: string;
|
|
1209
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1210
|
+
uploadType?: string;
|
|
1211
|
+
}): Request<ListChildAccountsResponse>;
|
|
1212
|
+
adclients: AdclientsResource;
|
|
1213
|
+
alerts: AlertsResource;
|
|
1214
|
+
payments: PaymentsResource;
|
|
1215
|
+
reports: ReportsResource;
|
|
1216
|
+
sites: SitesResource;
|
|
1217
|
+
}
|
|
1218
|
+
|
|
1219
|
+
const accounts: AccountsResource;
|
|
1220
|
+
}
|
|
1221
|
+
}
|