Moderator API . series

Instance Methods

responses()

Returns the responses Resource.

submissions()

Returns the submissions Resource.

get(seriesId)

Returns the specified series.

insert(body)

Inserts a new series.

list(q=None, max_results=None, start_index=None)

Searches the series and returns the search results.

patch(seriesId, body)

Updates the specified series. This method supports patch semantics.

update(seriesId, body)

Updates the specified series.

Method Details

get(seriesId)
Returns the specified series.

Args:
  seriesId: integer, The decimal ID of the Series. (required)

Returns:
  An object of the form:

    {
    "kind": "moderator#series",
    "description": "A String",
    "rules": {
      "votes": {
        "close": "A String",
        "open": "A String",
      },
      "submissions": {
        "close": "A String",
        "open": "A String",
      },
    },
    "unauthVotingAllowed": True or False,
    "videoSubmissionAllowed": True or False,
    "name": "A String",
    "numTopics": 42,
    "anonymousSubmissionAllowed": True or False,
    "unauthSubmissionAllowed": True or False,
    "id": {
      "seriesId": "A String",
    },
    "counters": {
      "users": 42,
      "noneVotes": 42,
      "videoSubmissions": 42,
      "minusVotes": 42,
      "anonymousSubmissions": 42,
      "submissions": 42,
      "plusVotes": 42,
    },
  }
insert(body)
Inserts a new series.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{
  "kind": "moderator#series",
  "description": "A String",
  "rules": {
    "votes": {
      "close": "A String",
      "open": "A String",
    },
    "submissions": {
      "close": "A String",
      "open": "A String",
    },
  },
  "unauthVotingAllowed": True or False,
  "videoSubmissionAllowed": True or False,
  "name": "A String",
  "numTopics": 42,
  "anonymousSubmissionAllowed": True or False,
  "unauthSubmissionAllowed": True or False,
  "id": {
    "seriesId": "A String",
  },
  "counters": {
    "users": 42,
    "noneVotes": 42,
    "videoSubmissions": 42,
    "minusVotes": 42,
    "anonymousSubmissions": 42,
    "submissions": 42,
    "plusVotes": 42,
  },
}


Returns:
  An object of the form:

    {
    "kind": "moderator#series",
    "description": "A String",
    "rules": {
      "votes": {
        "close": "A String",
        "open": "A String",
      },
      "submissions": {
        "close": "A String",
        "open": "A String",
      },
    },
    "unauthVotingAllowed": True or False,
    "videoSubmissionAllowed": True or False,
    "name": "A String",
    "numTopics": 42,
    "anonymousSubmissionAllowed": True or False,
    "unauthSubmissionAllowed": True or False,
    "id": {
      "seriesId": "A String",
    },
    "counters": {
      "users": 42,
      "noneVotes": 42,
      "videoSubmissions": 42,
      "minusVotes": 42,
      "anonymousSubmissions": 42,
      "submissions": 42,
      "plusVotes": 42,
    },
  }
list(q=None, max_results=None, start_index=None)
Searches the series and returns the search results.

Args:
  q: string, Search query.
  max_results: integer, Maximum number of results to return.
  start_index: integer, Index of the first result to be retrieved.

Returns:
  An object of the form:

    {
    "items": [
      {
        "kind": "moderator#series",
        "description": "A String",
        "rules": {
          "votes": {
            "close": "A String",
            "open": "A String",
          },
          "submissions": {
            "close": "A String",
            "open": "A String",
          },
        },
        "unauthVotingAllowed": True or False,
        "videoSubmissionAllowed": True or False,
        "name": "A String",
        "numTopics": 42,
        "anonymousSubmissionAllowed": True or False,
        "unauthSubmissionAllowed": True or False,
        "id": {
          "seriesId": "A String",
        },
        "counters": {
          "users": 42,
          "noneVotes": 42,
          "videoSubmissions": 42,
          "minusVotes": 42,
          "anonymousSubmissions": 42,
          "submissions": 42,
          "plusVotes": 42,
        },
      },
    ],
    "kind": "moderator#seriesList",
  }
patch(seriesId, body)
Updates the specified series. This method supports patch semantics.

Args:
  seriesId: integer, The decimal ID of the Series. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
  "kind": "moderator#series",
  "description": "A String",
  "rules": {
    "votes": {
      "close": "A String",
      "open": "A String",
    },
    "submissions": {
      "close": "A String",
      "open": "A String",
    },
  },
  "unauthVotingAllowed": True or False,
  "videoSubmissionAllowed": True or False,
  "name": "A String",
  "numTopics": 42,
  "anonymousSubmissionAllowed": True or False,
  "unauthSubmissionAllowed": True or False,
  "id": {
    "seriesId": "A String",
  },
  "counters": {
    "users": 42,
    "noneVotes": 42,
    "videoSubmissions": 42,
    "minusVotes": 42,
    "anonymousSubmissions": 42,
    "submissions": 42,
    "plusVotes": 42,
  },
}


Returns:
  An object of the form:

    {
    "kind": "moderator#series",
    "description": "A String",
    "rules": {
      "votes": {
        "close": "A String",
        "open": "A String",
      },
      "submissions": {
        "close": "A String",
        "open": "A String",
      },
    },
    "unauthVotingAllowed": True or False,
    "videoSubmissionAllowed": True or False,
    "name": "A String",
    "numTopics": 42,
    "anonymousSubmissionAllowed": True or False,
    "unauthSubmissionAllowed": True or False,
    "id": {
      "seriesId": "A String",
    },
    "counters": {
      "users": 42,
      "noneVotes": 42,
      "videoSubmissions": 42,
      "minusVotes": 42,
      "anonymousSubmissions": 42,
      "submissions": 42,
      "plusVotes": 42,
    },
  }
update(seriesId, body)
Updates the specified series.

Args:
  seriesId: integer, The decimal ID of the Series. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
  "kind": "moderator#series",
  "description": "A String",
  "rules": {
    "votes": {
      "close": "A String",
      "open": "A String",
    },
    "submissions": {
      "close": "A String",
      "open": "A String",
    },
  },
  "unauthVotingAllowed": True or False,
  "videoSubmissionAllowed": True or False,
  "name": "A String",
  "numTopics": 42,
  "anonymousSubmissionAllowed": True or False,
  "unauthSubmissionAllowed": True or False,
  "id": {
    "seriesId": "A String",
  },
  "counters": {
    "users": 42,
    "noneVotes": 42,
    "videoSubmissions": 42,
    "minusVotes": 42,
    "anonymousSubmissions": 42,
    "submissions": 42,
    "plusVotes": 42,
  },
}


Returns:
  An object of the form:

    {
    "kind": "moderator#series",
    "description": "A String",
    "rules": {
      "votes": {
        "close": "A String",
        "open": "A String",
      },
      "submissions": {
        "close": "A String",
        "open": "A String",
      },
    },
    "unauthVotingAllowed": True or False,
    "videoSubmissionAllowed": True or False,
    "name": "A String",
    "numTopics": 42,
    "anonymousSubmissionAllowed": True or False,
    "unauthSubmissionAllowed": True or False,
    "id": {
      "seriesId": "A String",
    },
    "counters": {
      "users": 42,
      "noneVotes": 42,
      "videoSubmissions": 42,
      "minusVotes": 42,
      "anonymousSubmissions": 42,
      "submissions": 42,
      "plusVotes": 42,
    },
  }