Zasób report identyfikuje konkretne wystąpienie raportu. Zasób określa przedział czasu, z którego pochodzą dane, oraz URL, z którego można go pobrać.
Metody
W tabeli poniżej znajdziesz metody, które interfejs API obsługuje w przypadku zasobów report.
| Metody | |
|---|---|
get |
Pobiera metadane określonego raportu. |
list |
Wyświetla listę raportów wygenerowanych na potrzeby określonego zadania raportowania. |
Reprezentacja zasobu JSON
Poniższa struktura JSON przedstawia format zasobu report:
{
"id": string,
"jobId": string,
"startTime": timestamp,
"endTime": timestamp,
"createTime": timestamp,
"jobExpireTime": timestamp,
"downloadUrl": string
}Właściwości
Tabela poniżej zawiera właściwości widoczne w tym zasobie:
| Właściwości | |
|---|---|
id |
string, Przypisywany przez YouTube identyfikator jednoznacznie identyfikujący raport. Każdy raport jest powiązany z jednym zadaniem, chociaż jedno zadanie może być powiązane z wieloma identyfikatorami raportów. |
jobId |
string, Identyfikator zadania, które utworzyło ten raport. |
startTime |
timestamp, Początek okresu, którego dotyczy dane wystąpienie raportu. Wartość uwzględniająca to sygnatura czasowa w RFC3339 UTC „Zulu” z dokładnością do mikrosekund. Przykład: "2015-10-02T15:01:23.045678Z". |
endTime |
timestamp, Koniec okresu, którego dotyczy dane wystąpienie raportu. Wartość wyłączna to sygnatura czasowa w RFC3339 UTC „Zulu” 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 jest sygnaturą czasową w dokumencie RFC3339 UTC „Zulu” z dokładnością do mikrosekund. Przykład: "2015-10-02T15:01:23.045678Z". |
jobExpireTime |
timestamp, Data i godzina, kiedy zadanie powiązane z raportem wygasło lub wygaśnie. Wartość właściwości jest sygnaturą czasową w dokumencie RFC3339 UTC „Zulu” z dokładnością do mikrosekund. Przykład: "2015-10-02T15:01:23.045678Z".Ta właściwość zawiera wartość, jeśli typ raportu powiązany z zadaniem raportu został wycofany lub raporty wygenerowane dla tego zadania nie były pobierane od dłuższego czasu. Wartość oznacza datę, po której YouTube nie będzie już generować nowych raportów dotyczących danego zadania. Jeśli masz zadanie, które określa datę ważności, zaktualizuj system, aby do tego dnia nie wysyłał już żądań raportu. W niektórych przypadkach może być dostępny raport zastępczy. |
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 na ten adres URL żądanie HTTP GET. W żądaniu ustaw nagłówek żądania HTTP Authorization, używając tokena autoryzacji jako wartości nagłówka.
Używanie programu gzip Możesz zmniejszyć przepustowość niezbędną do pobierania raportów, włączając kompresję gzip przy żądaniach pobierania. Aplikacja będzie potrzebować więcej czasu pracy procesora, aby zdekompresować odpowiedzi interfejsu API, jednak korzyści z używania mniejszej liczby zasobów sieciowych zwykle przewyższają ten koszt. Aby odebrać odpowiedź zakodowaną w formacie gzip, ustaw nagłówek żądania HTTP Accept-Encoding: gzip |