Webmasters.php
20 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
<?php
// namespace administrator\components\com_jmap\framework\google;
/**
*
* @package JMAP::FRAMEWORK::administrator::components::com_jmap
* @subpackage framework
* @subpackage google
* @author Joomla! Extensions Store
* @copyright (C) 2015 - Joomla! Extensions Store
* @license GNU/GPLv2 http://www.gnu.org/licenses/gpl-2.0.html
*/
defined ( '_JEXEC' ) or die ();
class Google_Service_Webmasters extends Google_Service
{
/** View and modify Webmaster Tools data for your verified sites. */
const WEBMASTERS =
"https://www.googleapis.com/auth/webmasters";
/** View Webmaster Tools data for your verified sites. */
const WEBMASTERS_READONLY =
"https://www.googleapis.com/auth/webmasters.readonly";
public $searchanalytics;
public $sitemaps;
public $sites;
/**
* Constructs the internal representation of the Webmasters service.
*
* @param Google_Client $client
*/
public function __construct(Google_Client $client)
{
parent::__construct($client);
$this->rootUrl = 'https://www.googleapis.com/';
$this->servicePath = 'webmasters/v3/';
$this->version = 'v3';
$this->serviceName = 'webmasters';
$this->searchanalytics = new Google_Service_Webmasters_Searchanalytics_Resource(
$this,
$this->serviceName,
'searchanalytics',
array(
'methods' => array(
'query' => array(
'path' => 'sites/{siteUrl}/searchAnalytics/query',
'httpMethod' => 'POST',
'parameters' => array(
'siteUrl' => array(
'location' => 'path',
'type' => 'string',
'required' => true,
),
),
),
)
)
);
$this->sitemaps = new Google_Service_Webmasters_Sitemaps_Resource(
$this,
$this->serviceName,
'sitemaps',
array(
'methods' => array(
'delete' => array(
'path' => 'sites/{siteUrl}/sitemaps/{feedpath}',
'httpMethod' => 'DELETE',
'parameters' => array(
'siteUrl' => array(
'location' => 'path',
'type' => 'string',
'required' => true,
),
'feedpath' => array(
'location' => 'path',
'type' => 'string',
'required' => true,
),
),
),'get' => array(
'path' => 'sites/{siteUrl}/sitemaps/{feedpath}',
'httpMethod' => 'GET',
'parameters' => array(
'siteUrl' => array(
'location' => 'path',
'type' => 'string',
'required' => true,
),
'feedpath' => array(
'location' => 'path',
'type' => 'string',
'required' => true,
),
),
),'list' => array(
'path' => 'sites/{siteUrl}/sitemaps',
'httpMethod' => 'GET',
'parameters' => array(
'siteUrl' => array(
'location' => 'path',
'type' => 'string',
'required' => true,
),
'sitemapIndex' => array(
'location' => 'query',
'type' => 'string',
),
),
),'submit' => array(
'path' => 'sites/{siteUrl}/sitemaps/{feedpath}',
'httpMethod' => 'PUT',
'parameters' => array(
'siteUrl' => array(
'location' => 'path',
'type' => 'string',
'required' => true,
),
'feedpath' => array(
'location' => 'path',
'type' => 'string',
'required' => true,
),
),
),
)
)
);
$this->sites = new Google_Service_Webmasters_Sites_Resource(
$this,
$this->serviceName,
'sites',
array(
'methods' => array(
'add' => array(
'path' => 'sites/{siteUrl}',
'httpMethod' => 'PUT',
'parameters' => array(
'siteUrl' => array(
'location' => 'path',
'type' => 'string',
'required' => true,
),
),
),'delete' => array(
'path' => 'sites/{siteUrl}',
'httpMethod' => 'DELETE',
'parameters' => array(
'siteUrl' => array(
'location' => 'path',
'type' => 'string',
'required' => true,
),
),
),'get' => array(
'path' => 'sites/{siteUrl}',
'httpMethod' => 'GET',
'parameters' => array(
'siteUrl' => array(
'location' => 'path',
'type' => 'string',
'required' => true,
),
),
),'list' => array(
'path' => 'sites',
'httpMethod' => 'GET',
'parameters' => array(),
),
)
)
);
}
}
/**
* The "searchanalytics" collection of methods.
* Typical usage is:
* <code>
* $webmastersService = new Google_Service_Webmasters(...);
* $searchanalytics = $webmastersService->searchanalytics;
* </code>
*/
class Google_Service_Webmasters_Searchanalytics_Resource extends Google_Service_Resource
{
/**
* [LIMITED ACCESS]
*
* 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. (searchanalytics.query)
*
* @param string $siteUrl The site's URL, including protocol. For example:
* http://www.example.com/
* @param Google_SearchAnalyticsQueryRequest $postBody
* @param array $optParams Optional parameters.
* @return Google_Service_Webmasters_SearchAnalyticsQueryResponse
*/
public function query($siteUrl, Google_Service_Webmasters_SearchAnalyticsQueryRequest $postBody, $optParams = array())
{
$params = array('siteUrl' => $siteUrl, 'postBody' => $postBody);
$params = array_merge($params, $optParams);
return $this->call('query', array($params), "Google_Service_Webmasters_SearchAnalyticsQueryResponse");
}
}
/**
* The "sitemaps" collection of methods.
* Typical usage is:
* <code>
* $webmastersService = new Google_Service_Webmasters(...);
* $sitemaps = $webmastersService->sitemaps;
* </code>
*/
class Google_Service_Webmasters_Sitemaps_Resource extends Google_Service_Resource
{
/**
* Deletes a sitemap from this site. (sitemaps.delete)
*
* @param string $siteUrl The site's URL, including protocol. For example:
* http://www.example.com/
* @param string $feedpath The URL of the actual sitemap. For example:
* http://www.example.com/sitemap.xml
* @param array $optParams Optional parameters.
*/
public function delete($siteUrl, $feedpath, $optParams = array())
{
$params = array('siteUrl' => $siteUrl, 'feedpath' => $feedpath);
$params = array_merge($params, $optParams);
return $this->call('delete', array($params));
}
/**
* Retrieves information about a specific sitemap. (sitemaps.get)
*
* @param string $siteUrl The site's URL, including protocol. For example:
* http://www.example.com/
* @param string $feedpath The URL of the actual sitemap. For example:
* http://www.example.com/sitemap.xml
* @param array $optParams Optional parameters.
* @return Google_Service_Webmasters_WmxSitemap
*/
public function get($siteUrl, $feedpath, $optParams = array())
{
$params = array('siteUrl' => $siteUrl, 'feedpath' => $feedpath);
$params = array_merge($params, $optParams);
return $this->call('get', array($params), "Google_Service_Webmasters_WmxSitemap");
}
/**
* Lists the sitemaps-entries submitted for this site, or included in the
* sitemap index file (if sitemapIndex is specified in the request).
* (sitemaps.listSitemaps)
*
* @param string $siteUrl The site's URL, including protocol. For example:
* http://www.example.com/
* @param array $optParams Optional parameters.
*
* @opt_param string sitemapIndex A URL of a site's sitemap index. For example:
* http://www.example.com/sitemapindex.xml
* @return Google_Service_Webmasters_SitemapsListResponse
*/
public function listSitemaps($siteUrl, $optParams = array())
{
$params = array('siteUrl' => $siteUrl);
$params = array_merge($params, $optParams);
return $this->call('list', array($params), "Google_Service_Webmasters_SitemapsListResponse");
}
/**
* Submits a sitemap for a site. (sitemaps.submit)
*
* @param string $siteUrl The site's URL, including protocol. For example:
* http://www.example.com/
* @param string $feedpath The URL of the sitemap to add. For example:
* http://www.example.com/sitemap.xml
* @param array $optParams Optional parameters.
*/
public function submit($siteUrl, $feedpath, $optParams = array())
{
$params = array('siteUrl' => $siteUrl, 'feedpath' => $feedpath);
$params = array_merge($params, $optParams);
return $this->call('submit', array($params));
}
}
/**
* The "sites" collection of methods.
* Typical usage is:
* <code>
* $webmastersService = new Google_Service_Webmasters(...);
* $sites = $webmastersService->sites;
* </code>
*/
class Google_Service_Webmasters_Sites_Resource extends Google_Service_Resource
{
/**
* Adds a site to the set of the user's sites in Webmaster Tools. (sites.add)
*
* @param string $siteUrl The URL of the site to add.
* @param array $optParams Optional parameters.
*/
public function add($siteUrl, $optParams = array())
{
$params = array('siteUrl' => $siteUrl);
$params = array_merge($params, $optParams);
return $this->call('add', array($params));
}
/**
* Removes a site from the set of the user's Webmaster Tools sites.
* (sites.delete)
*
* @param string $siteUrl The URI of the property as defined in Search Console.
* Examples: http://www.example.com/ or android-app://com.example/
* @param array $optParams Optional parameters.
*/
public function delete($siteUrl, $optParams = array())
{
$params = array('siteUrl' => $siteUrl);
$params = array_merge($params, $optParams);
return $this->call('delete', array($params));
}
/**
* Retrieves information about specific site. (sites.get)
*
* @param string $siteUrl The URI of the property as defined in Search Console.
* Examples: http://www.example.com/ or android-app://com.example/
* @param array $optParams Optional parameters.
* @return Google_Service_Webmasters_WmxSite
*/
public function get($siteUrl, $optParams = array())
{
$params = array('siteUrl' => $siteUrl);
$params = array_merge($params, $optParams);
return $this->call('get', array($params), "Google_Service_Webmasters_WmxSite");
}
/**
* Lists the user's Webmaster Tools sites. (sites.listSites)
*
* @param array $optParams Optional parameters.
* @return Google_Service_Webmasters_SitesListResponse
*/
public function listSites($optParams = array())
{
$params = array();
$params = array_merge($params, $optParams);
return $this->call('list', array($params), "Google_Service_Webmasters_SitesListResponse");
}
}
class Google_Service_Webmasters_ApiDataRow extends Google_Collection
{
protected $collection_key = 'keys';
protected $internal_gapi_mappings = array(
);
public $clicks;
public $ctr;
public $impressions;
public $keys;
public $position;
public function setClicks($clicks)
{
$this->clicks = $clicks;
}
public function getClicks()
{
return $this->clicks;
}
public function setCtr($ctr)
{
$this->ctr = $ctr;
}
public function getCtr()
{
return $this->ctr;
}
public function setImpressions($impressions)
{
$this->impressions = $impressions;
}
public function getImpressions()
{
return $this->impressions;
}
public function setKeys($keys)
{
$this->keys = $keys;
}
public function getKeys()
{
return $this->keys;
}
public function setPosition($position)
{
$this->position = $position;
}
public function getPosition()
{
return $this->position;
}
}
class Google_Service_Webmasters_ApiDimensionFilter extends Google_Model
{
protected $internal_gapi_mappings = array(
);
public $dimension;
public $expression;
public $operator;
public function setDimension($dimension)
{
$this->dimension = $dimension;
}
public function getDimension()
{
return $this->dimension;
}
public function setExpression($expression)
{
$this->expression = $expression;
}
public function getExpression()
{
return $this->expression;
}
public function setOperator($operator)
{
$this->operator = $operator;
}
public function getOperator()
{
return $this->operator;
}
}
class Google_Service_Webmasters_ApiDimensionFilterGroup extends Google_Collection
{
protected $collection_key = 'filters';
protected $internal_gapi_mappings = array(
);
protected $filtersType = 'Google_Service_Webmasters_ApiDimensionFilter';
protected $filtersDataType = 'array';
public $groupType;
public function setFilters($filters)
{
$this->filters = $filters;
}
public function getFilters()
{
return $this->filters;
}
public function setGroupType($groupType)
{
$this->groupType = $groupType;
}
public function getGroupType()
{
return $this->groupType;
}
}
class Google_Service_Webmasters_SearchAnalyticsQueryRequest extends Google_Collection
{
protected $collection_key = 'dimensions';
protected $internal_gapi_mappings = array(
);
public $aggregationType;
protected $dimensionFilterGroupsType = 'Google_Service_Webmasters_ApiDimensionFilterGroup';
protected $dimensionFilterGroupsDataType = 'array';
public $dimensions;
public $endDate;
public $rowLimit;
public $searchType;
public $startDate;
public function setAggregationType($aggregationType)
{
$this->aggregationType = $aggregationType;
}
public function getAggregationType()
{
return $this->aggregationType;
}
public function setDimensionFilterGroups($dimensionFilterGroups)
{
$this->dimensionFilterGroups = $dimensionFilterGroups;
}
public function getDimensionFilterGroups()
{
return $this->dimensionFilterGroups;
}
public function setDimensions($dimensions)
{
$this->dimensions = $dimensions;
}
public function getDimensions()
{
return $this->dimensions;
}
public function setEndDate($endDate)
{
$this->endDate = $endDate;
}
public function getEndDate()
{
return $this->endDate;
}
public function setRowLimit($rowLimit)
{
$this->rowLimit = $rowLimit;
}
public function getRowLimit()
{
return $this->rowLimit;
}
public function setSearchType($searchType)
{
$this->searchType = $searchType;
}
public function getSearchType()
{
return $this->searchType;
}
public function setStartDate($startDate)
{
$this->startDate = $startDate;
}
public function getStartDate()
{
return $this->startDate;
}
}
class Google_Service_Webmasters_SearchAnalyticsQueryResponse extends Google_Collection
{
protected $collection_key = 'rows';
protected $internal_gapi_mappings = array(
);
public $responseAggregationType;
protected $rowsType = 'Google_Service_Webmasters_ApiDataRow';
protected $rowsDataType = 'array';
public function setResponseAggregationType($responseAggregationType)
{
$this->responseAggregationType = $responseAggregationType;
}
public function getResponseAggregationType()
{
return $this->responseAggregationType;
}
public function setRows($rows)
{
$this->rows = $rows;
}
public function getRows()
{
return $this->rows;
}
}
class Google_Service_Webmasters_SitemapsListResponse extends Google_Collection
{
protected $collection_key = 'sitemap';
protected $internal_gapi_mappings = array(
);
protected $sitemapType = 'Google_Service_Webmasters_WmxSitemap';
protected $sitemapDataType = 'array';
public function setSitemap($sitemap)
{
$this->sitemap = $sitemap;
}
public function getSitemap()
{
return $this->sitemap;
}
}
class Google_Service_Webmasters_SitesListResponse extends Google_Collection
{
protected $collection_key = 'siteEntry';
protected $internal_gapi_mappings = array(
);
protected $siteEntryType = 'Google_Service_Webmasters_WmxSite';
protected $siteEntryDataType = 'array';
public function setSiteEntry($siteEntry)
{
$this->siteEntry = $siteEntry;
}
public function getSiteEntry()
{
return $this->siteEntry;
}
}
class Google_Service_Webmasters_WmxSite extends Google_Model
{
protected $internal_gapi_mappings = array(
);
public $permissionLevel;
public $siteUrl;
public function setPermissionLevel($permissionLevel)
{
$this->permissionLevel = $permissionLevel;
}
public function getPermissionLevel()
{
return $this->permissionLevel;
}
public function setSiteUrl($siteUrl)
{
$this->siteUrl = $siteUrl;
}
public function getSiteUrl()
{
return $this->siteUrl;
}
}
class Google_Service_Webmasters_WmxSitemap extends Google_Collection
{
protected $collection_key = 'contents';
protected $internal_gapi_mappings = array(
);
protected $contentsType = 'Google_Service_Webmasters_WmxSitemapContent';
protected $contentsDataType = 'array';
public $errors;
public $isPending;
public $isSitemapsIndex;
public $lastDownloaded;
public $lastSubmitted;
public $path;
public $type;
public $warnings;
public function setContents($contents)
{
$this->contents = $contents;
}
public function getContents()
{
return $this->contents;
}
public function setErrors($errors)
{
$this->errors = $errors;
}
public function getErrors()
{
return $this->errors;
}
public function setIsPending($isPending)
{
$this->isPending = $isPending;
}
public function getIsPending()
{
return $this->isPending;
}
public function setIsSitemapsIndex($isSitemapsIndex)
{
$this->isSitemapsIndex = $isSitemapsIndex;
}
public function getIsSitemapsIndex()
{
return $this->isSitemapsIndex;
}
public function setLastDownloaded($lastDownloaded)
{
$this->lastDownloaded = $lastDownloaded;
}
public function getLastDownloaded()
{
return $this->lastDownloaded;
}
public function setLastSubmitted($lastSubmitted)
{
$this->lastSubmitted = $lastSubmitted;
}
public function getLastSubmitted()
{
return $this->lastSubmitted;
}
public function setPath($path)
{
$this->path = $path;
}
public function getPath()
{
return $this->path;
}
public function setType($type)
{
$this->type = $type;
}
public function getType()
{
return $this->type;
}
public function setWarnings($warnings)
{
$this->warnings = $warnings;
}
public function getWarnings()
{
return $this->warnings;
}
}
class Google_Service_Webmasters_WmxSitemapContent extends Google_Model
{
protected $internal_gapi_mappings = array(
);
public $indexed;
public $submitted;
public $type;
public function setIndexed($indexed)
{
$this->indexed = $indexed;
}
public function getIndexed()
{
return $this->indexed;
}
public function setSubmitted($submitted)
{
$this->submitted = $submitted;
}
public function getSubmitted()
{
return $this->submitted;
}
public function setType($type)
{
$this->type = $type;
}
public function getType()
{
return $this->type;
}
}