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ı alabilir veya bir veya daha fazla grubu benzersiz kimliklerine göre alabilirsiniz.
İstek
HTTP isteği
GET https://youtubeanalytics.googleapis.com/v2/groups
Yetkilendirme
Bu istek için aşağıdaki kapsamlardan en az birinin yetkilendirilmesi gerekir (kimlik doğrulama ve yetkilendirme hakkında daha fazla bilgi edinin).
Nişan dürbünleri | |
---|---|
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 mali raporlarını görüntüleyin. Bu kapsam, kullanıcı etkinliği metriklerine ve tahmini gelir ile 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 öğelerini ve YouTube'daki ilişkili içerikleri görüntüleyin ve yönetin. YouTube Analytics API'de, içerik sahipleri bu kapsamı YouTube Analytics gruplarını ve grup öğelerini yönetmek için 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 birini tam olarak belirtin) | ||
id |
string id parametresi, alınan kaynaklara ait YouTube grup kimliklerinin virgülle ayrılmış listesini belirtir. Her grup, kimliği doğrulanmış kullanıcıya ait olmalıdır. 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 bir yetkili 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 bir yetkili istekte kullanılabilir. Not: Bu parametre yalnızca birçok farklı YouTube kanalının sahibi ve yöneticisi olan YouTube içerik iş ortakları için hazırlanmış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ı belirttiğini gösterir. Bu sayede içerik sahipleri, her kanal için kimlik doğrulama bilgileri sağlamak zorunda kalmadan bir kez kimlik doğrulaması yapabilir ve tüm video ve kanal verilerine erişebilir. Kullanıcının kimlik doğrulaması yaptığı hesabın, belirtilen YouTube içerik sahibine bağlı olması gerekir. |
|
pageToken |
string pageToken parametresi, sonuç kümesinde döndürülmesi gereken belirli bir sayfayı tanımlar. Bir API yanıtında, nextPageToken özelliği alınabilecek sonraki sayfayı tanımlar. |
İstek metni
Bu yöntemi çağırırken bir istek gövdesi sağlamayın.
Yanıt
Başarılı olursa bu yöntem aşağıdaki yapıya sahip bir yanıt gövdesi 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 olacak. |
etag |
etag Bu kaynağın Etag'i. |
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ümesinde sonraki sayfayı almak için pageToken parametresinin değeri olarak kullanılabilecek jeton. |
Hatalar
API, bu API yöntemine özel herhangi bir hata mesajı tanımlamaz. Ancak bu yöntem hata mesajı dokümanlarında listelenen genel API hatalarını döndürmeye devam edebilir.
Deneyin.
Bu API'yi çağırmak ve API isteği ile yanıtını görmek için APIs Explorer özelliğini kullanın.