Moderator API v1
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 submissions
procedure
→ jsexpr? seriesId : string? submissionId : string? lang : string? = 'N/A includeVotes : 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
seriesId: The decimal ID of the Series.
submissionId: The decimal ID of the Submission within the Series.
lang: The language code for the language the client prefers resuls in.
includeVotes: Specifies whether to include the current user’s vote
procedure
→ jsexpr? seriesId : string? topicId : string? anonymous : string? = 'N/A unauthToken : string? = 'N/A id : string? = 'N/A author : string? = 'N/A attribution : string? = 'N/A vote : string? = 'N/A geo : string? = 'N/A counters : string? = 'N/A attachmentUrl : string? = 'N/A parentSubmissionId : string? = 'N/A topics : string? = 'N/A translations : string? = 'N/A created : string? = 'N/A kind : string? = 'N/A text : 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
seriesId: The decimal ID of the Series.
topicId: The decimal ID of the Topic within the Series.
anonymous: Set to true to mark the new submission as anonymous.
unauthToken: User identifier for unauthenticated usage mode
id:
author:
attribution:
vote:
geo:
counters:
attachmentUrl:
parentSubmissionId:
topics:
translations:
created:
kind:
text:
2.2 votes
procedure
seriesId : string? max-results : string? = 'N/A start-index : 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
seriesId: The decimal ID of the Series.
max-results: Maximum number of results to return.
start-index: Index of the first result to be retrieved.
procedure
seriesId : string? submissionId : string? unauthToken : string? = 'N/A userId : 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
seriesId: The decimal ID of the Series.
submissionId: The decimal ID of the Submission within the Series.
unauthToken: User identifier for unauthenticated usage mode
userId:
procedure
seriesId : string? submissionId : string? unauthToken : string? = 'N/A id : string? = 'N/A flag : string? = 'N/A vote : 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
seriesId: The decimal ID of the Series.
submissionId: The decimal ID of the Submission within the Series.
unauthToken: User identifier for unauthenticated usage mode
id:
flag:
vote:
kind:
procedure
seriesId : string? submissionId : string? unauthToken : string? = 'N/A userId : string? = 'N/A id : string? = 'N/A flag : string? = 'N/A vote : 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
seriesId: The decimal ID of the Series.
submissionId: The decimal ID of the Submission within the Series.
unauthToken: User identifier for unauthenticated usage mode
userId:
id:
flag:
vote:
kind:
procedure
seriesId : string? submissionId : string? unauthToken : string? = 'N/A userId : string? = 'N/A id : string? = 'N/A flag : string? = 'N/A vote : 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
seriesId: The decimal ID of the Series.
submissionId: The decimal ID of the Submission within the Series.
unauthToken: User identifier for unauthenticated usage mode
userId:
id:
flag:
vote:
kind:
2.3 topics
3 Resources
procedure
seriesId : string? q : string? = 'N/A max-results : string? = 'N/A start-index : string? = 'N/A mode : 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
seriesId: The decimal ID of the Series.
q: Search query.
max-results: Maximum number of results to return.
start-index: Index of the first result to be retrieved.
mode:
procedure
(moderator-topics-get #:seriesId seriesId #:topicId topicId [ #:alt alt #:fields fields #:key key #:oauth_token oauth_token #:prettyPrint prettyPrint #:quotaUser quotaUser #:userIp userIp]) → jsexpr? seriesId : string? topicId : 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
seriesId: The decimal ID of the Series.
topicId: The decimal ID of the Topic within the Series.
procedure
→ jsexpr? seriesId : string? id : string? = 'N/A counters : string? = 'N/A rules : string? = 'N/A featuredSubmission : string? = 'N/A presenter : string? = 'N/A name : string? = 'N/A description : 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
seriesId: The decimal ID of the Series.
id:
counters:
rules:
featuredSubmission:
presenter:
name:
description:
kind:
procedure
→ jsexpr? seriesId : string? topicId : string? id : string? = 'N/A counters : string? = 'N/A rules : string? = 'N/A featuredSubmission : string? = 'N/A presenter : string? = 'N/A name : string? = 'N/A description : 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
seriesId: The decimal ID of the Series.
topicId: The decimal ID of the Topic within the Series.
id:
counters:
rules:
featuredSubmission:
presenter:
name:
description:
kind:
3.1 series
4 Resources
procedure
q : string? = 'N/A max-results : string? = 'N/A start-index : 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
q: Search query.
max-results: Maximum number of results to return.
start-index: Index of the first result to be retrieved.
procedure
(moderator-series-get #:seriesId seriesId [ #:alt alt #:fields fields #:key key #:oauth_token oauth_token #:prettyPrint prettyPrint #:quotaUser quotaUser #:userIp userIp]) → jsexpr? seriesId : 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
seriesId: The decimal ID of the Series.
procedure
→ jsexpr? id : string? = 'N/A anonymousSubmissionAllowed : string? = 'N/A counters : string? = 'N/A numTopics : string? = 'N/A rules : string? = 'N/A unauthSubmissionAllowed : string? = 'N/A unauthVotingAllowed : string? = 'N/A videoSubmissionAllowed : string? = 'N/A name : string? = 'N/A description : 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
id:
anonymousSubmissionAllowed:
counters:
numTopics:
rules:
unauthSubmissionAllowed:
unauthVotingAllowed:
videoSubmissionAllowed:
name:
description:
kind:
procedure
→ jsexpr? seriesId : string? id : string? = 'N/A anonymousSubmissionAllowed : string? = 'N/A counters : string? = 'N/A numTopics : string? = 'N/A rules : string? = 'N/A unauthSubmissionAllowed : string? = 'N/A unauthVotingAllowed : string? = 'N/A videoSubmissionAllowed : string? = 'N/A name : string? = 'N/A description : 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
seriesId: The decimal ID of the Series.
id:
anonymousSubmissionAllowed:
counters:
numTopics:
rules:
unauthSubmissionAllowed:
unauthVotingAllowed:
videoSubmissionAllowed:
name:
description:
kind:
procedure
→ jsexpr? seriesId : string? id : string? = 'N/A anonymousSubmissionAllowed : string? = 'N/A counters : string? = 'N/A numTopics : string? = 'N/A rules : string? = 'N/A unauthSubmissionAllowed : string? = 'N/A unauthVotingAllowed : string? = 'N/A videoSubmissionAllowed : string? = 'N/A name : string? = 'N/A description : 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
seriesId: The decimal ID of the Series.
id:
anonymousSubmissionAllowed:
counters:
numTopics:
rules:
unauthSubmissionAllowed:
unauthVotingAllowed:
videoSubmissionAllowed:
name:
description:
kind:
4.1 responses
procedure
→ jsexpr? seriesId : string? submissionId : string? sort : string? = 'N/A author : string? = 'N/A q : string? = 'N/A hasAttachedVideo : string? = 'N/A max-results : string? = 'N/A start-index : 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
seriesId: The decimal ID of the Series.
submissionId: The decimal ID of the Submission within the Series.
sort: Sort order.
author: Restricts the results to submissions by a specific author.
q: Search query.
hasAttachedVideo: Specifies whether to restrict to submissions that have videos attached.
max-results: Maximum number of results to return.
start-index: Index of the first result to be retrieved.
procedure
→ jsexpr? seriesId : string? topicId : string? parentSubmissionId : string? anonymous : string? = 'N/A unauthToken : string? = 'N/A id : string? = 'N/A author : string? = 'N/A attribution : string? = 'N/A vote : string? = 'N/A geo : string? = 'N/A counters : string? = 'N/A attachmentUrl : string? = 'N/A topics : string? = 'N/A translations : string? = 'N/A created : string? = 'N/A kind : string? = 'N/A text : 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
seriesId: The decimal ID of the Series.
topicId: The decimal ID of the Topic within the Series.
parentSubmissionId: The decimal ID of the parent Submission within the Series.
anonymous: Set to true to mark the new submission as anonymous.
unauthToken: User identifier for unauthenticated usage mode
id:
author:
attribution:
vote:
geo:
counters:
attachmentUrl:
topics:
translations:
created:
kind:
text:
4.2 featured
5 Resources
5.1 global
6 Resources
6.1 my
7 Resources
7.1 myrecent
8 Resources
8.1 profiles
procedure
(moderator-profiles-get [ #: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
procedure
id : string? = 'N/A attribution : 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
id:
attribution:
kind:
procedure
id : string? = 'N/A attribution : 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
id:
attribution:
kind:
8.2 tags
procedure
seriesId : string? submissionId : 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
seriesId: The decimal ID of the Series.
submissionId: The decimal ID of the Submission within the Series.
procedure
seriesId : string? submissionId : string? id : string? = 'N/A kind : string? = 'N/A text : 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
seriesId: The decimal ID of the Series.
submissionId: The decimal ID of the Submission within the Series.
id:
kind:
text:
procedure
seriesId : string? submissionId : string? tagId : 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
seriesId: The decimal ID of the Series.
submissionId: The decimal ID of the Submission within the Series.
tagId: