1{ 2 "kind": "discovery#restDescription", 3 "id": "moderator:v1", 4 "name": "moderator", 5 "version": "v1", 6 "description": "Moderator API", 7 "icons": { 8 "x16": "http://www.google.com/images/icons/product/moderator-32.png", 9 "x32": "http://www.google.com/images/icons/product/search-32.gif" 10 }, 11 "documentationLink": "http://code.google.com/apis/moderator/v1/using_rest.html", 12 "labels": [ 13 "labs" 14 ], 15 "protocol": "rest", 16 "basePath": "/moderator/v1/", 17 "auth": { 18 "oauth2": { 19 "scopes": { 20 "https://www.googleapis.com/auth/moderator": { 21 "description": "Manage your activity in Google Moderator" 22 } 23 } 24 } 25 }, 26 "features": [ 27 "dataWrapper" 28 ], 29 "schemas": { 30 "ModeratorTopicsResourcePartial": { 31 "id": "ModeratorTopicsResourcePartial", 32 "type": "object", 33 "properties": { 34 "id": { 35 "type": "object", 36 "properties": { 37 "seriesId": { 38 "type": "integer" 39 }, 40 "topicId": { 41 "type": "integer" 42 } 43 } 44 } 45 } 46 }, 47 "ModeratorVotesResourcePartial": { 48 "id": "ModeratorVotesResourcePartial", 49 "type": "object", 50 "properties": { 51 "flag": { 52 "type": "string" 53 }, 54 "vote": { 55 "type": "string" 56 } 57 } 58 }, 59 "Profile": { 60 "id": "Profile", 61 "type": "object", 62 "properties": { 63 "attribution": { 64 "type": "object", 65 "properties": { 66 "avatarUrl": { 67 "type": "string" 68 }, 69 "displayName": { 70 "type": "string" 71 }, 72 "geo": { 73 "type": "object", 74 "properties": { 75 "latitude": { 76 "type": "number" 77 }, 78 "location": { 79 "type": "string" 80 }, 81 "longitude": { 82 "type": "number" 83 } 84 } 85 }, 86 "location": { 87 "type": "string" 88 } 89 } 90 }, 91 "id": { 92 "type": "object", 93 "properties": { 94 "user": { 95 "type": "string" 96 } 97 } 98 }, 99 "kind": { 100 "type": "string", 101 "default": "moderator#profile" 102 } 103 } 104 }, 105 "Series": { 106 "id": "Series", 107 "type": "object", 108 "properties": { 109 "anonymousSubmissionAllowed": { 110 "type": "boolean" 111 }, 112 "counters": { 113 "type": "object", 114 "properties": { 115 "anonymousSubmissions": { 116 "type": "integer" 117 }, 118 "minusVotes": { 119 "type": "integer" 120 }, 121 "noneVotes": { 122 "type": "integer" 123 }, 124 "plusVotes": { 125 "type": "integer" 126 }, 127 "submissions": { 128 "type": "integer" 129 }, 130 "users": { 131 "type": "integer" 132 }, 133 "videoSubmissions": { 134 "type": "integer" 135 } 136 } 137 }, 138 "description": { 139 "type": "string" 140 }, 141 "id": { 142 "type": "object", 143 "properties": { 144 "seriesId": { 145 "type": "integer" 146 } 147 } 148 }, 149 "kind": { 150 "type": "string", 151 "default": "moderator#series" 152 }, 153 "name": { 154 "type": "string" 155 }, 156 "numTopics": { 157 "type": "integer" 158 }, 159 "videoSubmissionAllowed": { 160 "type": "boolean" 161 } 162 } 163 }, 164 "SeriesList": { 165 "id": "SeriesList", 166 "type": "object", 167 "properties": { 168 "items": { 169 "type": "array", 170 "items": { 171 "$ref": "Series" 172 } 173 }, 174 "kind": { 175 "type": "string", 176 "default": "moderator#seriesList" 177 } 178 } 179 }, 180 "Submission": { 181 "id": "Submission", 182 "type": "object", 183 "properties": { 184 "attachmentUrl": { 185 "type": "string" 186 }, 187 "attribution": { 188 "type": "object", 189 "properties": { 190 "avatarUrl": { 191 "type": "string" 192 }, 193 "displayName": { 194 "type": "string" 195 }, 196 "location": { 197 "type": "string" 198 } 199 } 200 }, 201 "author": { 202 "type": "string" 203 }, 204 "counters": { 205 "type": "object", 206 "properties": { 207 "minusVotes": { 208 "type": "integer" 209 }, 210 "noneVotes": { 211 "type": "integer" 212 }, 213 "plusVotes": { 214 "type": "integer" 215 } 216 } 217 }, 218 "created": { 219 "type": "integer" 220 }, 221 "geo": { 222 "type": "object", 223 "properties": { 224 "latitude": { 225 "type": "number" 226 }, 227 "location": { 228 "type": "string" 229 }, 230 "longitude": { 231 "type": "number" 232 } 233 } 234 }, 235 "id": { 236 "type": "object", 237 "properties": { 238 "seriesId": { 239 "type": "integer" 240 }, 241 "submissionId": { 242 "type": "integer" 243 } 244 } 245 }, 246 "kind": { 247 "type": "string", 248 "default": "moderator#submission" 249 }, 250 "parentSubmissionId": { 251 "type": "object", 252 "properties": { 253 "seriesId": { 254 "type": "integer" 255 }, 256 "submissionId": { 257 "type": "integer" 258 } 259 } 260 }, 261 "text": { 262 "type": "string" 263 }, 264 "topics": { 265 "type": "array", 266 "items": { 267 "$ref": "ModeratorTopicsResourcePartial" 268 } 269 }, 270 "translations": { 271 "type": "array", 272 "items": { 273 "type": "object", 274 "properties": { 275 "lang": { 276 "type": "string" 277 }, 278 "text": { 279 "type": "string" 280 } 281 } 282 } 283 }, 284 "vote": { 285 "$ref": "ModeratorVotesResourcePartial" 286 } 287 } 288 }, 289 "SubmissionList": { 290 "id": "SubmissionList", 291 "type": "object", 292 "properties": { 293 "items": { 294 "type": "array", 295 "items": { 296 "$ref": "Submission" 297 } 298 }, 299 "kind": { 300 "type": "string", 301 "default": "moderator#submissionList" 302 } 303 } 304 }, 305 "Tag": { 306 "id": "Tag", 307 "type": "object", 308 "properties": { 309 "id": { 310 "type": "object", 311 "properties": { 312 "seriesId": { 313 "type": "integer" 314 }, 315 "submissionId": { 316 "type": "integer" 317 }, 318 "tagId": { 319 "type": "string" 320 } 321 } 322 }, 323 "kind": { 324 "type": "string", 325 "default": "moderator#tag" 326 }, 327 "text": { 328 "type": "string" 329 } 330 } 331 }, 332 "TagList": { 333 "id": "TagList", 334 "type": "object", 335 "properties": { 336 "items": { 337 "type": "array", 338 "items": { 339 "$ref": "Tag" 340 } 341 }, 342 "kind": { 343 "type": "string", 344 "default": "moderator#tagList" 345 } 346 } 347 }, 348 "Topic": { 349 "id": "Topic", 350 "type": "object", 351 "properties": { 352 "counters": { 353 "type": "object", 354 "properties": { 355 "minusVotes": { 356 "type": "integer" 357 }, 358 "noneVotes": { 359 "type": "integer" 360 }, 361 "plusVotes": { 362 "type": "integer" 363 }, 364 "submissions": { 365 "type": "integer" 366 }, 367 "users": { 368 "type": "integer" 369 }, 370 "videoSubmissions": { 371 "type": "integer" 372 } 373 } 374 }, 375 "description": { 376 "type": "string" 377 }, 378 "featuredSubmission": { 379 "type": "any" 380 }, 381 "id": { 382 "type": "object", 383 "properties": { 384 "seriesId": { 385 "type": "integer" 386 }, 387 "topicId": { 388 "type": "integer" 389 } 390 } 391 }, 392 "kind": { 393 "type": "string", 394 "default": "moderator#topic" 395 }, 396 "name": { 397 "type": "string" 398 }, 399 "presenter": { 400 "type": "string" 401 }, 402 "rules": { 403 "type": "object", 404 "properties": { 405 "submissions": { 406 "type": "object", 407 "properties": { 408 "close": { 409 "type": "integer" 410 }, 411 "open": { 412 "type": "integer" 413 } 414 } 415 }, 416 "votes": { 417 "type": "object", 418 "properties": { 419 "close": { 420 "type": "integer" 421 }, 422 "open": { 423 "type": "integer" 424 } 425 } 426 } 427 } 428 } 429 } 430 }, 431 "Topic2": { 432 "id": "Topic2", 433 "type": "object", 434 "properties": { 435 "counters": { 436 "type": "object", 437 "properties": { 438 "minusVotes": { 439 "type": "integer" 440 }, 441 "noneVotes": { 442 "type": "integer" 443 }, 444 "plusVotes": { 445 "type": "integer" 446 }, 447 "submissions": { 448 "type": "integer" 449 }, 450 "users": { 451 "type": "integer" 452 }, 453 "videoSubmissions": { 454 "type": "integer" 455 } 456 } 457 }, 458 "description": { 459 "type": "string" 460 }, 461 "featuredSubmission": { 462 "$ref": "Submission" 463 }, 464 "id": { 465 "type": "object", 466 "properties": { 467 "seriesId": { 468 "type": "integer" 469 }, 470 "topicId": { 471 "type": "integer" 472 } 473 } 474 }, 475 "kind": { 476 "type": "string", 477 "default": "moderator#topic" 478 }, 479 "name": { 480 "type": "string" 481 }, 482 "presenter": { 483 "type": "string" 484 }, 485 "rules": { 486 "type": "object", 487 "properties": { 488 "submissions": { 489 "type": "object", 490 "properties": { 491 "close": { 492 "type": "integer" 493 }, 494 "open": { 495 "type": "integer" 496 } 497 } 498 }, 499 "votes": { 500 "type": "object", 501 "properties": { 502 "close": { 503 "type": "integer" 504 }, 505 "open": { 506 "type": "integer" 507 } 508 } 509 } 510 } 511 } 512 } 513 }, 514 "TopicList": { 515 "id": "TopicList", 516 "type": "object", 517 "properties": { 518 "items": { 519 "type": "array", 520 "items": { 521 "$ref": "Topic" 522 } 523 }, 524 "kind": { 525 "type": "string", 526 "default": "moderator#topicList" 527 } 528 } 529 }, 530 "Vote": { 531 "id": "Vote", 532 "type": "object", 533 "properties": { 534 "flag": { 535 "type": "string" 536 }, 537 "id": { 538 "type": "object", 539 "properties": { 540 "seriesId": { 541 "type": "integer" 542 }, 543 "submissionId": { 544 "type": "integer" 545 } 546 } 547 }, 548 "kind": { 549 "type": "string", 550 "default": "moderator#vote" 551 }, 552 "vote": { 553 "type": "string" 554 } 555 } 556 }, 557 "VoteList": { 558 "id": "VoteList", 559 "type": "object", 560 "properties": { 561 "items": { 562 "type": "array", 563 "items": { 564 "$ref": "Vote" 565 } 566 }, 567 "kind": { 568 "type": "string", 569 "default": "moderator#voteList" 570 } 571 } 572 } 573 }, 574 "resources": { 575 "featured": { 576 "resources": { 577 "series": { 578 "methods": { 579 "list": { 580 "id": "moderator.featured.series.list", 581 "path": "series/featured", 582 "httpMethod": "GET", 583 "description": "Lists the featured series.", 584 "response": { 585 "$ref": "SeriesList" 586 }, 587 "scopes": [ 588 "https://www.googleapis.com/auth/moderator" 589 ] 590 } 591 } 592 } 593 } 594 }, 595 "global": { 596 "resources": { 597 "series": { 598 "methods": { 599 "list": { 600 "id": "moderator.global.series.list", 601 "path": "search", 602 "httpMethod": "GET", 603 "description": "Searches the public series and returns the search results.", 604 "parameters": { 605 "max-results": { 606 "type": "integer", 607 "description": "Maximum number of results to return.", 608 "minimum": "0", 609 "maximum": "4294967295", 610 "location": "query" 611 }, 612 "q": { 613 "type": "string", 614 "description": "Search query.", 615 "location": "query" 616 }, 617 "start-index": { 618 "type": "integer", 619 "description": "Index of the first result to be retrieved.", 620 "minimum": "0", 621 "maximum": "4294967295", 622 "location": "query" 623 } 624 }, 625 "response": { 626 "$ref": "SeriesList" 627 }, 628 "scopes": [ 629 "https://www.googleapis.com/auth/moderator" 630 ] 631 } 632 } 633 } 634 } 635 }, 636 "my": { 637 "resources": { 638 "series": { 639 "methods": { 640 "list": { 641 "id": "moderator.my.series.list", 642 "path": "series/@me/mine", 643 "httpMethod": "GET", 644 "description": "Lists all series created by the authenticated user.", 645 "response": { 646 "$ref": "SeriesList" 647 }, 648 "scopes": [ 649 "https://www.googleapis.com/auth/moderator" 650 ] 651 } 652 } 653 } 654 } 655 }, 656 "myrecent": { 657 "resources": { 658 "series": { 659 "methods": { 660 "list": { 661 "id": "moderator.myrecent.series.list", 662 "path": "series/@me/recent", 663 "httpMethod": "GET", 664 "description": "Lists the series the authenticated user has visited.", 665 "response": { 666 "$ref": "SeriesList" 667 }, 668 "scopes": [ 669 "https://www.googleapis.com/auth/moderator" 670 ] 671 } 672 } 673 } 674 } 675 }, 676 "profiles": { 677 "methods": { 678 "get": { 679 "id": "moderator.profiles.get", 680 "path": "profiles/@me", 681 "httpMethod": "GET", 682 "description": "Returns the profile information for the authenticated user.", 683 "response": { 684 "$ref": "Profile" 685 }, 686 "scopes": [ 687 "https://www.googleapis.com/auth/moderator" 688 ] 689 }, 690 "update": { 691 "id": "moderator.profiles.update", 692 "path": "profiles/@me", 693 "httpMethod": "PUT", 694 "description": "Updates the profile information for the authenticated user.", 695 "request": { 696 "$ref": "Profile" 697 }, 698 "response": { 699 "$ref": "Profile" 700 }, 701 "scopes": [ 702 "https://www.googleapis.com/auth/moderator" 703 ] 704 } 705 } 706 }, 707 "responses": { 708 "methods": { 709 "insert": { 710 "id": "moderator.responses.insert", 711 "path": "series/{seriesId}/topics/{topicId}/submissions/{parentSubmissionId}/responses", 712 "httpMethod": "POST", 713 "description": "Inserts a response for the specified submission in the specified topic within the specified series.", 714 "parameters": { 715 "anonymous": { 716 "type": "boolean", 717 "description": "Set to true to mark the new submission as anonymous.", 718 "location": "query" 719 }, 720 "parentSubmissionId": { 721 "type": "integer", 722 "description": "The decimal ID of the parent Submission within the Series.", 723 "required": true, 724 "minimum": "0", 725 "maximum": "4294967295", 726 "location": "path" 727 }, 728 "seriesId": { 729 "type": "integer", 730 "description": "The decimal ID of the Series.", 731 "required": true, 732 "minimum": "0", 733 "maximum": "4294967295", 734 "location": "path" 735 }, 736 "topicId": { 737 "type": "integer", 738 "description": "The decimal ID of the Topic within the Series.", 739 "required": true, 740 "minimum": "0", 741 "maximum": "4294967295", 742 "location": "path" 743 } 744 }, 745 "parameterOrder": [ 746 "seriesId", 747 "topicId", 748 "parentSubmissionId" 749 ], 750 "request": { 751 "$ref": "Submission" 752 }, 753 "response": { 754 "$ref": "Submission" 755 }, 756 "scopes": [ 757 "https://www.googleapis.com/auth/moderator" 758 ] 759 }, 760 "list": { 761 "id": "moderator.responses.list", 762 "path": "series/{seriesId}/submissions/{submissionId}/responses", 763 "httpMethod": "GET", 764 "description": "Lists or searches the responses for the specified submission within the specified series and returns the search results.", 765 "parameters": { 766 "author": { 767 "type": "string", 768 "description": "Restricts the results to submissions by a specific author.", 769 "location": "query" 770 }, 771 "hasAttachedVideo": { 772 "type": "boolean", 773 "description": "Specifies whether to restrict to submissions that have videos attached.", 774 "location": "query" 775 }, 776 "max-results": { 777 "type": "integer", 778 "description": "Maximum number of results to return.", 779 "minimum": "0", 780 "maximum": "4294967295", 781 "location": "query" 782 }, 783 "q": { 784 "type": "string", 785 "description": "Search query.", 786 "location": "query" 787 }, 788 "seriesId": { 789 "type": "integer", 790 "description": "The decimal ID of the Series.", 791 "required": true, 792 "minimum": "0", 793 "maximum": "4294967295", 794 "location": "path" 795 }, 796 "sort": { 797 "type": "string", 798 "description": "Sort order.", 799 "location": "query" 800 }, 801 "start-index": { 802 "type": "integer", 803 "description": "Index of the first result to be retrieved.", 804 "minimum": "0", 805 "maximum": "4294967295", 806 "location": "query" 807 }, 808 "submissionId": { 809 "type": "integer", 810 "description": "The decimal ID of the Submission within the Series.", 811 "required": true, 812 "minimum": "0", 813 "maximum": "4294967295", 814 "location": "path" 815 } 816 }, 817 "parameterOrder": [ 818 "seriesId", 819 "submissionId" 820 ], 821 "response": { 822 "$ref": "SubmissionList" 823 }, 824 "scopes": [ 825 "https://www.googleapis.com/auth/moderator" 826 ] 827 } 828 } 829 }, 830 "series": { 831 "methods": { 832 "get": { 833 "id": "moderator.series.get", 834 "path": "series/{seriesId}", 835 "httpMethod": "GET", 836 "description": "Returns the specified series.", 837 "parameters": { 838 "seriesId": { 839 "type": "integer", 840 "description": "The decimal ID of the Series.", 841 "required": true, 842 "minimum": "0", 843 "maximum": "4294967295", 844 "location": "path" 845 } 846 }, 847 "parameterOrder": [ 848 "seriesId" 849 ], 850 "response": { 851 "$ref": "Series" 852 }, 853 "scopes": [ 854 "https://www.googleapis.com/auth/moderator" 855 ] 856 }, 857 "insert": { 858 "id": "moderator.series.insert", 859 "path": "series", 860 "httpMethod": "POST", 861 "description": "Inserts a new series.", 862 "request": { 863 "$ref": "Series" 864 }, 865 "response": { 866 "$ref": "Series" 867 }, 868 "scopes": [ 869 "https://www.googleapis.com/auth/moderator" 870 ] 871 }, 872 "list": { 873 "id": "moderator.series.list", 874 "path": "series", 875 "httpMethod": "GET", 876 "description": "Searches the series and returns the search results.", 877 "parameters": { 878 "max-results": { 879 "type": "integer", 880 "description": "Maximum number of results to return.", 881 "minimum": "0", 882 "maximum": "4294967295", 883 "location": "query" 884 }, 885 "q": { 886 "type": "string", 887 "description": "Search query.", 888 "location": "query" 889 }, 890 "start-index": { 891 "type": "integer", 892 "description": "Index of the first result to be retrieved.", 893 "minimum": "0", 894 "maximum": "4294967295", 895 "location": "query" 896 } 897 }, 898 "response": { 899 "$ref": "SeriesList" 900 }, 901 "scopes": [ 902 "https://www.googleapis.com/auth/moderator" 903 ] 904 }, 905 "update": { 906 "id": "moderator.series.update", 907 "path": "series/{seriesId}", 908 "httpMethod": "PUT", 909 "description": "Updates the specified series.", 910 "parameters": { 911 "seriesId": { 912 "type": "integer", 913 "description": "The decimal ID of the Series.", 914 "required": true, 915 "minimum": "0", 916 "maximum": "4294967295", 917 "location": "path" 918 } 919 }, 920 "parameterOrder": [ 921 "seriesId" 922 ], 923 "request": { 924 "$ref": "Series" 925 }, 926 "response": { 927 "$ref": "Series" 928 }, 929 "scopes": [ 930 "https://www.googleapis.com/auth/moderator" 931 ] 932 } 933 }, 934 "resources": { 935 "responses": { 936 "methods": { 937 "list": { 938 "id": "moderator.series.responses.list", 939 "path": "series/{seriesId}/responses", 940 "httpMethod": "GET", 941 "description": "Searches the responses for the specified series and returns the search results.", 942 "parameters": { 943 "author": { 944 "type": "string", 945 "description": "Restricts the results to submissions by a specific author.", 946 "location": "query" 947 }, 948 "hasAttachedVideo": { 949 "type": "boolean", 950 "description": "Specifies whether to restrict to submissions that have videos attached.", 951 "location": "query" 952 }, 953 "max-results": { 954 "type": "integer", 955 "description": "Maximum number of results to return.", 956 "minimum": "0", 957 "maximum": "4294967295", 958 "location": "query" 959 }, 960 "q": { 961 "type": "string", 962 "description": "Search query.", 963 "location": "query" 964 }, 965 "seriesId": { 966 "type": "integer", 967 "description": "The decimal ID of the Series.", 968 "required": true, 969 "minimum": "0", 970 "maximum": "4294967295", 971 "location": "path" 972 }, 973 "sort": { 974 "type": "string", 975 "description": "Sort order.", 976 "location": "query" 977 }, 978 "start-index": { 979 "type": "integer", 980 "description": "Index of the first result to be retrieved.", 981 "minimum": "0", 982 "maximum": "4294967295", 983 "location": "query" 984 } 985 }, 986 "parameterOrder": [ 987 "seriesId" 988 ], 989 "response": { 990 "$ref": "SeriesList" 991 }, 992 "scopes": [ 993 "https://www.googleapis.com/auth/moderator" 994 ] 995 } 996 } 997 }, 998 "submissions": { 999 "methods": { 1000 "list": { 1001 "id": "moderator.series.submissions.list", 1002 "path": "series/{seriesId}/submissions", 1003 "httpMethod": "GET", 1004 "description": "Searches the submissions for the specified series and returns the search results.", 1005 "parameters": { 1006 "author": { 1007 "type": "string", 1008 "description": "Restricts the results to submissions by a specific author.", 1009 "location": "query" 1010 }, 1011 "hasAttachedVideo": { 1012 "type": "boolean", 1013 "description": "Specifies whether to restrict to submissions that have videos attached.", 1014 "location": "query" 1015 }, 1016 "includeVotes": { 1017 "type": "boolean", 1018 "description": "Specifies whether to include the current user's vote", 1019 "location": "query" 1020 }, 1021 "lang": { 1022 "type": "string", 1023 "description": "The language code for the language the client prefers resuls in.", 1024 "location": "query" 1025 }, 1026 "max-results": { 1027 "type": "integer", 1028 "description": "Maximum number of results to return.", 1029 "minimum": "0", 1030 "maximum": "4294967295", 1031 "location": "query" 1032 }, 1033 "q": { 1034 "type": "string", 1035 "description": "Search query.", 1036 "location": "query" 1037 }, 1038 "seriesId": { 1039 "type": "integer", 1040 "description": "The decimal ID of the Series.", 1041 "required": true, 1042 "minimum": "0", 1043 "maximum": "4294967295", 1044 "location": "path" 1045 }, 1046 "sort": { 1047 "type": "string", 1048 "description": "Sort order.", 1049 "location": "query" 1050 }, 1051 "start-index": { 1052 "type": "integer", 1053 "description": "Index of the first result to be retrieved.", 1054 "minimum": "0", 1055 "maximum": "4294967295", 1056 "location": "query" 1057 } 1058 }, 1059 "parameterOrder": [ 1060 "seriesId" 1061 ], 1062 "response": { 1063 "$ref": "SubmissionList" 1064 }, 1065 "scopes": [ 1066 "https://www.googleapis.com/auth/moderator" 1067 ] 1068 } 1069 } 1070 } 1071 } 1072 }, 1073 "submissions": { 1074 "methods": { 1075 "get": { 1076 "id": "moderator.submissions.get", 1077 "path": "series/{seriesId}/submissions/{submissionId}", 1078 "httpMethod": "GET", 1079 "description": "Returns the specified submission within the specified series.", 1080 "parameters": { 1081 "includeVotes": { 1082 "type": "boolean", 1083 "description": "Specifies whether to include the current user's vote", 1084 "location": "query" 1085 }, 1086 "lang": { 1087 "type": "string", 1088 "description": "The language code for the language the client prefers resuls in.", 1089 "location": "query" 1090 }, 1091 "seriesId": { 1092 "type": "integer", 1093 "description": "The decimal ID of the Series.", 1094 "required": true, 1095 "minimum": "0", 1096 "maximum": "4294967295", 1097 "location": "path" 1098 }, 1099 "submissionId": { 1100 "type": "integer", 1101 "description": "The decimal ID of the Submission within the Series.", 1102 "required": true, 1103 "minimum": "0", 1104 "maximum": "4294967295", 1105 "location": "path" 1106 } 1107 }, 1108 "parameterOrder": [ 1109 "seriesId", 1110 "submissionId" 1111 ], 1112 "response": { 1113 "$ref": "Submission" 1114 }, 1115 "scopes": [ 1116 "https://www.googleapis.com/auth/moderator" 1117 ] 1118 }, 1119 "insert": { 1120 "id": "moderator.submissions.insert", 1121 "path": "series/{seriesId}/topics/{topicId}/submissions", 1122 "httpMethod": "POST", 1123 "description": "Inserts a new submission in the specified topic within the specified series.", 1124 "parameters": { 1125 "anonymous": { 1126 "type": "boolean", 1127 "description": "Set to true to mark the new submission as anonymous.", 1128 "location": "query" 1129 }, 1130 "seriesId": { 1131 "type": "integer", 1132 "description": "The decimal ID of the Series.", 1133 "required": true, 1134 "minimum": "0", 1135 "maximum": "4294967295", 1136 "location": "path" 1137 }, 1138 "topicId": { 1139 "type": "integer", 1140 "description": "The decimal ID of the Topic within the Series.", 1141 "required": true, 1142 "minimum": "0", 1143 "maximum": "4294967295", 1144 "location": "path" 1145 } 1146 }, 1147 "parameterOrder": [ 1148 "seriesId", 1149 "topicId" 1150 ], 1151 "request": { 1152 "$ref": "Submission" 1153 }, 1154 "response": { 1155 "$ref": "Submission" 1156 }, 1157 "scopes": [ 1158 "https://www.googleapis.com/auth/moderator" 1159 ] 1160 } 1161 } 1162 }, 1163 "tags": { 1164 "methods": { 1165 "delete": { 1166 "id": "moderator.tags.delete", 1167 "path": "series/{seriesId}/submissions/{submissionId}/tags/{tagId}", 1168 "httpMethod": "DELETE", 1169 "description": "Deletes the specified tag from the specified submission within the specified series.", 1170 "parameters": { 1171 "seriesId": { 1172 "type": "integer", 1173 "description": "The decimal ID of the Series.", 1174 "required": true, 1175 "minimum": "0", 1176 "maximum": "4294967295", 1177 "location": "path" 1178 }, 1179 "submissionId": { 1180 "type": "integer", 1181 "description": "The decimal ID of the Submission within the Series.", 1182 "required": true, 1183 "minimum": "0", 1184 "maximum": "4294967295", 1185 "location": "path" 1186 }, 1187 "tagId": { 1188 "type": "string", 1189 "required": true, 1190 "location": "path" 1191 } 1192 }, 1193 "parameterOrder": [ 1194 "seriesId", 1195 "submissionId", 1196 "tagId" 1197 ], 1198 "scopes": [ 1199 "https://www.googleapis.com/auth/moderator" 1200 ] 1201 }, 1202 "insert": { 1203 "id": "moderator.tags.insert", 1204 "path": "series/{seriesId}/submissions/{submissionId}/tags", 1205 "httpMethod": "POST", 1206 "description": "Inserts a new tag for the specified submission within the specified series.", 1207 "parameters": { 1208 "seriesId": { 1209 "type": "integer", 1210 "description": "The decimal ID of the Series.", 1211 "required": true, 1212 "minimum": "0", 1213 "maximum": "4294967295", 1214 "location": "path" 1215 }, 1216 "submissionId": { 1217 "type": "integer", 1218 "description": "The decimal ID of the Submission within the Series.", 1219 "required": true, 1220 "minimum": "0", 1221 "maximum": "4294967295", 1222 "location": "path" 1223 } 1224 }, 1225 "parameterOrder": [ 1226 "seriesId", 1227 "submissionId" 1228 ], 1229 "request": { 1230 "$ref": "Tag" 1231 }, 1232 "response": { 1233 "$ref": "Tag" 1234 }, 1235 "scopes": [ 1236 "https://www.googleapis.com/auth/moderator" 1237 ] 1238 }, 1239 "list": { 1240 "id": "moderator.tags.list", 1241 "path": "series/{seriesId}/submissions/{submissionId}/tags", 1242 "httpMethod": "GET", 1243 "description": "Lists all tags for the specified submission within the specified series.", 1244 "parameters": { 1245 "seriesId": { 1246 "type": "integer", 1247 "description": "The decimal ID of the Series.", 1248 "required": true, 1249 "minimum": "0", 1250 "maximum": "4294967295", 1251 "location": "path" 1252 }, 1253 "submissionId": { 1254 "type": "integer", 1255 "description": "The decimal ID of the Submission within the Series.", 1256 "required": true, 1257 "minimum": "0", 1258 "maximum": "4294967295", 1259 "location": "path" 1260 } 1261 }, 1262 "parameterOrder": [ 1263 "seriesId", 1264 "submissionId" 1265 ], 1266 "response": { 1267 "$ref": "TagList" 1268 }, 1269 "scopes": [ 1270 "https://www.googleapis.com/auth/moderator" 1271 ] 1272 } 1273 } 1274 }, 1275 "topics": { 1276 "methods": { 1277 "get": { 1278 "id": "moderator.topics.get", 1279 "path": "series/{seriesId}/topics/{topicId}", 1280 "httpMethod": "GET", 1281 "description": "Returns the specified topic from the specified series.", 1282 "parameters": { 1283 "seriesId": { 1284 "type": "integer", 1285 "description": "The decimal ID of the Series.", 1286 "required": true, 1287 "minimum": "0", 1288 "maximum": "4294967295", 1289 "location": "path" 1290 }, 1291 "topicId": { 1292 "type": "integer", 1293 "description": "The decimal ID of the Topic within the Series.", 1294 "required": true, 1295 "minimum": "0", 1296 "maximum": "4294967295", 1297 "location": "path" 1298 } 1299 }, 1300 "parameterOrder": [ 1301 "seriesId", 1302 "topicId" 1303 ], 1304 "response": { 1305 "$ref": "Topic2" 1306 }, 1307 "scopes": [ 1308 "https://www.googleapis.com/auth/moderator" 1309 ] 1310 }, 1311 "insert": { 1312 "id": "moderator.topics.insert", 1313 "path": "series/{seriesId}/topics", 1314 "httpMethod": "POST", 1315 "description": "Inserts a new topic into the specified series.", 1316 "parameters": { 1317 "seriesId": { 1318 "type": "integer", 1319 "description": "The decimal ID of the Series.", 1320 "required": true, 1321 "minimum": "0", 1322 "maximum": "4294967295", 1323 "location": "path" 1324 } 1325 }, 1326 "parameterOrder": [ 1327 "seriesId" 1328 ], 1329 "request": { 1330 "$ref": "Topic" 1331 }, 1332 "response": { 1333 "$ref": "Topic" 1334 }, 1335 "scopes": [ 1336 "https://www.googleapis.com/auth/moderator" 1337 ] 1338 }, 1339 "list": { 1340 "id": "moderator.topics.list", 1341 "path": "series/{seriesId}/topics", 1342 "httpMethod": "GET", 1343 "description": "Searches the topics within the specified series and returns the search results.", 1344 "parameters": { 1345 "max-results": { 1346 "type": "integer", 1347 "description": "Maximum number of results to return.", 1348 "minimum": "0", 1349 "maximum": "4294967295", 1350 "location": "query" 1351 }, 1352 "mode": { 1353 "type": "string", 1354 "location": "query" 1355 }, 1356 "q": { 1357 "type": "string", 1358 "description": "Search query.", 1359 "location": "query" 1360 }, 1361 "seriesId": { 1362 "type": "integer", 1363 "description": "The decimal ID of the Series.", 1364 "required": true, 1365 "minimum": "0", 1366 "maximum": "4294967295", 1367 "location": "path" 1368 }, 1369 "start-index": { 1370 "type": "integer", 1371 "description": "Index of the first result to be retrieved.", 1372 "minimum": "0", 1373 "maximum": "4294967295", 1374 "location": "query" 1375 } 1376 }, 1377 "parameterOrder": [ 1378 "seriesId" 1379 ], 1380 "response": { 1381 "$ref": "TopicList" 1382 }, 1383 "scopes": [ 1384 "https://www.googleapis.com/auth/moderator" 1385 ] 1386 }, 1387 "update": { 1388 "id": "moderator.topics.update", 1389 "path": "series/{seriesId}/topics/{topicId}", 1390 "httpMethod": "PUT", 1391 "description": "Updates the specified topic within the specified series.", 1392 "parameters": { 1393 "seriesId": { 1394 "type": "integer", 1395 "description": "The decimal ID of the Series.", 1396 "required": true, 1397 "minimum": "0", 1398 "maximum": "4294967295", 1399 "location": "path" 1400 }, 1401 "topicId": { 1402 "type": "integer", 1403 "description": "The decimal ID of the Topic within the Series.", 1404 "required": true, 1405 "minimum": "0", 1406 "maximum": "4294967295", 1407 "location": "path" 1408 } 1409 }, 1410 "parameterOrder": [ 1411 "seriesId", 1412 "topicId" 1413 ], 1414 "request": { 1415 "$ref": "Topic" 1416 }, 1417 "response": { 1418 "$ref": "Topic" 1419 }, 1420 "scopes": [ 1421 "https://www.googleapis.com/auth/moderator" 1422 ] 1423 } 1424 }, 1425 "resources": { 1426 "submissions": { 1427 "methods": { 1428 "list": { 1429 "id": "moderator.topics.submissions.list", 1430 "path": "series/{seriesId}/topics/{topicId}/submissions", 1431 "httpMethod": "GET", 1432 "description": "Searches the submissions for the specified topic within the specified series and returns the search results.", 1433 "parameters": { 1434 "author": { 1435 "type": "string", 1436 "description": "Restricts the results to submissions by a specific author.", 1437 "location": "query" 1438 }, 1439 "hasAttachedVideo": { 1440 "type": "boolean", 1441 "description": "Specifies whether to restrict to submissions that have videos attached.", 1442 "location": "query" 1443 }, 1444 "includeVotes": { 1445 "type": "boolean", 1446 "description": "Specifies whether to include the current user's vote", 1447 "location": "query" 1448 }, 1449 "max-results": { 1450 "type": "integer", 1451 "description": "Maximum number of results to return.", 1452 "minimum": "0", 1453 "maximum": "4294967295", 1454 "location": "query" 1455 }, 1456 "q": { 1457 "type": "string", 1458 "description": "Search query.", 1459 "location": "query" 1460 }, 1461 "seriesId": { 1462 "type": "integer", 1463 "description": "The decimal ID of the Series.", 1464 "required": true, 1465 "minimum": "0", 1466 "maximum": "4294967295", 1467 "location": "path" 1468 }, 1469 "sort": { 1470 "type": "string", 1471 "description": "Sort order.", 1472 "location": "query" 1473 }, 1474 "start-index": { 1475 "type": "integer", 1476 "description": "Index of the first result to be retrieved.", 1477 "minimum": "0", 1478 "maximum": "4294967295", 1479 "location": "query" 1480 }, 1481 "topicId": { 1482 "type": "integer", 1483 "description": "The decimal ID of the Topic within the Series.", 1484 "required": true, 1485 "minimum": "0", 1486 "maximum": "4294967295", 1487 "location": "path" 1488 } 1489 }, 1490 "parameterOrder": [ 1491 "seriesId", 1492 "topicId" 1493 ], 1494 "response": { 1495 "$ref": "SubmissionList" 1496 }, 1497 "scopes": [ 1498 "https://www.googleapis.com/auth/moderator" 1499 ] 1500 } 1501 } 1502 } 1503 } 1504 }, 1505 "votes": { 1506 "methods": { 1507 "get": { 1508 "id": "moderator.votes.get", 1509 "path": "series/{seriesId}/submissions/{submissionId}/votes/@me", 1510 "httpMethod": "GET", 1511 "description": "Returns the votes by the authenticated user for the specified submission within the specified series.", 1512 "parameters": { 1513 "seriesId": { 1514 "type": "integer", 1515 "description": "The decimal ID of the Series.", 1516 "required": true, 1517 "minimum": "0", 1518 "maximum": "4294967295", 1519 "location": "path" 1520 }, 1521 "submissionId": { 1522 "type": "integer", 1523 "description": "The decimal ID of the Submission within the Series.", 1524 "required": true, 1525 "minimum": "0", 1526 "maximum": "4294967295", 1527 "location": "path" 1528 }, 1529 "userId": { 1530 "type": "string", 1531 "location": "query" 1532 } 1533 }, 1534 "parameterOrder": [ 1535 "seriesId", 1536 "submissionId" 1537 ], 1538 "response": { 1539 "$ref": "Vote" 1540 }, 1541 "scopes": [ 1542 "https://www.googleapis.com/auth/moderator" 1543 ] 1544 }, 1545 "insert": { 1546 "id": "moderator.votes.insert", 1547 "path": "series/{seriesId}/submissions/{submissionId}/votes/@me", 1548 "httpMethod": "POST", 1549 "description": "Inserts a new vote by the authenticated user for the specified submission within the specified series.", 1550 "parameters": { 1551 "seriesId": { 1552 "type": "integer", 1553 "description": "The decimal ID of the Series.", 1554 "required": true, 1555 "minimum": "0", 1556 "maximum": "4294967295", 1557 "location": "path" 1558 }, 1559 "submissionId": { 1560 "type": "integer", 1561 "description": "The decimal ID of the Submission within the Series.", 1562 "required": true, 1563 "minimum": "0", 1564 "maximum": "4294967295", 1565 "location": "path" 1566 } 1567 }, 1568 "parameterOrder": [ 1569 "seriesId", 1570 "submissionId" 1571 ], 1572 "request": { 1573 "$ref": "Vote" 1574 }, 1575 "response": { 1576 "$ref": "Vote" 1577 }, 1578 "scopes": [ 1579 "https://www.googleapis.com/auth/moderator" 1580 ] 1581 }, 1582 "list": { 1583 "id": "moderator.votes.list", 1584 "path": "series/{seriesId}/votes/@me", 1585 "httpMethod": "GET", 1586 "description": "Lists the votes by the authenticated user for the given series.", 1587 "parameters": { 1588 "max-results": { 1589 "type": "integer", 1590 "description": "Maximum number of results to return.", 1591 "minimum": "0", 1592 "maximum": "4294967295", 1593 "location": "query" 1594 }, 1595 "seriesId": { 1596 "type": "integer", 1597 "description": "The decimal ID of the Series.", 1598 "required": true, 1599 "minimum": "0", 1600 "maximum": "4294967295", 1601 "location": "path" 1602 }, 1603 "start-index": { 1604 "type": "integer", 1605 "description": "Index of the first result to be retrieved.", 1606 "minimum": "0", 1607 "maximum": "4294967295", 1608 "location": "query" 1609 } 1610 }, 1611 "parameterOrder": [ 1612 "seriesId" 1613 ], 1614 "response": { 1615 "$ref": "VoteList" 1616 }, 1617 "scopes": [ 1618 "https://www.googleapis.com/auth/moderator" 1619 ] 1620 }, 1621 "update": { 1622 "id": "moderator.votes.update", 1623 "path": "series/{seriesId}/submissions/{submissionId}/votes/@me", 1624 "httpMethod": "PUT", 1625 "description": "Updates the votes by the authenticated user for the specified submission within the specified series.", 1626 "parameters": { 1627 "seriesId": { 1628 "type": "integer", 1629 "description": "The decimal ID of the Series.", 1630 "required": true, 1631 "minimum": "0", 1632 "maximum": "4294967295", 1633 "location": "path" 1634 }, 1635 "submissionId": { 1636 "type": "integer", 1637 "description": "The decimal ID of the Submission within the Series.", 1638 "required": true, 1639 "minimum": "0", 1640 "maximum": "4294967295", 1641 "location": "path" 1642 }, 1643 "userId": { 1644 "type": "string", 1645 "location": "query" 1646 } 1647 }, 1648 "parameterOrder": [ 1649 "seriesId", 1650 "submissionId" 1651 ], 1652 "request": { 1653 "$ref": "Vote" 1654 }, 1655 "response": { 1656 "$ref": "Vote" 1657 }, 1658 "scopes": [ 1659 "https://www.googleapis.com/auth/moderator" 1660 ] 1661 } 1662 } 1663 } 1664 } 1665} 1666