Orkut API v2
This documentation has been automatically generated using information supplied by the Google API Discovery service.
1 API Parameters
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.
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 acl
procedure
(orkut-acl-delete #:userId userId #:activityId activityId [ #:alt alt #:fields fields #:key key #:oauth_token oauth_token #:prettyPrint prettyPrint #:quotaUser quotaUser #:userIp userIp]) → jsexpr? userId : string? 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
userId: ID of the user to be removed from the activity.
activityId: ID of the activity.
2.2 counters
procedure
(orkut-counters-list #: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
userId: The ID of the user whose counters will be listed. Can be me to refer to caller.
2.3 activities
procedure
userId : string? collection : string? hl : 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
userId: The ID of the user whose activities will be listed. Can be me to refer to the viewer (i.e. the authenticated user).
collection: The collection of activities to list.
hl: Specifies the interface language (host language) of your user interface.
maxResults: The maximum number of activities to include in the response.
pageToken: A continuation token that allows pagination.
procedure
(orkut-activities-delete #: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
activityId: ID of the activity to remove.
2.4 activityVisibility
procedure
(orkut-activityVisibility-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
activityId: ID of the activity to get the visibility.
procedure
→ jsexpr? activityId : string? visibility : string? = 'N/A links : string? = 'N/A kind : 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
activityId: ID of the activity.
visibility: The visibility of the resource. Possible values are: - default: not hidden by the user - hidden: hidden
links: List of resources for the visibility item.
kind: Identifies this resource as a visibility item. Value: "orkut#visibility"
procedure
→ jsexpr? activityId : string? visibility : string? = 'N/A links : string? = 'N/A kind : 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
activityId: ID of the activity.
visibility: The visibility of the resource. Possible values are: - default: not hidden by the user - hidden: hidden
links: List of resources for the visibility item.
kind: Identifies this resource as a visibility item. Value: "orkut#visibility"
2.5 badges
procedure
(orkut-badges-list #: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
userId: The id of the user whose badges will be listed. Can be me to refer to caller.
procedure
(orkut-badges-get #:userId userId #:badgeId badgeId [ #:alt alt #:fields fields #:key key #:oauth_token oauth_token #:prettyPrint prettyPrint #:quotaUser quotaUser #:userIp userIp]) → jsexpr? userId : string? badgeId : 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
userId: The ID of the user whose badges will be listed. Can be me to refer to caller.
badgeId: The ID of the badge that will be retrieved.
2.6 comments
procedure
activityId : string? hl : string? = 'N/A orderBy : 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
activityId: The ID of the activity containing the comments.
hl: Specifies the interface language (host language) of your user interface.
orderBy: Sort search results.
maxResults: The maximum number of activities to include in the response.
pageToken: A continuation token that allows pagination.
procedure
(orkut-comments-get #:commentId commentId [ #:hl hl #:alt alt #:fields fields #:key key #:oauth_token oauth_token #:prettyPrint prettyPrint #:quotaUser quotaUser #:userIp userIp]) → jsexpr? commentId : string? hl : 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
commentId: ID of the comment to get.
hl: Specifies the interface language (host language) of your user interface.
procedure
activityId : string? id : string? = 'N/A actor : string? = 'N/A links : string? = 'N/A published : string? = 'N/A inReplyTo : string? = 'N/A kind : string? = 'N/A content : 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
activityId: The ID of the activity to contain the new comment.
id: The unique ID for the comment.
actor: The person who posted the comment.
links: List of resources for the comment.
published: The time the comment was initially published, in RFC 3339 format.
inReplyTo: Link to the original activity where this comment was posted.
kind: Identifies this resource as a comment. Value: "orkut#comment"
content: The content of the comment in text/html
procedure
(orkut-comments-delete #: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
commentId: ID of the comment to remove.
2.7 communities
procedure
userId : string? hl : string? = 'N/A orderBy : string? = 'N/A maxResults : 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
userId: The ID of the user whose communities will be listed. Can be me to refer to caller.
hl: Specifies the interface language (host language) of your user interface.
orderBy: How to order the communities by.
maxResults: The maximum number of communities to include in the response.
procedure
(orkut-communities-get #:communityId communityId [ #:hl hl #:alt alt #:fields fields #:key key #:oauth_token oauth_token #:prettyPrint prettyPrint #:quotaUser quotaUser #:userIp userIp]) → jsexpr? communityId : string? hl : 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
communityId: The ID of the community to get.
hl: Specifies the interface language (host language) of your user interface.
2.8 communityFollow
procedure
→ jsexpr? userId : string? communityId : 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
userId: ID of the user.
communityId: ID of the community.
procedure
→ jsexpr? userId : string? communityId : 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
userId: ID of the user.
communityId: ID of the community.
2.9 communityMembers
procedure
→ jsexpr? communityId : string? hl : string? = 'N/A friendsOnly : 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
communityId: The ID of the community whose members will be listed.
hl: Specifies the interface language (host language) of your user interface.
friendsOnly: Whether to list only community members who are friends of the user.
maxResults: The maximum number of members to include in the response.
pageToken: A continuation token that allows pagination.
procedure
→ jsexpr? userId : string? communityId : string? hl : 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
userId: ID of the user.
communityId: ID of the community.
hl: Specifies the interface language (host language) of your user interface.
procedure
→ jsexpr? userId : string? communityId : 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
userId: ID of the user.
communityId: ID of the community.
procedure
→ jsexpr? userId : string? communityId : 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
userId: ID of the user.
communityId: ID of the community.
2.10 communityMessages
procedure
→ jsexpr? topicId : string? communityId : string? hl : 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
topicId: The ID of the topic which messages will be listed.
communityId: The ID of the community which messages will be listed.
hl: Specifies the interface language (host language) of your user interface.
maxResults: The maximum number of messages to include in the response.
pageToken: A continuation token that allows pagination.
procedure
→ jsexpr? topicId : string? communityId : string? id : string? = 'N/A author : string? = 'N/A links : string? = 'N/A addedDate : string? = 'N/A isSpam : string? = 'N/A subject : string? = 'N/A body : string? = 'N/A kind : 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
topicId: The ID of the topic the message should be added to.
communityId: The ID of the community the message should be added to.
id: The ID of the message.
author: The creator of the message. If ommited, the message is annonimous.
links: List of resources for the community message.
addedDate: The timestamp of the date when the message was added, in RFC 3339 format.
isSpam: Whether this post was marked as spam by the viewer, when he/she is not the community owner or one of its moderators.
subject: The subject of the message.
body: The body of the message.
kind: Identifies this resource as a community message. Value: "orkut#communityMessage"
procedure
→ jsexpr? topicId : string? communityId : string? messageId : 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
topicId: The ID of the topic whose message will be moved to the trash folder.
communityId: The ID of the community whose message will be moved to the trash folder.
messageId: The ID of the message to be moved to the trash folder.
2.11 communityPollComments
procedure
→ jsexpr? communityId : string? pollId : string? hl : 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
communityId: The ID of the community whose poll is having its comments listed.
pollId: The ID of the community whose polls will be listed.
hl: Specifies the interface language (host language) of your user interface.
maxResults: The maximum number of comments to include in the response.
pageToken: A continuation token that allows pagination.
procedure
→ jsexpr? communityId : string? pollId : string? id : string? = 'N/A author : string? = 'N/A addedDate : string? = 'N/A body : string? = 'N/A kind : 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
communityId: The ID of the community whose poll is being commented.
pollId: The ID of the poll being commented.
id: The ID of the comment.
author: The creator of the comment.
addedDate: The date when the message was added, in RFC 3339 format.
body: The body of the message.
kind: Identifies this resource as a community poll comment. Value: "orkut#communityPollComment"
2.12 communityPollVotes
procedure
→ jsexpr? communityId : string? pollId : string? isVotevisible : string? = 'N/A optionIds : string? = 'N/A kind : 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
communityId: The ID of the community whose poll is being voted.
pollId: The ID of the poll being voted.
isVotevisible: Whether this vote is visible to other users or not.
optionIds: The ids of the voted options.
kind: Identifies this resource as a community poll vote. Value: "orkut#communityPollVote"
2.13 communityPolls
procedure
communityId : string? hl : 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
communityId: The ID of the community which polls will be listed.
hl: Specifies the interface language (host language) of your user interface.
maxResults: The maximum number of polls to include in the response.
pageToken: A continuation token that allows pagination.
procedure
communityId : string? pollId : string? hl : 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
communityId: The ID of the community for whose poll will be retrieved.
pollId: The ID of the poll to get.
hl: Specifies the interface language (host language) of your user interface.
2.14 communityRelated
procedure
(orkut-communityRelated-list #:communityId communityId [ #:hl hl #:alt alt #:fields fields #:key key #:oauth_token oauth_token #:prettyPrint prettyPrint #:quotaUser quotaUser #:userIp userIp]) → jsexpr? communityId : string? hl : 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
communityId: The ID of the community whose related communities will be listed.
hl: Specifies the interface language (host language) of your user interface.
2.15 communityTopics
procedure
→ jsexpr? communityId : string? hl : 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
communityId: The ID of the community which topics will be listed.
hl: Specifies the interface language (host language) of your user interface.
maxResults: The maximum number of topics to include in the response.
pageToken: A continuation token that allows pagination.
procedure
topicId : string? communityId : string? hl : 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
topicId: The ID of the topic to get.
communityId: The ID of the community whose topic will be retrieved.
hl: Specifies the interface language (host language) of your user interface.
procedure
→ jsexpr? communityId : string? isShout : string? = 'N/A id : string? = 'N/A author : string? = 'N/A links : string? = 'N/A isClosed : string? = 'N/A lastUpdate : string? = 'N/A latestMessageSnippet : string? = 'N/A messages : string? = 'N/A numberOfReplies : string? = 'N/A body : string? = 'N/A kind : string? = 'N/A title : 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
communityId: The ID of the community the topic should be added to.
isShout: Whether this topic is a shout.
id: The ID of the topic.
author: The creator of the topic.
links: List of resources for the community.
isClosed: Whether the topic is closed for new messages.
lastUpdate: The timestamp of the last update, in RFC 3339 format.
latestMessageSnippet: Snippet of the last message posted on this topic.
messages: Most recent messages.
numberOfReplies: The total number of replies this topic has received.
body: The body of the topic.
kind: Identifies this resource as a community topic. Value: "orkut#communityTopic"
title: The title of the topic.
procedure
→ jsexpr? topicId : string? communityId : 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
topicId: The ID of the topic to be moved to the trash folder.
communityId: The ID of the community whose topic will be moved to the trash folder.
2.16 scraps
procedure
id : string? = 'N/A access : string? = 'N/A actor : string? = 'N/A links : string? = 'N/A published : string? = 'N/A verb : string? = 'N/A kind : string? = 'N/A title : string? = 'N/A object : string? = 'N/A updated : 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
id: The ID for the activity.
access: Identifies who has access to see this activity.
actor: The person who performed the activity.
links: Links to resources related to this activity.
published: The time at which the activity was initially published.
verb: This activity’s verb, indicating what action was performed. Possible values are: - add - User added new content to profile or album, e.g. video, photo. - post - User publish content to the stream, e.g. status, scrap. - update - User commented on an activity. - make-friend - User added a new friend. - birthday - User has a birthday.
kind: The kind of activity. Always orkut#activity.
title: Title of the activity.
object: The activity’s object.
updated: The time at which the activity was last updated.