activities.list
gibt keine Kanalbulletins zurück und die Methode activities.insert
wird nicht mehr unterstützt. Weitere Informationen finden Sie in der YouTube-Hilfe.
Gibt eine Liste mit Ereignissen zu Kanalaktivitäten zurück, die den Anfragekriterien entsprechen. Sie können beispielsweise Ereignisse abrufen, die mit einem bestimmten Kanal oder mit dem eigenen Kanal des Nutzers verknüpft sind.
Auswirkungen auf Kontingente: Bei einem Aufruf dieser Methode fallen Kontingentkosten von 1 Einheit an.
Gängige Anwendungsfälle
Anfragen
HTTP-Anfrage
GET https://www.googleapis.com/youtube/v3/activities
Parameter
In der folgenden Tabelle sind die Parameter aufgeführt, die von dieser Abfrage unterstützt werden. Alle aufgeführten Parameter sind Abfrageparameter.
Parameter | ||
---|---|---|
Erforderliche Parameter | ||
part |
string Der Parameter part gibt eine durch Kommas getrennte Liste mit einer oder mehreren activity -Ressourceneigenschaften an, die in der API-Antwort enthalten sein werden.Wenn der Parameter eine Property mit untergeordneten Properties angibt, werden die untergeordneten Properties in die Antwort aufgenommen. In einer activity -Ressource enthält die Property snippet beispielsweise andere Properties, die die Art der Aktivität angeben, einen Anzeigetitel für die Aktivität usw. Wenn du part=snippet festlegst, enthält die API-Antwort auch alle diese verschachtelten Attribute.Die folgende Liste enthält die part -Namen, die du in den Parameterwert aufnehmen kannst:
|
|
Filter (genau einen der folgenden Parameter angeben) | ||
channelId |
string Der Parameter channelId gibt eine eindeutige YouTube-Kanal-ID an. Die API gibt dann eine Liste der Aktivitäten dieses Kanals zurück. |
|
home |
boolean Hinweis:Dieser Parameter wurde eingestellt. Bei Anfragen mit diesem Parameter enthält die API-Antwort ähnliche Elemente wie Nutzer, die nicht auf der YouTube-Startseite angemeldet waren. Dieser Parameter kann nur in einer ordnungsgemäß autorisierten Anfrage verwendet werden. |
|
mine |
boolean Dieser Parameter kann nur in einer ordnungsgemäß autorisierten Anfrage verwendet werden. Legen Sie den Wert dieses Parameters auf true fest, um einen Feed der Aktivitäten des authentifizierten Nutzers abzurufen. |
|
Optionale Parameter | ||
maxResults |
unsigned integer Der Parameter maxResults gibt die maximale Anzahl von Elementen an, die in der Ergebnismenge zurückgegeben werden sollen. Zulässige Werte sind 0 bis 50 . Der Standardwert ist 5 . |
|
pageToken |
string Der Parameter pageToken gibt eine bestimmte Seite im Ergebnissatz an, die zurückgegeben werden soll. In einer API-Antwort identifizieren die Attribute nextPageToken und prevPageToken andere Seiten, die abgerufen werden können. |
|
publishedAfter |
datetime Der Parameter publishedAfter gibt das früheste Datum und die früheste Uhrzeit an, zu dem eine Aktivität hätte stattfinden können, damit sie in die API-Antwort aufgenommen wird. Wenn der Parameterwert einen Tag, aber keine Uhrzeit angibt, werden alle Aktivitäten, die an diesem Tag stattgefunden haben, in der Ergebnismenge angezeigt. Der Wert wird im ISO 8601-Format (YYYY-MM-DDThh:mm:ss.sZ ) angegeben. |
|
publishedBefore |
datetime Der Parameter publishedBefore gibt das Datum und die Uhrzeit an, vor dem eine Aktivität stattgefunden haben muss, damit sie in die API-Antwort aufgenommen wird. Wenn der Parameterwert einen Tag, aber keine Uhrzeit angibt, werden alle Aktivitäten dieses Tages aus der Ergebnismenge ausgeschlossen. Der Wert wird im ISO 8601-Format (YYYY-MM-DDThh:mm:ss.sZ ) angegeben. |
|
regionCode |
string Der Parameter regionCode weist die API an, Ergebnisse für das angegebene Land zurückzugeben. Der Parameterwert ist ein ISO 3166-1 alpha-2-Ländercode. YouTube verwendet diesen Wert, wenn die bisherigen Aktivitäten des autorisierten Nutzers auf YouTube nicht genügend Informationen liefern, um den Aktivitätsfeed zu generieren. |
Anfragetext
Geben Sie beim Aufrufen dieser Methode keinen Anfragetext an.
Antwort
Bei Erfolg gibt diese Methode einen Antworttext mit der folgenden Struktur zurück:
{ "kind": "youtube#activityListResponse", "etag": etag, "nextPageToken": string, "prevPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ activity Resource ] }
Attribute
In der folgenden Tabelle werden die Attribute definiert, die in dieser Ressource angezeigt werden:
Attribute | |
---|---|
kind |
string Identifiziert den Typ der API-Ressource. Der Wert ist youtube#activityListResponse . |
etag |
etag Das ETag dieser Ressource. |
nextPageToken |
string Das Token, das als Wert des Parameters pageToken verwendet werden kann, um die nächste Seite im Ergebnissatz abzurufen. |
prevPageToken |
string Das Token, das als Wert des Parameters pageToken verwendet werden kann, um die vorherige Seite im Ergebnissatz abzurufen. |
pageInfo |
object Das pageInfo -Objekt enthält Seiteninformationen für die Ergebnismenge. |
pageInfo.totalResults |
integer Die Gesamtzahl der Ergebnisse in der Ergebnismenge. |
pageInfo.resultsPerPage |
integer Die Anzahl der Ergebnisse, die in der API-Antwort enthalten sind. |
items[] |
list Eine Liste von Aktivitäten oder Ereignissen, die den Anfragekriterien entsprechen. |
Fehler
In der folgenden Tabelle sind Fehlermeldungen aufgeführt, die von der API möglicherweise als Antwort auf einen Aufruf dieser Methode zurückgegeben werden. Weitere Informationen finden Sie in der Dokumentation zu Fehlermeldungen.
Fehlertyp | Fehlerdetails | Beschreibung |
---|---|---|
forbidden (403) |
forbidden |
Die Anfrage ist nicht ordnungsgemäß autorisiert. |
forbidden (403) |
homeParameterDeprecated |
Die Daten zur Homepage-Aktivität des Nutzers sind über diese API nicht verfügbar. Dieser Fehler kann auftreten, wenn Sie den Parameter home in einer nicht autorisierten Anfrage auf true setzen. |
notFound (404) |
channelNotFound |
Die vom Parameter channelId der Anfrage angegebene Kanal-ID wurde nicht gefunden. |
notFound (404) |
homeChannelNotFound |
Für den aktuell authentifizierten Nutzer wurde kein YouTube-Startseitenfeed gefunden. |
unauthorized (401) |
authorizationRequired |
Die Anfrage verwendet den Parameter home , ist aber nicht ordnungsgemäß autorisiert. |
Testen!
Verwenden Sie APIs Explorer, um diese API aufzurufen und die API-Anfrage und -Antwort anzusehen.