File

src/apis/searchconsole/v1.ts

Index

Properties
Methods

Constructor

constructor(context: APIRequestContext)
Parameters :
Name Type Optional
context APIRequestContext No

Properties

context
Type : APIRequestContext

Methods

query
query(params: Params$Resource$Searchanalytics$Query, options: StreamMethodOptions)

Query your data with filters and parameters that you define. Returns zero or more rows grouped by the row keys that you define. You must define a date range of one or more days. When date is one of the group by values, any days without data are omitted from the result list. If you need to know which days have data, issue a broad date range query grouped by date for any metric, and see which day rows are returned.

// Before running the sample:
// - Enable the API at:
//   https://console.developers.google.com/apis/api/searchconsole.googleapis.com
// - Login into gcloud by running:
//   `$ gcloud auth application-default login`
// - Install the npm module by running:
//   `$ npm install googleapis`

const {google} = require('googleapis');
const searchconsole = google.searchconsole('v1');

async function main() {
  const auth = new google.auth.GoogleAuth({
    // Scopes can be specified either as an array or as a single, space-delimited string.
    scopes: [
      'https://www.googleapis.com/auth/webmasters',
      'https://www.googleapis.com/auth/webmasters.readonly',
    ],
  });

  // Acquire an auth client, and bind it to all future calls
  const authClient = await auth.getClient();
  google.options({auth: authClient});

  // Do the magic
  const res = await webmasters.searchanalytics.query({
    // The site's URL, including protocol. For example: `http://www.example.com/`.
    siteUrl: 'placeholder-value',

    // Request body metadata
    requestBody: {
      // request body parameters
      // {
      //   "aggregationType": "my_aggregationType",
      //   "dataState": "my_dataState",
      //   "dimensionFilterGroups": [],
      //   "dimensions": [],
      //   "endDate": "my_endDate",
      //   "rowLimit": 0,
      //   "searchType": "my_searchType",
      //   "startDate": "my_startDate",
      //   "startRow": 0
      // }
    },
  });
  console.log(res.data);

  // Example response
  // {
  //   "responseAggregationType": "my_responseAggregationType",
  //   "rows": []
  // }
}

main().catch(e => {
  console.error(e);
  throw e;
});
Parameters :
Name Type Optional Description
params Params$Resource$Searchanalytics$Query No
  • Parameters for request
options StreamMethodOptions No
  • Optionally override request options, such as url, method, and encoding.
Example :
<pre><code class="language-js">// Before running the sample:
// - Enable the API at:
//   https://console.developers.google.com/apis/api/searchconsole.googleapis.com
// - Login into gcloud by running:
//   `$ gcloud auth application-default login`
// - Install the npm module by running:
//   `$ npm install googleapis`

const {google} = require(&#39;googleapis&#39;);
const searchconsole = google.searchconsole(&#39;v1&#39;);

async function main() {
  const auth = new google.auth.GoogleAuth({
    // Scopes can be specified either as an array or as a single, space-delimited string.
    scopes: [
      &#39;https://www.googleapis.com/auth/webmasters&#39;,
      &#39;https://www.googleapis.com/auth/webmasters.readonly&#39;,
    ],
  });

  // Acquire an auth client, and bind it to all future calls
  const authClient = await auth.getClient();
  google.options({auth: authClient});

  // Do the magic
  const res = await webmasters.searchanalytics.query({
    // The site&#39;s URL, including protocol. For example: `http://www.example.com/`.
    siteUrl: &#39;placeholder-value&#39;,

    // Request body metadata
    requestBody: {
      // request body parameters
      // {
      //   &quot;aggregationType&quot;: &quot;my_aggregationType&quot;,
      //   &quot;dataState&quot;: &quot;my_dataState&quot;,
      //   &quot;dimensionFilterGroups&quot;: [],
      //   &quot;dimensions&quot;: [],
      //   &quot;endDate&quot;: &quot;my_endDate&quot;,
      //   &quot;rowLimit&quot;: 0,
      //   &quot;searchType&quot;: &quot;my_searchType&quot;,
      //   &quot;startDate&quot;: &quot;my_startDate&quot;,
      //   &quot;startRow&quot;: 0
      // }
    },
  });
  console.log(res.data);

  // Example response
  // {
  //   &quot;responseAggregationType&quot;: &quot;my_responseAggregationType&quot;,
  //   &quot;rows&quot;: []
  // }
}

main().catch(e =&gt; {
  console.error(e);
  throw e;
});
</code></pre>
Returns : GaxiosPromise<Readable>

A promise if used with async/await, or void if used with a callback.

query
query(params?: Params$Resource$Searchanalytics$Query, options?: MethodOptions)
Parameters :
Name Type Optional
params Params$Resource$Searchanalytics$Query Yes
options MethodOptions Yes
query
query(params: Params$Resource$Searchanalytics$Query, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback)
Parameters :
Name Type Optional
params Params$Resource$Searchanalytics$Query No
options StreamMethodOptions | BodyResponseCallback<Readable> No
callback BodyResponseCallback<Readable> No
Returns : void
query
query(params: Params$Resource$Searchanalytics$Query, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback<Schema$SearchAnalyticsQueryResponse>)
Parameters :
Name Type Optional
params Params$Resource$Searchanalytics$Query No
options MethodOptions | BodyResponseCallback<Schema$SearchAnalyticsQueryResponse> No
callback BodyResponseCallback<Schema$SearchAnalyticsQueryResponse> No
Returns : void
query
query(params: Params$Resource$Searchanalytics$Query, callback: BodyResponseCallback<Schema$SearchAnalyticsQueryResponse>)
Returns : void
query
query(callback: BodyResponseCallback<Schema$SearchAnalyticsQueryResponse>)
Parameters :
Name Type Optional
callback BodyResponseCallback<Schema$SearchAnalyticsQueryResponse> No
Returns : void
query
query(paramsOrCallback?: Params$Resource$Searchanalytics$Query | BodyResponseCallback<Schema$SearchAnalyticsQueryResponse> | BodyResponseCallback<Readable>, optionsOrCallback?: MethodOptions | StreamMethodOptions | BodyResponseCallback | BodyResponseCallback, callback?: BodyResponseCallback<Schema$SearchAnalyticsQueryResponse> | BodyResponseCallback<Readable>)
Parameters :
Name Type Optional
paramsOrCallback Params$Resource$Searchanalytics$Query | BodyResponseCallback<Schema$SearchAnalyticsQueryResponse> | BodyResponseCallback<Readable> Yes
optionsOrCallback MethodOptions | StreamMethodOptions | BodyResponseCallback<Schema$SearchAnalyticsQueryResponse> | BodyResponseCallback<Readable> Yes
callback BodyResponseCallback<Schema$SearchAnalyticsQueryResponse> | BodyResponseCallback<Readable> Yes
Returns : void | GaxiosPromise | GaxiosPromise
import {
  OAuth2Client,
  JWT,
  Compute,
  UserRefreshClient,
  BaseExternalAccountClient,
  GaxiosPromise,
  GoogleConfigurable,
  createAPIRequest,
  MethodOptions,
  StreamMethodOptions,
  GlobalOptions,
  GoogleAuth,
  BodyResponseCallback,
  APIRequestContext,
} from 'googleapis-common';
import {Readable} from 'stream';

export namespace searchconsole_v1 {
  export interface Options extends GlobalOptions {
    version: 'v1';
  }

  interface StandardParameters {
    /**
     * Auth client or API Key for the request
     */
    auth?:
      | string
      | OAuth2Client
      | JWT
      | Compute
      | UserRefreshClient
      | BaseExternalAccountClient
      | GoogleAuth;

    /**
     * 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 API
   *
   * The Search Console API provides access to both Search Console data (verified users only) and to public information on an URL basis (anyone)
   *
   * @example
   * ```js
   * const {google} = require('googleapis');
   * const searchconsole = google.searchconsole('v1');
   * ```
   */
  export class Searchconsole {
    context: APIRequestContext;
    searchanalytics: Resource$Searchanalytics;
    sitemaps: Resource$Sitemaps;
    sites: Resource$Sites;
    urlTestingTools: Resource$Urltestingtools;

    constructor(options: GlobalOptions, google?: GoogleConfigurable) {
      this.context = {
        _options: options || {},
        google,
      };

      this.searchanalytics = new Resource$Searchanalytics(this.context);
      this.sitemaps = new Resource$Sitemaps(this.context);
      this.sites = new Resource$Sites(this.context);
      this.urlTestingTools = new Resource$Urltestingtools(this.context);
    }
  }

  export interface Schema$ApiDataRow {
    clicks?: number | null;
    ctr?: number | null;
    impressions?: number | null;
    keys?: string[] | null;
    position?: number | null;
  }
  /**
   * A filter test to be applied to each row in the data set, where a match can return the row. Filters are string comparisons, and values and dimension names are not case-sensitive. Individual filters are either AND'ed or OR'ed within their parent filter group, according to the group's group type. You do not need to group by a specified dimension to filter against it.
   */
  export interface Schema$ApiDimensionFilter {
    dimension?: string | null;
    expression?: string | null;
    operator?: string | null;
  }
  /**
   * A set of dimension value filters to test against each row. Only rows that pass all filter groups will be returned. All results within a filter group are either AND'ed or OR'ed together, depending on the group type selected. All filter groups are AND'ed together.
   */
  export interface Schema$ApiDimensionFilterGroup {
    filters?: Schema$ApiDimensionFilter[];
    groupType?: string | null;
  }
  /**
   * 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;
  }
  export interface Schema$SearchAnalyticsQueryRequest {
    /**
     * [Optional; Default is \"auto\"] How data is aggregated. If aggregated by property, all data for the same property is aggregated; if aggregated by page, all data is aggregated by canonical URI. If you filter or group by page, choose AUTO; otherwise you can aggregate either by property or by page, depending on how you want your data calculated; see the help documentation to learn how data is calculated differently by site versus by page. **Note:** If you group or filter by page, you cannot aggregate by property. If you specify any value other than AUTO, the aggregation type in the result will match the requested type, or if you request an invalid type, you will get an error. The API will never change your aggregation type if the requested type is invalid.
     */
    aggregationType?: string | null;
    /**
     * The data state to be fetched, can be full or all, the latter including full and partial data.
     */
    dataState?: string | null;
    /**
     * [Optional] Zero or more filters to apply to the dimension grouping values; for example, 'query contains \"buy\"' to see only data where the query string contains the substring \"buy\" (not case-sensitive). You can filter by a dimension without grouping by it.
     */
    dimensionFilterGroups?: Schema$ApiDimensionFilterGroup[];
    /**
     * [Optional] Zero or more dimensions to group results by. Dimensions are the group-by values in the Search Analytics page. Dimensions are combined to create a unique row key for each row. Results are grouped in the order that you supply these dimensions.
     */
    dimensions?: string[] | null;
    /**
     * [Required] End date of the requested date range, in YYYY-MM-DD format, in PST (UTC - 8:00). Must be greater than or equal to the start date. This value is included in the range.
     */
    endDate?: string | null;
    /**
     * [Optional; Default is 1000] The maximum number of rows to return. Must be a number from 1 to 25,000 (inclusive).
     */
    rowLimit?: number | null;
    /**
     * [Optional; Default is \"web\"] The search type to filter for.
     */
    searchType?: string | null;
    /**
     *  [Required] Start date of the requested date range, in YYYY-MM-DD format, in PST time (UTC - 8:00). Must be less than or equal to the end date. This value is included in the range.
     */
    startDate?: string | null;
    /**
     * [Optional; Default is 0] Zero-based index of the first row in the response. Must be a non-negative number.
     */
    startRow?: number | null;
  }
  /**
   * A list of rows, one per result, grouped by key. Metrics in each row are aggregated for all data grouped by that key either by page or property, as specified by the aggregation type parameter.
   */
  export interface Schema$SearchAnalyticsQueryResponse {
    /**
     * How the results were aggregated.
     */
    responseAggregationType?: string | null;
    /**
     * A list of rows grouped by the key values in the order given in the query.
     */
    rows?: Schema$ApiDataRow[];
  }
  /**
   * List of sitemaps.
   */
  export interface Schema$SitemapsListResponse {
    /**
     * Contains detailed information about a specific URL submitted as a [sitemap](https://support.google.com/webmasters/answer/156184).
     */
    sitemap?: Schema$WmxSitemap[];
  }
  /**
   * List of sites with access level information.
   */
  export interface Schema$SitesListResponse {
    /**
     * Contains permission level information about a Search Console site. For more information, see [Permissions in Search Console](https://support.google.com/webmasters/answer/2451999).
     */
    siteEntry?: Schema$WmxSite[];
  }
  /**
   * 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;
  }
  /**
   * Contains permission level information about a Search Console site. For more information, see [Permissions in Search Console](https://support.google.com/webmasters/answer/2451999).
   */
  export interface Schema$WmxSite {
    /**
     * The user's permission level for the site.
     */
    permissionLevel?: string | null;
    /**
     * The URL of the site.
     */
    siteUrl?: string | null;
  }
  /**
   * Contains detailed information about a specific URL submitted as a [sitemap](https://support.google.com/webmasters/answer/156184).
   */
  export interface Schema$WmxSitemap {
    /**
     * The various content types in the sitemap.
     */
    contents?: Schema$WmxSitemapContent[];
    /**
     * Number of errors in the sitemap. These are issues with the sitemap itself that need to be fixed before it can be processed correctly.
     */
    errors?: string | null;
    /**
     * If true, the sitemap has not been processed.
     */
    isPending?: boolean | null;
    /**
     * If true, the sitemap is a collection of sitemaps.
     */
    isSitemapsIndex?: boolean | null;
    /**
     * Date & time in which this sitemap was last downloaded. Date format is in RFC 3339 format (yyyy-mm-dd).
     */
    lastDownloaded?: string | null;
    /**
     * Date & time in which this sitemap was submitted. Date format is in RFC 3339 format (yyyy-mm-dd).
     */
    lastSubmitted?: string | null;
    /**
     * The url of the sitemap.
     */
    path?: string | null;
    /**
     * The type of the sitemap. For example: `rssFeed`.
     */
    type?: string | null;
    /**
     * Number of warnings for the sitemap. These are generally non-critical issues with URLs in the sitemaps.
     */
    warnings?: string | null;
  }
  /**
   * Information about the various content types in the sitemap.
   */
  export interface Schema$WmxSitemapContent {
    /**
     * The number of URLs from the sitemap that were indexed (of the content type).
     */
    indexed?: string | null;
    /**
     * The number of URLs in the sitemap (of the content type).
     */
    submitted?: string | null;
    /**
     * The specific type of content in this sitemap. For example: `web`.
     */
    type?: string | null;
  }

  export class Resource$Searchanalytics {
    context: APIRequestContext;
    constructor(context: APIRequestContext) {
      this.context = context;
    }

    /**
     * Query your data with filters and parameters that you define. Returns zero or more rows grouped by the row keys that you define. You must define a date range of one or more days. When date is one of the group by values, any days without data are omitted from the result list. If you need to know which days have data, issue a broad date range query grouped by date for any metric, and see which day rows are returned.
     * @example
     * ```js
     * // Before running the sample:
     * // - Enable the API at:
     * //   https://console.developers.google.com/apis/api/searchconsole.googleapis.com
     * // - Login into gcloud by running:
     * //   `$ gcloud auth application-default login`
     * // - Install the npm module by running:
     * //   `$ npm install googleapis`
     *
     * const {google} = require('googleapis');
     * const searchconsole = google.searchconsole('v1');
     *
     * async function main() {
     *   const auth = new google.auth.GoogleAuth({
     *     // Scopes can be specified either as an array or as a single, space-delimited string.
     *     scopes: [
     *       'https://www.googleapis.com/auth/webmasters',
     *       'https://www.googleapis.com/auth/webmasters.readonly',
     *     ],
     *   });
     *
     *   // Acquire an auth client, and bind it to all future calls
     *   const authClient = await auth.getClient();
     *   google.options({auth: authClient});
     *
     *   // Do the magic
     *   const res = await webmasters.searchanalytics.query({
     *     // The site's URL, including protocol. For example: `http://www.example.com/`.
     *     siteUrl: 'placeholder-value',
     *
     *     // Request body metadata
     *     requestBody: {
     *       // request body parameters
     *       // {
     *       //   "aggregationType": "my_aggregationType",
     *       //   "dataState": "my_dataState",
     *       //   "dimensionFilterGroups": [],
     *       //   "dimensions": [],
     *       //   "endDate": "my_endDate",
     *       //   "rowLimit": 0,
     *       //   "searchType": "my_searchType",
     *       //   "startDate": "my_startDate",
     *       //   "startRow": 0
     *       // }
     *     },
     *   });
     *   console.log(res.data);
     *
     *   // Example response
     *   // {
     *   //   "responseAggregationType": "my_responseAggregationType",
     *   //   "rows": []
     *   // }
     * }
     *
     * main().catch(e => {
     *   console.error(e);
     *   throw e;
     * });
     *
     * ```
     *
     * @param params - Parameters for request
     * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
     * @param callback - Optional callback that handles the response.
     * @returns A promise if used with async/await, or void if used with a callback.
     */
    query(
      params: Params$Resource$Searchanalytics$Query,
      options: StreamMethodOptions
    ): GaxiosPromise<Readable>;
    query(
      params?: Params$Resource$Searchanalytics$Query,
      options?: MethodOptions
    ): GaxiosPromise<Schema$SearchAnalyticsQueryResponse>;
    query(
      params: Params$Resource$Searchanalytics$Query,
      options: StreamMethodOptions | BodyResponseCallback<Readable>,
      callback: BodyResponseCallback<Readable>
    ): void;
    query(
      params: Params$Resource$Searchanalytics$Query,
      options:
        | MethodOptions
        | BodyResponseCallback<Schema$SearchAnalyticsQueryResponse>,
      callback: BodyResponseCallback<Schema$SearchAnalyticsQueryResponse>
    ): void;
    query(
      params: Params$Resource$Searchanalytics$Query,
      callback: BodyResponseCallback<Schema$SearchAnalyticsQueryResponse>
    ): void;
    query(
      callback: BodyResponseCallback<Schema$SearchAnalyticsQueryResponse>
    ): void;
    query(
      paramsOrCallback?:
        | Params$Resource$Searchanalytics$Query
        | BodyResponseCallback<Schema$SearchAnalyticsQueryResponse>
        | BodyResponseCallback<Readable>,
      optionsOrCallback?:
        | MethodOptions
        | StreamMethodOptions
        | BodyResponseCallback<Schema$SearchAnalyticsQueryResponse>
        | BodyResponseCallback<Readable>,
      callback?:
        | BodyResponseCallback<Schema$SearchAnalyticsQueryResponse>
        | BodyResponseCallback<Readable>
    ):
      | void
      | GaxiosPromise<Schema$SearchAnalyticsQueryResponse>
      | GaxiosPromise<Readable> {
      let params = (paramsOrCallback ||
        {}) as Params$Resource$Searchanalytics$Query;
      let options = (optionsOrCallback || {}) as MethodOptions;

      if (typeof paramsOrCallback === 'function') {
        callback = paramsOrCallback;
        params = {} as Params$Resource$Searchanalytics$Query;
        options = {};
      }

      if (typeof optionsOrCallback === 'function') {
        callback = optionsOrCallback;
        options = {};
      }

      const rootUrl =
        options.rootUrl || 'https://searchconsole.googleapis.com/';
      const parameters = {
        options: Object.assign(
          {
            url: (
              rootUrl + '/webmasters/v3/sites/{siteUrl}/searchAnalytics/query'
            ).replace(/([^:]\/)\/+/g, '$1'),
            method: 'POST',
          },
          options
        ),
        params,
        requiredParams: ['siteUrl'],
        pathParams: ['siteUrl'],
        context: this.context,
      };
      if (callback) {
        createAPIRequest<Schema$SearchAnalyticsQueryResponse>(
          parameters,
          callback as BodyResponseCallback<unknown>
        );
      } else {
        return createAPIRequest<Schema$SearchAnalyticsQueryResponse>(
          parameters
        );
      }
    }
  }

  export interface Params$Resource$Searchanalytics$Query
    extends StandardParameters {
    /**
     * The site's URL, including protocol. For example: `http://www.example.com/`.
     */
    siteUrl?: string;

    /**
     * Request body metadata
     */
    requestBody?: Schema$SearchAnalyticsQueryRequest;
  }

  export class Resource$Sitemaps {
    context: APIRequestContext;
    constructor(context: APIRequestContext) {
      this.context = context;
    }

    /**
     * Deletes a sitemap from this site.
     * @example
     * ```js
     * // Before running the sample:
     * // - Enable the API at:
     * //   https://console.developers.google.com/apis/api/searchconsole.googleapis.com
     * // - Login into gcloud by running:
     * //   `$ gcloud auth application-default login`
     * // - Install the npm module by running:
     * //   `$ npm install googleapis`
     *
     * const {google} = require('googleapis');
     * const searchconsole = google.searchconsole('v1');
     *
     * async function main() {
     *   const auth = new google.auth.GoogleAuth({
     *     // Scopes can be specified either as an array or as a single, space-delimited string.
     *     scopes: ['https://www.googleapis.com/auth/webmasters'],
     *   });
     *
     *   // Acquire an auth client, and bind it to all future calls
     *   const authClient = await auth.getClient();
     *   google.options({auth: authClient});
     *
     *   // Do the magic
     *   const res = await webmasters.sitemaps.delete({
     *     // The URL of the actual sitemap. For example: `http://www.example.com/sitemap.xml`.
     *     feedpath: 'placeholder-value',
     *     // The site's URL, including protocol. For example: `http://www.example.com/`.
     *     siteUrl: 'placeholder-value',
     *   });
     *   console.log(res.data);
     * }
     *
     * main().catch(e => {
     *   console.error(e);
     *   throw e;
     * });
     *
     * ```
     *
     * @param params - Parameters for request
     * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
     * @param callback - Optional callback that handles the response.
     * @returns A promise if used with async/await, or void if used with a callback.
     */
    delete(
      params: Params$Resource$Sitemaps$Delete,
      options: StreamMethodOptions
    ): GaxiosPromise<Readable>;
    delete(
      params?: Params$Resource$Sitemaps$Delete,
      options?: MethodOptions
    ): GaxiosPromise<void>;
    delete(
      params: Params$Resource$Sitemaps$Delete,
      options: StreamMethodOptions | BodyResponseCallback<Readable>,
      callback: BodyResponseCallback<Readable>
    ): void;
    delete(
      params: Params$Resource$Sitemaps$Delete,
      options: MethodOptions | BodyResponseCallback<void>,
      callback: BodyResponseCallback<void>
    ): void;
    delete(
      params: Params$Resource$Sitemaps$Delete,
      callback: BodyResponseCallback<void>
    ): void;
    delete(callback: BodyResponseCallback<void>): void;
    delete(
      paramsOrCallback?:
        | Params$Resource$Sitemaps$Delete
        | BodyResponseCallback<void>
        | BodyResponseCallback<Readable>,
      optionsOrCallback?:
        | MethodOptions
        | StreamMethodOptions
        | BodyResponseCallback<void>
        | BodyResponseCallback<Readable>,
      callback?: BodyResponseCallback<void> | BodyResponseCallback<Readable>
    ): void | GaxiosPromise<void> | GaxiosPromise<Readable> {
      let params = (paramsOrCallback || {}) as Params$Resource$Sitemaps$Delete;
      let options = (optionsOrCallback || {}) as MethodOptions;

      if (typeof paramsOrCallback === 'function') {
        callback = paramsOrCallback;
        params = {} as Params$Resource$Sitemaps$Delete;
        options = {};
      }

      if (typeof optionsOrCallback === 'function') {
        callback = optionsOrCallback;
        options = {};
      }

      const rootUrl =
        options.rootUrl || 'https://searchconsole.googleapis.com/';
      const parameters = {
        options: Object.assign(
          {
            url: (
              rootUrl + '/webmasters/v3/sites/{siteUrl}/sitemaps/{feedpath}'
            ).replace(/([^:]\/)\/+/g, '$1'),
            method: 'DELETE',
          },
          options
        ),
        params,
        requiredParams: ['siteUrl', 'feedpath'],
        pathParams: ['feedpath', 'siteUrl'],
        context: this.context,
      };
      if (callback) {
        createAPIRequest<void>(
          parameters,
          callback as BodyResponseCallback<unknown>
        );
      } else {
        return createAPIRequest<void>(parameters);
      }
    }

    /**
     * Retrieves information about a specific sitemap.
     * @example
     * ```js
     * // Before running the sample:
     * // - Enable the API at:
     * //   https://console.developers.google.com/apis/api/searchconsole.googleapis.com
     * // - Login into gcloud by running:
     * //   `$ gcloud auth application-default login`
     * // - Install the npm module by running:
     * //   `$ npm install googleapis`
     *
     * const {google} = require('googleapis');
     * const searchconsole = google.searchconsole('v1');
     *
     * async function main() {
     *   const auth = new google.auth.GoogleAuth({
     *     // Scopes can be specified either as an array or as a single, space-delimited string.
     *     scopes: [
     *       'https://www.googleapis.com/auth/webmasters',
     *       'https://www.googleapis.com/auth/webmasters.readonly',
     *     ],
     *   });
     *
     *   // Acquire an auth client, and bind it to all future calls
     *   const authClient = await auth.getClient();
     *   google.options({auth: authClient});
     *
     *   // Do the magic
     *   const res = await webmasters.sitemaps.get({
     *     // The URL of the actual sitemap. For example: `http://www.example.com/sitemap.xml`.
     *     feedpath: 'placeholder-value',
     *     // The site's URL, including protocol. For example: `http://www.example.com/`.
     *     siteUrl: 'placeholder-value',
     *   });
     *   console.log(res.data);
     *
     *   // Example response
     *   // {
     *   //   "contents": [],
     *   //   "errors": "my_errors",
     *   //   "isPending": false,
     *   //   "isSitemapsIndex": false,
     *   //   "lastDownloaded": "my_lastDownloaded",
     *   //   "lastSubmitted": "my_lastSubmitted",
     *   //   "path": "my_path",
     *   //   "type": "my_type",
     *   //   "warnings": "my_warnings"
     *   // }
     * }
     *
     * main().catch(e => {
     *   console.error(e);
     *   throw e;
     * });
     *
     * ```
     *
     * @param params - Parameters for request
     * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
     * @param callback - Optional callback that handles the response.
     * @returns A promise if used with async/await, or void if used with a callback.
     */
    get(
      params: Params$Resource$Sitemaps$Get,
      options: StreamMethodOptions
    ): GaxiosPromise<Readable>;
    get(
      params?: Params$Resource$Sitemaps$Get,
      options?: MethodOptions
    ): GaxiosPromise<Schema$WmxSitemap>;
    get(
      params: Params$Resource$Sitemaps$Get,
      options: StreamMethodOptions | BodyResponseCallback<Readable>,
      callback: BodyResponseCallback<Readable>
    ): void;
    get(
      params: Params$Resource$Sitemaps$Get,
      options: MethodOptions | BodyResponseCallback<Schema$WmxSitemap>,
      callback: BodyResponseCallback<Schema$WmxSitemap>
    ): void;
    get(
      params: Params$Resource$Sitemaps$Get,
      callback: BodyResponseCallback<Schema$WmxSitemap>
    ): void;
    get(callback: BodyResponseCallback<Schema$WmxSitemap>): void;
    get(
      paramsOrCallback?:
        | Params$Resource$Sitemaps$Get
        | BodyResponseCallback<Schema$WmxSitemap>
        | BodyResponseCallback<Readable>,
      optionsOrCallback?:
        | MethodOptions
        | StreamMethodOptions
        | BodyResponseCallback<Schema$WmxSitemap>
        | BodyResponseCallback<Readable>,
      callback?:
        | BodyResponseCallback<Schema$WmxSitemap>
        | BodyResponseCallback<Readable>
    ): void | GaxiosPromise<Schema$WmxSitemap> | GaxiosPromise<Readable> {
      let params = (paramsOrCallback || {}) as Params$Resource$Sitemaps$Get;
      let options = (optionsOrCallback || {}) as MethodOptions;

      if (typeof paramsOrCallback === 'function') {
        callback = paramsOrCallback;
        params = {} as Params$Resource$Sitemaps$Get;
        options = {};
      }

      if (typeof optionsOrCallback === 'function') {
        callback = optionsOrCallback;
        options = {};
      }

      const rootUrl =
        options.rootUrl || 'https://searchconsole.googleapis.com/';
      const parameters = {
        options: Object.assign(
          {
            url: (
              rootUrl + '/webmasters/v3/sites/{siteUrl}/sitemaps/{feedpath}'
            ).replace(/([^:]\/)\/+/g, '$1'),
            method: 'GET',
          },
          options
        ),
        params,
        requiredParams: ['siteUrl', 'feedpath'],
        pathParams: ['feedpath', 'siteUrl'],
        context: this.context,
      };
      if (callback) {
        createAPIRequest<Schema$WmxSitemap>(
          parameters,
          callback as BodyResponseCallback<unknown>
        );
      } else {
        return createAPIRequest<Schema$WmxSitemap>(parameters);
      }
    }

    /**
     *  Lists the [sitemaps-entries](/webmaster-tools/v3/sitemaps) submitted for this site, or included in the sitemap index file (if `sitemapIndex` is specified in the request).
     * @example
     * ```js
     * // Before running the sample:
     * // - Enable the API at:
     * //   https://console.developers.google.com/apis/api/searchconsole.googleapis.com
     * // - Login into gcloud by running:
     * //   `$ gcloud auth application-default login`
     * // - Install the npm module by running:
     * //   `$ npm install googleapis`
     *
     * const {google} = require('googleapis');
     * const searchconsole = google.searchconsole('v1');
     *
     * async function main() {
     *   const auth = new google.auth.GoogleAuth({
     *     // Scopes can be specified either as an array or as a single, space-delimited string.
     *     scopes: [
     *       'https://www.googleapis.com/auth/webmasters',
     *       'https://www.googleapis.com/auth/webmasters.readonly',
     *     ],
     *   });
     *
     *   // Acquire an auth client, and bind it to all future calls
     *   const authClient = await auth.getClient();
     *   google.options({auth: authClient});
     *
     *   // Do the magic
     *   const res = await webmasters.sitemaps.list({
     *     //  A URL of a site's sitemap index. For example: `http://www.example.com/sitemapindex.xml`.
     *     sitemapIndex: 'placeholder-value',
     *     // The site's URL, including protocol. For example: `http://www.example.com/`.
     *     siteUrl: 'placeholder-value',
     *   });
     *   console.log(res.data);
     *
     *   // Example response
     *   // {
     *   //   "sitemap": []
     *   // }
     * }
     *
     * main().catch(e => {
     *   console.error(e);
     *   throw e;
     * });
     *
     * ```
     *
     * @param params - Parameters for request
     * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
     * @param callback - Optional callback that handles the response.
     * @returns A promise if used with async/await, or void if used with a callback.
     */
    list(
      params: Params$Resource$Sitemaps$List,
      options: StreamMethodOptions
    ): GaxiosPromise<Readable>;
    list(
      params?: Params$Resource$Sitemaps$List,
      options?: MethodOptions
    ): GaxiosPromise<Schema$SitemapsListResponse>;
    list(
      params: Params$Resource$Sitemaps$List,
      options: StreamMethodOptions | BodyResponseCallback<Readable>,
      callback: BodyResponseCallback<Readable>
    ): void;
    list(
      params: Params$Resource$Sitemaps$List,
      options:
        | MethodOptions
        | BodyResponseCallback<Schema$SitemapsListResponse>,
      callback: BodyResponseCallback<Schema$SitemapsListResponse>
    ): void;
    list(
      params: Params$Resource$Sitemaps$List,
      callback: BodyResponseCallback<Schema$SitemapsListResponse>
    ): void;
    list(callback: BodyResponseCallback<Schema$SitemapsListResponse>): void;
    list(
      paramsOrCallback?:
        | Params$Resource$Sitemaps$List
        | BodyResponseCallback<Schema$SitemapsListResponse>
        | BodyResponseCallback<Readable>,
      optionsOrCallback?:
        | MethodOptions
        | StreamMethodOptions
        | BodyResponseCallback<Schema$SitemapsListResponse>
        | BodyResponseCallback<Readable>,
      callback?:
        | BodyResponseCallback<Schema$SitemapsListResponse>
        | BodyResponseCallback<Readable>
    ):
      | void
      | GaxiosPromise<Schema$SitemapsListResponse>
      | GaxiosPromise<Readable> {
      let params = (paramsOrCallback || {}) as Params$Resource$Sitemaps$List;
      let options = (optionsOrCallback || {}) as MethodOptions;

      if (typeof paramsOrCallback === 'function') {
        callback = paramsOrCallback;
        params = {} as Params$Resource$Sitemaps$List;
        options = {};
      }

      if (typeof optionsOrCallback === 'function') {
        callback = optionsOrCallback;
        options = {};
      }

      const rootUrl =
        options.rootUrl || 'https://searchconsole.googleapis.com/';
      const parameters = {
        options: Object.assign(
          {
            url: (rootUrl + '/webmasters/v3/sites/{siteUrl}/sitemaps').replace(
              /([^:]\/)\/+/g,
              '$1'
            ),
            method: 'GET',
          },
          options
        ),
        params,
        requiredParams: ['siteUrl'],
        pathParams: ['siteUrl'],
        context: this.context,
      };
      if (callback) {
        createAPIRequest<Schema$SitemapsListResponse>(
          parameters,
          callback as BodyResponseCallback<unknown>
        );
      } else {
        return createAPIRequest<Schema$SitemapsListResponse>(parameters);
      }
    }

    /**
     * Submits a sitemap for a site.
     * @example
     * ```js
     * // Before running the sample:
     * // - Enable the API at:
     * //   https://console.developers.google.com/apis/api/searchconsole.googleapis.com
     * // - Login into gcloud by running:
     * //   `$ gcloud auth application-default login`
     * // - Install the npm module by running:
     * //   `$ npm install googleapis`
     *
     * const {google} = require('googleapis');
     * const searchconsole = google.searchconsole('v1');
     *
     * async function main() {
     *   const auth = new google.auth.GoogleAuth({
     *     // Scopes can be specified either as an array or as a single, space-delimited string.
     *     scopes: ['https://www.googleapis.com/auth/webmasters'],
     *   });
     *
     *   // Acquire an auth client, and bind it to all future calls
     *   const authClient = await auth.getClient();
     *   google.options({auth: authClient});
     *
     *   // Do the magic
     *   const res = await webmasters.sitemaps.submit({
     *     // The URL of the actual sitemap. For example: `http://www.example.com/sitemap.xml`.
     *     feedpath: 'placeholder-value',
     *     // The site's URL, including protocol. For example: `http://www.example.com/`.
     *     siteUrl: 'placeholder-value',
     *   });
     *   console.log(res.data);
     * }
     *
     * main().catch(e => {
     *   console.error(e);
     *   throw e;
     * });
     *
     * ```
     *
     * @param params - Parameters for request
     * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
     * @param callback - Optional callback that handles the response.
     * @returns A promise if used with async/await, or void if used with a callback.
     */
    submit(
      params: Params$Resource$Sitemaps$Submit,
      options: StreamMethodOptions
    ): GaxiosPromise<Readable>;
    submit(
      params?: Params$Resource$Sitemaps$Submit,
      options?: MethodOptions
    ): GaxiosPromise<void>;
    submit(
      params: Params$Resource$Sitemaps$Submit,
      options: StreamMethodOptions | BodyResponseCallback<Readable>,
      callback: BodyResponseCallback<Readable>
    ): void;
    submit(
      params: Params$Resource$Sitemaps$Submit,
      options: MethodOptions | BodyResponseCallback<void>,
      callback: BodyResponseCallback<void>
    ): void;
    submit(
      params: Params$Resource$Sitemaps$Submit,
      callback: BodyResponseCallback<void>
    ): void;
    submit(callback: BodyResponseCallback<void>): void;
    submit(
      paramsOrCallback?:
        | Params$Resource$Sitemaps$Submit
        | BodyResponseCallback<void>
        | BodyResponseCallback<Readable>,
      optionsOrCallback?:
        | MethodOptions
        | StreamMethodOptions
        | BodyResponseCallback<void>
        | BodyResponseCallback<Readable>,
      callback?: BodyResponseCallback<void> | BodyResponseCallback<Readable>
    ): void | GaxiosPromise<void> | GaxiosPromise<Readable> {
      let params = (paramsOrCallback || {}) as Params$Resource$Sitemaps$Submit;
      let options = (optionsOrCallback || {}) as MethodOptions;

      if (typeof paramsOrCallback === 'function') {
        callback = paramsOrCallback;
        params = {} as Params$Resource$Sitemaps$Submit;
        options = {};
      }

      if (typeof optionsOrCallback === 'function') {
        callback = optionsOrCallback;
        options = {};
      }

      const rootUrl =
        options.rootUrl || 'https://searchconsole.googleapis.com/';
      const parameters = {
        options: Object.assign(
          {
            url: (
              rootUrl + '/webmasters/v3/sites/{siteUrl}/sitemaps/{feedpath}'
            ).replace(/([^:]\/)\/+/g, '$1'),
            method: 'PUT',
          },
          options
        ),
        params,
        requiredParams: ['siteUrl', 'feedpath'],
        pathParams: ['feedpath', 'siteUrl'],
        context: this.context,
      };
      if (callback) {
        createAPIRequest<void>(
          parameters,
          callback as BodyResponseCallback<unknown>
        );
      } else {
        return createAPIRequest<void>(parameters);
      }
    }
  }

  export interface Params$Resource$Sitemaps$Delete extends StandardParameters {
    /**
     * The URL of the actual sitemap. For example: `http://www.example.com/sitemap.xml`.
     */
    feedpath?: string;
    /**
     * The site's URL, including protocol. For example: `http://www.example.com/`.
     */
    siteUrl?: string;
  }
  export interface Params$Resource$Sitemaps$Get extends StandardParameters {
    /**
     * The URL of the actual sitemap. For example: `http://www.example.com/sitemap.xml`.
     */
    feedpath?: string;
    /**
     * The site's URL, including protocol. For example: `http://www.example.com/`.
     */
    siteUrl?: string;
  }
  export interface Params$Resource$Sitemaps$List extends StandardParameters {
    /**
     *  A URL of a site's sitemap index. For example: `http://www.example.com/sitemapindex.xml`.
     */
    sitemapIndex?: string;
    /**
     * The site's URL, including protocol. For example: `http://www.example.com/`.
     */
    siteUrl?: string;
  }
  export interface Params$Resource$Sitemaps$Submit extends StandardParameters {
    /**
     * The URL of the actual sitemap. For example: `http://www.example.com/sitemap.xml`.
     */
    feedpath?: string;
    /**
     * The site's URL, including protocol. For example: `http://www.example.com/`.
     */
    siteUrl?: string;
  }

  export class Resource$Sites {
    context: APIRequestContext;
    constructor(context: APIRequestContext) {
      this.context = context;
    }

    /**
     *  Adds a site to the set of the user's sites in Search Console.
     * @example
     * ```js
     * // Before running the sample:
     * // - Enable the API at:
     * //   https://console.developers.google.com/apis/api/searchconsole.googleapis.com
     * // - Login into gcloud by running:
     * //   `$ gcloud auth application-default login`
     * // - Install the npm module by running:
     * //   `$ npm install googleapis`
     *
     * const {google} = require('googleapis');
     * const searchconsole = google.searchconsole('v1');
     *
     * async function main() {
     *   const auth = new google.auth.GoogleAuth({
     *     // Scopes can be specified either as an array or as a single, space-delimited string.
     *     scopes: ['https://www.googleapis.com/auth/webmasters'],
     *   });
     *
     *   // Acquire an auth client, and bind it to all future calls
     *   const authClient = await auth.getClient();
     *   google.options({auth: authClient});
     *
     *   // Do the magic
     *   const res = await webmasters.sites.add({
     *     // The URL of the site to add.
     *     siteUrl: 'placeholder-value',
     *   });
     *   console.log(res.data);
     * }
     *
     * main().catch(e => {
     *   console.error(e);
     *   throw e;
     * });
     *
     * ```
     *
     * @param params - Parameters for request
     * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
     * @param callback - Optional callback that handles the response.
     * @returns A promise if used with async/await, or void if used with a callback.
     */
    add(
      params: Params$Resource$Sites$Add,
      options: StreamMethodOptions
    ): GaxiosPromise<Readable>;
    add(
      params?: Params$Resource$Sites$Add,
      options?: MethodOptions
    ): GaxiosPromise<void>;
    add(
      params: Params$Resource$Sites$Add,
      options: StreamMethodOptions | BodyResponseCallback<Readable>,
      callback: BodyResponseCallback<Readable>
    ): void;
    add(
      params: Params$Resource$Sites$Add,
      options: MethodOptions | BodyResponseCallback<void>,
      callback: BodyResponseCallback<void>
    ): void;
    add(
      params: Params$Resource$Sites$Add,
      callback: BodyResponseCallback<void>
    ): void;
    add(callback: BodyResponseCallback<void>): void;
    add(
      paramsOrCallback?:
        | Params$Resource$Sites$Add
        | BodyResponseCallback<void>
        | BodyResponseCallback<Readable>,
      optionsOrCallback?:
        | MethodOptions
        | StreamMethodOptions
        | BodyResponseCallback<void>
        | BodyResponseCallback<Readable>,
      callback?: BodyResponseCallback<void> | BodyResponseCallback<Readable>
    ): void | GaxiosPromise<void> | GaxiosPromise<Readable> {
      let params = (paramsOrCallback || {}) as Params$Resource$Sites$Add;
      let options = (optionsOrCallback || {}) as MethodOptions;

      if (typeof paramsOrCallback === 'function') {
        callback = paramsOrCallback;
        params = {} as Params$Resource$Sites$Add;
        options = {};
      }

      if (typeof optionsOrCallback === 'function') {
        callback = optionsOrCallback;
        options = {};
      }

      const rootUrl =
        options.rootUrl || 'https://searchconsole.googleapis.com/';
      const parameters = {
        options: Object.assign(
          {
            url: (rootUrl + '/webmasters/v3/sites/{siteUrl}').replace(
              /([^:]\/)\/+/g,
              '$1'
            ),
            method: 'PUT',
          },
          options
        ),
        params,
        requiredParams: ['siteUrl'],
        pathParams: ['siteUrl'],
        context: this.context,
      };
      if (callback) {
        createAPIRequest<void>(
          parameters,
          callback as BodyResponseCallback<unknown>
        );
      } else {
        return createAPIRequest<void>(parameters);
      }
    }

    /**
     *  Removes a site from the set of the user's Search Console sites.
     * @example
     * ```js
     * // Before running the sample:
     * // - Enable the API at:
     * //   https://console.developers.google.com/apis/api/searchconsole.googleapis.com
     * // - Login into gcloud by running:
     * //   `$ gcloud auth application-default login`
     * // - Install the npm module by running:
     * //   `$ npm install googleapis`
     *
     * const {google} = require('googleapis');
     * const searchconsole = google.searchconsole('v1');
     *
     * async function main() {
     *   const auth = new google.auth.GoogleAuth({
     *     // Scopes can be specified either as an array or as a single, space-delimited string.
     *     scopes: ['https://www.googleapis.com/auth/webmasters'],
     *   });
     *
     *   // Acquire an auth client, and bind it to all future calls
     *   const authClient = await auth.getClient();
     *   google.options({auth: authClient});
     *
     *   // Do the magic
     *   const res = await webmasters.sites.delete({
     *     // The URI of the property as defined in Search Console. **Examples:** `http://www.example.com/` or `sc-domain:example.com`.
     *     siteUrl: 'placeholder-value',
     *   });
     *   console.log(res.data);
     * }
     *
     * main().catch(e => {
     *   console.error(e);
     *   throw e;
     * });
     *
     * ```
     *
     * @param params - Parameters for request
     * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
     * @param callback - Optional callback that handles the response.
     * @returns A promise if used with async/await, or void if used with a callback.
     */
    delete(
      params: Params$Resource$Sites$Delete,
      options: StreamMethodOptions
    ): GaxiosPromise<Readable>;
    delete(
      params?: Params$Resource$Sites$Delete,
      options?: MethodOptions
    ): GaxiosPromise<void>;
    delete(
      params: Params$Resource$Sites$Delete,
      options: StreamMethodOptions | BodyResponseCallback<Readable>,
      callback: BodyResponseCallback<Readable>
    ): void;
    delete(
      params: Params$Resource$Sites$Delete,
      options: MethodOptions | BodyResponseCallback<void>,
      callback: BodyResponseCallback<void>
    ): void;
    delete(
      params: Params$Resource$Sites$Delete,
      callback: BodyResponseCallback<void>
    ): void;
    delete(callback: BodyResponseCallback<void>): void;
    delete(
      paramsOrCallback?:
        | Params$Resource$Sites$Delete
        | BodyResponseCallback<void>
        | BodyResponseCallback<Readable>,
      optionsOrCallback?:
        | MethodOptions
        | StreamMethodOptions
        | BodyResponseCallback<void>
        | BodyResponseCallback<Readable>,
      callback?: BodyResponseCallback<void> | BodyResponseCallback<Readable>
    ): void | GaxiosPromise<void> | GaxiosPromise<Readable> {
      let params = (paramsOrCallback || {}) as Params$Resource$Sites$Delete;
      let options = (optionsOrCallback || {}) as MethodOptions;

      if (typeof paramsOrCallback === 'function') {
        callback = paramsOrCallback;
        params = {} as Params$Resource$Sites$Delete;
        options = {};
      }

      if (typeof optionsOrCallback === 'function') {
        callback = optionsOrCallback;
        options = {};
      }

      const rootUrl =
        options.rootUrl || 'https://searchconsole.googleapis.com/';
      const parameters = {
        options: Object.assign(
          {
            url: (rootUrl + '/webmasters/v3/sites/{siteUrl}').replace(
              /([^:]\/)\/+/g,
              '$1'
            ),
            method: 'DELETE',
          },
          options
        ),
        params,
        requiredParams: ['siteUrl'],
        pathParams: ['siteUrl'],
        context: this.context,
      };
      if (callback) {
        createAPIRequest<void>(
          parameters,
          callback as BodyResponseCallback<unknown>
        );
      } else {
        return createAPIRequest<void>(parameters);
      }
    }

    /**
     *  Retrieves information about specific site.
     * @example
     * ```js
     * // Before running the sample:
     * // - Enable the API at:
     * //   https://console.developers.google.com/apis/api/searchconsole.googleapis.com
     * // - Login into gcloud by running:
     * //   `$ gcloud auth application-default login`
     * // - Install the npm module by running:
     * //   `$ npm install googleapis`
     *
     * const {google} = require('googleapis');
     * const searchconsole = google.searchconsole('v1');
     *
     * async function main() {
     *   const auth = new google.auth.GoogleAuth({
     *     // Scopes can be specified either as an array or as a single, space-delimited string.
     *     scopes: [
     *       'https://www.googleapis.com/auth/webmasters',
     *       'https://www.googleapis.com/auth/webmasters.readonly',
     *     ],
     *   });
     *
     *   // Acquire an auth client, and bind it to all future calls
     *   const authClient = await auth.getClient();
     *   google.options({auth: authClient});
     *
     *   // Do the magic
     *   const res = await webmasters.sites.get({
     *     // The URI of the property as defined in Search Console. **Examples:** `http://www.example.com/` or `sc-domain:example.com`.
     *     siteUrl: 'placeholder-value',
     *   });
     *   console.log(res.data);
     *
     *   // Example response
     *   // {
     *   //   "permissionLevel": "my_permissionLevel",
     *   //   "siteUrl": "my_siteUrl"
     *   // }
     * }
     *
     * main().catch(e => {
     *   console.error(e);
     *   throw e;
     * });
     *
     * ```
     *
     * @param params - Parameters for request
     * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
     * @param callback - Optional callback that handles the response.
     * @returns A promise if used with async/await, or void if used with a callback.
     */
    get(
      params: Params$Resource$Sites$Get,
      options: StreamMethodOptions
    ): GaxiosPromise<Readable>;
    get(
      params?: Params$Resource$Sites$Get,
      options?: MethodOptions
    ): GaxiosPromise<Schema$WmxSite>;
    get(
      params: Params$Resource$Sites$Get,
      options: StreamMethodOptions | BodyResponseCallback<Readable>,
      callback: BodyResponseCallback<Readable>
    ): void;
    get(
      params: Params$Resource$Sites$Get,
      options: MethodOptions | BodyResponseCallback<Schema$WmxSite>,
      callback: BodyResponseCallback<Schema$WmxSite>
    ): void;
    get(
      params: Params$Resource$Sites$Get,
      callback: BodyResponseCallback<Schema$WmxSite>
    ): void;
    get(callback: BodyResponseCallback<Schema$WmxSite>): void;
    get(
      paramsOrCallback?:
        | Params$Resource$Sites$Get
        | BodyResponseCallback<Schema$WmxSite>
        | BodyResponseCallback<Readable>,
      optionsOrCallback?:
        | MethodOptions
        | StreamMethodOptions
        | BodyResponseCallback<Schema$WmxSite>
        | BodyResponseCallback<Readable>,
      callback?:
        | BodyResponseCallback<Schema$WmxSite>
        | BodyResponseCallback<Readable>
    ): void | GaxiosPromise<Schema$WmxSite> | GaxiosPromise<Readable> {
      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://searchconsole.googleapis.com/';
      const parameters = {
        options: Object.assign(
          {
            url: (rootUrl + '/webmasters/v3/sites/{siteUrl}').replace(
              /([^:]\/)\/+/g,
              '$1'
            ),
            method: 'GET',
          },
          options
        ),
        params,
        requiredParams: ['siteUrl'],
        pathParams: ['siteUrl'],
        context: this.context,
      };
      if (callback) {
        createAPIRequest<Schema$WmxSite>(
          parameters,
          callback as BodyResponseCallback<unknown>
        );
      } else {
        return createAPIRequest<Schema$WmxSite>(parameters);
      }
    }

    /**
     *  Lists the user's Search Console sites.
     * @example
     * ```js
     * // Before running the sample:
     * // - Enable the API at:
     * //   https://console.developers.google.com/apis/api/searchconsole.googleapis.com
     * // - Login into gcloud by running:
     * //   `$ gcloud auth application-default login`
     * // - Install the npm module by running:
     * //   `$ npm install googleapis`
     *
     * const {google} = require('googleapis');
     * const searchconsole = google.searchconsole('v1');
     *
     * async function main() {
     *   const auth = new google.auth.GoogleAuth({
     *     // Scopes can be specified either as an array or as a single, space-delimited string.
     *     scopes: [
     *       'https://www.googleapis.com/auth/webmasters',
     *       'https://www.googleapis.com/auth/webmasters.readonly',
     *     ],
     *   });
     *
     *   // Acquire an auth client, and bind it to all future calls
     *   const authClient = await auth.getClient();
     *   google.options({auth: authClient});
     *
     *   // Do the magic
     *   const res = await webmasters.sites.list({});
     *   console.log(res.data);
     *
     *   // Example response
     *   // {
     *   //   "siteEntry": []
     *   // }
     * }
     *
     * main().catch(e => {
     *   console.error(e);
     *   throw e;
     * });
     *
     * ```
     *
     * @param params - Parameters for request
     * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
     * @param callback - Optional callback that handles the response.
     * @returns A promise if used with async/await, or void if used with a callback.
     */
    list(
      params: Params$Resource$Sites$List,
      options: StreamMethodOptions
    ): GaxiosPromise<Readable>;
    list(
      params?: Params$Resource$Sites$List,
      options?: MethodOptions
    ): GaxiosPromise<Schema$SitesListResponse>;
    list(
      params: Params$Resource$Sites$List,
      options: StreamMethodOptions | BodyResponseCallback<Readable>,
      callback: BodyResponseCallback<Readable>
    ): void;
    list(
      params: Params$Resource$Sites$List,
      options: MethodOptions | BodyResponseCallback<Schema$SitesListResponse>,
      callback: BodyResponseCallback<Schema$SitesListResponse>
    ): void;
    list(
      params: Params$Resource$Sites$List,
      callback: BodyResponseCallback<Schema$SitesListResponse>
    ): void;
    list(callback: BodyResponseCallback<Schema$SitesListResponse>): void;
    list(
      paramsOrCallback?:
        | Params$Resource$Sites$List
        | BodyResponseCallback<Schema$SitesListResponse>
        | BodyResponseCallback<Readable>,
      optionsOrCallback?:
        | MethodOptions
        | StreamMethodOptions
        | BodyResponseCallback<Schema$SitesListResponse>
        | BodyResponseCallback<Readable>,
      callback?:
        | BodyResponseCallback<Schema$SitesListResponse>
        | BodyResponseCallback<Readable>
    ):
      | void
      | GaxiosPromise<Schema$SitesListResponse>
      | GaxiosPromise<Readable> {
      let params = (paramsOrCallback || {}) as Params$Resource$Sites$List;
      let options = (optionsOrCallback || {}) as MethodOptions;

      if (typeof paramsOrCallback === 'function') {
        callback = paramsOrCallback;
        params = {} as Params$Resource$Sites$List;
        options = {};
      }

      if (typeof optionsOrCallback === 'function') {
        callback = optionsOrCallback;
        options = {};
      }

      const rootUrl =
        options.rootUrl || 'https://searchconsole.googleapis.com/';
      const parameters = {
        options: Object.assign(
          {
            url: (rootUrl + '/webmasters/v3/sites').replace(
              /([^:]\/)\/+/g,
              '$1'
            ),
            method: 'GET',
          },
          options
        ),
        params,
        requiredParams: [],
        pathParams: [],
        context: this.context,
      };
      if (callback) {
        createAPIRequest<Schema$SitesListResponse>(
          parameters,
          callback as BodyResponseCallback<unknown>
        );
      } else {
        return createAPIRequest<Schema$SitesListResponse>(parameters);
      }
    }
  }

  export interface Params$Resource$Sites$Add extends StandardParameters {
    /**
     * The URL of the site to add.
     */
    siteUrl?: string;
  }
  export interface Params$Resource$Sites$Delete extends StandardParameters {
    /**
     * The URI of the property as defined in Search Console. **Examples:** `http://www.example.com/` or `sc-domain:example.com`.
     */
    siteUrl?: string;
  }
  export interface Params$Resource$Sites$Get extends StandardParameters {
    /**
     * The URI of the property as defined in Search Console. **Examples:** `http://www.example.com/` or `sc-domain:example.com`.
     */
    siteUrl?: string;
  }
  export interface Params$Resource$Sites$List extends StandardParameters {}

  export class Resource$Urltestingtools {
    context: APIRequestContext;
    mobileFriendlyTest: Resource$Urltestingtools$Mobilefriendlytest;
    constructor(context: APIRequestContext) {
      this.context = context;
      this.mobileFriendlyTest = new Resource$Urltestingtools$Mobilefriendlytest(
        this.context
      );
    }
  }

  export class Resource$Urltestingtools$Mobilefriendlytest {
    context: APIRequestContext;
    constructor(context: APIRequestContext) {
      this.context = context;
    }

    /**
     * Runs Mobile-Friendly Test for a given URL.
     * @example
     * ```js
     * // Before running the sample:
     * // - Enable the API at:
     * //   https://console.developers.google.com/apis/api/searchconsole.googleapis.com
     * // - Login into gcloud by running:
     * //   `$ gcloud auth application-default login`
     * // - Install the npm module by running:
     * //   `$ npm install googleapis`
     *
     * const {google} = require('googleapis');
     * const searchconsole = google.searchconsole('v1');
     *
     * async function main() {
     *   const auth = new google.auth.GoogleAuth({
     *     // Scopes can be specified either as an array or as a single, space-delimited string.
     *     scopes: [],
     *   });
     *
     *   // Acquire an auth client, and bind it to all future calls
     *   const authClient = await auth.getClient();
     *   google.options({auth: authClient});
     *
     *   // Do the magic
     *   const res = await searchconsole.urlTestingTools.mobileFriendlyTest.run({
     *     // Request body metadata
     *     requestBody: {
     *       // request body parameters
     *       // {
     *       //   "requestScreenshot": false,
     *       //   "url": "my_url"
     *       // }
     *     },
     *   });
     *   console.log(res.data);
     *
     *   // Example response
     *   // {
     *   //   "mobileFriendliness": "my_mobileFriendliness",
     *   //   "mobileFriendlyIssues": [],
     *   //   "resourceIssues": [],
     *   //   "screenshot": {},
     *   //   "testStatus": {}
     *   // }
     * }
     *
     * main().catch(e => {
     *   console.error(e);
     *   throw e;
     * });
     *
     * ```
     *
     * @param params - Parameters for request
     * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
     * @param callback - Optional callback that handles the response.
     * @returns A promise if used with async/await, or void if used with a callback.
     */
    run(
      params: Params$Resource$Urltestingtools$Mobilefriendlytest$Run,
      options: StreamMethodOptions
    ): GaxiosPromise<Readable>;
    run(
      params?: Params$Resource$Urltestingtools$Mobilefriendlytest$Run,
      options?: MethodOptions
    ): GaxiosPromise<Schema$RunMobileFriendlyTestResponse>;
    run(
      params: Params$Resource$Urltestingtools$Mobilefriendlytest$Run,
      options: StreamMethodOptions | BodyResponseCallback<Readable>,
      callback: BodyResponseCallback<Readable>
    ): void;
    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;
    run(
      paramsOrCallback?:
        | Params$Resource$Urltestingtools$Mobilefriendlytest$Run
        | BodyResponseCallback<Schema$RunMobileFriendlyTestResponse>
        | BodyResponseCallback<Readable>,
      optionsOrCallback?:
        | MethodOptions
        | StreamMethodOptions
        | BodyResponseCallback<Schema$RunMobileFriendlyTestResponse>
        | BodyResponseCallback<Readable>,
      callback?:
        | BodyResponseCallback<Schema$RunMobileFriendlyTestResponse>
        | BodyResponseCallback<Readable>
    ):
      | void
      | GaxiosPromise<Schema$RunMobileFriendlyTestResponse>
      | GaxiosPromise<Readable> {
      let params = (paramsOrCallback ||
        {}) as Params$Resource$Urltestingtools$Mobilefriendlytest$Run;
      let options = (optionsOrCallback || {}) as MethodOptions;

      if (typeof paramsOrCallback === 'function') {
        callback = paramsOrCallback;
        params = {} as Params$Resource$Urltestingtools$Mobilefriendlytest$Run;
        options = {};
      }

      if (typeof optionsOrCallback === 'function') {
        callback = optionsOrCallback;
        options = {};
      }

      const rootUrl =
        options.rootUrl || 'https://searchconsole.googleapis.com/';
      const parameters = {
        options: Object.assign(
          {
            url: (
              rootUrl + '/v1/urlTestingTools/mobileFriendlyTest:run'
            ).replace(/([^:]\/)\/+/g, '$1'),
            method: 'POST',
          },
          options
        ),
        params,
        requiredParams: [],
        pathParams: [],
        context: this.context,
      };
      if (callback) {
        createAPIRequest<Schema$RunMobileFriendlyTestResponse>(
          parameters,
          callback as BodyResponseCallback<unknown>
        );
      } else {
        return createAPIRequest<Schema$RunMobileFriendlyTestResponse>(
          parameters
        );
      }
    }
  }

  export interface Params$Resource$Urltestingtools$Mobilefriendlytest$Run
    extends StandardParameters {
    /**
     * Request body metadata
     */
    requestBody?: Schema$RunMobileFriendlyTestRequest;
  }
}

result-matching ""

    No results matching ""