Groups: list

Menampilkan daftar grup yang cocok dengan parameter permintaan API. Misalnya, Anda dapat mengambil semua grup yang dimiliki pengguna terautentikasi, atau Anda dapat mengambil satu atau beberapa grup berdasarkan ID unik mereka.

Permintaan

Permintaan HTTP

GET https://youtubeanalytics.googleapis.com/v2/groups

Otorisasi

Permintaan ini memerlukan otorisasi dengan setidaknya satu cakupan berikut (baca selengkapnya tentang autentikasi dan otorisasi).

Cakupan
https://www.googleapis.com/auth/yt-analytics.readonly	Lihat laporan YouTube Analytics untuk konten YouTube Anda. Cakupan ini memberikan akses ke metrik aktivitas pengguna, seperti jumlah penayangan dan jumlah rating.
https://www.googleapis.com/auth/yt-analytics-monetary.readonly	Lihat laporan moneter YouTube Analytics untuk konten YouTube Anda. Cakupan ini memberikan akses ke metrik aktivitas pengguna dan estimasi pendapatan serta metrik performa iklan.
https://www.googleapis.com/auth/youtube	Mengelola akun YouTube Anda. Di YouTube Analytics API, pemilik channel menggunakan cakupan ini untuk mengelola grup dan item grup YouTube Analytics.
https://www.googleapis.com/auth/youtubepartner	Melihat dan mengelola aset YouTube dan konten terkait di YouTube. Di YouTube Analytics API, pemilik konten menggunakan cakupan ini untuk mengelola grup dan item grup YouTube Analytics.

Parameter

Tabel di bawah mencantumkan parameter yang didukung kueri ini. Semua parameter yang tercantum adalah parameter kueri.

Parameter
Filter (sebutkan salah satu parameter berikut)
id	string Parameter id menentukan daftar ID grup YouTube yang dipisahkan koma untuk resource yang sedang diambil. Setiap grup harus dimiliki oleh pengguna yang terautentikasi. Di resource group, properti id menentukan ID grup YouTube grup. Perhatikan bahwa jika Anda tidak menentukan nilai untuk parameter id, Anda harus menetapkan parameter mine ke true.
mine	boolean Parameter ini hanya dapat digunakan dalam permintaan yang diizinkan dengan benar. Tetapkan nilai parameter ini ke true untuk mengambil semua grup yang dimiliki oleh pengguna yang diautentikasi.
Parameter opsional
onBehalfOfContentOwner	string Parameter ini hanya dapat digunakan dalam permintaan yang diizinkan dengan benar. Catatan: Parameter ini ditujukan secara eksklusif untuk partner konten YouTube yang memiliki dan mengelola berbagai channel YouTube. Parameter onBehalfOfContentOwner menunjukkan bahwa kredensial otorisasi permintaan mengidentifikasi pengguna YouTube yang bertindak atas nama pemilik konten yang ditentukan dalam nilai parameter. Dengan kebijakan ini, pemilik konten dapat mengautentikasi sekali serta mendapatkan akses ke semua data video dan channel mereka, tanpa harus memberikan kredensial autentikasi untuk setiap channel. Akun yang diautentikasi pengguna harus ditautkan dengan pemilik konten YouTube yang ditentukan.
pageToken	string Parameter pageToken mengidentifikasi halaman tertentu dalam kumpulan hasil yang harus ditampilkan. Dalam respons API, properti nextPageToken mengidentifikasi halaman berikutnya yang dapat diambil.

Isi permintaan

Jangan berikan isi permintaan saat memanggil metode ini.

Tanggapan

Jika berhasil, metode ini akan menampilkan isi respons dengan struktur berikut:

{
  "kind": "youtube#groupListResponse",
  "etag": etag,
  "items": [
    group Resource
  ],
  "nextPageToken": string
}

Properti

Tabel berikut menentukan properti yang muncul di resource ini:

Properti
kind	string Mengidentifikasi jenis resource API. Nilainya adalah youtube#groupListResponse.
etag	etag Etag resource ini.
items[]	list Daftar grup yang cocok dengan parameter permintaan API. Setiap item dalam daftar mewakili resource group.
nextPageToken	string Token yang dapat digunakan sebagai nilai parameter pageToken untuk mengambil halaman berikutnya dalam kumpulan hasil.

Error

API tidak menetapkan pesan error apa pun yang unik untuk metode API ini. Namun, metode ini tetap dapat menampilkan error API umum yang tercantum dalam dokumentasi pesan error.

Cobalah!

Gunakan APIs Explorer untuk memanggil API ini dan melihat permintaan dan respons API.