W tym dokumencie opisujemy kilka technik, których możesz użyć, aby poprawić wydajność swojej aplikacji. W niektórych przypadkach do zilustrowania przedstawionych pomysłów użyliśmy przykładów z innych interfejsów API lub ogólnych interfejsów API. Te same pojęcia mają jednak zastosowanie w przypadku interfejsu Google Drive API.
Kompresja za pomocą gzip
Kompresja gzip pozwala łatwo i wygodnie zmniejszyć przepustowość potrzebną do obsługi żądań. Mimo że dekompresja wyników wymaga dodatkowego czasu procesora, to kompresja kosztów sieciowych zazwyczaj jest bardzo korzystna.
Aby odebrać odpowiedź zakodowaną w formacie gzip, ustaw nagłówek Accept-Encoding
i dodaj do klienta użytkownika ciąg tekstowy gzip
. Oto przykład prawidłowo sformatowanych nagłówków HTTP, które umożliwiają włączenie kompresji gzip:
Accept-Encoding: gzip User-Agent: my program (gzip)
Praca z częściowymi zasobami
Innym sposobem na poprawę wydajności wywołań interfejsu API jest wysyłanie i odbieranie tylko części danych, które Cię interesują. Dzięki temu aplikacja nie musi przesyłać, analizować i przechowywać niepotrzebnych pól, a tym samym efektywniej wykorzystywać zasoby, w tym sieć, procesor i pamięć.
Istnieją 2 typy żądań częściowych:
- Odpowiedź częściowa: w tym żądaniu wybierasz, które pola mają znajdować się w odpowiedzi (użyj parametru żądania
fields
). - Poprawka: w tym żądaniu aktualizacji wysyłasz tylko te pola, które chcesz zmienić (użyj czasownika HTTP
PATCH
).
Więcej informacji na temat tworzenia częściowych żądań znajdziesz w sekcjach poniżej.
Odpowiedź częściowa
Po przetworzeniu żądań serwer domyślnie odsyła pełną reprezentację zasobu. Aby zwiększyć wydajność, możesz wysłać do serwera żądanie, by wysyłał tylko te pola, których potrzebujesz, i otrzymał odpowiedź częściową.
Aby wysłać takie żądanie, użyj parametru żądania fields
, określając w nim pola, które chcesz odebrać w odpowiedzi. Tego parametru możesz użyć w przypadku każdego żądania, które zwraca dane odpowiedzi.
Pamiętaj, że parametr fields
wpływa tylko na dane odpowiedzi. Nie ma wpływu na dane, które musisz wysłać. Aby zmniejszyć ilość danych wysyłanych po zmianie zasobów, użyj żądania poprawki.
Przykład
Przykład poniżej pokazuje wykorzystanie parametru fields
z ogólnym (fikcyjnym) interfejsem API „Demo”.
Proste żądanie: to żądanie HTTP GET
pomija parametr fields
i zwraca pełny zasób.
https://www.googleapis.com/demo/v1
Odpowiedź z pełnym zasobem: pełne dane zasobu obejmują poniższe pola i wiele innych pól pominiętych ze względu na długość odpowiedzi.
{ "kind": "demo", ... "items": [ { "title": "First title", "comment": "First comment.", "characteristics": { "length": "short", "accuracy": "high", "followers": ["Jo", "Will"], }, "status": "active", ... }, { "title": "Second title", "comment": "Second comment.", "characteristics": { "length": "long", "accuracy": "medium" "followers": [ ], }, "status": "pending", ... }, ... ] }
Żądanie odpowiedzi częściowej: poniższe żądanie tego samego zasobu używa parametru fields
, aby znacznie zmniejszyć ilość zwracanych danych.
https://www.googleapis.com/demo/v1?fields=kind,items(title,characteristics/length)
Odpowiedź częściowa: w odpowiedzi na powyższe żądanie serwer wysyła odpowiedź, która zawiera tylko informacje o rodzaju oraz skróconą tablicę elementów, która w każdym elemencie zawiera tylko informacje o tytule HTML i długości elementów.
200 OK
{ "kind": "demo", "items": [{ "title": "First title", "characteristics": { "length": "short" } }, { "title": "Second title", "characteristics": { "length": "long" } }, ... ] }
Pamiętaj, że odpowiedź to obiekt JSON, który zawiera tylko wybrane pola i ich obiekty nadrzędne.
Szczegółowe informacje o formatowaniu parametru fields
znajdziesz poniżej. Opisaliśmy też szczegółowo zawartość odpowiedzi.
Podsumowanie składni parametrów pól
Format wartości parametru żądania fields
jest oparty na składni XPath. Podsumowanie obsługiwanej składni znajdziesz poniżej. Dodatkowe przykłady znajdziesz w sekcji poniżej.
- Aby wybrać wiele pól, użyj listy oddzielonej przecinkami.
- Użyj
a/b
, aby wybrać poleb
zagnieżdżone w polua
. Użyja/b/c
, aby wybrać polec
zagnieżdżone w polub
.
Wyjątek: jeśli odpowiedź interfejsu API używa kodu danych i jest zagnieżdżona w obiekcie
data
, który wygląda jakdata: { ... }
, nie dodawaj „data
” do specyfikacjifields
. Dodanie do specyfikacji fields obiektu data, takiego jakdata/a/b
, powoduje błąd. Użyj tylko specyfikacjifields
, takiej jaka/b
. - Użyj selektora podrzędnego, aby zażądać zbioru konkretnych podrzędnych pól tablic lub obiektów. W tym celu umieść wyrażenia w nawiasach „
( )
”.Przykład:
fields=items(id,author/email)
zwraca tylko identyfikator elementu i adres e-mail autora każdego elementu tablicy. Możesz też podać jedno pole podrzędne, gdziefields=items(id)
jest równoważne zfields=items/id
. - Jeśli to konieczne, w wybranych polach używaj symboli wieloznacznych.
Przykład:
fields=items/pagemap/*
wybiera wszystkie obiekty w elemencie pagemap.
Więcej przykładów użycia parametru fields
W poniższych przykładach opisano, jak wartość parametru fields
wpływa na odpowiedź.
Uwaga: tak jak w przypadku wszystkich wartości parametrów zapytania, wartość parametru fields
musi być zakodowana na potrzeby adresu URL. Aby zwiększyć czytelność, w przykładach w tym dokumencie kodowanie zostało pominięte.
- Zidentyfikuj pola, które chcesz zwrócić, lub wybierz pola.
- Wartość parametru żądania
fields
ma postać listy pól rozdzielonych przecinkami. Każde pole jest określane względem elementu głównego odpowiedzi. Oznacza to, że jeśli wykonujesz operację na liście, w odpowiedzi otrzymasz kolekcję, która zwykle zawiera tablicę zasobów. Jeśli wykonujesz operację, która zwraca 1 zasób, pola są określane względem tego zasobu. Jeśli wybrane pole jest tablicą (lub jest jej częścią), serwer zwraca wybraną część wszystkich elementów tablicy.
Oto kilka przykładów na poziomie kolekcji:
Przykłady Efekt items
Zwraca wszystkie elementy tablicy, łącznie ze wszystkimi polami w każdym elemencie (nie zwraca żadnych innych pól). etag,items
Zwraca zarówno pole etag
, jak i wszystkie elementy tablicy.items/title
Zwraca tylko pole title
każdego elementu tablicy.
Gdy jest zwracane zagnieżdżone pole, odpowiedź zawiera obiekty nadrzędne. Pola nadrzędne nie zawierają żadnych innych pól podrzędnych, chyba że również zostaną wyraźnie wybrane.context/facets/label
Zwraca tylko pole label
każdego elementu tablicyfacets
, która jest zagnieżdżona w obiekciecontext
.items/pagemap/*/title
Zwraca tylko pole title
(jeśli jest obecne) każdego elementu tablicy we wszystkich obiektach podrzędnych obiektupagemap
.
Oto kilka przykładów na poziomie zasobu:
Przykłady Efekt title
Zwraca pole title
żądanego zasobu.author/uri
Zwraca pole podrzędne uri
obiektuauthor
w żądanym zasobie.links/*/href
Zwraca pole href
wszystkich obiektów podrzędnych obiektulinks
. - Aby żądać tylko fragmentów pól, dokonaj wyborów podrzędnych.
- Jeśli żądanie dotyczy określonych pól, serwer zwraca domyślnie całe obiekty lub elementy tablicy. Możesz określić odpowiedź, która zawiera tylko określone pola podrzędne. W tym celu użyj składni wyboru podrzędnego „
( )
”, jak pokazujemy w tym przykładzie.Przykład Efekt items(title,author/uri)
Zwraca tylko wartości title
iuri
autora z każdego elementu tablicy.
Obsługa odpowiedzi częściowych
Gdy serwer przetworzy prawidłowe żądanie z parametrem zapytania fields
, razem z żądanymi danymi wyśle kod stanu HTTP 200 OK
. Jeśli parametr zapytania fields
zawiera błąd lub jest nieprawidłowy z innego powodu, serwer zwraca kod stanu HTTP 400 Bad Request
i komunikat o błędzie z informacją o problemie z wyborem pól (na przykład "Invalid field selection a/b"
).
Poniżej znajdziesz przykładową odpowiedź częściową, o której mowa powyżej, we wprowadzeniu. Aby określić, które pola zwrócić, żądanie używa parametru fields
.
https://www.googleapis.com/demo/v1?fields=kind,items(title,characteristics/length)
Odpowiedź częściowa wygląda tak:
200 OK
{ "kind": "demo", "items": [{ "title": "First title", "characteristics": { "length": "short" } }, { "title": "Second title", "characteristics": { "length": "long" } }, ... ] }
Uwaga: w przypadku interfejsów API, które obsługują parametry zapytania do podziału danych na strony (na przykład maxResults
i nextPageToken
), te parametry pozwalają zmniejszyć liczbę wyników zapytań do rozmiaru, który ułatwia obsługę. W przeciwnym razie wzrost wydajności wynikający z odpowiedzi częściowej może nie zostać osiągnięty.
Poprawka (częściowa aktualizacja)
Nie musisz też wysyłać niepotrzebnych danych podczas modyfikowania zasobów. Aby wysłać tylko zaktualizowane dane pól, które zmieniasz, użyj czasownika HTTP PATCH
. Semantyka poprawki opisana w tym dokumencie jest inna (i prostsza) niż w przypadku starszej implementacji częściowej aktualizacji GData.
Krótki przykład poniżej pokazuje, jak użycie poprawki pozwala zminimalizować ilość danych, które trzeba wysyłać przy dokonywaniu niewielkiej aktualizacji.
Przykład
Ten przykład przedstawia proste żądanie poprawki, które aktualizuje tylko tytuł zasobu ogólnego (fikcyjnego) interfejsu API „Demo”. Zasób ma też komentarz, zbiór cech, stan i wiele innych pól, ale to żądanie wysyła tylko pole title
, ponieważ tylko ono zostało zmienione:
PATCH https://www.googleapis.com/demo/v1/324 Authorization: Bearer your_auth_token Content-Type: application/json { "title": "New title" }
Odpowiedź:
200 OK
{ "title": "New title", "comment": "First comment.", "characteristics": { "length": "short", "accuracy": "high", "followers": ["Jo", "Will"], }, "status": "active", ... }
Serwer zwraca kod stanu 200 OK
i pełną reprezentację zaktualizowanego zasobu. Żądanie poprawki dotyczy tylko pola title
, dlatego jest to jedyna wartość inna niż we wcześniejszym przykładzie.
Uwaga: jeśli używasz parametru fields
odpowiedzi częściowej w połączeniu z poprawką, możesz jeszcze bardziej zwiększyć wydajność żądań aktualizacji. Żądanie poprawki zmniejsza tylko rozmiar żądania. Odpowiedź częściowa zmniejsza rozmiar tej odpowiedzi. Aby zmniejszyć ilość danych wysyłanych w obie strony, użyj żądania poprawki z parametrem fields
.
Znaczenie żądania poprawki
Treść żądania poprawki zawiera tylko pola zasobów, które chcesz zmodyfikować. Gdy podajesz pole, musisz uwzględnić wszystkie obiekty nadrzędne, tak jak obiekty nadrzędne zwracane w odpowiedzi częściowej. Zmodyfikowane dane, które wysyłasz, są scalane z danymi obiektu nadrzędnego (jeśli taki istnieje).
- Dodawanie: aby dodać nowe pole, podaj jego nazwę i wartość.
- Zmiana: aby zmienić wartość dotychczasowego pola, podaj jego nazwę i ustaw je na nową wartość.
- Usuwanie: aby usunąć pole, podaj je i ustaw na
null
. Na przykład:"comment": null
. Możesz też usunąć cały obiekt (jeśli jest zmienny), ustawiając go nanull
. Jeśli używasz biblioteki klienta interfejsu Java API, użyjData.NULL_STRING
. Szczegóły znajdziesz na stronie dotyczącej pustej wartości JSON.
Uwaga o tablicach: żądania poprawki z tablicami zastępują dotychczasową tablicę tą podaną przez Ciebie. Nie możesz zmieniać, dodawać ani usuwać elementów tablicy stopniowo.
Używanie poprawki w cyklu odczytu, modyfikacji i zapisu
Warto najpierw pobrać odpowiedź częściową z danymi, które chcesz zmodyfikować. Jest to szczególnie ważne w przypadku zasobów używających znaczników ETag, ponieważ musisz podać bieżącą wartość ETag w nagłówku HTTP If-Match
, aby zaktualizować zasób. Po pobraniu danych możesz zmienić wartości, które chcesz zmienić, i odesłać zmodyfikowaną częściową reprezentację z żądaniem poprawki. Oto przykład, w którym założono, że zasób Demo używa znaczników ETag:
GET https://www.googleapis.com/demo/v1/324?fields=etag,title,comment,characteristics Authorization: Bearer your_auth_token
To jest odpowiedź częściowa:
200 OK
{ "etag": "ETagString" "title": "New title" "comment": "First comment.", "characteristics": { "length": "short", "level": "5", "followers": ["Jo", "Will"], } }
Żądanie poprawki opisane poniżej jest oparte na tej odpowiedzi. Jak pokazano poniżej, użyliśmy też parametru fields
, aby ograniczyć ilość danych zwracanych w odpowiedzi poprawki:
PATCH https://www.googleapis.com/demo/v1/324?fields=etag,title,comment,characteristics Authorization: Bearer your_auth_token Content-Type: application/json If-Match: "ETagString"
{ "etag": "ETagString" "title": "", /* Clear the value of the title by setting it to the empty string. */ "comment": null, /* Delete the comment by replacing its value with null. */ "characteristics": { "length": "short", "level": "10", /* Modify the level value. */ "followers": ["Jo", "Liz"], /* Replace the followers array to delete Will and add Liz. */ "accuracy": "high" /* Add a new characteristic. */ }, }
Serwer w odpowiedzi wysyła kod stanu HTTP 200 OK i częściową reprezentację zaktualizowanego zasobu:
200 OK
{ "etag": "newETagString" "title": "", /* Title is cleared; deleted comment field is missing. */ "characteristics": { "length": "short", "level": "10", /* Value is updated.*/ "followers": ["Jo" "Liz"], /* New follower Liz is present; deleted Will is missing. */ "accuracy": "high" /* New characteristic is present. */ } }
Bezpośrednie tworzenie żądania poprawki
W przypadku niektórych żądań poprawki musisz oprzeć je na pobranych wcześniej danych. Jeśli na przykład chcesz dodać element do tablicy bez utraty żadnego z istniejących elementów tablicy, musisz najpierw pobrać istniejące dane. Podobnie jeśli interfejs API używa znaczników ETag, razem z żądaniem musisz wysłać poprzednią wartość ETag, aby zaktualizować zasób.
Uwaga: aby wymusić zastosowanie poprawki, gdy są używane tagi ETag, możesz użyć nagłówka HTTP "If-Match: *"
. W takim przypadku nie musisz wykonywać odczytu przed zapisem.
Jednak w innych przypadkach możesz utworzyć żądanie poprawki bezpośrednio, bez wcześniejszego pobierania istniejących danych. Możesz na przykład łatwo skonfigurować żądanie poprawki, które aktualizuje pole do nowej wartości lub dodaje nowe pole. Oto przykład:
PATCH https://www.googleapis.com/demo/v1/324?fields=comment,characteristics Authorization: Bearer your_auth_token Content-Type: application/json { "comment": "A new comment", "characteristics": { "volume": "loud", "accuracy": null } }
Jeśli pole komentarza ma już jakąś wartość, zastąpi ją nowa wartość. W przeciwnym razie zostanie w nim ustawiona nowa wartość. Jeśli natomiast ma już jakąś cechę woluminu, jej wartość zostanie zastąpiona. W przeciwnym razie zostanie ona utworzona. Pole dokładności zostanie usunięte (jeśli jest ustawione).
Obsługa odpowiedzi na poprawkę
Po przetworzeniu prawidłowego żądania poprawki interfejs API zwraca kod odpowiedzi HTTP 200 OK
i pełną reprezentację zmienionego zasobu. Jeśli interfejs API używa znaczników ETag, serwer aktualizuje wartości ETag po przetworzeniu żądania poprawki, tak jak w przypadku PUT
.
Żądanie poprawki zwraca reprezentację całego zasobu, chyba że używasz parametru fields
, aby zmniejszyć ilość zwracanych danych.
Jeśli żądanie poprawki powoduje ustawienie nowego stanu zasobu, który jest składniowo lub semantycznie nieprawidłowy, serwer zwraca kod stanu HTTP 400 Bad Request
lub 422 Unprocessable Entity
, a stan zasobu pozostaje bez zmian. Jeśli na przykład spróbujesz usunąć wartość pola wymaganego, serwer zwróci błąd.
Alternatywny zapis, gdy czasownik HTTP PATCH nie jest obsługiwany
Jeśli zapora sieciowa nie zezwala na żądania HTTP PATCH
, wykonaj żądanie HTTP POST
i ustaw nagłówek zastąpienia na PATCH
, jak pokazano poniżej:
POST https://www.googleapis.com/... X-HTTP-Method-Override: PATCH ...
Różnica między poprawką a aktualizacją
Gdy wysyłasz dane żądania aktualizacji, które używa czasownika HTTP PUT
, musisz wysłać tylko te pola, które są wymagane lub opcjonalne. Jeśli wyślesz wartości pól ustawionych przez serwer, zostaną one zignorowane. Może się to wydawać inny sposób przeprowadzenia częściowej aktualizacji, ale ma pewne ograniczenia. W przypadku aktualizacji, które używają czasownika HTTP PUT
, żądanie nie powiedzie się, jeśli nie podasz wymaganych parametrów, oraz czyści ustawione wcześniej dane, jeśli nie podasz parametrów opcjonalnych.
Z tego powodu dużo bezpieczniejsze jest użycie poprawki. Podajesz tylko dane pól, które chcesz zmienić. Pominięte pola nie są opróżniane. Jedynym wyjątkiem od tej reguły są powtarzające się elementy lub tablice. Jeśli pominiesz je wszystkie, pozostaną niezmienione. Jeśli podasz którykolwiek z nich, cały zbiór zostanie zastąpiony przez Ciebie.
Żądania zbiorcze
W tym dokumencie opisujemy, jak grupować wywołania interfejsu API, by zmniejszyć liczbę połączeń HTTP, które musi nawiązać klient.
Ten dokument dotyczy tworzenia żądań zbiorczych przez wysyłanie żądań HTTP. Jeśli zamiast tego używasz biblioteki klienta Google do wysyłania żądania zbiorczego, zapoznaj się z dokumentacją biblioteki klienta.
Opis
Każde połączenie HTTP tworzone przez klienta wiąże się z określonym obciążeniem. Interfejs Google Drive API obsługuje grupowanie, dzięki czemu klient może umieścić kilka wywołań interfejsu API w jednym żądaniu HTTP.
Przykłady sytuacji, w których warto użyć grupowania:
- Pobieranie metadanych dla dużej liczby plików.
- Zbiorcza aktualizacja metadanych lub właściwości.
- zmienianie uprawnień dla dużej liczby plików, na przykład dodanie nowego użytkownika lub grupy;
- Synchronizowanie lokalnych danych klienta po raz pierwszy lub po dłuższym czasie działania w trybie offline.
W każdym przypadku zamiast wysyłać każde wywołanie osobno, możesz je zgrupować w jedno żądanie HTTP. Wszystkie żądania wewnętrzne muszą trafiać do tego samego interfejsu API Google.
Jedno żądanie zbiorcze może zawierać maksymalnie 100 wywołań. Jeśli musisz wykonać więcej wywołań, użyj wielu żądań zbiorczych.
Uwaga: system wsadowy dla interfejsu Google Drive API używa tej samej składni co system wsadowego przetwarzania wsadowego OData, ale jego semantyka.
Uwaga: żądania zbiorcze zawierające ponad 100 wywołań mogą spowodować błędy.
Uwaga: długość adresu URL w każdym żądaniu wewnętrznym jest ograniczona do 8000 znaków.
Uwaga: obecnie Dysk Google nie obsługuje operacji zbiorczych plików multimedialnych na potrzeby przesyłania ani pobierania.
Szczegóły wsadu
Żądanie zbiorcze składa się z wielu wywołań interfejsu API połączonych w 1 żądanie HTTP, które można przesłać na adres batchPath
podany w dokumencie opisującym interfejs API. Domyślna ścieżka to /batch/api_name/api_version
. W tej sekcji szczegółowo opisujemy składnię wsadu. Później znajdziesz przykład.
Uwaga: zbiór żądań n zgrupowanych razem wlicza się do limitu wykorzystania jako żądania n, a nie jako jedno żądanie. Przed przetworzeniem żądanie zbiorcze jest dzielone na zbiór żądań.
Format żądania zbiorczego
Żądanie zbiorcze to pojedyncze standardowe żądanie HTTP, które zawiera wiele wywołań interfejsu API Dysku Google korzystających z typu treści multipart/mixed
. Każda część głównego żądania HTTP zawiera zagnieżdżone żądanie HTTP.
Każda część zaczyna się od własnego nagłówka HTTP Content-Type: application/http
. Może też mieć opcjonalny nagłówek Content-ID
. Nagłówki części mają jednak służyć tylko do zaznaczania początku części. Są one niezależne od zagnieżdżonego żądania. Po rozpakowaniu żądania zbiorczego przez serwer do osobnych żądań nagłówki części są ignorowane.
Treść każdej części to kompletne żądanie HTTP z własnym czasownikiem, adresem URL, nagłówkami i treścią. Żądanie HTTP może zawierać tylko część ścieżki adresu URL. W żądaniach zbiorczych nie można używać pełnych adresów URL.
Nagłówki HTTP zewnętrznego żądania wsadowego, z wyjątkiem nagłówków Content-
, takich jak Content-Type
, mają zastosowanie do każdego żądania w grupie. Jeśli określisz nagłówek HTTP zarówno w żądaniu zewnętrznym, jak i w pojedynczym wywołaniu, wartość poszczególnych nagłówków zastąpi wartość nagłówka zewnętrznego żądania zbiorczego. Nagłówki pojedynczego wywołania mają zastosowanie tylko do tego wywołania.
Jeśli na przykład dla określonego wywołania podasz nagłówek Autoryzacja, będzie on stosowany tylko do tego wywołania. Jeśli podasz nagłówek autoryzacji dla żądania zewnętrznego, będzie on stosowany do wszystkich poszczególnych wywołań, chyba że zastąpi je własnymi nagłówkami autoryzacji.
Po otrzymaniu żądania zbiorczego serwer stosuje do każdej części parametry zapytania i nagłówki żądania zewnętrznego (stosownie do sytuacji), a następnie traktuje każdą część tak, jakby było to osobne żądanie HTTP.
Odpowiedź na żądanie zbiorcze
Odpowiedź serwera jest pojedynczą standardową odpowiedzią HTTP z typem treści multipart/mixed
. Każda część to odpowiedź na jedno z żądań zbiorczych, w tej samej kolejności co żądania.
Podobnie jak części żądania, każda część odpowiedzi zawiera pełną odpowiedź HTTP wraz z kodem stanu, nagłówkami i treścią. Podobnie jak części żądania, każda odpowiedź jest poprzedzona nagłówkiem Content-Type
oznaczającym początek części.
Jeśli dana część żądania miała nagłówek Content-ID
, odpowiadająca jej część ma pasujący nagłówek Content-ID
z pierwotną wartością poprzedzoną ciągiem response-
, jak w poniższym przykładzie.
Uwaga: serwer może wykonywać wywołania w dowolnej kolejności. Nie licz na ich wykonanie w takiej kolejności, w jakiej zostały przez Ciebie określone. Jeśli chcesz mieć pewność, że w danej kolejności wystąpią 2 wywołania, nie możesz wysłać ich w jednym żądaniu. Zamiast tego wyślij pierwsze z nich osobno, a następnie poczekaj na odpowiedź na pierwsze, zanim wyślesz drugie.
Przykład
Przykład poniżej pokazuje wykorzystanie grupowania za pomocą interfejsu Google Drive API.
Przykładowe żądanie zbiorcze
POST https://www.googleapis.com/batch/drive/v3 Accept-Encoding: gzip User-Agent: Google-HTTP-Java-Client/1.20.0 (gzip) Content-Type: multipart/mixed; boundary=END_OF_PART Content-Length: 963--END_OF_PART Content-Length: 337 Content-Type: application/http content-id: 1 content-transfer-encoding: binary
POST https://www.googleapis.com/drive/v3/files/fileId/permissions?fields=id Authorization: Bearer authorization_token Content-Length: 70 Content-Type: application/json; charset=UTF-8
{ "emailAddress":"example@appsrocks.com", "role":"writer", "type":"user" } --END_OF_PART Content-Length: 353 Content-Type: application/http content-id: 2 content-transfer-encoding: binary
POST https://www.googleapis.com/drive/v3/files/fileId/permissions?fields=id&sendNotificationEmail=false Authorization: Bearer authorization_token Content-Length: 58 Content-Type: application/json; charset=UTF-8
{ "domain":"appsrocks.com", "role":"reader", "type":"domain" } --END_OF_PART--
Przykładowa odpowiedź zbiorcza
To jest odpowiedź na przykładowe żądanie z poprzedniej sekcji.
HTTP/1.1 200 OK Alt-Svc: quic=":443"; p="1"; ma=604800 Server: GSE Alternate-Protocol: 443:quic,p=1 X-Frame-Options: SAMEORIGIN Content-Encoding: gzip X-XSS-Protection: 1; mode=block Content-Type: multipart/mixed; boundary=batch_6VIxXCQbJoQ_AATxy_GgFUk Transfer-Encoding: chunked X-Content-Type-Options: nosniff Date: Fri, 13 Nov 2015 19:28:59 GMT Cache-Control: private, max-age=0 Vary: X-Origin Vary: Origin Expires: Fri, 13 Nov 2015 19:28:59 GMT--batch_6VIxXCQbJoQ_AATxy_GgFUk Content-Type: application/http Content-ID: response-1
HTTP/1.1 200 OK Content-Type: application/json; charset=UTF-8 Date: Fri, 13 Nov 2015 19:28:59 GMT Expires: Fri, 13 Nov 2015 19:28:59 GMT Cache-Control: private, max-age=0 Content-Length: 35
{ "id": "12218244892818058021i" }
--batch_6VIxXCQbJoQ_AATxy_GgFUk Content-Type: application/http Content-ID: response-2
HTTP/1.1 200 OK Content-Type: application/json; charset=UTF-8 Date: Fri, 13 Nov 2015 19:28:59 GMT Expires: Fri, 13 Nov 2015 19:28:59 GMT Cache-Control: private, max-age=0 Content-Length: 35
{ "id": "04109509152946699072k" }
--batch_6VIxXCQbJoQ_AATxy_GgFUk--
Zwracanie określonych pól z żądania
Domyślnie serwer odsyła domyślny zestaw pól zasobów specyficznych dla używanej metody. Na przykład metoda files.list
może zwracać tylko wartości id
, name
i mimeType
. Nie muszą to być pola, których potrzebujesz. Jeśli musisz zwrócić inne pola, zapoznaj się z sekcją Zwracanie określonych pól w pliku.