v1.d.ts
41.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
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
/**
* Copyright 2019 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { OAuth2Client, JWT, Compute, UserRefreshClient } from 'google-auth-library';
import { GoogleConfigurable, MethodOptions, GlobalOptions, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { GaxiosPromise } from 'gaxios';
export declare namespace plus_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* 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;
}
/**
* Google+ API
*
* Builds on top of the Google+ platform.
*
* @example
* const {google} = require('googleapis');
* const plus = google.plus('v1');
*
* @namespace plus
* @type {Function}
* @version v1
* @variation v1
* @param {object=} options Options for Plus
*/
export class Plus {
context: APIRequestContext;
activities: Resource$Activities;
comments: Resource$Comments;
people: Resource$People;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
export interface Schema$Acl {
/**
* Description of the access granted, suitable for display.
*/
description?: string | null;
/**
* The list of access entries.
*/
items?: Schema$PlusAclentryResource[];
/**
* Identifies this resource as a collection of access controls. Value: "plus#acl".
*/
kind?: string | null;
}
export interface Schema$Activity {
/**
* Identifies who has access to see this activity.
*/
access?: Schema$Acl;
/**
* The person who performed this activity.
*/
actor?: {
clientSpecificActorInfo?: {
youtubeActorInfo?: {
channelId?: string;
};
};
displayName?: string;
id?: string;
image?: {
url?: string;
};
name?: {
familyName?: string;
givenName?: string;
};
url?: string;
verification?: {
adHocVerified?: string;
};
} | null;
/**
* Street address where this activity occurred.
*/
address?: string | null;
/**
* Additional content added by the person who shared this activity, applicable only when resharing an activity.
*/
annotation?: string | null;
/**
* If this activity is a crosspost from another system, this property specifies the ID of the original activity.
*/
crosspostSource?: string | null;
/**
* ETag of this response for caching purposes.
*/
etag?: string | null;
/**
* Latitude and longitude where this activity occurred. Format is latitude followed by longitude, space separated.
*/
geocode?: string | null;
/**
* The ID of this activity.
*/
id?: string | null;
/**
* Identifies this resource as an activity. Value: "plus#activity".
*/
kind?: string | null;
/**
* The location where this activity occurred.
*/
location?: Schema$Place;
/**
* The object of this activity.
*/
object?: {
actor?: {
clientSpecificActorInfo?: {
youtubeActorInfo?: {
channelId?: string;
};
};
displayName?: string;
id?: string;
image?: {
url?: string;
};
url?: string;
verification?: {
adHocVerified?: string;
};
};
attachments?: Array<{
content?: string;
displayName?: string;
embed?: {
type?: string;
url?: string;
};
fullImage?: {
height?: number;
type?: string;
url?: string;
width?: number;
};
id?: string;
image?: {
height?: number;
type?: string;
url?: string;
width?: number;
};
objectType?: string;
thumbnails?: Array<{
description?: string;
image?: {
height?: number;
type?: string;
url?: string;
width?: number;
};
url?: string;
}>;
url?: string;
}>;
content?: string;
id?: string;
objectType?: string;
originalContent?: string;
plusoners?: {
selfLink?: string;
totalItems?: number;
};
replies?: {
selfLink?: string;
totalItems?: number;
};
resharers?: {
selfLink?: string;
totalItems?: number;
};
url?: string;
} | null;
/**
* ID of the place where this activity occurred.
*/
placeId?: string | null;
/**
* Name of the place where this activity occurred.
*/
placeName?: string | null;
/**
* The service provider that initially published this activity.
*/
provider?: {
title?: string;
} | null;
/**
* The time at which this activity was initially published. Formatted as an RFC 3339 timestamp.
*/
published?: string | null;
/**
* Radius, in meters, of the region where this activity occurred, centered at the latitude and longitude identified in geocode.
*/
radius?: string | null;
/**
* Title of this activity.
*/
title?: string | null;
/**
* The time at which this activity was last updated. Formatted as an RFC 3339 timestamp.
*/
updated?: string | null;
/**
* The link to this activity.
*/
url?: string | null;
/**
* This activity's verb, which indicates the action that was performed. Possible values include, but are not limited to, the following values: - "post" - Publish content to the stream. - "share" - Reshare an activity.
*/
verb?: string | null;
}
export interface Schema$ActivityFeed {
/**
* ETag of this response for caching purposes.
*/
etag?: string | null;
/**
* The ID of this collection of activities. Deprecated.
*/
id?: string | null;
/**
* The activities in this page of results.
*/
items?: Schema$Activity[];
/**
* Identifies this resource as a collection of activities. Value: "plus#activityFeed".
*/
kind?: string | null;
/**
* Link to the next page of activities.
*/
nextLink?: string | null;
/**
* The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
*/
nextPageToken?: string | null;
/**
* Link to this activity resource.
*/
selfLink?: string | null;
/**
* The title of this collection of activities, which is a truncated portion of the content.
*/
title?: string | null;
/**
* The time at which this collection of activities was last updated. Formatted as an RFC 3339 timestamp.
*/
updated?: string | null;
}
export interface Schema$Comment {
/**
* The person who posted this comment.
*/
actor?: {
clientSpecificActorInfo?: {
youtubeActorInfo?: {
channelId?: string;
};
};
displayName?: string;
id?: string;
image?: {
url?: string;
};
url?: string;
verification?: {
adHocVerified?: string;
};
} | null;
/**
* ETag of this response for caching purposes.
*/
etag?: string | null;
/**
* The ID of this comment.
*/
id?: string | null;
/**
* The activity this comment replied to.
*/
inReplyTo?: Array<{
id?: string;
url?: string;
}> | null;
/**
* Identifies this resource as a comment. Value: "plus#comment".
*/
kind?: string | null;
/**
* The object of this comment.
*/
object?: {
content?: string;
objectType?: string;
originalContent?: string;
} | null;
/**
* People who +1'd this comment.
*/
plusoners?: {
totalItems?: number;
} | null;
/**
* The time at which this comment was initially published. Formatted as an RFC 3339 timestamp.
*/
published?: string | null;
/**
* Link to this comment resource.
*/
selfLink?: string | null;
/**
* The time at which this comment was last updated. Formatted as an RFC 3339 timestamp.
*/
updated?: string | null;
/**
* This comment's verb, indicating what action was performed. Possible values are: - "post" - Publish content to the stream.
*/
verb?: string | null;
}
export interface Schema$CommentFeed {
/**
* ETag of this response for caching purposes.
*/
etag?: string | null;
/**
* The ID of this collection of comments.
*/
id?: string | null;
/**
* The comments in this page of results.
*/
items?: Schema$Comment[];
/**
* Identifies this resource as a collection of comments. Value: "plus#commentFeed".
*/
kind?: string | null;
/**
* Link to the next page of activities.
*/
nextLink?: string | null;
/**
* The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
*/
nextPageToken?: string | null;
/**
* The title of this collection of comments.
*/
title?: string | null;
/**
* The time at which this collection of comments was last updated. Formatted as an RFC 3339 timestamp.
*/
updated?: string | null;
}
export interface Schema$PeopleFeed {
/**
* ETag of this response for caching purposes.
*/
etag?: string | null;
/**
* The people in this page of results. Each item includes the id, displayName, image, and url for the person. To retrieve additional profile data, see the people.get method.
*/
items?: Schema$Person[];
/**
* Identifies this resource as a collection of people. Value: "plus#peopleFeed".
*/
kind?: string | null;
/**
* The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
*/
nextPageToken?: string | null;
/**
* Link to this resource.
*/
selfLink?: string | null;
/**
* The title of this collection of people.
*/
title?: string | null;
/**
* The total number of people available in this list. The number of people in a response might be smaller due to paging. This might not be set for all collections.
*/
totalItems?: number | null;
}
export interface Schema$Person {
/**
* A short biography for this person.
*/
aboutMe?: string | null;
/**
* The age range of the person. Valid ranges are 17 or younger, 18 to 20, and 21 or older. Age is determined from the user's birthday using Western age reckoning.
*/
ageRange?: {
max?: number;
min?: number;
} | null;
/**
* The person's date of birth, represented as YYYY-MM-DD.
*/
birthday?: string | null;
/**
* The "bragging rights" line of this person.
*/
braggingRights?: string | null;
/**
* For followers who are visible, the number of people who have added this person or page to a circle.
*/
circledByCount?: number | null;
/**
* The cover photo content.
*/
cover?: {
coverInfo?: {
leftImageOffset?: number;
topImageOffset?: number;
};
coverPhoto?: {
height?: number;
url?: string;
width?: number;
};
layout?: string;
} | null;
/**
* (this field is not currently used)
*/
currentLocation?: string | null;
/**
* The name of this person, which is suitable for display.
*/
displayName?: string | null;
/**
* The hosted domain name for the user's Google Apps account. For instance, example.com. The plus.profile.emails.read or email scope is needed to get this domain name.
*/
domain?: string | null;
/**
* A list of email addresses that this person has, including their Google account email address, and the public verified email addresses on their Google+ profile. The plus.profile.emails.read scope is needed to retrieve these email addresses, or the email scope can be used to retrieve just the Google account email address.
*/
emails?: Array<{
type?: string;
value?: string;
}> | null;
/**
* ETag of this response for caching purposes.
*/
etag?: string | null;
/**
* The person's gender. Possible values include, but are not limited to, the following values: - "male" - Male gender. - "female" - Female gender. - "other" - Other.
*/
gender?: string | null;
/**
* The ID of this person.
*/
id?: string | null;
/**
* The representation of the person's profile photo.
*/
image?: {
isDefault?: boolean;
url?: string;
} | null;
/**
* Whether this user has signed up for Google+.
*/
isPlusUser?: boolean | null;
/**
* Identifies this resource as a person. Value: "plus#person".
*/
kind?: string | null;
/**
* The user's preferred language for rendering.
*/
language?: string | null;
/**
* An object representation of the individual components of a person's name.
*/
name?: {
familyName?: string;
formatted?: string;
givenName?: string;
honorificPrefix?: string;
honorificSuffix?: string;
middleName?: string;
} | null;
/**
* The nickname of this person.
*/
nickname?: string | null;
/**
* Type of person within Google+. Possible values include, but are not limited to, the following values: - "person" - represents an actual person. - "page" - represents a page.
*/
objectType?: string | null;
/**
* The occupation of this person.
*/
occupation?: string | null;
/**
* A list of current or past organizations with which this person is associated.
*/
organizations?: Array<{
department?: string;
description?: string;
endDate?: string;
location?: string;
name?: string;
primary?: boolean;
startDate?: string;
title?: string;
type?: string;
}> | null;
/**
* A list of places where this person has lived.
*/
placesLived?: Array<{
primary?: boolean;
value?: string;
}> | null;
/**
* If a Google+ Page, the number of people who have +1'd this page.
*/
plusOneCount?: number | null;
/**
* The person's relationship status. Possible values include, but are not limited to, the following values: - "single" - Person is single. - "in_a_relationship" - Person is in a relationship. - "engaged" - Person is engaged. - "married" - Person is married. - "its_complicated" - The relationship is complicated. - "open_relationship" - Person is in an open relationship. - "widowed" - Person is widowed. - "in_domestic_partnership" - Person is in a domestic partnership. - "in_civil_union" - Person is in a civil union.
*/
relationshipStatus?: string | null;
/**
* The person's skills.
*/
skills?: string | null;
/**
* The brief description (tagline) of this person.
*/
tagline?: string | null;
/**
* The URL of this person's profile.
*/
url?: string | null;
/**
* A list of URLs for this person.
*/
urls?: Array<{
label?: string;
type?: string;
value?: string;
}> | null;
/**
* Whether the person or Google+ Page has been verified.
*/
verified?: boolean | null;
}
export interface Schema$Place {
/**
* The physical address of the place.
*/
address?: {
formatted?: string;
} | null;
/**
* The display name of the place.
*/
displayName?: string | null;
/**
* The id of the place.
*/
id?: string | null;
/**
* Identifies this resource as a place. Value: "plus#place".
*/
kind?: string | null;
/**
* The position of the place.
*/
position?: {
latitude?: number;
longitude?: number;
} | null;
}
export interface Schema$PlusAclentryResource {
/**
* A descriptive name for this entry. Suitable for display.
*/
displayName?: string | null;
/**
* The ID of the entry. For entries of type "person" or "circle", this is the ID of the resource. For other types, this property is not set.
*/
id?: string | null;
/**
* The type of entry describing to whom access is granted. Possible values are: - "person" - Access to an individual. - "circle" - Access to members of a circle. - "myCircles" - Access to members of all the person's circles. - "extendedCircles" - Access to members of all the person's circles, plus all of the people in their circles. - "domain" - Access to members of the person's Google Apps domain. - "public" - Access to anyone on the web.
*/
type?: string | null;
}
export class Resource$Activities {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* plus.activities.get
* @desc Shut down. See https://developers.google.com/+/api-shutdown for more details.
* @alias plus.activities.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.activityId The ID of the activity to get.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Activities$Get, options?: MethodOptions): GaxiosPromise<Schema$Activity>;
get(params: Params$Resource$Activities$Get, options: MethodOptions | BodyResponseCallback<Schema$Activity>, callback: BodyResponseCallback<Schema$Activity>): void;
get(params: Params$Resource$Activities$Get, callback: BodyResponseCallback<Schema$Activity>): void;
get(callback: BodyResponseCallback<Schema$Activity>): void;
/**
* plus.activities.list
* @desc Shut down. See https://developers.google.com/+/api-shutdown for more details.
* @alias plus.activities.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.collection The collection of activities to list.
* @param {integer=} params.maxResults The maximum number of activities to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.
* @param {string=} params.pageToken The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.
* @param {string} params.userId The ID of the user to get activities for. The special value "me" can be used to indicate the authenticated user.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Activities$List, options?: MethodOptions): GaxiosPromise<Schema$ActivityFeed>;
list(params: Params$Resource$Activities$List, options: MethodOptions | BodyResponseCallback<Schema$ActivityFeed>, callback: BodyResponseCallback<Schema$ActivityFeed>): void;
list(params: Params$Resource$Activities$List, callback: BodyResponseCallback<Schema$ActivityFeed>): void;
list(callback: BodyResponseCallback<Schema$ActivityFeed>): void;
/**
* plus.activities.search
* @desc Shut down. See https://developers.google.com/+/api-shutdown for more details.
* @alias plus.activities.search
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.language Specify the preferred language to search with. See search language codes for available values.
* @param {integer=} params.maxResults The maximum number of activities to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.
* @param {string=} params.orderBy Specifies how to order search results.
* @param {string=} params.pageToken The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. This token can be of any length.
* @param {string} params.query Full-text search query string.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
search(params?: Params$Resource$Activities$Search, options?: MethodOptions): GaxiosPromise<Schema$ActivityFeed>;
search(params: Params$Resource$Activities$Search, options: MethodOptions | BodyResponseCallback<Schema$ActivityFeed>, callback: BodyResponseCallback<Schema$ActivityFeed>): void;
search(params: Params$Resource$Activities$Search, callback: BodyResponseCallback<Schema$ActivityFeed>): void;
search(callback: BodyResponseCallback<Schema$ActivityFeed>): void;
}
export interface Params$Resource$Activities$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the activity to get.
*/
activityId?: string;
}
export interface Params$Resource$Activities$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The collection of activities to list.
*/
collection?: string;
/**
* The maximum number of activities to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.
*/
maxResults?: number;
/**
* The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.
*/
pageToken?: string;
/**
* The ID of the user to get activities for. The special value "me" can be used to indicate the authenticated user.
*/
userId?: string;
}
export interface Params$Resource$Activities$Search extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Specify the preferred language to search with. See search language codes for available values.
*/
language?: string;
/**
* The maximum number of activities to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.
*/
maxResults?: number;
/**
* Specifies how to order search results.
*/
orderBy?: string;
/**
* The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. This token can be of any length.
*/
pageToken?: string;
/**
* Full-text search query string.
*/
query?: string;
}
export class Resource$Comments {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* plus.comments.get
* @desc Shut down. See https://developers.google.com/+/api-shutdown for more details.
* @alias plus.comments.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.commentId The ID of the comment to get.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Comments$Get, options?: MethodOptions): GaxiosPromise<Schema$Comment>;
get(params: Params$Resource$Comments$Get, options: MethodOptions | BodyResponseCallback<Schema$Comment>, callback: BodyResponseCallback<Schema$Comment>): void;
get(params: Params$Resource$Comments$Get, callback: BodyResponseCallback<Schema$Comment>): void;
get(callback: BodyResponseCallback<Schema$Comment>): void;
/**
* plus.comments.list
* @desc Shut down. See https://developers.google.com/+/api-shutdown for more details.
* @alias plus.comments.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.activityId The ID of the activity to get comments for.
* @param {integer=} params.maxResults The maximum number of comments to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.
* @param {string=} params.pageToken The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.
* @param {string=} params.sortOrder The order in which to sort the list of comments.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Comments$List, options?: MethodOptions): GaxiosPromise<Schema$CommentFeed>;
list(params: Params$Resource$Comments$List, options: MethodOptions | BodyResponseCallback<Schema$CommentFeed>, callback: BodyResponseCallback<Schema$CommentFeed>): void;
list(params: Params$Resource$Comments$List, callback: BodyResponseCallback<Schema$CommentFeed>): void;
list(callback: BodyResponseCallback<Schema$CommentFeed>): void;
}
export interface Params$Resource$Comments$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the comment to get.
*/
commentId?: string;
}
export interface Params$Resource$Comments$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the activity to get comments for.
*/
activityId?: string;
/**
* The maximum number of comments to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.
*/
maxResults?: number;
/**
* The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.
*/
pageToken?: string;
/**
* The order in which to sort the list of comments.
*/
sortOrder?: string;
}
export class Resource$People {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* plus.people.get
* @desc Get a person's profile. If your app uses scope https://www.googleapis.com/auth/plus.login, this method is guaranteed to return ageRange and language.
* @alias plus.people.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.userId The ID of the person to get the profile for. The special value "me" can be used to indicate the authenticated user.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$People$Get, options?: MethodOptions): GaxiosPromise<Schema$Person>;
get(params: Params$Resource$People$Get, options: MethodOptions | BodyResponseCallback<Schema$Person>, callback: BodyResponseCallback<Schema$Person>): void;
get(params: Params$Resource$People$Get, callback: BodyResponseCallback<Schema$Person>): void;
get(callback: BodyResponseCallback<Schema$Person>): void;
/**
* plus.people.list
* @desc List all of the people in the specified collection.
* @alias plus.people.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.collection The collection of people to list.
* @param {integer=} params.maxResults The maximum number of people to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.
* @param {string=} params.orderBy The order to return people in.
* @param {string=} params.pageToken The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.
* @param {string} params.userId Get the collection of people for the person identified. Use "me" to indicate the authenticated user.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$People$List, options?: MethodOptions): GaxiosPromise<Schema$PeopleFeed>;
list(params: Params$Resource$People$List, options: MethodOptions | BodyResponseCallback<Schema$PeopleFeed>, callback: BodyResponseCallback<Schema$PeopleFeed>): void;
list(params: Params$Resource$People$List, callback: BodyResponseCallback<Schema$PeopleFeed>): void;
list(callback: BodyResponseCallback<Schema$PeopleFeed>): void;
/**
* plus.people.listByActivity
* @desc Shut down. See https://developers.google.com/+/api-shutdown for more details.
* @alias plus.people.listByActivity
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.activityId The ID of the activity to get the list of people for.
* @param {string} params.collection The collection of people to list.
* @param {integer=} params.maxResults The maximum number of people to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.
* @param {string=} params.pageToken The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
listByActivity(params?: Params$Resource$People$Listbyactivity, options?: MethodOptions): GaxiosPromise<Schema$PeopleFeed>;
listByActivity(params: Params$Resource$People$Listbyactivity, options: MethodOptions | BodyResponseCallback<Schema$PeopleFeed>, callback: BodyResponseCallback<Schema$PeopleFeed>): void;
listByActivity(params: Params$Resource$People$Listbyactivity, callback: BodyResponseCallback<Schema$PeopleFeed>): void;
listByActivity(callback: BodyResponseCallback<Schema$PeopleFeed>): void;
/**
* plus.people.search
* @desc Shut down. See https://developers.google.com/+/api-shutdown for more details.
* @alias plus.people.search
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.language Specify the preferred language to search with. See search language codes for available values.
* @param {integer=} params.maxResults The maximum number of people to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.
* @param {string=} params.pageToken The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. This token can be of any length.
* @param {string} params.query Specify a query string for full text search of public text in all profiles.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
search(params?: Params$Resource$People$Search, options?: MethodOptions): GaxiosPromise<Schema$PeopleFeed>;
search(params: Params$Resource$People$Search, options: MethodOptions | BodyResponseCallback<Schema$PeopleFeed>, callback: BodyResponseCallback<Schema$PeopleFeed>): void;
search(params: Params$Resource$People$Search, callback: BodyResponseCallback<Schema$PeopleFeed>): void;
search(callback: BodyResponseCallback<Schema$PeopleFeed>): void;
}
export interface Params$Resource$People$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the person to get the profile for. The special value "me" can be used to indicate the authenticated user.
*/
userId?: string;
}
export interface Params$Resource$People$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The collection of people to list.
*/
collection?: string;
/**
* The maximum number of people to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.
*/
maxResults?: number;
/**
* The order to return people in.
*/
orderBy?: string;
/**
* The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.
*/
pageToken?: string;
/**
* Get the collection of people for the person identified. Use "me" to indicate the authenticated user.
*/
userId?: string;
}
export interface Params$Resource$People$Listbyactivity extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the activity to get the list of people for.
*/
activityId?: string;
/**
* The collection of people to list.
*/
collection?: string;
/**
* The maximum number of people to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.
*/
maxResults?: number;
/**
* The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.
*/
pageToken?: string;
}
export interface Params$Resource$People$Search extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Specify the preferred language to search with. See search language codes for available values.
*/
language?: string;
/**
* The maximum number of people to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.
*/
maxResults?: number;
/**
* The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. This token can be of any length.
*/
pageToken?: string;
/**
* Specify a query string for full text search of public text in all profiles.
*/
query?: string;
}
export {};
}