Sponsors: list
با مجموعه‌ها، منظم بمانید
ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.
توجه: این روش از 31 مارس 2020 منسوخ شده است. با روش
members.list جایگزین شده است. می‌توانید اطلاعات مربوط به آن روش را در مستندات YouTube Data API بیابید.
روش
sponsors.list دیگر در 30 سپتامبر 2020 یا پس از آن پشتیبانی نخواهد شد. مشتریان API باید تماس‌ها را به روش
sponsors.list به‌روزرسانی کنند تا از روش
members.list استفاده کنند.
فهرست اعضا (که قبلا به عنوان "حامیان مالی" شناخته می شد) برای یک کانال. درخواست API باید توسط مالک کانال مجاز باشد.
موارد استفاده رایج
درخواست
درخواست HTTP
GET https://www.googleapis.com/youtube/v3/sponsors
مجوز
این درخواست به مجوز حداقل با یکی از حوزه های زیر نیاز دارد ( در مورد احراز هویت و مجوز بیشتر بخوانید ).
| محدوده |
|---|
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
https://www.googleapis.com/auth/youtube.readonly |
مولفه های
جدول زیر پارامترهایی را که این کوئری پشتیبانی می کند فهرست می کند. تمام پارامترهای لیست شده پارامترهای پرس و جو هستند.
| مولفه های |
|---|
| پارامترهای مورد نیاز |
part | string
پارامتر part قسمت های منبع sponsor را مشخص می کند که پاسخ API شامل آن خواهد شد. مقادیر پشتیبانی شده id و snippet هستند. |
| پارامترهای اختیاری |
filter | string
پارامتر filter مشخص می کند که کدام کانال حامی مالی را بازگرداند. مقدار پیش فرض newest است.
مقادیر قابل قبول عبارتند از:-
all - همه حامیان مالی، از جدیدترین تا قدیمی‌ترین را برگردانید. -
newest - یک صفحه از جدیدترین حامیان مالی را برگردانید. درخواست‌های بعدی با استفاده از nextPageToken ، مشترکین جدیدتر را هنگام ثبت‌نام بازیابی می‌کنند.
|
maxResults | unsigned integer
پارامتر maxResults حداکثر تعداد مواردی را که باید در مجموعه نتایج برگردانده شوند را مشخص می کند. مقادیر قابل قبول شامل 0 تا 50 است. مقدار پیش فرض 5 است. |
pageToken | string
پارامتر pageToken صفحه خاصی را در مجموعه نتایج مشخص می کند که باید برگردانده شود. در یک پاسخ API، ویژگی های nextPageToken و prevPageToken صفحات دیگری را شناسایی می کنند که می توانند بازیابی شوند. |
درخواست بدن
هنگام فراخوانی این روش، بدنه درخواست ارائه نکنید.
واکنش
در صورت موفقیت آمیز بودن، این روش یک بدنه پاسخ با ساختار زیر را برمی گرداند:
{
"kind": "youtube#sponsorListResponse",
"etag": etag,
"nextPageToken": string,
"pageInfo": {
"totalResults": integer,
"resultsPerPage": integer
},
"items": [
sponsor resource
]
} خواص
جدول زیر ویژگی های ظاهر شده در این منبع را تعریف می کند:
| خواص |
|---|
kind | string
نوع منبع API را مشخص می کند. مقدار youtube#sponsorListResponse خواهد بود. |
etag | etag
Etag این منبع |
nextPageToken | string
نشانه ای که می تواند به عنوان مقدار پارامتر pageToken برای بازیابی صفحه بعدی در مجموعه نتایج استفاده شود. |
pageInfo | object
شی pageInfo اطلاعات صفحه‌بندی را برای مجموعه نتایج کپسوله می‌کند. |
pageInfo. totalResults | integer
تعداد کل نتایج در مجموعه نتایج. |
pageInfo. resultsPerPage | integer
تعداد نتایج موجود در پاسخ API. |
items[] | list
فهرستی از حامیان مالی که با معیارهای درخواست مطابقت دارند. |
خطاها
جدول زیر پیام های خطایی را مشخص می کند که API می تواند در پاسخ به تماس با این روش بازگرداند. لطفاً برای جزئیات بیشتر به مستندات پیام خطا مراجعه کنید.
آن را امتحان کنید!
از APIs Explorer برای فراخوانی این API و مشاهده درخواست و پاسخ API استفاده کنید.
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین به‌روزرسانی 2024-04-26 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین به‌روزرسانی 2024-04-26 بهوقت ساعت هماهنگ جهانی."],[],[],null,["# Sponsors: list\n\nNote: This method is deprecated as of March 31, 2020. It has been replaced by the [members.list](/youtube/v3/docs/members/list) method. You can find information about that method in the YouTube Data API documentation. \n\nThe `sponsors.list` method will no longer be supported on or after September 30, 2020. API clients should update calls to the `sponsors.list` method to use the [members.list](/youtube/v3/docs/members/list) method instead.\n\nLists members (formerly known as \"sponsors\") for a channel. The API request must be authorized\nby the channel owner.\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/sponsors\n```\n\n### Authorization\n\nThis request requires authorization with at least one of the following scopes ([read more about authentication and authorization](/youtube/v3/live/authentication)).\n\n| Scope |\n|-----------------------------------------------------|\n| `https://www.googleapis.com/auth/youtube` |\n| `https://www.googleapis.com/auth/youtube.force-ssl` |\n| `https://www.googleapis.com/auth/youtube.readonly` |\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 the `sponsor` resource parts that the API response will include. Supported values are `id` and `snippet`. |\n| **Optional parameters** |||\n| `filter` | `string` The **filter** parameter specifies which channel sponsors to return. The default value is `newest`. Acceptable values are: - **all** -- Return all sponsors, from newest to oldest. - **newest** -- Return one page of the most recent sponsors. Subsequent requests using the [nextPageToken](#nextPageToken) retrieve newer subscribers as they sign up. |\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#sponsorListResponse\",\n \"etag\": etag,\n \"nextPageToken\": string,\n \"pageInfo\": {\n \"totalResults\": integer,\n \"resultsPerPage\": integer\n },\n \"items\": [\n sponsor 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#sponsorListResponse`. |\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 sponsors 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/live/docs/errors) documentation for more detail.\n\n| Error type | Error detail | Description |\n|----------------------|-------------------------------------|---------------------------------------------------------------------------|\n| `forbidden (403)` | `insufficientPermissions` | You do not have the necessary permissions to view the channel's sponsors. |\n| `invalidValue (400)` | `invalidValueInRequest` | The request contains an invalid value. |\n| `invalidValue (400)` | `sponsorshipNotEnabledForChannelId` | The channel does not have sponsorships enabled. |\n\nTry it!\n-------\n\nUse the APIs Explorer to call this API and see the API request and response."]]
