activities.list
masih
tidak menampilkan buletin saluran, dan
metode activities.insert
tidak
lagi didukung. Untuk mengetahui detail selengkapnya, buka
Pusat Bantuan YouTube.
Menampilkan daftar peristiwa aktivitas saluran yang cocok dengan kriteria permintaan. Misalnya, Anda dapat mengambil peristiwa yang terkait dengan saluran tertentu atau dengan saluran pengguna itu sendiri.
Dampak kuota: Panggilan ke metode ini memiliki biaya kuota 1 unit.
Kasus penggunaan umum
Permintaan
Permintaan HTTP
GET https://www.googleapis.com/youtube/v3/activities
Parameter
Tabel berikut mencantumkan parameter yang didukung kueri ini. Semua parameter yang tercantum adalah parameter kueri.
Parameter | ||
---|---|---|
Parameter yang diperlukan | ||
part |
string Parameter part menentukan daftar yang dipisahkan koma dari satu atau beberapa properti resource activity yang akan disertakan dalam respons API.Jika parameter mengidentifikasi properti yang berisi properti turunan, properti turunan akan disertakan dalam respons. Misalnya, dalam resource activity , properti snippet berisi properti lain yang mengidentifikasi jenis aktivitas, judul tampilan untuk aktivitas tersebut, dan seterusnya. Jika Anda menyetel part=snippet , respons API juga akan berisi semua properti bertingkat tersebut.Daftar berikut berisi nama part yang dapat Anda sertakan dalam nilai parameter:
|
|
Filter (sebutkan salah satu parameter berikut) | ||
channelId |
string Parameter channelId menentukan ID channel YouTube yang unik. API kemudian akan menampilkan daftar aktivitas saluran tersebut. |
|
home |
boolean Catatan: Parameter ini tidak digunakan lagi. Untuk permintaan yang menyetel parameter ini, respons API berisi item yang serupa dengan yang akan dilihat oleh pengguna yang logout di halaman beranda YouTube. Perhatikan bahwa parameter ini hanya dapat digunakan dalam permintaan yang sah dengan benar. |
|
mine |
boolean Parameter ini hanya dapat digunakan dalam permintaan yang diizinkan dengan benar. Setel nilai parameter ini ke true untuk mengambil feed aktivitas pengguna yang diautentikasi. |
|
Parameter opsional | ||
maxResults |
unsigned integer Parameter maxResults menentukan jumlah maksimum item yang harus ditampilkan dalam kumpulan hasil. Nilai yang dapat diterima adalah 0 hingga 50 , inklusif. Nilai defaultnya adalah 5 . |
|
pageToken |
string Parameter pageToken mengidentifikasi halaman tertentu dalam kumpulan hasil yang harus ditampilkan. Dalam respons API, properti nextPageToken dan prevPageToken mengidentifikasi halaman lain yang dapat diambil. |
|
publishedAfter |
datetime Parameter publishedAfter menentukan tanggal dan waktu paling awal yang dapat terjadi untuk aktivitas yang akan disertakan dalam respons API. Jika nilai parameter menentukan hari, tetapi bukan waktu, maka aktivitas apa pun yang terjadi pada hari tersebut akan disertakan dalam kumpulan hasil. Nilai ditetapkan dalam format ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ ). |
|
publishedBefore |
datetime Parameter publishedBefore menentukan tanggal dan waktu sebelum aktivitas harus terjadi agar aktivitas tersebut disertakan dalam respons API. Jika nilai parameter menentukan hari, tetapi bukan waktu, maka aktivitas yang terjadi pada hari tersebut akan dikecualikan dari kumpulan hasil. Nilai ditetapkan dalam format ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ ). |
|
regionCode |
string Parameter regionCode menginstruksikan API untuk menampilkan hasil bagi negara yang ditentukan. Nilai parameter adalah kode negara ISO 3166-1 alpha-2. YouTube akan menggunakan nilai ini saat aktivitas sebelumnya dari pengguna yang diotorisasi di YouTube tidak memberikan informasi yang cukup untuk membuat feed aktivitas. |
Isi permintaan
Jangan berikan isi permintaan saat memanggil metode ini.
Tanggapan
Jika berhasil, metode ini akan menampilkan isi respons dengan struktur berikut:
{ "kind": "youtube#activityListResponse", "etag": etag, "nextPageToken": string, "prevPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ activity Resource ] }
Properti
Tabel berikut menentukan properti yang muncul di resource ini:
Properti | |
---|---|
kind |
string Mengidentifikasi jenis resource API. Nilainya adalah youtube#activityListResponse . |
etag |
etag Etag resource ini. |
nextPageToken |
string Token yang dapat digunakan sebagai nilai parameter pageToken untuk mengambil halaman berikutnya dalam kumpulan hasil. |
prevPageToken |
string Token yang dapat digunakan sebagai nilai parameter pageToken untuk mengambil halaman sebelumnya dalam kumpulan hasil. |
pageInfo |
object Objek pageInfo mengenkapsulasi informasi paging untuk kumpulan hasil. |
pageInfo.totalResults |
integer Total jumlah hasil dalam kumpulan hasil. |
pageInfo.resultsPerPage |
integer Jumlah hasil yang disertakan dalam respons API. |
items[] |
list Daftar aktivitas, atau peristiwa, yang cocok dengan kriteria permintaan. |
Error
Tabel berikut mengidentifikasi pesan error yang dapat ditampilkan API sebagai respons terhadap panggilan ke metode ini. Lihat dokumentasi pesan error untuk mengetahui detail selengkapnya.
Jenis error | Detail error | Deskripsi |
---|---|---|
forbidden (403) |
forbidden |
Permintaan tidak diotorisasi dengan benar. |
forbidden (403) |
homeParameterDeprecated |
Data aktivitas halaman beranda pengguna tidak tersedia melalui API ini. Error ini mungkin terjadi jika Anda menyetel parameter home ke true dalam permintaan yang tidak sah. |
notFound (404) |
channelNotFound |
ID saluran yang diidentifikasi oleh parameter channelId permintaan tidak dapat ditemukan. |
notFound (404) |
homeChannelNotFound |
Feed halaman beranda YouTube tidak dapat ditemukan untuk pengguna yang saat ini diautentikasi. |
unauthorized (401) |
authorizationRequired |
Permintaan menggunakan parameter home , tetapi tidak diotorisasi dengan benar. |
Cobalah!
Gunakan APIs Explorer untuk memanggil API ini dan melihat permintaan dan respons API.