Files
google-apis-rs/google_youtube3_cli/comments_list/index.html
2024-03-05 21:06:01 +01:00

510 lines
24 KiB
HTML

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><link rel="canonical" href="http://byron.github.io/google-apis-rs/google-youtube3-cli/comments_list/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>List - YouTube v5.0.4+20240303</title>
<link rel="stylesheet" href="../css/theme.css" />
<link rel="stylesheet" href="../css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
<script>
// Current page data
var mkdocs_page_name = "List";
var mkdocs_page_input_path = "comments_list.md";
var mkdocs_page_url = "/google-apis-rs/google-youtube3-cli/comments_list/";
</script>
<script src="../js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="../js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> YouTube v5.0.4+20240303
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Abuse Reports</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../abuse-reports_insert/">Insert</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Activities</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../activities_list/">List</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Captions</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../captions_delete/">Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../captions_download/">Download</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../captions_insert/">Insert</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../captions_list/">List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../captions_update/">Update</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Channel Banners</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../channel-banners_insert/">Insert</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Channel Sections</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../channel-sections_delete/">Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../channel-sections_insert/">Insert</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../channel-sections_list/">List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../channel-sections_update/">Update</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Channels</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../channels_list/">List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../channels_update/">Update</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Comment Threads</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../comment-threads_insert/">Insert</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../comment-threads_list/">List</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Comments</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../comments_delete/">Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../comments_insert/">Insert</a>
</li>
<li class="toctree-l1 current"><a class="reference internal current" href="./">List</a>
<ul class="current">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../comments_mark-as-spam/">Mark As Spam</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../comments_set-moderation-status/">Set Moderation Status</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../comments_update/">Update</a>
</li>
</ul>
<p class="caption"><span class="caption-text">I18n Languages</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../i18n-languages_list/">List</a>
</li>
</ul>
<p class="caption"><span class="caption-text">I18n Regions</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../i18n-regions_list/">List</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Live Broadcasts</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../live-broadcasts_bind/">Bind</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../live-broadcasts_delete/">Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../live-broadcasts_insert/">Insert</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../live-broadcasts_insert-cuepoint/">Insert Cuepoint</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../live-broadcasts_list/">List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../live-broadcasts_transition/">Transition</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../live-broadcasts_update/">Update</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Live Chat Bans</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../live-chat-bans_delete/">Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../live-chat-bans_insert/">Insert</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Live Chat Messages</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../live-chat-messages_delete/">Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../live-chat-messages_insert/">Insert</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../live-chat-messages_list/">List</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Live Chat Moderators</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../live-chat-moderators_delete/">Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../live-chat-moderators_insert/">Insert</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../live-chat-moderators_list/">List</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Live Streams</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../live-streams_delete/">Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../live-streams_insert/">Insert</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../live-streams_list/">List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../live-streams_update/">Update</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Members</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../members_list/">List</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Memberships Levels</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../memberships-levels_list/">List</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Playlist Images</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../playlist-images_delete/">Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../playlist-images_insert/">Insert</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../playlist-images_list/">List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../playlist-images_update/">Update</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Playlist Items</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../playlist-items_delete/">Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../playlist-items_insert/">Insert</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../playlist-items_list/">List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../playlist-items_update/">Update</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Playlists</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../playlists_delete/">Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../playlists_insert/">Insert</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../playlists_list/">List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../playlists_update/">Update</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Search</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../search_list/">List</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Subscriptions</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../subscriptions_delete/">Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../subscriptions_insert/">Insert</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../subscriptions_list/">List</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Super Chat Events</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../super-chat-events_list/">List</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Tests</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../tests_insert/">Insert</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Third Party Links</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../third-party-links_delete/">Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../third-party-links_insert/">Insert</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../third-party-links_list/">List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../third-party-links_update/">Update</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Thumbnails</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../thumbnails_set/">Set</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Video Abuse Report Reasons</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../video-abuse-report-reasons_list/">List</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Video Categories</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../video-categories_list/">List</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Videos</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../videos_delete/">Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../videos_get-rating/">Get Rating</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../videos_insert/">Insert</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../videos_list/">List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../videos_rate/">Rate</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../videos_report-abuse/">Report Abuse</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../videos_update/">Update</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Watermarks</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../watermarks_set/">Set</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../watermarks_unset/">Unset</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Youtube</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../youtube_v3-update-comment-threads/">V3 Update Comment Threads</a>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">YouTube v5.0.4+20240303</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href=".." class="icon icon-home" alt="Docs"></a> &raquo;</li>
<li>Comments &raquo;</li>
<li>List</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/youtube3-cli/edit/master/docs/comments_list.md"
class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">
<p>Retrieves a list of resources, possibly filtered.</p>
<h1 id="scopes">Scopes</h1>
<p>You will need authorization for the <em>https://www.googleapis.com/auth/youtube.force-ssl</em> scope to make a valid call.</p>
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/youtube.force-ssl</em>.
You can set the scope for this method like this: <code>youtube3 --scope &lt;scope&gt; comments list ...</code></p>
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
<ul>
<li><strong>&lt;part&gt;...</strong> <em>(string)</em><ul>
<li>The <em>part</em> parameter specifies a comma-separated list of one or more comment resource properties that the API response will include.</li>
<li>This property can be specified one or more times</li>
</ul>
</li>
</ul>
<h1 id="optional-output-flags">Optional Output Flags</h1>
<p>The method's return value a JSON encoded structure, which will be written to standard output by default.</p>
<ul>
<li><strong>-o out</strong><ul>
<li><em>out</em> specifies the <em>destination</em> to which to write the server's result to.
It will be a JSON-encoded structure.
The <em>destination</em> may be <code>-</code> to indicate standard output, or a filepath that is to contain the received bytes.
If unset, it defaults to standard output.</li>
</ul>
</li>
</ul>
<h1 id="optional-method-properties">Optional Method Properties</h1>
<p>You may set the following properties to further configure the call. Please note that <code>-p</code> is followed by one
or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> even though the listing below repeats the
<code>-p</code> for completeness.</p>
<ul>
<li>
<p><strong>-p id=string</strong></p>
<ul>
<li>Returns the comments with the given IDs for One Platform.</li>
</ul>
</li>
<li>
<p><strong>-p max-results=integer</strong></p>
<ul>
<li>The <em>maxResults</em> parameter specifies the maximum number of items that should be returned in the result set.</li>
</ul>
</li>
<li>
<p><strong>-p page-token=string</strong></p>
<ul>
<li>The <em>pageToken</em> parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.</li>
</ul>
</li>
<li>
<p><strong>-p parent-id=string</strong></p>
<ul>
<li>Returns replies to the specified comment. Note, currently YouTube features only one level of replies (ie replies to top level comments). However replies to replies may be supported in the future.</li>
</ul>
</li>
<li>
<p><strong>-p text-format=string</strong></p>
<ul>
<li>The requested text format for the returned comments.</li>
</ul>
</li>
</ul>
<h1 id="optional-general-properties">Optional General Properties</h1>
<p>The following properties can configure any call, and are not specific to this method.</p>
<ul>
<li>
<p><strong>-p $-xgafv=string</strong></p>
<ul>
<li>V1 error format.</li>
</ul>
</li>
<li>
<p><strong>-p access-token=string</strong></p>
<ul>
<li>OAuth access token.</li>
</ul>
</li>
<li>
<p><strong>-p alt=string</strong></p>
<ul>
<li>Data format for response.</li>
</ul>
</li>
<li>
<p><strong>-p callback=string</strong></p>
<ul>
<li>JSONP</li>
</ul>
</li>
<li>
<p><strong>-p fields=string</strong></p>
<ul>
<li>Selector specifying which fields to include in a partial response.</li>
</ul>
</li>
<li>
<p><strong>-p key=string</strong></p>
<ul>
<li>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.</li>
</ul>
</li>
<li>
<p><strong>-p oauth-token=string</strong></p>
<ul>
<li>OAuth 2.0 token for the current user.</li>
</ul>
</li>
<li>
<p><strong>-p pretty-print=boolean</strong></p>
<ul>
<li>Returns response with indentations and line breaks.</li>
</ul>
</li>
<li>
<p><strong>-p quota-user=string</strong></p>
<ul>
<li>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.</li>
</ul>
</li>
<li>
<p><strong>-p upload-type=string</strong></p>
<ul>
<li>Legacy upload protocol for media (e.g. &#34;media&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
<li>
<p><strong>-p upload-protocol=string</strong></p>
<ul>
<li>Upload protocol for media (e.g. &#34;raw&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
</ul>
</div>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="../comments_insert/" class="btn btn-neutral float-left" title="Insert"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../comments_mark-as-spam/" class="btn btn-neutral float-right" title="Mark As Spam">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
<p>Copyright &copy; 2015-2020, `Sebastian Thiel`</p>
</div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span>
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/youtube3-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
<span><a href="../comments_insert/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../comments_mark-as-spam/" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
<script>var base_url = '..';</script>
<script src="../js/theme_extra.js" defer></script>
<script src="../js/theme.js" defer></script>
<script src="../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>