Moderator API . responses

Instance Methods

insert(seriesId, topicId, parentSubmissionId, body, unauthToken=None, anonymous=None)

Inserts a response for the specified submission in the specified topic within the specified series.

list(seriesId, submissionId, sort=None, author=None, q=None, max_results=None, hasAttachedVideo=None, start_index=None)

Lists or searches the responses for the specified submission within the specified series and returns the search results.

Method Details

insert(seriesId, topicId, parentSubmissionId, body, unauthToken=None, anonymous=None)
Inserts a response for the specified submission in the specified topic within the specified series.

Args:
  seriesId: integer, The decimal ID of the Series. (required)
  topicId: integer, The decimal ID of the Topic within the Series. (required)
  parentSubmissionId: integer, The decimal ID of the parent Submission within the Series. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "kind": "moderator#submission",
    "attribution": {
      "displayName": "A String",
      "location": "A String",
      "avatarUrl": "A String",
    },
    "created": "A String",
    "text": "A String",
    "topics": [
      {
        "id": {
          "seriesId": "A String",
          "topicId": "A String",
        },
      },
    ],
    "author": "A String",
    "translations": [
      {
        "lang": "A String",
        "text": "A String",
      },
    ],
    "parentSubmissionId": {
      "seriesId": "A String",
      "submissionId": "A String",
    },
    "vote": {
      "vote": "A String",
      "flag": "A String",
    },
    "attachmentUrl": "A String",
    "geo": {
      "latitude": 3.14,
      "location": "A String",
      "longitude": 3.14,
    },
    "id": {
      "seriesId": "A String",
      "submissionId": "A String",
    },
    "counters": {
      "noneVotes": 42,
      "minusVotes": 42,
      "plusVotes": 42,
    },
  }

  unauthToken: string, User identifier for unauthenticated usage mode
  anonymous: boolean, Set to true to mark the new submission as anonymous.

Returns:
  An object of the form:

    {
      "kind": "moderator#submission",
      "attribution": {
        "displayName": "A String",
        "location": "A String",
        "avatarUrl": "A String",
      },
      "created": "A String",
      "text": "A String",
      "topics": [
        {
          "id": {
            "seriesId": "A String",
            "topicId": "A String",
          },
        },
      ],
      "author": "A String",
      "translations": [
        {
          "lang": "A String",
          "text": "A String",
        },
      ],
      "parentSubmissionId": {
        "seriesId": "A String",
        "submissionId": "A String",
      },
      "vote": {
        "vote": "A String",
        "flag": "A String",
      },
      "attachmentUrl": "A String",
      "geo": {
        "latitude": 3.14,
        "location": "A String",
        "longitude": 3.14,
      },
      "id": {
        "seriesId": "A String",
        "submissionId": "A String",
      },
      "counters": {
        "noneVotes": 42,
        "minusVotes": 42,
        "plusVotes": 42,
      },
    }
list(seriesId, submissionId, sort=None, author=None, q=None, max_results=None, hasAttachedVideo=None, start_index=None)
Lists or searches the responses for the specified submission within the specified series and returns the search results.

Args:
  seriesId: integer, The decimal ID of the Series. (required)
  submissionId: integer, The decimal ID of the Submission within the Series. (required)
  sort: string, Sort order.
  author: string, Restricts the results to submissions by a specific author.
  q: string, Search query.
  max_results: integer, Maximum number of results to return.
  hasAttachedVideo: boolean, Specifies whether to restrict to submissions that have videos attached.
  start_index: integer, Index of the first result to be retrieved.

Returns:
  An object of the form:

    {
    "items": [
      {
          "kind": "moderator#submission",
          "attribution": {
            "displayName": "A String",
            "location": "A String",
            "avatarUrl": "A String",
          },
          "created": "A String",
          "text": "A String",
          "topics": [
            {
              "id": {
                "seriesId": "A String",
                "topicId": "A String",
              },
            },
          ],
          "author": "A String",
          "translations": [
            {
              "lang": "A String",
              "text": "A String",
            },
          ],
          "parentSubmissionId": {
            "seriesId": "A String",
            "submissionId": "A String",
          },
          "vote": {
            "vote": "A String",
            "flag": "A String",
          },
          "attachmentUrl": "A String",
          "geo": {
            "latitude": 3.14,
            "location": "A String",
            "longitude": 3.14,
          },
          "id": {
            "seriesId": "A String",
            "submissionId": "A String",
          },
          "counters": {
            "noneVotes": 42,
            "minusVotes": 42,
            "plusVotes": 42,
          },
        },
    ],
    "kind": "moderator#submissionList",
  }