Sponsors: list
Koleksiyonlar ile düzeninizi koruyun
İçeriği tercihlerinize göre kaydedin ve kategorilere ayırın.
Not: Bu yöntem 31 Mart 2020 itibarıyla kullanımdan kaldırılmıştır. Bu parametre,
members.list yöntemiyle değiştirildi. Bu yöntemle ilgili bilgileri YouTube Data API belgelerinde bulabilirsiniz.
sponsors.list yöntemi, 30 Eylül 2020'de veya sonrasında artık desteklenmeyecektir.
API istemcileri, bunun yerine
members.list yöntemini kullanmak için
sponsors.list yöntemine yapılan çağrıları güncellemelidir.
Bir kanalın üyelerini (önceki adıyla "sponsorlar") listeler. API isteği, kanal sahibi tarafından yetkilendirilmelidir.
Yaygın kullanım alanları
İstek
HTTP isteği
GET https://www.googleapis.com/youtube/v3/sponsors
Parametreler
Aşağıdaki tabloda, bu sorgunun desteklediği parametreler listelenmiştir. Listelenen parametrelerin tümü sorgu parametreleridir.
| Parametreler |
| Gerekli parametreler |
part |
string
part parametresi, API yanıtının içereceği sponsor kaynak parçalarını belirtir. id ve snippet değerleri desteklenir. |
| İsteğe bağlı parametreler |
filter |
string
filter parametresi, hangi kanal sponsorlarının döndürüleceğini belirtir. Varsayılan değer newest değeridir.
Kabul edilebilir değerler şunlardır:
all – En yeniden en eskiye doğru tüm sponsorları döndürür.newest – En son sponsorların bir sayfasını döndürür. nextPageToken kullanılarak gönderilen sonraki istekler, kaydolan yeni aboneleri alır.
|
maxResults |
unsigned integer
maxResults parametresi, sonuç kümesinde döndürülmesi gereken maksimum öğe sayısını belirtir. Kabul edilebilir değerler 0 ile 50 arasındadır (bu değerler dahil). Varsayılan değer 5 değeridir. |
pageToken |
string
pageToken parametresi, sonuç kümesinde döndürülmesi gereken belirli bir sayfayı tanımlar. Bir API yanıtında nextPageToken ve prevPageToken özellikleri, alınabilecek diğer sayfaları tanımlar. |
İstek içeriği
Bu yöntemi çağırırken istek gövdesi sağlamayın.
Yanıt
Başarılı olursa bu yöntem aşağıdaki yapıya sahip bir yanıt gövdesi döndürür:
{
"kind": "youtube#sponsorListResponse",
"etag": etag,
"nextPageToken": string,
"pageInfo": {
"totalResults": integer,
"resultsPerPage": integer
},
"items": [
sponsor resource
]
}
Özellikler
Aşağıdaki tabloda bu kaynakta görünen özellikler tanımlanmaktadır:
| Özellikler |
kind |
string
API kaynağının türünü tanımlar. Değer youtube#sponsorListResponse olur. |
etag |
etag
Bu kaynağın Etag'i. |
nextPageToken |
string
Sonuç grubundaki bir sonraki sayfayı almak için pageToken parametresinin değeri olarak kullanılabilecek jeton. |
pageInfo |
object
pageInfo nesnesi, sonuç kümesiyle ilgili sayfalama bilgilerini içerir. |
pageInfo.totalResults |
integer
Sonuç kümesindeki toplam sonuç sayısı. |
pageInfo.resultsPerPage |
integer
API yanıtına dahil edilen sonuçların sayısı. |
items[] |
list
İstek ölçütleriyle eşleşen sponsorların listesi. |
Hatalar
Aşağıdaki tabloda, API'nin bu yönteme yapılan çağrıya yanıt olarak döndürebileceği hata mesajları tanımlanmaktadır. Daha fazla bilgi için lütfen hata mesajı dokümanlarına bakın.
| Hata türü |
Hata ayrıntısı |
Açıklama |
Deneyin.
Bu API'yi çağırmak ve API isteğini ve yanıtını görmek için APIs Explorer kullanın.
Aksi belirtilmediği sürece bu sayfanın içeriği Creative Commons Atıf 4.0 Lisansı altında ve kod örnekleri Apache 2.0 Lisansı altında lisanslanmıştır. Ayrıntılı bilgi için Google Developers Site Politikaları'na göz atın. Java, Oracle ve/veya satış ortaklarının tescilli ticari markasıdır.
Son güncelleme tarihi: 2024-04-26 UTC.
[null,null,["Son güncelleme tarihi: 2024-04-26 UTC."],[],[],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."]]
