report kaynağı, raporun belirli bir örneğini tanımlar. Kaynak, raporun veri içerdiği zaman aralığını ve raporun indirilebileceği URL'yi tanımlar.
Yöntemler
Aşağıdaki tabloda, API'nin report kaynakları için desteklediği yöntemler gösterilmektedir.
| Yöntemler | |
|---|---|
get |
Belirli bir rapora ait meta verileri alır. |
list |
Belirtilen raporlama işi için oluşturulan raporları listeler. |
JSON kaynak gösterimi
Aşağıdaki JSON yapısında, report kaynağının biçimi gösterilmektedir:
{
"id": string,
"jobId": string,
"startTime": timestamp,
"endTime": timestamp,
"createTime": timestamp,
"jobExpireTime": timestamp,
"downloadUrl": string
}Özellikler
Aşağıdaki tabloda, bu kaynakta görünen özellikler tanımlanmaktadır:
| Özellikler | |
|---|---|
id |
stringYouTube'un raporu benzersiz şekilde tanımlamak için atadığı kimlik. Her rapor tek bir işle ilişkilendirilir ancak bir işlem birçok rapor kimliğiyle ilişkilendirilebilir. |
jobId |
stringBu raporu oluşturan işin kimliği. |
startTime |
timestampRapor örneğinin kapsadığı zaman aralığının başlangıcı. Kapsayıcı değer, mikrosaniye oranında doğruluğa sahip ve RFC3339 UTC "Zulu" biçiminde bir zaman damgasıdır. Örnek: "2015-10-02T15:01:23.045678Z". |
endTime |
timestampRapor örneğinin kapsadığı dönemin sonu. Hariç tutulan değer, mikrosaniyeye kadar doğru olan RFC3339 UTC "Zulu" biçiminde bir zaman damgasıdır. Örnek: "2015-10-02T15:01:23.045678Z". |
createTime |
timestampİşin oluşturulduğu tarih ve saat. Özellik değeri, mikrosaniye oranında doğruluğa sahip ve RFC3339 UTC "Zulu" biçiminde bir zaman damgasıdır. Örnek: "2015-10-02T15:01:23.045678Z". |
jobExpireTime |
timestampRaporla ilişkili işin sona erdiği veya sona ereceği tarih ve saat. Özellik değeri, mikrosaniye oranında doğruluğa sahip ve RFC3339 UTC "Zulu" biçiminde bir zaman damgasıdır. Örnek: "2015-10-02T15:01:23.045678Z".Bu özellik, raporun işiyle ilişkili rapor türünün desteği sonlandırıldıysa veya bu iş için oluşturulan raporlar uzun bir süre boyunca indirilmediyse bir değere sahiptir. Bu değer, YouTube'un bu iş için yeni rapor oluşturmayı bırakacağı tarihi gösterir. Son kullanma tarihi olan bir işiniz varsa sisteminizi, bu tarihe kadar rapor isteğinde bulunmayı durduracak şekilde güncellemeniz gerekir. Bazı durumlarda, değiştirme raporu kullanılabilir. |
downloadUrl |
stringRaporun indirilebileceği URL. Özellik değeri en fazla 1.000 karakter uzunluğunda olabilir. Raporu almak için bu URL'ye bir HTTP GET isteği gönderin. İstek başlığında, yetkilendirme jetonunuzu kullanarak Authorization HTTP isteği başlığını ayarlayın.
gzip kullanma İndirme isteklerinde gzip sıkıştırmayı etkinleştirerek raporları indirmek için gereken bant genişliğini azaltabilirsiniz. Uygulamanızın API yanıtlarını açmak için ek CPU süresine ihtiyacı olsa da daha az ağ kaynağı kullanmanın avantajı genellikle bu maliyetten daha fazladır. Gzip ile kodlanmış bir yanıt almak için Accept-Encoding: gzip |