Reports

Zasób report określa konkretną instancję raportu. Zasób określa okres, z którego raport zawiera dane, a także URL, z którego można go pobrać.

Metody

W tabeli poniżej podano metody, które interfejs API obsługuje w przypadku report zasobów.

Metody
get Pobiera metadane określonego raportu.
list Wyświetla listę raportów, które zostały wygenerowane dla określonego zadania raportowania.

Reprezentacja zasobów JSON

Struktura JSON poniżej przedstawia format zasobu report:

{
  "id": string,
  "jobId": string,
  "startTime": timestamp,
  "endTime": timestamp,
  "createTime": timestamp,
  "jobExpireTime": timestamp,
  "downloadUrl": string
}

Usługi

Poniższa tabela określa właściwości, które pojawiają się w tym zasobie:

Usługi
id string
Identyfikator przypisywany w YouTube do jednoznacznego identyfikowania raportu. Każdy raport jest powiązany z 1 zadaniem, chociaż może ono być powiązane z wieloma identyfikatorami raportów.
jobId string
Identyfikator zadania, za pomocą którego utworzono ten raport.
startTime timestamp
Początek okresu, którego dotyczy instancja raportu. Wartość „włącznie” to sygnatura czasowa w formacie „RFC 3339 UTC „Zulu” z dokładnością do mikrosekund. Przykład: "2015-10-02T15:01:23.045678Z".

endTime timestamp
Koniec okresu objętego raportem. Wartość wyłączna to sygnatura czasowa w formacie UTC „Zulu” z sygnaturą RFC 3339, z dokładnością do mikrosekund. Przykład: "2015-10-02T15:01:23.045678Z".

createTime timestamp
Data i godzina utworzenia zadania. Wartość właściwości to sygnatura czasowa w formacie „RFC 3339 UTC „Zulu” z dokładnością do mikrosekund. Przykład: "2015-10-02T15:01:23.045678Z".

jobExpireTime timestamp
Data i godzina zakończenia zadania powiązanego z raportem wygaśnie lub wygaśnie. Wartość właściwości to sygnatura czasowa w formacie „RFC 3339 UTC „Zulu” z dokładnością do mikrosekund. Przykład: "2015-10-02T15:01:23.045678Z".

Ta właściwość ma wartość, jeśli typ raportu powiązany z zadaniem raportu został wycofany lub raporty dotyczące tego zadania nie były pobierane przez dłuższy czas. Wartość oznacza datę, po której YouTube nie będzie już generować nowych raportów dla tego zlecenia.

Jeśli masz ofertę pracy z datą wygaśnięcia, musisz zaktualizować swój system, aby przestała żądać raportu do tego dnia. W niektórych przypadkach może być dostępny raport o zastępstwie.
downloadUrl string
Adres URL, z którego można pobrać raport. Wartość właściwości może mieć maksymalnie 1000 znaków.

Aby pobrać raport, wyślij żądanie HTTP GET na ten adres URL. W żądaniu ustaw nagłówek HTTP Authorization, używając tokena autoryzacji jako wartości nagłówka.

Korzystanie z gzip

Możesz zmniejszyć przepustowość potrzebną do pobierania raportów, włączając kompresję gzip w przypadku żądań pobierania. Choć aplikacja potrzebuje więcej czasu na skompresowanie odpowiedzi interfejsu API, korzyści zużywania mniejszej liczby zasobów sieciowych zwykle przewyższają ten koszt.

Aby otrzymać odpowiedź zakodowaną w formacie gzip, ustaw nagłówek HTTP Accept-Encoding na gzip, jak w tym przykładzie:

Accept-Encoding: gzip