نحن بصدد تعديل Data API لتتطابق مع طريقة YouTube في احتساب مشاهدات Shorts.
مزيد من المعلومات
Comments: list
تنظيم صفحاتك في مجموعات
يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
تعرض قائمة بالتعليقات التي تتطابق مع مَعلمات طلب البيانات من واجهة برمجة التطبيقات.
تأثير الحصة: تتطلب أي مكالمة إلى هذه الطريقة تكلفة حصة تبلغ وحدة واحدة.
حالات الاستخدام الشائعة
الطلب
طلب HTTP
GET https://www.googleapis.com/youtube/v3/comments
المَعلمات
يسرد الجدول التالي المعلَمات التي يتيحها طلب البحث هذا. كلّ المَعلمات المدرَجة هي مَعلمات طلب بحث.
| المَعلمات |
| المَعلمات المطلوبة |
part |
string
تحدّد المَعلمة part قائمة مفصولة بفواصل تتضمّن سمة واحدة أو أكثر من خصائص comment مورد ما ستتضمّنه استجابة واجهة برمجة التطبيقات.
تتضمّن القائمة التالية أسماء part التي يمكنك تضمينها في قيمة المَعلمة:
|
| الفلاتر (حدِّد إحدى المَعلمات التالية بالضبط) |
id |
string
تحدّد المعلَمة id قائمة مفصولة بفواصل من معرّفات التعليقات للموارد التي يتم استردادها. في مورد comment، تُحدِّد السمة id معرّف التعليق. |
parentId |
string
تحدّد المَعلمة parentId رقم تعريف التعليق الذي يجب استرداد الردود عليه.
ملاحظة: تتيح منصّة YouTube حاليًا الردود على التعليقات ذات المستوى الأعلى فقط. ولكن قد تتم إتاحة الردود على الردود في المستقبل. |
| المَعلمات الاختيارية |
maxResults |
unsigned integer
تحدّد المعلَمة maxResults الحدّ الأقصى لعدد العناصر التي يجب عرضها في مجموعة النتائج.
ملاحظة: هذه المَعلمة غير متاحة للاستخدام مع مَعلمة id. تتراوح القيم المقبولة بين 1 و100، بما في ذلك القيم الواقعة بينهما. القيمة التلقائية هي 20. |
pageToken |
string
تحدِّد المعلَمة pageToken صفحة معيّنة في مجموعة النتائج يجب عرضها. في استجابة واجهة برمجة التطبيقات، تحدّد السمة nextPageToken الصفحة التالية من النتيجة التي يمكن استردادها.
ملاحظة: هذه المَعلمة غير متاحة للاستخدام مع مَعلمة id. |
textFormat |
string
تشير هذه المَعلمة إلى ما إذا كان يجب أن تعرض واجهة برمجة التطبيقات التعليقات المنسَّقة بتنسيق HTML أو كنص عادي. القيمة التلقائية هي html.
القيم المقبولة هي:
html – تعرض التعليقات بتنسيق HTML. هذه هي القيمة الافتراضية.plainText – تعرض التعليقات بتنسيق نص عادي.
|
نص الطلب
لا تقدِّم نص طلب عند استدعاء هذه الطريقة.
الإجابة
إذا نجحت هذه الطريقة، ستعرض هذه الطريقة نص استجابة بالبنية التالية:
{
"kind": "youtube#commentListResponse",
"etag": etag,
"nextPageToken": string,
"pageInfo": {
"totalResults": integer,
"resultsPerPage": integer
},
"items": [
comment Resource
]
}
أماكن إقامة
يحدد الجدول التالي الخصائص التي تظهر في هذا المورد:
| أماكن إقامة |
kind |
string
يحدّد نوع مورد واجهة برمجة التطبيقات. ستكون القيمة youtube#commentListResponse. |
etag |
etag
علامة هذا المرجع. |
nextPageToken |
string
الرمز المميّز الذي يمكن استخدامه كقيمة للمَعلمة pageToken لاسترداد الصفحة التالية في مجموعة النتائج. |
pageInfo |
object
يحتوي الكائن pageInfo على معلومات التقسيم على صفحات لمجموعة النتائج. |
pageInfo.totalResults |
integer
إجمالي عدد النتائج في مجموعة النتائج. |
pageInfo.resultsPerPage |
integer
عدد النتائج المضمَّنة في ردّ واجهة برمجة التطبيقات |
items[] |
list
قائمة بالتعليقات التي تتطابق مع معايير الطلب |
الأخطاء
يحدّد الجدول التالي رسائل الخطأ التي يمكن أن تعرضها واجهة برمجة التطبيقات استجابةً لطلب بيانات إلى هذه الطريقة. يُرجى الاطّلاع على وثائق رسالة الخطأ للحصول على مزيد من التفاصيل.
| نوع الخطأ |
تفاصيل الخطأ |
الوصف |
تجربة
يمكنك استخدام APIs Explorer لطلب بيانات من واجهة برمجة التطبيقات هذه والاطّلاع على طلب البيانات من واجهة برمجة التطبيقات والاستجابة لها.
إنّ محتوى هذه الصفحة مرخّص بموجب ترخيص Creative Commons Attribution 4.0 ما لم يُنصّ على خلاف ذلك، ونماذج الرموز مرخّصة بموجب ترخيص Apache 2.0. للاطّلاع على التفاصيل، يُرجى مراجعة سياسات موقع Google Developers. إنّ Java هي علامة تجارية مسجَّلة لشركة Oracle و/أو شركائها التابعين.
تاريخ التعديل الأخير: 2024-04-26 (حسب التوقيت العالمي المتفَّق عليه)
[null,null,["تاريخ التعديل الأخير: 2024-04-26 (حسب التوقيت العالمي المتفَّق عليه)"],[],[],null,["# Comments: list\n\nReturns a list of comments that match the API request parameters.\n\n**Quota impact:** A call to this method has a [quota cost](/youtube/v3/getting-started#quota) of 1 unit.\n\nCommon use cases\n----------------\n\nThe list below shows common use cases for this method. Hover over a use case to see its description, or click on a use case to load sample parameter values in the APIs Explorer. You can open the [fullscreen APIs Explorer](#) to see code samples that dynamically update to reflect the parameter values entered in the Explorer.\n\nThe table below shows common use cases for this method. You can click on a use case name to load sample parameter values in the APIs Explorer. Or you can see code samples for a use case in the fullscreen APIs Explorer by clicking on the code icon below a use case name. In the fullscreen UI, you can update parameter and property values and the code samples will dynamically update to reflect the values you enter. \nThis method has one common use case, which is described below. The buttons below the description populate the APIs Explorer with sample values or open the fullscreen APIs Explorer to show code samples that use those values. The code samples also dynamically update if you change the values.\n\n\u003cbr /\u003e\n\nRequest\n-------\n\n### HTTP request\n\n```\nGET https://www.googleapis.com/youtube/v3/comments\n```\n\n### Parameters\n\nThe following table lists the parameters that this query supports. All of the parameters listed are query parameters.\n\n| Parameters ||\n|--------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| **Required parameters** |||\n| `part` | `string` The **part** parameter specifies a comma-separated list of one or more `comment` resource properties that the API response will include. The following list contains the `part` names that you can include in the parameter value: - `id` - `snippet` |\n| **Filters (specify exactly one of the following parameters)** |||\n| `id` | `string` The **id** parameter specifies a comma-separated list of comment IDs for the resources that are being retrieved. In a `comment` resource, the `id` property specifies the comment's ID. |\n| `parentId` | `string` The **parentId** parameter specifies the ID of the comment for which replies should be retrieved. **Note:** YouTube currently supports replies only for top-level comments. However, replies to replies may be supported in the future. |\n| **Optional parameters** |||\n| `maxResults` | `unsigned integer` The **maxResults** parameter specifies the maximum number of items that should be returned in the result set. **Note:** This parameter is not supported for use in conjunction with the [id](#id) parameter. Acceptable values are `1` to `100`, inclusive. The default value is `20`. |\n| `pageToken` | `string` The **pageToken** parameter identifies a specific page in the result set that should be returned. In an API response, the `nextPageToken` property identifies the next page of the result that can be retrieved. **Note:** This parameter is not supported for use in conjunction with the [id](#id) parameter. |\n| `textFormat` | `string` This parameter indicates whether the API should return comments formatted as HTML or as plain text. The default value is `html`. Acceptable values are: - **html** -- Returns the comments in HTML format. This is the default value. - **plainText** -- Returns the comments in plain text format. |\n\n### Request body\n\nDo not provide a request body when calling this method.\n\nResponse\n--------\n\nIf successful, this method returns a response body with the following structure: \n\n```objective-c\n{\n \"kind\": \"youtube#commentListResponse\",\n \"etag\": etag,\n \"nextPageToken\": string,\n \"pageInfo\": {\n \"totalResults\": integer,\n \"resultsPerPage\": integer\n },\n \"items\": [\n comment Resource\n ]\n}\n```\n\n### Properties\n\nThe following table defines the properties that appear in this resource:\n\n| Properties ||\n|---------------------------|----------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Identifies the API resource's type. The value will be `youtube#commentListResponse`. |\n| `etag` | `etag` The Etag of this resource. |\n| `nextPageToken` | `string` The token that can be used as the value of the `pageToken` parameter to retrieve the next page in the result set. |\n| `pageInfo` | `object` The `pageInfo` object encapsulates paging information for the result set. |\n| pageInfo.`totalResults` | `integer` The total number of results in the result set. |\n| pageInfo.`resultsPerPage` | `integer` The number of results included in the API response. |\n| `items[]` | `list` A list of comments that match the request criteria. |\n\nErrors\n------\n\nThe following table identifies error messages that the API could return in response to a call to this method. Please see the [error message](/youtube/v3/docs/errors) documentation for more detail.\n\n| Error type | Error detail | Description |\n|--------------------|-------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `badRequest (400)` | `operationNotSupported` | The id filter is only compatible with comments based on Google+. |\n| `forbidden (403)` | `forbidden` | One or more of the requested comments cannot be retrieved due to insufficient permissions. The request might not be properly authorized. |\n| `notFound (404)` | `commentNotFound` | One or more of the specified comments cannot be found. Check the values of the request's [id](/youtube/v3/docs/comments/list#id) and [parentId](/youtube/v3/docs/comments/list#parentId) parameters to ensure that they are correct. |\n\nTry it!\n-------\n\nUse the APIs Explorer to call this API and see the API request and response."]]
