v1.d.ts
10.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
/**
* Copyright 2019 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { GaxiosPromise } from 'gaxios';
import { Compute, JWT, OAuth2Client, UserRefreshClient } from 'google-auth-library';
import { APIRequestContext, BodyResponseCallback, GlobalOptions, GoogleConfigurable, MethodOptions } from 'googleapis-common';
export declare namespace urlshortener_v1 {
interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* Data format for the response.
*/
alt?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* 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.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* An opaque string that represents a user for quota purposes. Must not
* exceed 40 characters.
*/
quotaUser?: string;
/**
* Deprecated. Please use quotaUser instead.
*/
userIp?: string;
}
/**
* URL Shortener API
*
* Lets you create, inspect, and manage goo.gl short URLs
*
* @example
* const {google} = require('googleapis');
* const urlshortener = google.urlshortener('v1');
*
* @namespace urlshortener
* @type {Function}
* @version v1
* @variation v1
* @param {object=} options Options for Urlshortener
*/
class Urlshortener {
context: APIRequestContext;
url: Resource$Url;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
interface Schema$AnalyticsSnapshot {
/**
* Top browsers, e.g. "Chrome"; sorted by (descending) click
* counts. Only present if this data is available.
*/
browsers?: Schema$StringCount[];
/**
* Top countries (expressed as country codes), e.g. "US" or
* "DE"; sorted by (descending) click counts. Only present if this
* data is available.
*/
countries?: Schema$StringCount[];
/**
* Number of clicks on all goo.gl short URLs pointing to this long URL.
*/
longUrlClicks?: string;
/**
* Top platforms or OSes, e.g. "Windows"; sorted by (descending)
* click counts. Only present if this data is available.
*/
platforms?: Schema$StringCount[];
/**
* Top referring hosts, e.g. "www.google.com"; sorted by
* (descending) click counts. Only present if this data is available.
*/
referrers?: Schema$StringCount[];
/**
* Number of clicks on this short URL.
*/
shortUrlClicks?: string;
}
interface Schema$AnalyticsSummary {
/**
* Click analytics over all time.
*/
allTime?: Schema$AnalyticsSnapshot;
/**
* Click analytics over the last day.
*/
day?: Schema$AnalyticsSnapshot;
/**
* Click analytics over the last month.
*/
month?: Schema$AnalyticsSnapshot;
/**
* Click analytics over the last two hours.
*/
twoHours?: Schema$AnalyticsSnapshot;
/**
* Click analytics over the last week.
*/
week?: Schema$AnalyticsSnapshot;
}
interface Schema$StringCount {
/**
* Number of clicks for this top entry, e.g. for this particular country or
* browser.
*/
count?: string;
/**
* Label assigned to this top entry, e.g. "US" or
* "Chrome".
*/
id?: string;
}
interface Schema$Url {
/**
* A summary of the click analytics for the short and long URL. Might not be
* present if not requested or currently unavailable.
*/
analytics?: Schema$AnalyticsSummary;
/**
* Time the short URL was created; ISO 8601 representation using the
* yyyy-MM-dd'T'HH:mm:ss.SSSZZ format, e.g.
* "2010-10-14T19:01:24.944+00:00".
*/
created?: string;
/**
* Short URL, e.g. "http://goo.gl/l6MS".
*/
id?: string;
/**
* The fixed string "urlshortener#url".
*/
kind?: string;
/**
* Long URL, e.g. "http://www.google.com/". Might not be present
* if the status is "REMOVED".
*/
longUrl?: string;
/**
* Status of the target URL. Possible values: "OK",
* "MALWARE", "PHISHING", or "REMOVED". A URL
* might be marked "REMOVED" if it was flagged as spam, for
* example.
*/
status?: string;
}
interface Schema$UrlHistory {
/**
* A list of URL resources.
*/
items?: Schema$Url[];
/**
* Number of items returned with each full "page" of results. Note
* that the last page could have fewer items than the
* "itemsPerPage" value.
*/
itemsPerPage?: number;
/**
* The fixed string "urlshortener#urlHistory".
*/
kind?: string;
/**
* A token to provide to get the next page of results.
*/
nextPageToken?: string;
/**
* Total number of short URLs associated with this user (may be
* approximate).
*/
totalItems?: number;
}
class Resource$Url {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* urlshortener.url.get
* @desc Expands a short URL or gets creation time and analytics.
* @alias urlshortener.url.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.projection Additional information to return.
* @param {string} params.shortUrl The short URL, including the protocol.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Url$Get, options?: MethodOptions): GaxiosPromise<Schema$Url>;
get(params: Params$Resource$Url$Get, options: MethodOptions | BodyResponseCallback<Schema$Url>, callback: BodyResponseCallback<Schema$Url>): void;
get(params: Params$Resource$Url$Get, callback: BodyResponseCallback<Schema$Url>): void;
get(callback: BodyResponseCallback<Schema$Url>): void;
/**
* urlshortener.url.insert
* @desc Creates a new short URL.
* @alias urlshortener.url.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {().Url} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
insert(params?: Params$Resource$Url$Insert, options?: MethodOptions): GaxiosPromise<Schema$Url>;
insert(params: Params$Resource$Url$Insert, options: MethodOptions | BodyResponseCallback<Schema$Url>, callback: BodyResponseCallback<Schema$Url>): void;
insert(params: Params$Resource$Url$Insert, callback: BodyResponseCallback<Schema$Url>): void;
insert(callback: BodyResponseCallback<Schema$Url>): void;
/**
* urlshortener.url.list
* @desc Retrieves a list of URLs shortened by a user.
* @alias urlshortener.url.list
* @memberOf! ()
*
* @param {object=} params Parameters for request
* @param {string=} params.projection Additional information to return.
* @param {string=} params.start-token Token for requesting successive pages of results.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Url$List, options?: MethodOptions): GaxiosPromise<Schema$UrlHistory>;
list(params: Params$Resource$Url$List, options: MethodOptions | BodyResponseCallback<Schema$UrlHistory>, callback: BodyResponseCallback<Schema$UrlHistory>): void;
list(params: Params$Resource$Url$List, callback: BodyResponseCallback<Schema$UrlHistory>): void;
list(callback: BodyResponseCallback<Schema$UrlHistory>): void;
}
interface Params$Resource$Url$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Additional information to return.
*/
projection?: string;
/**
* The short URL, including the protocol.
*/
shortUrl?: string;
}
interface Params$Resource$Url$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Request body metadata
*/
requestBody?: Schema$Url;
}
interface Params$Resource$Url$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Additional information to return.
*/
projection?: string;
/**
* Token for requesting successive pages of results.
*/
'start-token'?: string;
}
}