Ten dokument zawiera szczegółową dokumentację referencyjną protokołu nieprzetworzonego (XML i HTTP) interfejsu Google Sites Data API.
Ten dokument nie zawiera informacji o bibliotekach klienta języka programowania. Informacje referencyjne dotyczące biblioteki klienta znajdziesz w linkach w sekcji dotyczącej języka programowania w przewodniku dla deweloperów.
Odbiorcy
Ten dokument jest przeznaczony dla programistów, którzy chcą pisać aplikacje klienckie obsługujące Witryny Google.
Jest to dokument referencyjny, który zakłada, że znasz pojęcia opisane w przewodniku po protokole oraz ogólne założenia protokołu interfejsów Google Data API.
Typy kanałów Witryn Google
Interfejs API danych Witryn Google udostępnia następujące typy kanałów:
Karta aktywności
Plik danych o aktywności to plik danych zawierający opisy wszystkich aktywności na stronie.
Identyfikator URI GET tego pliku danych dla witryny w danej domenie to:
https://sites.google.com/feeds/activity/domainName/siteName/[activityEntryID]
domainName to albo „witryna”, albo domena G Suite.
siteName to nazwa witryny w postaci wyświetlanej w adresie URL strony docelowej witryny: http://sites.google.com/a/domainName/siteName/.
Wszystkie żądania wysyłane do tego kanału muszą być uwierzytelnione.
Obsługiwane typy żądań: GET
Źródło treści
Jest to kanał zawierający bieżącą, edytowalną treść witryny.
Identyfikator URI GET tego kanału dla witryny w konkretnej domenie to:
https://sites.google.com/feeds/content/domainName/siteName/[contentEntryID]
domainName to „witryna” lub domena G Suite.
siteName to nazwa witryny widoczna w adresie URL strony docelowej: http://sites.google.com/a/domainName/siteName.
Żądania dotyczące tego pliku danych mogą wymagać uwierzytelniania lub nie, w zależności od ustawień witryny (opublikowanych).
Obsługiwane typy żądań: GET, POST, PUT, DELETE
Oprócz standardowych parametrów zapytania do interfejsu Data API interfejs Sites Data API zezwala na wysyłanie żądań GET za pomocą tych opcjonalnych parametrów za pomocą pliku danych o treści:
| Parametr | Opis | Typ | Uwagi |
|---|---|---|---|
ancestor |
Wymaga tylko wpisów, które mają określonego przodka. | ciąg znaków | Podaj identyfikator odpowiedniego wpisu przodka. Na przykład: 0123456789. Zwraca wszystkie wpisy, które mają określony przodek jako nadrzędny, nadrzędny nadrzędnego itd. |
include-deleted |
Określa, czy mają być uwzględniane usunięte wpisy. | wartość logiczna | Możliwe wartości to true lub false. Wartość domyślna to false. |
include-draft |
Określa, czy uwzględnić wpisy w wersji roboczej. | wartość logiczna | Możliwe wartości to true lub false. Wartość domyślna to false. Aby wyświetlić wersję roboczą, musisz być jej właścicielem lub autorem. |
kind |
Określa rodzaje wpisów treści, które mają być zwracane. Odnoszą się one do typu strony w Witrynach Google. | rozdzielana przecinkami lista ciągów znaków | Możliwe wartości to announcement, announcementspage, attachment, comment, filecabinet, listitem, listpage, webpage, webattachment, template. |
parent |
Wymaga tylko wpisów, które mają określony element nadrzędny. | ciąg znaków | Podaj identyfikator wpisu nadrzędnego. Na przykład: 0123456789. |
path |
Żądania dotyczące treści w ramach określonej hierarchii stron | ciąg znaków | Ścieżka do podstrony w witrynie, z której pobierane są treści. Na przykład: path=/path/to/page. |
Plik danych z wersjami
Plik danych o wersjach to kanał zawierający historyczne wersje treści witryny.
Identyfikator URI GET tego kanału dla witryny w konkretnej domenie to:
https://sites.google.com/feeds/revision/domainName/siteName/contentEntryID/[revisionEntryID]
domainName to „witryna” lub domena G Suite.
siteName to nazwa witryny w postaci wyświetlanej w adresie URL strony docelowej witryny: http://sites.google.com/a/domainName/siteName.
Wszystkie żądania wysyłane do tego kanału muszą być uwierzytelnione.
Obsługiwane typy żądań: GET
Plik danych witryny
Plik danych o witrynach może zawierać listę witryn Google Sites, których użytkownik jest właścicielem lub do których ma uprawnienia do wyświetlania. Możesz też używać tego narzędzia do tworzenia nowych witryn, kopiowania witryny lub modyfikowania nazwy istniejącej witryny.
Identyfikator URI kanału dla wykazu witryn to:
https://sites.google.com/feeds/site/domainName/[siteName]
domainName to „witryna” lub domena G Suite.
Wszystkie żądania dotyczące tego pliku danych muszą być uwierzytelniane.
Obsługiwane typy żądań: GET, POST, PUT
Plik danych o witrynach obsługuje te (opcjonalne) parametry podczas wysyłania żądania GET dotyczącego witryn z ofertą:
| Parametr | Opis | Typ | Uwagi |
|---|---|---|---|
include-all-sites |
Lista wszystkich witryn, które użytkownik może przynajmniej wyświetlać w domenie G Suite. | wartość logiczna | Ten parametr jest odpowiedni tylko w przypadku wyświetlania witryn w domenie G Suite. Możliwe wartości to true lub false. Wartość domyślna to false. |
with-mappings |
Obejmuje mapowania adresów internetowych w pliku z informacjami o witrynie. | wartość logiczna | Możliwe wartości to true lub false. Wartość domyślna to false. |
Plik danych ACL
Plik danych z listą kontroli dostępu można używać do wyświetlania i modyfikowania uprawnień do udostępniania (ACL) witryny Google Site.
Identyfikator URI kanału dla wykazu witryn to:
https://sites.google.com/feeds/acl/site/domainName/siteName/[aclEntryID]
domainName to „witryna” lub domena G Suite.
Wszystkie żądania dotyczące tego pliku danych muszą być uwierzytelniane.
Obsługiwane typy żądań: GET, POST, PUT, DELETE
Informacje o parametrach zapytań Witryn Google
Obsługiwane parametry zapytania z protokołu Google Data API:
max-resultspublished-max(tylko źródło treści)published-min(tylko plik danych o treściach)start-indexupdated-maxupdated-minq(zapytania pełnotekstowe)
Aby poznać listę parametrów związanych z danym plikiem danych, zapoznaj się z poszczególnymi plikami danych.