LiveChatModerators: list
تنظيم صفحاتك في مجموعات
يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
يسرد المشرفين على محادثة مباشرة. يجب أن يوافق مالك قناة المحادثة المباشرة على هذا الطلب.
حالات الاستخدام الشائعة
الطلب
طلب HTTP
GET https://www.googleapis.com/youtube/v3/liveChat/moderators
المَعلمات
يسرد الجدول التالي المعلَمات التي يتيحها طلب البحث هذا. كلّ المَعلمات المدرَجة هي مَعلمات طلب بحث.
المَعلمات |
المَعلمات المطلوبة |
liveChatId |
string
تحدّد المعلَمة liveChatId المحادثة المباشرة في YouTube التي يجب أن تعيد واجهة برمجة التطبيقات تعيين مشرفين لها. يتم عرض معرّف المحادثة المباشرة المرتبط بالبث في السمة snippet.liveChatId لمورد liveBroadcast . |
part |
string
تحدّد المعلَمة part أجزاء الموارد liveChatModerator التي ستتضمّنها استجابة واجهة برمجة التطبيقات. القيمتان المسموح بإدراجهما هما id وsnippet . |
المَعلمات الاختيارية |
maxResults |
unsigned integer
تحدّد المعلَمة maxResults الحدّ الأقصى لعدد العناصر التي يجب عرضها في مجموعة النتائج. تتراوح القيم المقبولة بين 0 و50 ، بما في ذلك القيم الواقعة بينهما. القيمة التلقائية هي 5 . |
pageToken |
string
تحدِّد المعلَمة pageToken صفحة معيّنة في مجموعة النتائج يجب عرضها. في استجابة واجهة برمجة التطبيقات، تحدّد السمتان nextPageToken وprevPageToken الصفحات الأخرى التي يمكن استردادها. |
نص الطلب
لا تقدِّم نص طلب عند استدعاء هذه الطريقة.
الإجابة
إذا نجحت هذه الطريقة، ستعرض هذه الطريقة نص استجابة بالبنية التالية:
{
"kind": "youtube#liveChatModeratorListResponse",
"etag": etag,
"prevPageToken": string,
"nextPageToken": string,
"pageInfo": {
"totalResults": integer,
"resultsPerPage": integer
},
"items": [
liveChatModerator Resource
]
}
أماكن إقامة
يحدد الجدول التالي الخصائص التي تظهر في هذا المورد:
أماكن إقامة |
kind |
string
يحدّد نوع مورد واجهة برمجة التطبيقات. ستكون القيمة youtube#liveChatModeratorListResponse . |
etag |
etag
علامة هذا المرجع. |
prevPageToken |
string
الرمز المميّز الذي يمكن استخدامه كقيمة للمَعلمة pageToken لاسترداد الصفحة السابقة في مجموعة النتائج. |
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,["# LiveChatModerators: list\n\nLists moderators for a live chat. The request must be authorized by the owner of the live chat's channel.\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/liveChat/moderators\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| `liveChatId` | `string` The **liveChatId** parameter specifies the YouTube live chat for which the API should return moderators. The live chat ID associated with a broadcast is returned in the `liveBroadcast` resource's `snippet.liveChatId` property. |\n| `part` | `string` The **part** parameter specifies the `liveChatModerator` resource parts that the API response will include. Supported values are `id` and `snippet`. |\n| **Optional parameters** |||\n| `maxResults` | `unsigned integer` The **maxResults** parameter specifies the maximum number of items that should be returned in the result set. Acceptable values are `0` to `50`, inclusive. The default value is `5`. |\n| `pageToken` | `string` The **pageToken** 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. |\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#liveChatModeratorListResponse\",\n \"etag\": etag,\n \"prevPageToken\": string,\n \"nextPageToken\": string,\n \"pageInfo\": {\n \"totalResults\": integer,\n \"resultsPerPage\": integer\n },\n \"items\": [\n liveChatModerator 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#liveChatModeratorListResponse`. |\n| `etag` | `etag` The Etag of this resource. |\n| `prevPageToken` | `string` The token that can be used as the value of the `pageToken` parameter to retrieve the previous page in the result set. |\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 moderators that match the request criteria. |\n\nErrors\n------\n\nThe API does not define any error messages that are unique to this API method. However, this method could still return general API errors listed in the [error message](/youtube/v3/live/docs/errors#general) documentation.\n\nTry it!\n-------\n\nUse the APIs Explorer to call this API and see the API request and response."]]