report
kaynağı, raporun belirli bir örneğini tanımlar. Bu kaynak, raporun veri içerdiği dönemin yanı sıra 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 raporun meta verilerini alır. |
list |
Belirtilen raporlama işi için oluşturulan raporları listeler. |
JSON kaynak gösterimi
Aşağıdaki JSON yapısı, bir report
kaynağının biçimini gösterir:
{ "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 |
string
YouTube'un raporu benzersiz şekilde tanımlamak için atadığı kimlik. Her rapor tek bir işle ilişkilendirilir ancak bir iş, birçok rapor kimliğiyle ilişkilendirilebilir. |
jobId |
string
Bu raporu oluşturan işin kimliği. |
startTime |
timestamp
Rapor örneğinin kapsadığı dönemin başlangıcı. Kapsayıcı değer, RFC3339 UTC "Zulu" bölümündeki bir zaman damgasıdır biçiminde, mikrosaniyelere kadar doğrulukta. Örnek: "2015-10-02T15:01:23.045678Z" . |
endTime |
timestamp
Rapor örneğinin kapsadığı dönemin sonu. Özel değer, RFC3339 UTC "Zulu" bölümündeki bir zaman damgasıdır biçiminde, mikrosaniyelere kadar doğrulukta. Örnek: "2015-10-02T15:01:23.045678Z" . |
createTime |
timestamp
İşin oluşturulduğu tarih ve saat. Özellik değeri, RFC3339 UTC "Zulu" zaman damgasıdır biçiminde, mikrosaniyelere kadar doğrulukta. Örnek: "2015-10-02T15:01:23.045678Z" . |
jobExpireTime |
timestamp
Raporla ilişkilendirilen işin süresinin dolduğu veya sona ereceği tarih ve saat. Özellik değeri, RFC3339 UTC "Zulu" zaman damgasıdır biçiminde, mikrosaniyelere kadar doğrulukta. Örnek: "2015-10-02T15:01:23.045678Z" .Raporun işiyle ilişkili rapor türü kullanımdan kaldırıldıysa veya bu iş için oluşturulan raporlar uzun bir süre boyunca indirilmemişse bu mülkte bir değer bulunur. Bu değer, YouTube'un artık iş için yeni raporlar oluşturmayacağı tarihi gösterir. Sona erme tarihi içeren bir işiniz varsa sisteminizi bu tarihe kadar rapor isteğinde bulunmayacak şekilde güncellemeniz gerekir. Bazı durumlarda değişim raporu sunulabilir. |
downloadUrl |
string
Raporun indirilebileceği URL. Özellik değerinin maksimum uzunluğu 1.000 karakterdir.Raporu almak için bu URL'ye bir HTTP GET isteği gönderin. İstekte, başlık değeri olarak yetkilendirme jetonunuzu kullanarak Authorization HTTP İsteği başlığını ayarlayın.
Gzip uygulamasını 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ı olacak olsa da daha az ağ kaynağı tüketmenin avantajı, genellikle bu maliyetten daha ağır basar. gzip kodlu bir yanıt almak için Accept-Encoding: gzip |