API isteği parametreleriyle eşleşen grupların listesini döndürür. Örneğin, kimliği doğrulanmış kullanıcının sahip olduğu tüm grupları veya benzersiz kimliklerine göre bir veya daha fazla grubu alabilirsiniz.
İstek
HTTP isteği
GET https://youtubeanalytics.googleapis.com/v2/groups
Yetkilendirme
Bu istek, aşağıdaki kapsamlardan en az biriyle yetkilendirme gerektirir (kimlik doğrulama ve yetkilendirme hakkında daha fazla bilgi edinin).
Kapsamlar | |
---|---|
https://www.googleapis.com/auth/yt-analytics.readonly | YouTube içeriğiniz için YouTube Analytics raporlarını görüntüleyin. Bu kapsam, görüntüleme sayısı ve puan sayısı gibi kullanıcı etkinliği metriklerine erişim sağlar. |
https://www.googleapis.com/auth/yt-analytics-monetary.readonly | YouTube içeriğiniz için YouTube Analytics'teki parasal raporları görüntüleyin. Bu kapsam, kullanıcı etkinliği metriklerine, tahmini gelir ve reklam performansı metriklerine erişim sağlar. |
https://www.googleapis.com/auth/youtube | YouTube hesabınızı yönetin. YouTube Analytics API'de kanal sahipleri, YouTube Analytics gruplarını ve grup öğelerini yönetmek için bu kapsamı kullanır. |
https://www.googleapis.com/auth/youtubepartner | YouTube'daki YouTube öğelerini ve ilişkili içeriği görüntüleyin ve yönetin. YouTube Analytics API'de içerik sahipleri, YouTube Analytics gruplarını ve grup öğelerini yönetmek için bu kapsamı kullanır. |
Parametreler
Aşağıdaki tabloda bu sorgunun desteklediği parametreler listelenmiştir. Listelenen tüm parametreler sorgu parametreleridir.
Parametreler | ||
---|---|---|
Filtreler (aşağıdaki parametrelerden tam olarak birini belirtin) | ||
id |
string id parametresi, alınan kaynakların YouTube grup kimliklerinin virgülle ayrılmış listesini belirtir. Her grubun, kimliği doğrulanmış kullanıcıya ait olması gerekir. Bir group kaynağında id özelliği, grubun YouTube grup kimliğini belirtir.id parametresi için değer belirtmezseniz mine parametresini true olarak ayarlamanız gerektiğini unutmayın. |
|
mine |
boolean Bu parametre yalnızca uygun şekilde yetkilendirilmiş bir istekte kullanılabilir. Kimliği doğrulanmış kullanıcının sahip olduğu tüm grupları almak için bu parametrenin değerini true olarak ayarlayın. |
|
İsteğe bağlı parametreler | ||
onBehalfOfContentOwner |
string Bu parametre yalnızca uygun şekilde yetkilendirilmiş bir istekte kullanılabilir. Not: Bu parametre, birçok farklı YouTube kanalına sahip olan ve bunları yöneten YouTube içerik iş ortakları için tasarlanmıştır. onBehalfOfContentOwner parametresi, isteğin yetkilendirme kimlik bilgilerinin, parametre değerinde belirtilen içerik sahibi adına hareket eden bir YouTube kullanıcısını tanımladığını gösterir. Bu sayede içerik sahipleri, her kanal için kimlik doğrulama kimlik bilgilerini sağlamak zorunda kalmadan tek seferde kimlik doğrulama yapabilir ve tüm video ve kanal verilerine erişebilir. Kullanıcının kimliğini doğruladığı hesap, belirtilen YouTube içerik sahibine bağlı olmalıdır. |
|
pageToken |
string pageToken parametresi, sonuç kümesinde döndürülmesi gereken belirli bir sayfayı tanımlar. API yanıtında nextPageToken mülkü, alınabilecek bir sonraki sayfayı tanımlar. |
İstek içeriği
Bu yöntemi çağırırken istek gövdesini belirtmeyin.
Yanıt
Başarılı olursa bu yöntem aşağıdaki yapıya sahip bir yanıt metni döndürür:
{ "kind": "youtube#groupListResponse", "etag": etag, "items": [ group Resource ], "nextPageToken": string }
Özellikler
Aşağıdaki tabloda bu kaynakta görünen özellikler tanımlanmaktadır:
Özellikler | |
---|---|
kind |
string API kaynağının türünü tanımlar. Değer youtube#groupListResponse olur. |
etag |
etag Bu kaynağın Etag değeri. |
items[] |
list API isteği parametreleriyle eşleşen grupların listesi. Listedeki her öğe bir group kaynağını temsil eder. |
nextPageToken |
string Sonuç kümesindeki bir sonraki sayfayı almak için pageToken parametresinin değeri olarak kullanılabilen jeton. |
Hatalar
API, bu API yöntemine özgü herhangi bir hata mesajı tanımlamaz. Ancak bu yöntem yine de hata mesajı dokümanlarında listelenen genel API hatalarını döndürebilir.
Deneyin!
Bu API'yi çağırmak ve API isteğini ve yanıtını görmek için APIs Explorer simgesini kullanın.