0.0.20241102 • Published 10 months ago

@maxim_mazurok/gapi.client.searchconsole-v1 v0.0.20241102

Weekly downloads
-
License
MIT
Repository
github
Last release
10 months ago

TypeScript typings for Google Search Console API v1

The Search Console API provides access to both Search Console data (verified users only) and to public information on an URL basis (anyone) For detailed description please check documentation.

Installing

Install typings for Google Search Console API:

npm install @types/gapi.client.searchconsole-v1 --save-dev

Usage

You need to initialize Google API client in your code:

gapi.load('client', () => {
  // now we can use gapi.client
  // ...
});

Then load api client wrapper:

gapi.client.load(
  'https://searchconsole.googleapis.com/$discovery/rest?version=v1',
  () => {
    // now we can use:
    // gapi.client.searchconsole
    // gapi.client.webmasters
  }
);
// Deprecated, use discovery document URL, see https://github.com/google/google-api-javascript-client/blob/master/docs/reference.md#----gapiclientloadname----version----callback--
gapi.client.load('searchconsole', 'v1', () => {
  // now we can use:
  // gapi.client.searchconsole
  // gapi.client.webmasters
});

Don't forget to authenticate your client before sending any request to resources:

// declare client_id registered in Google Developers Console
var client_id = '',
  scope = [
    // View and manage Search Console data for your verified sites
    'https://www.googleapis.com/auth/webmasters',

    // View Search Console data for your verified sites
    'https://www.googleapis.com/auth/webmasters.readonly',
  ],
  immediate = true;
// ...

gapi.auth.authorize(
  {client_id: client_id, scope: scope, immediate: immediate},
  authResult => {
    if (authResult && !authResult.error) {
      /* handle successful authorization */
    } else {
      /* handle authorization error */
    }
  }
);

After that you can use Google Search Console API resources:

/*
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.
*/
await gapi.client.webmasters.searchanalytics.query({siteUrl: 'siteUrl'});

/*
Deletes a sitemap from the Sitemaps report. Does not stop Google from crawling this sitemap or the URLs that were previously crawled in the deleted sitemap.
*/
await gapi.client.webmasters.sitemaps.delete({
  feedpath: 'feedpath',
  siteUrl: 'siteUrl',
});

/*
Retrieves information about a specific sitemap.
*/
await gapi.client.webmasters.sitemaps.get({
  feedpath: 'feedpath',
  siteUrl: 'siteUrl',
});

/*
 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).
*/
await gapi.client.webmasters.sitemaps.list({siteUrl: 'siteUrl'});

/*
Submits a sitemap for a site.
*/
await gapi.client.webmasters.sitemaps.submit({
  feedpath: 'feedpath',
  siteUrl: 'siteUrl',
});

/*
 Adds a site to the set of the user's sites in Search Console.
*/
await gapi.client.webmasters.sites.add({siteUrl: 'siteUrl'});

/*
 Removes a site from the set of the user's Search Console sites.
*/
await gapi.client.webmasters.sites.delete({siteUrl: 'siteUrl'});

/*
 Retrieves information about specific site.
*/
await gapi.client.webmasters.sites.get({siteUrl: 'siteUrl'});

/*
 Lists the user's Search Console sites.
*/
await gapi.client.webmasters.sites.list({});
0.0.20241102

10 months ago

0.0.20241023

10 months ago

0.0.20241030

10 months ago

0.0.20241029

10 months ago

0.0.20241027

10 months ago

0.0.20241014

10 months ago

0.0.20240929

11 months ago

0.0.20240925

11 months ago

0.0.20240928

11 months ago

0.0.20240930

11 months ago

0.0.20241013

10 months ago

0.0.20241012

10 months ago

0.0.20241008

11 months ago

0.0.20241007

11 months ago

0.0.20240907

12 months ago

0.0.20240908

12 months ago

0.0.20240909

12 months ago

0.0.20240914

11 months ago

0.0.20240916

11 months ago

0.0.20240917

11 months ago

0.0.20240922

11 months ago

0.0.20240923

11 months ago

0.0.20240924

11 months ago

0.0.20240903

12 months ago

0.0.20240904

12 months ago

0.0.20240901

12 months ago

0.0.20240902

12 months ago

0.0.20240827

12 months ago

0.0.20240828

12 months ago

0.0.20240831

12 months ago

0.0.20240826

12 months ago

0.0.20240825

12 months ago

0.0.20240727

1 year ago

0.0.20240728

1 year ago

0.0.20240729

1 year ago

0.0.20240608

1 year ago

0.0.20240723

1 year ago

0.0.20240602

1 year ago

0.0.20240724

1 year ago

0.0.20240603

1 year ago

0.0.20240604

1 year ago

0.0.20240605

1 year ago

0.0.20240720

1 year ago

0.0.20240722

1 year ago

0.0.20240601

1 year ago

0.0.20240617

1 year ago

0.0.20240618

1 year ago

0.0.20240619

1 year ago

0.0.20240615

1 year ago

0.0.20240616

1 year ago

0.0.20240730

1 year ago

0.0.20240731

1 year ago

0.0.20240629

1 year ago

0.0.20240624

1 year ago

0.0.20240625

1 year ago

0.0.20240626

1 year ago

0.0.20240623

1 year ago

0.0.20240529

1 year ago

0.0.20240525

1 year ago

0.0.20240526

1 year ago

0.0.20240527

1 year ago

0.0.20240528

1 year ago

0.0.20240521

1 year ago

0.0.20240522

1 year ago

0.0.20240804

1 year ago

0.0.20240805

1 year ago

0.0.20240806

1 year ago

0.0.20240819

1 year ago

0.0.20240817

1 year ago

0.0.20240811

1 year ago

0.0.20240813

1 year ago

0.0.20240814

1 year ago

0.0.20240810

1 year ago

0.0.20240709

1 year ago

0.0.20240706

1 year ago

0.0.20240707

1 year ago

0.0.20240708

1 year ago

0.0.20240702

1 year ago

0.0.20240824

12 months ago

0.0.20240703

1 year ago

0.0.20240820

1 year ago

0.0.20240821

1 year ago

0.0.20240716

1 year ago

0.0.20240718

1 year ago

0.0.20240713

1 year ago

0.0.20240715

1 year ago

0.0.20240520

1 year ago

0.0.20240519

1 year ago

0.0.20240518

1 year ago

0.0.20240515

1 year ago

0.0.20240514

1 year ago

0.0.20240511

1 year ago

0.0.20240508

1 year ago

0.0.20240507

1 year ago

0.0.20240504

1 year ago

0.0.20240501

1 year ago

0.0.20240423

1 year ago

0.0.20240420

1 year ago

0.0.20240416

1 year ago

0.0.20240415

1 year ago

0.0.20240413

1 year ago

0.0.20240410

1 year ago

0.0.20240409

1 year ago

0.0.20240408

1 year ago

0.0.20240407

1 year ago

0.0.20240406

1 year ago

0.0.20240403

1 year ago

0.0.20240401

1 year ago

0.0.20240402

1 year ago

0.0.20240330

1 year ago

0.0.20240327

1 year ago

0.0.20240326

1 year ago

0.0.20240325

1 year ago

0.0.20240324

1 year ago

0.0.20240323

1 year ago

0.0.20240320

1 year ago

0.0.20240318

1 year ago

0.0.20240317

1 year ago

0.0.20240316

1 year ago

0.0.20240313

1 year ago

0.0.20240312

1 year ago

0.0.20240310

1 year ago

0.0.20240309

1 year ago

0.0.20240306

1 year ago

0.0.20240305

1 year ago

0.0.20240304

1 year ago

0.0.20240302

1 year ago

0.0.20240228

1 year ago

0.0.20240227

1 year ago

0.0.20240225

1 year ago

0.0.20240221

1 year ago

0.0.20240224

1 year ago

0.0.20240218

2 years ago

0.0.20240219

2 years ago

0.0.20240214

2 years ago

0.0.20240208

2 years ago

0.0.20240129

2 years ago

0.0.20240128

2 years ago

0.0.20240127

2 years ago

0.0.20240122

2 years ago

0.0.20240120

2 years ago

0.0.20240113

2 years ago

0.0.20240115

2 years ago

0.0.20240110

2 years ago

0.0.20240109

2 years ago

0.0.20240107

2 years ago

0.0.20240106

2 years ago

0.0.20240103

2 years ago

0.0.20240102

2 years ago

0.0.20231223

2 years ago

0.0.20231220

2 years ago

0.0.20231217

2 years ago

0.0.20231213

2 years ago

0.0.20231210

2 years ago

0.0.20231211

2 years ago

0.0.20231209

2 years ago

0.0.20231205

2 years ago

0.0.20231203

2 years ago

0.0.20231202

2 years ago

0.0.20230819

2 years ago

0.0.20231105

2 years ago

0.0.20230811

2 years ago

0.0.20231107

2 years ago

0.0.20230815

2 years ago

0.0.20230812

2 years ago

0.0.20231111

2 years ago

0.0.20231112

2 years ago

0.0.20231114

2 years ago

0.0.20230807

2 years ago

0.0.20230808

2 years ago

0.0.20230926

2 years ago

0.0.20230805

2 years ago

0.0.20230927

2 years ago

0.0.20230809

2 years ago

0.0.20230920

2 years ago

0.0.20230801

2 years ago

0.0.20231101

2 years ago

0.0.20230717

2 years ago

0.0.20230718

2 years ago

0.0.20231128

2 years ago

0.0.20231007

2 years ago

0.0.20230711

2 years ago

0.0.20231127

2 years ago

0.0.20230712

2 years ago

0.0.20231009

2 years ago

0.0.20230830

2 years ago

0.0.20231008

2 years ago

0.0.20230710

2 years ago

0.0.20230715

2 years ago

0.0.20230716

2 years ago

0.0.20231011

2 years ago

0.0.20231013

2 years ago

0.0.20231015

2 years ago

0.0.20230829

2 years ago

0.0.20230708

2 years ago

0.0.20230827

2 years ago

0.0.20230828

2 years ago

0.0.20230822

2 years ago

0.0.20230701

2 years ago

0.0.20231119

2 years ago

0.0.20230820

2 years ago

0.0.20230704

2 years ago

0.0.20230826

2 years ago

0.0.20230705

2 years ago

0.0.20230823

2 years ago

0.0.20230703

2 years ago

0.0.20231120

2 years ago

0.0.20231122

2 years ago

0.0.20231121

2 years ago

0.0.20231124

2 years ago

0.0.20231029

2 years ago

0.0.20231028

2 years ago

0.0.20230731

2 years ago

0.0.20231031

2 years ago

0.0.20231030

2 years ago

0.0.20230729

2 years ago

0.0.20231018

2 years ago

0.0.20231017

2 years ago

0.0.20230721

2 years ago

0.0.20230726

2 years ago

0.0.20230724

2 years ago

0.0.20230725

2 years ago

0.0.20231021

2 years ago

0.0.20231023

2 years ago

0.0.20231022

2 years ago

0.0.20231025

2 years ago

0.0.20231024

2 years ago

0.0.20230917

2 years ago

0.0.20230918

2 years ago

0.0.20230910

2 years ago

0.0.20230913

2 years ago

0.0.20230911

2 years ago

0.0.20230912

2 years ago

0.0.20230906

2 years ago

0.0.20230904

2 years ago

0.0.20230905

2 years ago

0.0.20230909

2 years ago

0.0.20230902

2 years ago

0.0.20230903

2 years ago

0.0.20230622

2 years ago

0.0.20230625

2 years ago

0.0.20230626

2 years ago

0.0.20230522

2 years ago

0.0.20230529

2 years ago

0.0.20230527

2 years ago

0.0.20230531

2 years ago

0.0.20230530

2 years ago

0.0.20230429

2 years ago

0.0.20230618

2 years ago

0.0.20230619

2 years ago

0.0.20230612

2 years ago

0.0.20230613

2 years ago

0.0.20230610

2 years ago

0.0.20230617

2 years ago

0.0.20230620

2 years ago

0.0.20230607

2 years ago

0.0.20230605

2 years ago

0.0.20230606

2 years ago

0.0.20230603

2 years ago

0.0.20230513

2 years ago

0.0.20230514

2 years ago

0.0.20230517

2 years ago

0.0.20230515

2 years ago

0.0.20230516

2 years ago

0.0.20230521

2 years ago

0.0.20230508

2 years ago

0.0.20230509

2 years ago

0.0.20230502

2 years ago

0.0.20230503

2 years ago

0.0.20230621

2 years ago

0.0.20230506

2 years ago

0.0.20230507

2 years ago

0.0.20230510

2 years ago

0.0.20230415

2 years ago

0.0.20230412

2 years ago

0.0.20230418

2 years ago

0.0.20230419

2 years ago

0.0.20230422

2 years ago

0.0.20230301

2 years ago

0.0.20230403

2 years ago

0.0.20230401

2 years ago

0.0.20230315

2 years ago

0.0.20230314

2 years ago

0.0.20230318

2 years ago

0.0.20230320

2 years ago

0.0.20230321

2 years ago

0.0.20230426

2 years ago

0.0.20230305

2 years ago

0.0.20230308

2 years ago

0.0.20230306

2 years ago

0.0.20230307

2 years ago

0.0.20230312

2 years ago

0.0.20230326

2 years ago

0.0.20230327

2 years ago

0.0.20230325

2 years ago

0.0.20230328

2 years ago

0.0.20230329

2 years ago

0.0.20230228

2 years ago

0.0.20230225

2 years ago

0.0.20230226

2 years ago

0.0.20230214

3 years ago

0.0.20230218

3 years ago

0.0.20230219

3 years ago

0.0.20230220

3 years ago

0.0.20230221

2 years ago

0.0.20230222

2 years ago

0.0.20230205

3 years ago

0.0.20230128

3 years ago

0.0.20230206

3 years ago

0.0.20230129

3 years ago

0.0.20230126

3 years ago

0.0.20230204

3 years ago

0.0.20230131

3 years ago

0.0.20230212

3 years ago

0.0.20230213

3 years ago

0.0.20230211

3 years ago

0.0.20230201

3 years ago

0.0.20221115

3 years ago

0.0.20221114

3 years ago

0.0.20221112

3 years ago

0.0.20221109

3 years ago

0.0.20221108

3 years ago

0.0.20221107

3 years ago

0.0.20221106

3 years ago

0.0.20221105

3 years ago

0.0.20221221

3 years ago

0.0.20221218

3 years ago

0.0.20221130

3 years ago

0.0.20230117

3 years ago

0.0.20230118

3 years ago

0.0.20221214

3 years ago

0.0.20230115

3 years ago

0.0.20230116

3 years ago

0.0.20221210

3 years ago

0.0.20230121

3 years ago

0.0.20230124

3 years ago

0.0.20230125

3 years ago

0.0.20221207

3 years ago

0.0.20230122

3 years ago

0.0.20221206

3 years ago

0.0.20221129

3 years ago

0.0.20230123

3 years ago

0.0.20221128

3 years ago

0.0.20230107

3 years ago

0.0.20221203

3 years ago

0.0.20221126

3 years ago

0.0.20230104

3 years ago

0.0.20221122

3 years ago

0.0.20230108

3 years ago

0.0.20221121

3 years ago

0.0.20221120

3 years ago

0.0.20230110

3 years ago

0.0.20230114

3 years ago

0.0.20230111

3 years ago

0.0.20221029

3 years ago

0.0.20221026

3 years ago

0.0.20221102

3 years ago

0.0.20221025

3 years ago

0.0.20221101

3 years ago

0.0.20221024

3 years ago

0.0.20221023

3 years ago

0.0.20221001

3 years ago

0.0.20221022

3 years ago

0.0.20220927

3 years ago

0.0.20220928

3 years ago

0.0.20221019

3 years ago

0.0.20220916

3 years ago

0.0.20220829

3 years ago

0.0.20220907

3 years ago

0.0.20220819

3 years ago

0.0.20220920

3 years ago

0.0.20220910

3 years ago

0.0.20220822

3 years ago

0.0.20220823

3 years ago

0.0.20220912

3 years ago

0.0.20220824

3 years ago

0.0.20220902

3 years ago

0.0.20220914

3 years ago

0.0.20220826

3 years ago

0.0.20220904

3 years ago

0.0.20220817

3 years ago

0.0.20220816

3 years ago

0.0.20220812

3 years ago

0.0.20220806

3 years ago