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 uniknya.

Permintaan

Permintaan HTTP

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

Otorisasi

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

Cakupan
https://www.googleapis.com/auth/yt-analytics.readonly Melihat 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 Melihat laporan moneter YouTube Analytics untuk konten YouTube Anda. Cakupan ini memberikan akses ke metrik aktivitas pengguna serta estimasi metrik pendapatan dan 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 serta 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 (tentukan dengan tepat salah satu parameter berikut)
id string
Parameter id menentukan daftar ID grup YouTube yang dipisahkan koma untuk resource yang diambil. Setiap grup harus dimiliki oleh pengguna terautentikasi. Dalam 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 diberi otorisasi 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 diberi otorisasi dengan benar. Catatan: Parameter ini ditujukan khusus 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. Fitur ini memungkinkan pemilik konten melakukan autentikasi satu kali dan mendapatkan akses ke semua data video dan channel mereka, tanpa harus memberikan kredensial autentikasi untuk setiap channel. Akun yang digunakan pengguna untuk melakukan autentikasi harus ditautkan ke pemilik konten YouTube yang ditentukan.
pageToken string
Parameter pageToken mengidentifikasi halaman tertentu dalam set 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.

Respons

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 dalam resource ini:

Properti
kind string
Mengidentifikasi jenis resource API. Nilainya akan menjadi 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 set hasil.

Error

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

Cobalah!

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