/** * 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 { BodyResponseCallback, GlobalOptions, GoogleConfigurable, MethodOptions } from 'googleapis-common'; export declare namespace searchconsole_v1 { 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 */ class Searchconsole { urlTestingTools: Resource$Urltestingtools; constructor(options: GlobalOptions, google?: GoogleConfigurable); } /** * Blocked resource. */ interface Schema$BlockedResource { /** * URL of the blocked resource. */ url?: string; } /** * Describe image data. */ 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; /** * The mime-type of the image data. */ mimeType?: string; } /** * Mobile-friendly issue. */ interface Schema$MobileFriendlyIssue { /** * Rule violated. */ rule?: string; } /** * Information about a resource with issue. */ interface Schema$ResourceIssue { /** * Describes a blocked resource issue. */ blockedResource?: Schema$BlockedResource; } /** * Mobile-friendly test request. */ interface Schema$RunMobileFriendlyTestRequest { /** * Whether or not screenshot is requested. Default is false. */ requestScreenshot?: boolean; /** * URL for inspection. */ url?: string; } /** * Mobile-friendly test response, including mobile-friendly issues and * resource issues. */ interface Schema$RunMobileFriendlyTestResponse { /** * Test verdict, whether the page is mobile friendly or not. */ mobileFriendliness?: string; /** * 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. */ interface Schema$TestStatus { /** * Error details if applicable. */ details?: string; /** * Status of the test. */ status?: string; } class Resource$Urltestingtools { mobileFriendlyTest: Resource$Urltestingtools$Mobilefriendlytest; constructor(); } class Resource$Urltestingtools$Mobilefriendlytest { constructor(); /** * 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; run(params: Params$Resource$Urltestingtools$Mobilefriendlytest$Run, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; run(params: Params$Resource$Urltestingtools$Mobilefriendlytest$Run, callback: BodyResponseCallback): void; run(callback: BodyResponseCallback): void; } 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; } }