mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2025-10-16 12:05:41 +00:00
1325 lines
69 KiB
TypeScript
1325 lines
69 KiB
TypeScript
// Type definitions for non-npm package Google Google+ Domains API v1 1.0
|
|
// Project: https://developers.google.com/+/domains/
|
|
// Definitions by: Bolisov Alexey <https://github.com/Bolisov>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
// TypeScript Version: 2.3
|
|
|
|
// IMPORTANT
|
|
// This file was generated by https://github.com/Bolisov/google-api-typings-generator. Please do not edit it manually.
|
|
// In case of any problems please post issue to https://github.com/Bolisov/google-api-typings-generator
|
|
// Generated from: https://www.googleapis.com/discovery/v1/apis/plusDomains/v1/rest
|
|
|
|
/// <reference types="gapi.client" />
|
|
|
|
declare namespace gapi.client {
|
|
/** Load Google+ Domains API v1 */
|
|
function load(name: "plusdomains", version: "v1"): PromiseLike<void>;
|
|
function load(name: "plusdomains", version: "v1", callback: () => any): void;
|
|
|
|
const activities: plusdomains.ActivitiesResource;
|
|
|
|
const audiences: plusdomains.AudiencesResource;
|
|
|
|
const circles: plusdomains.CirclesResource;
|
|
|
|
const comments: plusdomains.CommentsResource;
|
|
|
|
const media: plusdomains.MediaResource;
|
|
|
|
const people: plusdomains.PeopleResource;
|
|
|
|
namespace plusdomains {
|
|
interface Acl {
|
|
/** Description of the access granted, suitable for display. */
|
|
description?: string;
|
|
/** Whether access is restricted to the domain. */
|
|
domainRestricted?: boolean;
|
|
/** The list of access entries. */
|
|
items?: PlusDomainsAclentryResource[];
|
|
/** Identifies this resource as a collection of access controls. Value: "plus#acl". */
|
|
kind?: string;
|
|
}
|
|
interface Activity {
|
|
/** Identifies who has access to see this activity. */
|
|
access?: Acl;
|
|
/** The person who performed this activity. */
|
|
actor?: {
|
|
/** Actor info specific to particular clients. */
|
|
clientSpecificActorInfo?: {
|
|
/** Actor info specific to YouTube clients. */
|
|
youtubeActorInfo?: {
|
|
/** ID of the YouTube channel owned by the Actor. */
|
|
channelId?: string;
|
|
};
|
|
};
|
|
/** The name of the actor, suitable for display. */
|
|
displayName?: string;
|
|
/** The ID of the actor's Person resource. */
|
|
id?: string;
|
|
/** The image representation of the actor. */
|
|
image?: {
|
|
/**
|
|
* The URL of the actor's profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of
|
|
* each side.
|
|
*/
|
|
url?: string;
|
|
};
|
|
/** An object representation of the individual components of name. */
|
|
name?: {
|
|
/** The family name ("last name") of the actor. */
|
|
familyName?: string;
|
|
/** The given name ("first name") of the actor. */
|
|
givenName?: string;
|
|
};
|
|
/** The link to the actor's Google profile. */
|
|
url?: string;
|
|
/** Verification status of actor. */
|
|
verification?: {
|
|
/** Verification for one-time or manual processes. */
|
|
adHocVerified?: string;
|
|
};
|
|
};
|
|
/** Street address where this activity occurred. */
|
|
address?: string;
|
|
/** Additional content added by the person who shared this activity, applicable only when resharing an activity. */
|
|
annotation?: string;
|
|
/** If this activity is a crosspost from another system, this property specifies the ID of the original activity. */
|
|
crosspostSource?: string;
|
|
/** ETag of this response for caching purposes. */
|
|
etag?: string;
|
|
/** Latitude and longitude where this activity occurred. Format is latitude followed by longitude, space separated. */
|
|
geocode?: string;
|
|
/** The ID of this activity. */
|
|
id?: string;
|
|
/** Identifies this resource as an activity. Value: "plus#activity". */
|
|
kind?: string;
|
|
/** The location where this activity occurred. */
|
|
location?: Place;
|
|
/** The object of this activity. */
|
|
object?: {
|
|
/**
|
|
* If this activity's object is itself another activity, such as when a person reshares an activity, this property specifies the original activity's
|
|
* actor.
|
|
*/
|
|
actor?: {
|
|
/** Actor info specific to particular clients. */
|
|
clientSpecificActorInfo?: {
|
|
/** Actor info specific to YouTube clients. */
|
|
youtubeActorInfo?: {
|
|
/** ID of the YouTube channel owned by the Actor. */
|
|
channelId?: string;
|
|
};
|
|
};
|
|
/** The original actor's name, which is suitable for display. */
|
|
displayName?: string;
|
|
/** ID of the original actor. */
|
|
id?: string;
|
|
/** The image representation of the original actor. */
|
|
image?: {
|
|
/** A URL that points to a thumbnail photo of the original actor. */
|
|
url?: string;
|
|
};
|
|
/** A link to the original actor's Google profile. */
|
|
url?: string;
|
|
/** Verification status of actor. */
|
|
verification?: {
|
|
/** Verification for one-time or manual processes. */
|
|
adHocVerified?: string;
|
|
};
|
|
};
|
|
/** The media objects attached to this activity. */
|
|
attachments?: Array<{
|
|
/** If the attachment is an article, this property contains a snippet of text from the article. It can also include descriptions for other types. */
|
|
content?: string;
|
|
/** The title of the attachment, such as a photo caption or an article title. */
|
|
displayName?: string;
|
|
/** If the attachment is a video, the embeddable link. */
|
|
embed?: {
|
|
/** Media type of the link. */
|
|
type?: string;
|
|
/** URL of the link. */
|
|
url?: string;
|
|
};
|
|
/** The full image URL for photo attachments. */
|
|
fullImage?: {
|
|
/** The height, in pixels, of the linked resource. */
|
|
height?: number;
|
|
/** Media type of the link. */
|
|
type?: string;
|
|
/** URL of the image. */
|
|
url?: string;
|
|
/** The width, in pixels, of the linked resource. */
|
|
width?: number;
|
|
};
|
|
/** The ID of the attachment. */
|
|
id?: string;
|
|
/** The preview image for photos or videos. */
|
|
image?: {
|
|
/** The height, in pixels, of the linked resource. */
|
|
height?: number;
|
|
/** Media type of the link. */
|
|
type?: string;
|
|
/** Image URL. */
|
|
url?: string;
|
|
/** The width, in pixels, of the linked resource. */
|
|
width?: number;
|
|
};
|
|
/**
|
|
* The type of media object. Possible values include, but are not limited to, the following values:
|
|
* - "photo" - A photo.
|
|
* - "album" - A photo album.
|
|
* - "video" - A video.
|
|
* - "article" - An article, specified by a link.
|
|
*/
|
|
objectType?: string;
|
|
/**
|
|
* When previewing, these are the optional thumbnails for the post. When posting an article, choose one by setting the attachment.image.url property. If
|
|
* you don't choose one, one will be chosen for you.
|
|
*/
|
|
previewThumbnails?: Array<{
|
|
/** URL of the thumbnail image. */
|
|
url?: string;
|
|
}>;
|
|
/** If the attachment is an album, this property is a list of potential additional thumbnails from the album. */
|
|
thumbnails?: Array<{
|
|
/** Potential name of the thumbnail. */
|
|
description?: string;
|
|
/** Image resource. */
|
|
image?: {
|
|
/** The height, in pixels, of the linked resource. */
|
|
height?: number;
|
|
/** Media type of the link. */
|
|
type?: string;
|
|
/** Image url. */
|
|
url?: string;
|
|
/** The width, in pixels, of the linked resource. */
|
|
width?: number;
|
|
};
|
|
/** URL of the webpage containing the image. */
|
|
url?: string;
|
|
}>;
|
|
/** The link to the attachment, which should be of type text/html. */
|
|
url?: string;
|
|
}>;
|
|
/** The HTML-formatted content, which is suitable for display. */
|
|
content?: string;
|
|
/** The ID of the object. When resharing an activity, this is the ID of the activity that is being reshared. */
|
|
id?: string;
|
|
/**
|
|
* The type of the object. Possible values include, but are not limited to, the following values:
|
|
* - "note" - Textual content.
|
|
* - "activity" - A Google+ activity.
|
|
*/
|
|
objectType?: string;
|
|
/**
|
|
* The content (text) as provided by the author, which is stored without any HTML formatting. When creating or updating an activity, this value must be
|
|
* supplied as plain text in the request.
|
|
*/
|
|
originalContent?: string;
|
|
/** People who +1'd this activity. */
|
|
plusoners?: {
|
|
/** The URL for the collection of people who +1'd this activity. */
|
|
selfLink?: string;
|
|
/** Total number of people who +1'd this activity. */
|
|
totalItems?: number;
|
|
};
|
|
/** Comments in reply to this activity. */
|
|
replies?: {
|
|
/** The URL for the collection of comments in reply to this activity. */
|
|
selfLink?: string;
|
|
/** Total number of comments on this activity. */
|
|
totalItems?: number;
|
|
};
|
|
/** People who reshared this activity. */
|
|
resharers?: {
|
|
/** The URL for the collection of resharers. */
|
|
selfLink?: string;
|
|
/** Total number of people who reshared this activity. */
|
|
totalItems?: number;
|
|
};
|
|
/** Status of the activity as seen by the viewer. */
|
|
statusForViewer?: {
|
|
/** Whether the viewer can comment on the activity. */
|
|
canComment?: boolean;
|
|
/** Whether the viewer can +1 the activity. */
|
|
canPlusone?: boolean;
|
|
/** Whether the viewer can edit or delete the activity. */
|
|
canUpdate?: boolean;
|
|
/** Whether the viewer has +1'd the activity. */
|
|
isPlusOned?: boolean;
|
|
/** Whether reshares are disabled for the activity. */
|
|
resharingDisabled?: boolean;
|
|
};
|
|
/** The URL that points to the linked resource. */
|
|
url?: string;
|
|
};
|
|
/** ID of the place where this activity occurred. */
|
|
placeId?: string;
|
|
/** Name of the place where this activity occurred. */
|
|
placeName?: string;
|
|
/** The service provider that initially published this activity. */
|
|
provider?: {
|
|
/** Name of the service provider. */
|
|
title?: string;
|
|
};
|
|
/** The time at which this activity was initially published. Formatted as an RFC 3339 timestamp. */
|
|
published?: string;
|
|
/** Radius, in meters, of the region where this activity occurred, centered at the latitude and longitude identified in geocode. */
|
|
radius?: string;
|
|
/** Title of this activity. */
|
|
title?: string;
|
|
/** The time at which this activity was last updated. Formatted as an RFC 3339 timestamp. */
|
|
updated?: string;
|
|
/** The link to this activity. */
|
|
url?: string;
|
|
/**
|
|
* 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;
|
|
}
|
|
interface ActivityFeed {
|
|
/** ETag of this response for caching purposes. */
|
|
etag?: string;
|
|
/** The ID of this collection of activities. Deprecated. */
|
|
id?: string;
|
|
/** The activities in this page of results. */
|
|
items?: Activity[];
|
|
/** Identifies this resource as a collection of activities. Value: "plus#activityFeed". */
|
|
kind?: string;
|
|
/** Link to the next page of activities. */
|
|
nextLink?: string;
|
|
/** 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;
|
|
/** Link to this activity resource. */
|
|
selfLink?: string;
|
|
/** The title of this collection of activities, which is a truncated portion of the content. */
|
|
title?: string;
|
|
/** The time at which this collection of activities was last updated. Formatted as an RFC 3339 timestamp. */
|
|
updated?: string;
|
|
}
|
|
interface Audience {
|
|
/** ETag of this response for caching purposes. */
|
|
etag?: string;
|
|
/** The access control list entry. */
|
|
item?: PlusDomainsAclentryResource;
|
|
/** Identifies this resource as an audience. Value: "plus#audience". */
|
|
kind?: string;
|
|
/** The number of people in this circle. This only applies if entity_type is CIRCLE. */
|
|
memberCount?: number;
|
|
/**
|
|
* The circle members' visibility as chosen by the owner of the circle. This only applies for items with "item.type" equals "circle". Possible values are:
|
|
*
|
|
* - "public" - Members are visible to the public.
|
|
* - "limited" - Members are visible to a limited audience.
|
|
* - "private" - Members are visible to the owner only.
|
|
*/
|
|
visibility?: string;
|
|
}
|
|
interface AudiencesFeed {
|
|
/** ETag of this response for caching purposes. */
|
|
etag?: string;
|
|
/** The audiences in this result. */
|
|
items?: Audience[];
|
|
/** Identifies this resource as a collection of audiences. Value: "plus#audienceFeed". */
|
|
kind?: string;
|
|
/** 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;
|
|
/** The total number of ACL entries. The number of entries in this response may be smaller due to paging. */
|
|
totalItems?: number;
|
|
}
|
|
interface Circle {
|
|
/** The description of this circle. */
|
|
description?: string;
|
|
/** The circle name. */
|
|
displayName?: string;
|
|
/** ETag of this response for caching purposes. */
|
|
etag?: string;
|
|
/** The ID of the circle. */
|
|
id?: string;
|
|
/** Identifies this resource as a circle. Value: "plus#circle". */
|
|
kind?: string;
|
|
/** The people in this circle. */
|
|
people?: {
|
|
/** The total number of people in this circle. */
|
|
totalItems?: number;
|
|
};
|
|
/** Link to this circle resource */
|
|
selfLink?: string;
|
|
}
|
|
interface CircleFeed {
|
|
/** ETag of this response for caching purposes. */
|
|
etag?: string;
|
|
/** The circles in this page of results. */
|
|
items?: Circle[];
|
|
/** Identifies this resource as a collection of circles. Value: "plus#circleFeed". */
|
|
kind?: string;
|
|
/** Link to the next page of circles. */
|
|
nextLink?: string;
|
|
/** 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;
|
|
/** Link to this page of circles. */
|
|
selfLink?: string;
|
|
/** The title of this list of resources. */
|
|
title?: string;
|
|
/** The total number of circles. The number of circles in this response may be smaller due to paging. */
|
|
totalItems?: number;
|
|
}
|
|
interface Comment {
|
|
/** The person who posted this comment. */
|
|
actor?: {
|
|
/** Actor info specific to particular clients. */
|
|
clientSpecificActorInfo?: {
|
|
/** Actor info specific to YouTube clients. */
|
|
youtubeActorInfo?: {
|
|
/** ID of the YouTube channel owned by the Actor. */
|
|
channelId?: string;
|
|
};
|
|
};
|
|
/** The name of this actor, suitable for display. */
|
|
displayName?: string;
|
|
/** The ID of the actor. */
|
|
id?: string;
|
|
/** The image representation of this actor. */
|
|
image?: {
|
|
/**
|
|
* The URL of the actor's profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of
|
|
* each side.
|
|
*/
|
|
url?: string;
|
|
};
|
|
/** A link to the Person resource for this actor. */
|
|
url?: string;
|
|
/** Verification status of actor. */
|
|
verification?: {
|
|
/** Verification for one-time or manual processes. */
|
|
adHocVerified?: string;
|
|
};
|
|
};
|
|
/** ETag of this response for caching purposes. */
|
|
etag?: string;
|
|
/** The ID of this comment. */
|
|
id?: string;
|
|
/** The activity this comment replied to. */
|
|
inReplyTo?: Array<{
|
|
/** The ID of the activity. */
|
|
id?: string;
|
|
/** The URL of the activity. */
|
|
url?: string;
|
|
}>;
|
|
/** Identifies this resource as a comment. Value: "plus#comment". */
|
|
kind?: string;
|
|
/** The object of this comment. */
|
|
object?: {
|
|
/** The HTML-formatted content, suitable for display. */
|
|
content?: string;
|
|
/**
|
|
* The object type of this comment. Possible values are:
|
|
* - "comment" - A comment in reply to an activity.
|
|
*/
|
|
objectType?: string;
|
|
/**
|
|
* The content (text) as provided by the author, stored without any HTML formatting. When creating or updating a comment, this value must be supplied as
|
|
* plain text in the request.
|
|
*/
|
|
originalContent?: string;
|
|
};
|
|
/** People who +1'd this comment. */
|
|
plusoners?: {
|
|
/** Total number of people who +1'd this comment. */
|
|
totalItems?: number;
|
|
};
|
|
/** The time at which this comment was initially published. Formatted as an RFC 3339 timestamp. */
|
|
published?: string;
|
|
/** Link to this comment resource. */
|
|
selfLink?: string;
|
|
/** The time at which this comment was last updated. Formatted as an RFC 3339 timestamp. */
|
|
updated?: string;
|
|
/**
|
|
* This comment's verb, indicating what action was performed. Possible values are:
|
|
* - "post" - Publish content to the stream.
|
|
*/
|
|
verb?: string;
|
|
}
|
|
interface CommentFeed {
|
|
/** ETag of this response for caching purposes. */
|
|
etag?: string;
|
|
/** The ID of this collection of comments. */
|
|
id?: string;
|
|
/** The comments in this page of results. */
|
|
items?: Comment[];
|
|
/** Identifies this resource as a collection of comments. Value: "plus#commentFeed". */
|
|
kind?: string;
|
|
/** Link to the next page of activities. */
|
|
nextLink?: string;
|
|
/** 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;
|
|
/** The title of this collection of comments. */
|
|
title?: string;
|
|
/** The time at which this collection of comments was last updated. Formatted as an RFC 3339 timestamp. */
|
|
updated?: string;
|
|
}
|
|
interface Media {
|
|
/** The person who uploaded this media. */
|
|
author?: {
|
|
/** The author's name. */
|
|
displayName?: string;
|
|
/** ID of the author. */
|
|
id?: string;
|
|
/** The author's Google profile image. */
|
|
image?: {
|
|
/**
|
|
* The URL of the author's profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels
|
|
* of each side.
|
|
*/
|
|
url?: string;
|
|
};
|
|
/** A link to the author's Google profile. */
|
|
url?: string;
|
|
};
|
|
/** The display name for this media. */
|
|
displayName?: string;
|
|
/** ETag of this response for caching purposes. */
|
|
etag?: string;
|
|
/** Exif information of the media item. */
|
|
exif?: {
|
|
/** The time the media was captured. Formatted as an RFC 3339 timestamp. */
|
|
time?: string;
|
|
};
|
|
/** The height in pixels of the original image. */
|
|
height?: number;
|
|
/** ID of this media, which is generated by the API. */
|
|
id?: string;
|
|
/** The type of resource. */
|
|
kind?: string;
|
|
/** The time at which this media was originally created in UTC. Formatted as an RFC 3339 timestamp that matches this example: 2010-11-25T14:30:27.655Z */
|
|
mediaCreatedTime?: string;
|
|
/** The URL of this photo or video's still image. */
|
|
mediaUrl?: string;
|
|
/** The time at which this media was uploaded. Formatted as an RFC 3339 timestamp. */
|
|
published?: string;
|
|
/** The size in bytes of this video. */
|
|
sizeBytes?: string;
|
|
/** The list of video streams for this video. There might be several different streams available for a single video, either Flash or MPEG, of various sizes */
|
|
streams?: Videostream[];
|
|
/** A description, or caption, for this media. */
|
|
summary?: string;
|
|
/** The time at which this media was last updated. This includes changes to media metadata. Formatted as an RFC 3339 timestamp. */
|
|
updated?: string;
|
|
/** The URL for the page that hosts this media. */
|
|
url?: string;
|
|
/** The duration in milliseconds of this video. */
|
|
videoDuration?: string;
|
|
/**
|
|
* The encoding status of this video. Possible values are:
|
|
* - "UPLOADING" - Not all the video bytes have been received.
|
|
* - "PENDING" - Video not yet processed.
|
|
* - "FAILED" - Video processing failed.
|
|
* - "READY" - A single video stream is playable.
|
|
* - "FINAL" - All video streams are playable.
|
|
*/
|
|
videoStatus?: string;
|
|
/** The width in pixels of the original image. */
|
|
width?: number;
|
|
}
|
|
interface PeopleFeed {
|
|
/** ETag of this response for caching purposes. */
|
|
etag?: string;
|
|
/**
|
|
* 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?: Person[];
|
|
/** Identifies this resource as a collection of people. Value: "plus#peopleFeed". */
|
|
kind?: string;
|
|
/** 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;
|
|
/** Link to this resource. */
|
|
selfLink?: string;
|
|
/** The title of this collection of people. */
|
|
title?: string;
|
|
/**
|
|
* 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;
|
|
}
|
|
interface Person {
|
|
/** A short biography for this person. */
|
|
aboutMe?: string;
|
|
/** The person's date of birth, represented as YYYY-MM-DD. */
|
|
birthday?: string;
|
|
/** The "bragging rights" line of this person. */
|
|
braggingRights?: string;
|
|
/** For followers who are visible, the number of people who have added this person or page to a circle. */
|
|
circledByCount?: number;
|
|
/** The cover photo content. */
|
|
cover?: {
|
|
/** Extra information about the cover photo. */
|
|
coverInfo?: {
|
|
/** The difference between the left position of the cover image and the actual displayed cover image. Only valid for banner layout. */
|
|
leftImageOffset?: number;
|
|
/** The difference between the top position of the cover image and the actual displayed cover image. Only valid for banner layout. */
|
|
topImageOffset?: number;
|
|
};
|
|
/** The person's primary cover image. */
|
|
coverPhoto?: {
|
|
/** The height of the image. */
|
|
height?: number;
|
|
/** The URL of the image. */
|
|
url?: string;
|
|
/** The width of the image. */
|
|
width?: number;
|
|
};
|
|
/**
|
|
* The layout of the cover art. Possible values include, but are not limited to, the following values:
|
|
* - "banner" - One large image banner.
|
|
*/
|
|
layout?: string;
|
|
};
|
|
/** (this field is not currently used) */
|
|
currentLocation?: string;
|
|
/** The name of this person, which is suitable for display. */
|
|
displayName?: string;
|
|
/**
|
|
* 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;
|
|
/**
|
|
* 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<{
|
|
/**
|
|
* The type of address. Possible values include, but are not limited to, the following values:
|
|
* - "account" - Google account email address.
|
|
* - "home" - Home email address.
|
|
* - "work" - Work email address.
|
|
* - "other" - Other.
|
|
*/
|
|
type?: string;
|
|
/** The email address. */
|
|
value?: string;
|
|
}>;
|
|
/** ETag of this response for caching purposes. */
|
|
etag?: string;
|
|
/**
|
|
* 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;
|
|
/** The ID of this person. */
|
|
id?: string;
|
|
/** The representation of the person's profile photo. */
|
|
image?: {
|
|
/** Whether the person's profile photo is the default one */
|
|
isDefault?: boolean;
|
|
/**
|
|
* The URL of the person's profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels
|
|
* of each side.
|
|
*/
|
|
url?: string;
|
|
};
|
|
/** Whether this user has signed up for Google+. */
|
|
isPlusUser?: boolean;
|
|
/** Identifies this resource as a person. Value: "plus#person". */
|
|
kind?: string;
|
|
/** An object representation of the individual components of a person's name. */
|
|
name?: {
|
|
/** The family name (last name) of this person. */
|
|
familyName?: string;
|
|
/** The full name of this person, including middle names, suffixes, etc. */
|
|
formatted?: string;
|
|
/** The given name (first name) of this person. */
|
|
givenName?: string;
|
|
/** The honorific prefixes (such as "Dr." or "Mrs.") for this person. */
|
|
honorificPrefix?: string;
|
|
/** The honorific suffixes (such as "Jr.") for this person. */
|
|
honorificSuffix?: string;
|
|
/** The middle name of this person. */
|
|
middleName?: string;
|
|
};
|
|
/** The nickname of this person. */
|
|
nickname?: string;
|
|
/**
|
|
* 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;
|
|
/** The occupation of this person. */
|
|
occupation?: string;
|
|
/** A list of current or past organizations with which this person is associated. */
|
|
organizations?: Array<{
|
|
/** The department within the organization. Deprecated. */
|
|
department?: string;
|
|
/** A short description of the person's role in this organization. Deprecated. */
|
|
description?: string;
|
|
/** The date that the person left this organization. */
|
|
endDate?: string;
|
|
/** The location of this organization. Deprecated. */
|
|
location?: string;
|
|
/** The name of the organization. */
|
|
name?: string;
|
|
/** If "true", indicates this organization is the person's primary one, which is typically interpreted as the current one. */
|
|
primary?: boolean;
|
|
/** The date that the person joined this organization. */
|
|
startDate?: string;
|
|
/** The person's job title or role within the organization. */
|
|
title?: string;
|
|
/**
|
|
* The type of organization. Possible values include, but are not limited to, the following values:
|
|
* - "work" - Work.
|
|
* - "school" - School.
|
|
*/
|
|
type?: string;
|
|
}>;
|
|
/** A list of places where this person has lived. */
|
|
placesLived?: Array<{
|
|
/** If "true", this place of residence is this person's primary residence. */
|
|
primary?: boolean;
|
|
/** A place where this person has lived. For example: "Seattle, WA", "Near Toronto". */
|
|
value?: string;
|
|
}>;
|
|
/** If a Google+ Page, the number of people who have +1'd this page. */
|
|
plusOneCount?: number;
|
|
/**
|
|
* 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;
|
|
/** The person's skills. */
|
|
skills?: string;
|
|
/** The brief description (tagline) of this person. */
|
|
tagline?: string;
|
|
/** The URL of this person's profile. */
|
|
url?: string;
|
|
/** A list of URLs for this person. */
|
|
urls?: Array<{
|
|
/** The label of the URL. */
|
|
label?: string;
|
|
/**
|
|
* The type of URL. Possible values include, but are not limited to, the following values:
|
|
* - "otherProfile" - URL for another profile.
|
|
* - "contributor" - URL to a site for which this person is a contributor.
|
|
* - "website" - URL for this Google+ Page's primary website.
|
|
* - "other" - Other URL.
|
|
*/
|
|
type?: string;
|
|
/** The URL value. */
|
|
value?: string;
|
|
}>;
|
|
/** Whether the person or Google+ Page has been verified. */
|
|
verified?: boolean;
|
|
}
|
|
interface Place {
|
|
/** The physical address of the place. */
|
|
address?: {
|
|
/** The formatted address for display. */
|
|
formatted?: string;
|
|
};
|
|
/** The display name of the place. */
|
|
displayName?: string;
|
|
/** The id of the place. */
|
|
id?: string;
|
|
/** Identifies this resource as a place. Value: "plus#place". */
|
|
kind?: string;
|
|
/** The position of the place. */
|
|
position?: {
|
|
/** The latitude of this position. */
|
|
latitude?: number;
|
|
/** The longitude of this position. */
|
|
longitude?: number;
|
|
};
|
|
}
|
|
interface PlusDomainsAclentryResource {
|
|
/** A descriptive name for this entry. Suitable for display. */
|
|
displayName?: string;
|
|
/** 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;
|
|
/**
|
|
* 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;
|
|
}
|
|
interface Videostream {
|
|
/** The height, in pixels, of the video resource. */
|
|
height?: number;
|
|
/** MIME type of the video stream. */
|
|
type?: string;
|
|
/** URL of the video stream. */
|
|
url?: string;
|
|
/** The width, in pixels, of the video resource. */
|
|
width?: number;
|
|
}
|
|
interface ActivitiesResource {
|
|
/** Get an activity. */
|
|
get(request: {
|
|
/** The ID of the activity to get. */
|
|
activityId: string;
|
|
/** 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;
|
|
/**
|
|
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
* Overrides userIp if both are provided.
|
|
*/
|
|
quotaUser?: string;
|
|
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
|
|
userIp?: string;
|
|
}): Request<Activity>;
|
|
/** Create a new activity for the authenticated user. */
|
|
insert(request: {
|
|
/** 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;
|
|
/**
|
|
* If "true", extract the potential media attachments for a URL. The response will include all possible attachments for a URL, including video, photos,
|
|
* and articles based on the content of the page.
|
|
*/
|
|
preview?: boolean;
|
|
/**
|
|
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
* Overrides userIp if both are provided.
|
|
*/
|
|
quotaUser?: string;
|
|
/** The ID of the user to create the activity on behalf of. Its value should be "me", to indicate the authenticated user. */
|
|
userId: string;
|
|
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
|
|
userIp?: string;
|
|
}): Request<Activity>;
|
|
/** List all of the activities in the specified collection for a particular user. */
|
|
list(request: {
|
|
/** Data format for the response. */
|
|
alt?: string;
|
|
/** The collection of activities to list. */
|
|
collection: 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;
|
|
/**
|
|
* 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;
|
|
/** OAuth 2.0 token for the current user. */
|
|
oauth_token?: 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;
|
|
/** Returns response with indentations and line breaks. */
|
|
prettyPrint?: boolean;
|
|
/**
|
|
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
* Overrides userIp if both are provided.
|
|
*/
|
|
quotaUser?: string;
|
|
/** The ID of the user to get activities for. The special value "me" can be used to indicate the authenticated user. */
|
|
userId: string;
|
|
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
|
|
userIp?: string;
|
|
}): Request<ActivityFeed>;
|
|
}
|
|
interface AudiencesResource {
|
|
/** List all of the audiences to which a user can share. */
|
|
list(request: {
|
|
/** 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;
|
|
/**
|
|
* The maximum number of circles 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;
|
|
/** OAuth 2.0 token for the current user. */
|
|
oauth_token?: 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;
|
|
/** Returns response with indentations and line breaks. */
|
|
prettyPrint?: boolean;
|
|
/**
|
|
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
* Overrides userIp if both are provided.
|
|
*/
|
|
quotaUser?: string;
|
|
/** The ID of the user to get audiences for. The special value "me" can be used to indicate the authenticated user. */
|
|
userId: string;
|
|
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
|
|
userIp?: string;
|
|
}): Request<AudiencesFeed>;
|
|
}
|
|
interface CirclesResource {
|
|
/** Add a person to a circle. Google+ limits certain circle operations, including the number of circle adds. Learn More. */
|
|
addPeople(request: {
|
|
/** Data format for the response. */
|
|
alt?: string;
|
|
/** The ID of the circle to add the person to. */
|
|
circleId: string;
|
|
/** Email of the people to add to the circle. Optional, can be repeated. */
|
|
email?: string;
|
|
/** Selector specifying which fields to include in a partial response. */
|
|
fields?: string;
|
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
key?: string;
|
|
/** OAuth 2.0 token for the current user. */
|
|
oauth_token?: string;
|
|
/** Returns response with indentations and line breaks. */
|
|
prettyPrint?: boolean;
|
|
/**
|
|
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
* Overrides userIp if both are provided.
|
|
*/
|
|
quotaUser?: string;
|
|
/** IDs of the people to add to the circle. Optional, can be repeated. */
|
|
userId?: string;
|
|
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
|
|
userIp?: string;
|
|
}): Request<Circle>;
|
|
/** Get a circle. */
|
|
get(request: {
|
|
/** Data format for the response. */
|
|
alt?: string;
|
|
/** The ID of the circle to get. */
|
|
circleId: string;
|
|
/** Selector specifying which fields to include in a partial response. */
|
|
fields?: string;
|
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
key?: string;
|
|
/** OAuth 2.0 token for the current user. */
|
|
oauth_token?: string;
|
|
/** Returns response with indentations and line breaks. */
|
|
prettyPrint?: boolean;
|
|
/**
|
|
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
* Overrides userIp if both are provided.
|
|
*/
|
|
quotaUser?: string;
|
|
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
|
|
userIp?: string;
|
|
}): Request<Circle>;
|
|
/** Create a new circle for the authenticated user. */
|
|
insert(request: {
|
|
/** 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;
|
|
/**
|
|
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
* Overrides userIp if both are provided.
|
|
*/
|
|
quotaUser?: string;
|
|
/** The ID of the user to create the circle on behalf of. The value "me" can be used to indicate the authenticated user. */
|
|
userId: string;
|
|
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
|
|
userIp?: string;
|
|
}): Request<Circle>;
|
|
/** List all of the circles for a user. */
|
|
list(request: {
|
|
/** 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;
|
|
/**
|
|
* The maximum number of circles 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;
|
|
/** OAuth 2.0 token for the current user. */
|
|
oauth_token?: 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;
|
|
/** Returns response with indentations and line breaks. */
|
|
prettyPrint?: boolean;
|
|
/**
|
|
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
* Overrides userIp if both are provided.
|
|
*/
|
|
quotaUser?: string;
|
|
/** The ID of the user to get circles for. The special value "me" can be used to indicate the authenticated user. */
|
|
userId: string;
|
|
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
|
|
userIp?: string;
|
|
}): Request<CircleFeed>;
|
|
/** Update a circle's description. This method supports patch semantics. */
|
|
patch(request: {
|
|
/** Data format for the response. */
|
|
alt?: string;
|
|
/** The ID of the circle to update. */
|
|
circleId: string;
|
|
/** Selector specifying which fields to include in a partial response. */
|
|
fields?: string;
|
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
key?: string;
|
|
/** OAuth 2.0 token for the current user. */
|
|
oauth_token?: string;
|
|
/** Returns response with indentations and line breaks. */
|
|
prettyPrint?: boolean;
|
|
/**
|
|
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
* Overrides userIp if both are provided.
|
|
*/
|
|
quotaUser?: string;
|
|
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
|
|
userIp?: string;
|
|
}): Request<Circle>;
|
|
/** Delete a circle. */
|
|
remove(request: {
|
|
/** Data format for the response. */
|
|
alt?: string;
|
|
/** The ID of the circle to delete. */
|
|
circleId: string;
|
|
/** Selector specifying which fields to include in a partial response. */
|
|
fields?: string;
|
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
key?: string;
|
|
/** OAuth 2.0 token for the current user. */
|
|
oauth_token?: string;
|
|
/** Returns response with indentations and line breaks. */
|
|
prettyPrint?: boolean;
|
|
/**
|
|
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
* Overrides userIp if both are provided.
|
|
*/
|
|
quotaUser?: string;
|
|
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
|
|
userIp?: string;
|
|
}): Request<void>;
|
|
/** Remove a person from a circle. */
|
|
removePeople(request: {
|
|
/** Data format for the response. */
|
|
alt?: string;
|
|
/** The ID of the circle to remove the person from. */
|
|
circleId: string;
|
|
/** Email of the people to add to the circle. Optional, can be repeated. */
|
|
email?: string;
|
|
/** Selector specifying which fields to include in a partial response. */
|
|
fields?: string;
|
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
key?: string;
|
|
/** OAuth 2.0 token for the current user. */
|
|
oauth_token?: string;
|
|
/** Returns response with indentations and line breaks. */
|
|
prettyPrint?: boolean;
|
|
/**
|
|
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
* Overrides userIp if both are provided.
|
|
*/
|
|
quotaUser?: string;
|
|
/** IDs of the people to remove from the circle. Optional, can be repeated. */
|
|
userId?: string;
|
|
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
|
|
userIp?: string;
|
|
}): Request<void>;
|
|
/** Update a circle's description. */
|
|
update(request: {
|
|
/** Data format for the response. */
|
|
alt?: string;
|
|
/** The ID of the circle to update. */
|
|
circleId: string;
|
|
/** Selector specifying which fields to include in a partial response. */
|
|
fields?: string;
|
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
key?: string;
|
|
/** OAuth 2.0 token for the current user. */
|
|
oauth_token?: string;
|
|
/** Returns response with indentations and line breaks. */
|
|
prettyPrint?: boolean;
|
|
/**
|
|
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
* Overrides userIp if both are provided.
|
|
*/
|
|
quotaUser?: string;
|
|
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
|
|
userIp?: string;
|
|
}): Request<Circle>;
|
|
}
|
|
interface CommentsResource {
|
|
/** Get a comment. */
|
|
get(request: {
|
|
/** Data format for the response. */
|
|
alt?: string;
|
|
/** The ID of the comment to get. */
|
|
commentId: string;
|
|
/** Selector specifying which fields to include in a partial response. */
|
|
fields?: string;
|
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
key?: string;
|
|
/** OAuth 2.0 token for the current user. */
|
|
oauth_token?: string;
|
|
/** Returns response with indentations and line breaks. */
|
|
prettyPrint?: boolean;
|
|
/**
|
|
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
* Overrides userIp if both are provided.
|
|
*/
|
|
quotaUser?: string;
|
|
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
|
|
userIp?: string;
|
|
}): Request<Comment>;
|
|
/** Create a new comment in reply to an activity. */
|
|
insert(request: {
|
|
/** The ID of the activity to reply to. */
|
|
activityId: string;
|
|
/** 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;
|
|
/**
|
|
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
* Overrides userIp if both are provided.
|
|
*/
|
|
quotaUser?: string;
|
|
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
|
|
userIp?: string;
|
|
}): Request<Comment>;
|
|
/** List all of the comments for an activity. */
|
|
list(request: {
|
|
/** The ID of the activity to get comments for. */
|
|
activityId: string;
|
|
/** 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;
|
|
/**
|
|
* 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;
|
|
/** OAuth 2.0 token for the current user. */
|
|
oauth_token?: 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;
|
|
/** Returns response with indentations and line breaks. */
|
|
prettyPrint?: boolean;
|
|
/**
|
|
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
* Overrides userIp if both are provided.
|
|
*/
|
|
quotaUser?: string;
|
|
/** The order in which to sort the list of comments. */
|
|
sortOrder?: string;
|
|
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
|
|
userIp?: string;
|
|
}): Request<CommentFeed>;
|
|
}
|
|
interface MediaResource {
|
|
/**
|
|
* Add a new media item to an album. The current upload size limitations are 36MB for a photo and 1GB for a video. Uploads do not count against quota if
|
|
* photos are less than 2048 pixels on their longest side or videos are less than 15 minutes in length.
|
|
*/
|
|
insert(request: {
|
|
/** Data format for the response. */
|
|
alt?: string;
|
|
collection: string;
|
|
/** Selector specifying which fields to include in a partial response. */
|
|
fields?: string;
|
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
key?: string;
|
|
/** OAuth 2.0 token for the current user. */
|
|
oauth_token?: string;
|
|
/** Returns response with indentations and line breaks. */
|
|
prettyPrint?: boolean;
|
|
/**
|
|
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
* Overrides userIp if both are provided.
|
|
*/
|
|
quotaUser?: string;
|
|
/** The ID of the user to create the activity on behalf of. */
|
|
userId: string;
|
|
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
|
|
userIp?: string;
|
|
}): Request<Media>;
|
|
}
|
|
interface PeopleResource {
|
|
/** Get a person's profile. */
|
|
get(request: {
|
|
/** 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;
|
|
/**
|
|
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
* Overrides userIp if both are provided.
|
|
*/
|
|
quotaUser?: string;
|
|
/** The ID of the person to get the profile for. The special value "me" can be used to indicate the authenticated user. */
|
|
userId: string;
|
|
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
|
|
userIp?: string;
|
|
}): Request<Person>;
|
|
/** List all of the people in the specified collection. */
|
|
list(request: {
|
|
/** Data format for the response. */
|
|
alt?: string;
|
|
/** The collection of people to list. */
|
|
collection: 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;
|
|
/**
|
|
* 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;
|
|
/** OAuth 2.0 token for the current user. */
|
|
oauth_token?: string;
|
|
/** 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;
|
|
/** Returns response with indentations and line breaks. */
|
|
prettyPrint?: boolean;
|
|
/**
|
|
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
* Overrides userIp if both are provided.
|
|
*/
|
|
quotaUser?: string;
|
|
/** Get the collection of people for the person identified. Use "me" to indicate the authenticated user. */
|
|
userId: string;
|
|
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
|
|
userIp?: string;
|
|
}): Request<PeopleFeed>;
|
|
/** List all of the people in the specified collection for a particular activity. */
|
|
listByActivity(request: {
|
|
/** The ID of the activity to get the list of people for. */
|
|
activityId: string;
|
|
/** Data format for the response. */
|
|
alt?: string;
|
|
/** The collection of people to list. */
|
|
collection: 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;
|
|
/**
|
|
* 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;
|
|
/** OAuth 2.0 token for the current user. */
|
|
oauth_token?: 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;
|
|
/** Returns response with indentations and line breaks. */
|
|
prettyPrint?: boolean;
|
|
/**
|
|
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
* Overrides userIp if both are provided.
|
|
*/
|
|
quotaUser?: string;
|
|
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
|
|
userIp?: string;
|
|
}): Request<PeopleFeed>;
|
|
/** List all of the people who are members of a circle. */
|
|
listByCircle(request: {
|
|
/** Data format for the response. */
|
|
alt?: string;
|
|
/** The ID of the circle to get the members of. */
|
|
circleId: 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;
|
|
/**
|
|
* 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;
|
|
/** OAuth 2.0 token for the current user. */
|
|
oauth_token?: 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;
|
|
/** Returns response with indentations and line breaks. */
|
|
prettyPrint?: boolean;
|
|
/**
|
|
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
* Overrides userIp if both are provided.
|
|
*/
|
|
quotaUser?: string;
|
|
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
|
|
userIp?: string;
|
|
}): Request<PeopleFeed>;
|
|
}
|
|
}
|
|
}
|