v3.d.ts
37.8 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
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
/// <reference types="node" />
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosPromise, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace webmasters_v3 {
export interface Options extends GlobalOptions {
version: 'v3';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* Data format for the response.
*/
alt?: 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;
/**
* An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
*/
quotaUser?: string;
/**
* Deprecated. Please use quotaUser instead.
*/
userIp?: string;
}
/**
* Search Console API
*
* View Google Search Console data for your verified sites.
*
* @example
* ```js
* const {google} = require('googleapis');
* const webmasters = google.webmasters('v3');
* ```
*/
export class Webmasters {
context: APIRequestContext;
searchanalytics: Resource$Searchanalytics;
sitemaps: Resource$Sitemaps;
sites: Resource$Sites;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
export interface Schema$ApiDataRow {
clicks?: number | null;
ctr?: number | null;
impressions?: number | null;
keys?: string[] | null;
position?: number | null;
}
export interface Schema$ApiDimensionFilter {
dimension?: string | null;
expression?: string | null;
operator?: string | null;
}
export interface Schema$ApiDimensionFilterGroup {
filters?: Schema$ApiDimensionFilter[];
groupType?: string | null;
}
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;
/**
* [Optional] If "all" (case-insensitive), data will include fresh data. If "final" (case-insensitive) or if this parameter is omitted, the returned data will include only finalized 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 5,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.
*/
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.
*/
siteEntry?: Schema$WmxSite[];
}
/**
* Contains permission level information about a Search Console site. For more information, see Permissions in Search Console.
*/
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.
*/
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);
/**
* 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/webmasters.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 webmasters = google.webmasters('v3');
*
* 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;
}
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);
/**
* Deletes a sitemap from this site.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/webmasters.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 webmasters = google.webmasters('v3');
*
* 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;
/**
* Retrieves information about a specific sitemap.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/webmasters.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 webmasters = google.webmasters('v3');
*
* 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;
/**
* Lists the sitemaps-entries 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/webmasters.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 webmasters = google.webmasters('v3');
*
* 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;
/**
* Submits a sitemap for a site.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/webmasters.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 webmasters = google.webmasters('v3');
*
* 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 sitemap to add. 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;
}
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 sitemap to add. 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);
/**
* 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/webmasters.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 webmasters = google.webmasters('v3');
*
* 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;
/**
* 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/webmasters.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 webmasters = google.webmasters('v3');
*
* 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 android-app://com.example/ Note: for property-sets, use the URI that starts with sc-set: which is used in Search Console URLs.
* 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;
/**
* Retrieves information about specific site.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/webmasters.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 webmasters = google.webmasters('v3');
*
* 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 android-app://com.example/ Note: for property-sets, use the URI that starts with sc-set: which is used in Search Console URLs.
* 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;
/**
* Lists the user's Search Console sites.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/webmasters.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 webmasters = google.webmasters('v3');
*
* 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;
}
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 android-app://com.example/ Note: for property-sets, use the URI that starts with sc-set: which is used in Search Console URLs.
*/
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 android-app://com.example/ Note: for property-sets, use the URI that starts with sc-set: which is used in Search Console URLs.
*/
siteUrl?: string;
}
export interface Params$Resource$Sites$List extends StandardParameters {
}
export {};
}