/
v1.ts
295 lines (266 loc) · 9.97 KB
/
v1.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
/**
* Copyright 2015 Google Inc. All Rights Reserved.
*
* 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 {AxiosPromise} from 'axios';
import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library';
import {BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from '../../shared/src';
// tslint:disable: no-any
// tslint:disable: class-name
// tslint:disable: variable-name
// tslint:disable: jsdoc-format
// tslint:disable: no-namespace
export namespace abusiveexperiencereport_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
/**
* Abusive Experience Report API
*
* View Abusive Experience Report data, and get a list of sites that have a
* significant number of abusive experiences.
*
* @example
* const {google} = require('googleapis');
* const abusiveexperiencereport = google.abusiveexperiencereport('v1');
*
* @namespace abusiveexperiencereport
* @type {Function}
* @version v1
* @variation v1
* @param {object=} options Options for Abusiveexperiencereport
*/
export class Abusiveexperiencereport {
_options: GlobalOptions;
google?: GoogleConfigurable;
root = this;
sites: Resource$Sites;
violatingSites: Resource$Violatingsites;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
this._options = options || {};
this.google = google;
this.getRoot.bind(this);
this.sites = new Resource$Sites(this);
this.violatingSites = new Resource$Violatingsites(this);
}
getRoot() {
return this.root;
}
}
/**
* Response message for GetSiteSummary. Do not confuse with same message in
* google.ads.experiencereport.v1
*/
export interface Schema$SiteSummaryResponse {
/**
* The status of the site reviewed for the abusive experiences.
*/
abusiveStatus?: string;
/**
* The date on which enforcement begins.
*/
enforcementTime?: string;
/**
* The abusive experience enforcement status of the site.
*/
filterStatus?: string;
/**
* The last time that the site changed status.
*/
lastChangeTime?: string;
/**
* A link that leads to a full abusive experience report.
*/
reportUrl?: string;
/**
* The name of the site reviewed.
*/
reviewedSite?: string;
/**
* Whether the site is currently under review.
*/
underReview?: boolean;
}
/**
* Response message for ListViolatingSites.
*/
export interface Schema$ViolatingSitesResponse {
/**
* A list of summaries of violating sites.
*/
violatingSites?: Schema$SiteSummaryResponse[];
}
export class Resource$Sites {
root: Abusiveexperiencereport;
constructor(root: Abusiveexperiencereport) {
this.root = root;
this.getRoot.bind(this);
}
getRoot() {
return this.root;
}
/**
* abusiveexperiencereport.sites.get
* @desc Gets a summary of the abusive experience rating of a site.
* @alias abusiveexperiencereport.sites.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The required site name. This is the site property whose abusive experiences have been reviewed, and it must be URL-encoded. For example, sites/https%3A%2F%2Fwww.google.com. The server will return an error of BAD_REQUEST if this field is not filled in. Note that if the site property is not yet verified in Search Console, the reportUrl field returned by the API will lead to the verification page, prompting the user to go through that process before they can gain access to the Abusive Experience Report.
* @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$Sites$Get,
options?: MethodOptions): AxiosPromise<Schema$SiteSummaryResponse>;
get(params: Params$Resource$Sites$Get,
options: MethodOptions|BodyResponseCallback<Schema$SiteSummaryResponse>,
callback: BodyResponseCallback<Schema$SiteSummaryResponse>): void;
get(params: Params$Resource$Sites$Get,
callback: BodyResponseCallback<Schema$SiteSummaryResponse>): void;
get(callback: BodyResponseCallback<Schema$SiteSummaryResponse>): void;
get(paramsOrCallback?: Params$Resource$Sites$Get|
BodyResponseCallback<Schema$SiteSummaryResponse>,
optionsOrCallback?: MethodOptions|
BodyResponseCallback<Schema$SiteSummaryResponse>,
callback?: BodyResponseCallback<Schema$SiteSummaryResponse>):
void|AxiosPromise<Schema$SiteSummaryResponse> {
let params = (paramsOrCallback || {}) as Params$Resource$Sites$Get;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Sites$Get;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl =
options.rootUrl || 'https://abusiveexperiencereport.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'),
method: 'GET'
},
options),
params,
requiredParams: ['name'],
pathParams: ['name'],
context: this.getRoot()
};
if (callback) {
createAPIRequest<Schema$SiteSummaryResponse>(parameters, callback);
} else {
return createAPIRequest<Schema$SiteSummaryResponse>(parameters);
}
}
}
export interface Params$Resource$Sites$Get {
/**
* Auth client or API Key for the request
*/
auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient;
/**
* The required site name. This is the site property whose abusive
* experiences have been reviewed, and it must be URL-encoded. For example,
* sites/https%3A%2F%2Fwww.google.com. The server will return an error of
* BAD_REQUEST if this field is not filled in. Note that if the site
* property is not yet verified in Search Console, the reportUrl field
* returned by the API will lead to the verification page, prompting the
* user to go through that process before they can gain access to the
* Abusive Experience Report.
*/
name?: string;
}
export class Resource$Violatingsites {
root: Abusiveexperiencereport;
constructor(root: Abusiveexperiencereport) {
this.root = root;
this.getRoot.bind(this);
}
getRoot() {
return this.root;
}
/**
* abusiveexperiencereport.violatingSites.list
* @desc Lists sites with Abusive Experience Report statuses of "Failing".
* @alias abusiveexperiencereport.violatingSites.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @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$Violatingsites$List, options?: MethodOptions):
AxiosPromise<Schema$ViolatingSitesResponse>;
list(
params: Params$Resource$Violatingsites$List,
options: MethodOptions|
BodyResponseCallback<Schema$ViolatingSitesResponse>,
callback: BodyResponseCallback<Schema$ViolatingSitesResponse>): void;
list(
params: Params$Resource$Violatingsites$List,
callback: BodyResponseCallback<Schema$ViolatingSitesResponse>): void;
list(callback: BodyResponseCallback<Schema$ViolatingSitesResponse>): void;
list(
paramsOrCallback?: Params$Resource$Violatingsites$List|
BodyResponseCallback<Schema$ViolatingSitesResponse>,
optionsOrCallback?: MethodOptions|
BodyResponseCallback<Schema$ViolatingSitesResponse>,
callback?: BodyResponseCallback<Schema$ViolatingSitesResponse>):
void|AxiosPromise<Schema$ViolatingSitesResponse> {
let params =
(paramsOrCallback || {}) as Params$Resource$Violatingsites$List;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Violatingsites$List;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl =
options.rootUrl || 'https://abusiveexperiencereport.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/violatingSites')
.replace(/([^:]\/)\/+/g, '$1'),
method: 'GET'
},
options),
params,
requiredParams: [],
pathParams: [],
context: this.getRoot()
};
if (callback) {
createAPIRequest<Schema$ViolatingSitesResponse>(parameters, callback);
} else {
return createAPIRequest<Schema$ViolatingSitesResponse>(parameters);
}
}
}
export interface Params$Resource$Violatingsites$List {
/**
* Auth client or API Key for the request
*/
auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient;
}
}