v1.d.ts
7.3 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
/**
* 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 { OAuth2Client, JWT, Compute, UserRefreshClient } from 'google-auth-library';
import { GoogleConfigurable, MethodOptions, GlobalOptions, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { GaxiosPromise } from 'gaxios';
export declare namespace searchconsole_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: 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;
/**
* 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.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Google Search Console URL Testing Tools API
*
* Provides tools for running validation tests against single URLs
*
* @example
* const {google} = require('googleapis');
* const searchconsole = google.searchconsole('v1');
*
* @namespace searchconsole
* @type {Function}
* @version v1
* @variation v1
* @param {object=} options Options for Searchconsole
*/
export class Searchconsole {
context: APIRequestContext;
urlTestingTools: Resource$Urltestingtools;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Blocked resource.
*/
export interface Schema$BlockedResource {
/**
* URL of the blocked resource.
*/
url?: string | null;
}
/**
* Describe image data.
*/
export interface Schema$Image {
/**
* Image data in format determined by the mime type. Currently, the format will always be "image/png", but this might change in the future.
*/
data?: string | null;
/**
* The mime-type of the image data.
*/
mimeType?: string | null;
}
/**
* Mobile-friendly issue.
*/
export interface Schema$MobileFriendlyIssue {
/**
* Rule violated.
*/
rule?: string | null;
}
/**
* Information about a resource with issue.
*/
export interface Schema$ResourceIssue {
/**
* Describes a blocked resource issue.
*/
blockedResource?: Schema$BlockedResource;
}
/**
* Mobile-friendly test request.
*/
export interface Schema$RunMobileFriendlyTestRequest {
/**
* Whether or not screenshot is requested. Default is false.
*/
requestScreenshot?: boolean | null;
/**
* URL for inspection.
*/
url?: string | null;
}
/**
* Mobile-friendly test response, including mobile-friendly issues and resource issues.
*/
export interface Schema$RunMobileFriendlyTestResponse {
/**
* Test verdict, whether the page is mobile friendly or not.
*/
mobileFriendliness?: string | null;
/**
* List of mobile-usability issues.
*/
mobileFriendlyIssues?: Schema$MobileFriendlyIssue[];
/**
* Information about embedded resources issues.
*/
resourceIssues?: Schema$ResourceIssue[];
/**
* Screenshot of the requested URL.
*/
screenshot?: Schema$Image;
/**
* Final state of the test, can be either complete or an error.
*/
testStatus?: Schema$TestStatus;
}
/**
* Final state of the test, including error details if necessary.
*/
export interface Schema$TestStatus {
/**
* Error details if applicable.
*/
details?: string | null;
/**
* Status of the test.
*/
status?: string | null;
}
export class Resource$Urltestingtools {
context: APIRequestContext;
mobileFriendlyTest: Resource$Urltestingtools$Mobilefriendlytest;
constructor(context: APIRequestContext);
}
export class Resource$Urltestingtools$Mobilefriendlytest {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* searchconsole.urlTestingTools.mobileFriendlyTest.run
* @desc Runs Mobile-Friendly Test for a given URL.
* @alias searchconsole.urlTestingTools.mobileFriendlyTest.run
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {().RunMobileFriendlyTestRequest} 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
*/
run(params?: Params$Resource$Urltestingtools$Mobilefriendlytest$Run, options?: MethodOptions): GaxiosPromise<Schema$RunMobileFriendlyTestResponse>;
run(params: Params$Resource$Urltestingtools$Mobilefriendlytest$Run, options: MethodOptions | BodyResponseCallback<Schema$RunMobileFriendlyTestResponse>, callback: BodyResponseCallback<Schema$RunMobileFriendlyTestResponse>): void;
run(params: Params$Resource$Urltestingtools$Mobilefriendlytest$Run, callback: BodyResponseCallback<Schema$RunMobileFriendlyTestResponse>): void;
run(callback: BodyResponseCallback<Schema$RunMobileFriendlyTestResponse>): void;
}
export interface Params$Resource$Urltestingtools$Mobilefriendlytest$Run extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Request body metadata
*/
requestBody?: Schema$RunMobileFriendlyTestRequest;
}
export {};
}