Zasób subscription zawiera informacje o subskrypcji użytkownika YouTube. Subskrypcja powiadamia użytkownika, gdy na kanale pojawią się nowe filmy lub gdy inny użytkownik wykona w YouTube jedno z kilku działań, takich jak przesłanie filmu, ocenienie filmu lub skomentowanie filmu.
Metody
Interfejs API obsługuje te metody w przypadku zasobów subscriptions:
- list
- Zwraca zasoby subskrypcji, które spełniają kryteria żądania API. Wypróbuj teraz
- wstaw
- Dodaje subskrypcję kanału uwierzytelnionego użytkownika. Wypróbuj teraz
- usuń
- Usuwa subskrypcję. Wypróbuj teraz
Prezentacja zasobów
Poniższa struktura JSON przedstawia format zasobu subscriptions:
{
"kind": "youtube#subscription",
"etag": etag,
"id": string,
"snippet": {
"publishedAt": datetime,
"channelTitle": string,
"title": string,
"description": string,
"resourceId": {
"kind": string,
"channelId": string,
},
"channelId": string,
"thumbnails": {
(key): {
"url": string,
"width": unsigned integer,
"height": unsigned integer
}
}
},
"contentDetails": {
"totalItemCount": unsigned integer,
"newItemCount": unsigned integer,
"activityType": string
},
"subscriberSnippet": {
"title": string,
"description": string,
"channelId": string,
"thumbnails": {
(key): {
"url": string,
"width": unsigned integer,
"height": unsigned integer
}
}
}
}Właściwości
Poniższa tabela zawiera definicje właściwości, które pojawiają się w tym zasobie:
| Właściwości | |
|---|---|
kind |
stringOkreśla typ zasobu interfejsu API. Wartość będzie wynosić youtube#subscription. |
etag |
etagTag ETag tego zasobu. |
id |
stringIdentyfikator, którego YouTube używa do jednoznacznej identyfikacji subskrypcji. |
snippet |
objectObiekt snippet zawiera podstawowe informacje o subskrypcji, w tym jej tytuł i kanał, który subskrybuje użytkownik. |
snippet.publishedAt |
datetimeData i godzina utworzenia subskrypcji. Wartość jest podana w formacie ISO 8601. |
snippet.title |
stringTytuł subskrypcji. |
snippet.description |
stringSzczegóły subskrypcji. |
snippet.resourceId |
objectObiekt id zawiera informacje o kanale, który subskrybuje użytkownik. |
snippet.resourceId.kind |
stringTyp zasobu interfejsu API. |
snippet.resourceId.channelId |
stringWartość, której YouTube używa do jednoznacznego identyfikowania kanału, który subskrybuje użytkownik. |
snippet.channelId |
stringIdentyfikator, którego YouTube używa do jednoznacznego identyfikowania kanału subskrybenta. Obiekt resource_id określa kanał, który subskrybuje użytkownik. |
snippet.thumbnails |
objectMapa obrazów miniaturowych powiązanych z subskrypcją. W przypadku każdego obiektu na mapie kluczem jest nazwa miniatury, a wartością jest obiekt zawierający inne informacje o miniaturze. |
snippet.thumbnails.(key) |
objectPrawidłowe wartości klucza to:
|
snippet.thumbnails.(key).url |
stringAdres URL obrazu. |
snippet.thumbnails.(key).width |
unsigned integerSzerokość obrazu. |
snippet.thumbnails.(key).height |
unsigned integerWysokość obrazu. |
contentDetails |
objectObiekt contentDetails zawiera podstawowe statystyki dotyczące subskrypcji. |
contentDetails.totalItemCount |
unsigned integerPrzybliżona liczba elementów, do których odnosi się subskrypcja. |
contentDetails.newItemCount |
unsigned integerLiczba nowych pozycji w subskrypcji od czasu ostatniego przeczytania treści. |
contentDetails.activityType |
stringTyp aktywności, której dotyczy subskrypcja (tylko przesyłanie, wszystko). Prawidłowe wartości tego pola to:
|
subscriberSnippet |
objectObiekt subscriberSnippet zawiera podstawowe informacje o subskrybencie. |
subscriberSnippet.title |
stringTytuł kanału subskrybenta. |
subscriberSnippet.description |
stringOpis kanału subskrybenta. |
subscriberSnippet.channelId |
stringIdentyfikator, który YouTube przypisuje, aby jednoznacznie określić kanał subskrybenta. |
subscriberSnippet.thumbnails |
objectMiniatury kanału subskrybenta. |
subscriberSnippet.thumbnails.(key) |
objectPrawidłowe wartości klucza to:
|
subscriberSnippet.thumbnails.(key).url |
stringAdres URL obrazu. |
subscriberSnippet.thumbnails.(key).width |
unsigned integerSzerokość obrazu. |
subscriberSnippet.thumbnails.(key).height |
unsigned integerWysokość obrazu. |