Google+ API v1

Version: 5.3

Google+ API v1

This documentation has been automatically generated using information supplied by the Google API Discovery service.

The Google+ API enables developers to build on top of the Google+ platform. Google documentation.

(require gapi/macro)

(require-gapi-doc plus.v1.js)

1 API Parameters

The following optional keyword arguments may be passed to all functions for this web service:

procedure
(_ [ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

This is not actually a function. This is just using Scribble’s defproc form to list the optional keyword arguments that may be passed to all functions for this service.

alt: Data format for the response.

fields: Selector specifying which fields to include in a partial response.

key: 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.

oauth_token: OAuth 2.0 token for the current user.

prettyPrint: Returns response with indentations and line breaks.

quotaUser: 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.

userIp: IP address of the site where the request originates. Use this if you want to enforce per-user limits.

2 Resources

2.1 activities

procedure
(plus-activities-list #:collection collection
#:userId userId
[ #:maxResults maxResults
#:pageToken pageToken
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  collection : string?
  userId : string?
  maxResults : string? = 'N/A
  pageToken : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

List all of the activities in the specified collection for a particular user.

collection: The collection of activities to list.

userId: The ID of the user to get activities for. The special value "me" can be used to indicate the authenticated user.

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.

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.

procedure
(plus-activities-get #:activityId activityId
[ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  activityId : string?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Get an activity.

activityId: The ID of the activity to get.

procedure
(plus-activities-search #:query query
[ #:maxResults maxResults
#:pageToken pageToken
#:language language
#:orderBy orderBy
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  query : string?
  maxResults : string? = 'N/A
  pageToken : string? = 'N/A
  language : string? = 'N/A
  orderBy : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Search public activities.

query: Full-text search query string.

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.

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.

language: Specify the preferred language to search with. See search language codes for available values.

orderBy: Specifies how to order search results.

2.2 comments

procedure
(plus-comments-list #:activityId activityId
[ #:sortOrder sortOrder
#:maxResults maxResults
#:pageToken pageToken
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  activityId : string?
  sortOrder : string? = 'N/A
  maxResults : string? = 'N/A
  pageToken : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

List all of the comments for an activity.

activityId: The ID of the activity to get comments for.

sortOrder: The order in which to sort the list of comments.

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.

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.

procedure
(plus-comments-get #:commentId commentId
[ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  commentId : string?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Get a comment.

commentId: The ID of the comment to get.

2.3 people

procedure
(plus-people-get #:userId userId
[ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  userId : string?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Get a person’s profile.

userId: The ID of the person to get the profile for. The special value "me" can be used to indicate the authenticated user.

procedure
(plus-people-search #:query query
[ #:maxResults maxResults
#:pageToken pageToken
#:language language
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  query : string?
  maxResults : string? = 'N/A
  pageToken : string? = 'N/A
  language : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Search all public profiles.

query: Specify a query string for full text search of public text in all profiles.

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.

language: Specify the preferred language to search with. See search language codes for available values.

procedure
(plus-people-listByActivity #:collection collection
#:activityId activityId
[ #:maxResults maxResults
#:pageToken pageToken
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  collection : string?
  activityId : string?
  maxResults : string? = 'N/A
  pageToken : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

List all of the people in the specified collection for a particular activity.

collection: The collection of people to list.

activityId: The ID of the activity to get the list of people for.

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.

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.