Ten dokument zawiera szczegółową dokumentację referencyjną do protokołu RAW (XML i HTTP) dla interfejsu API danych Witryn Google.
Ten dokument nie zawiera informacji o bibliotekach klienta dla języka programowania. Informacje o bibliotece klienta znajdziesz, klikając linki w sekcjach podręcznika programisty poświęconych językowi programowania.
Odbiorcy
Ten dokument jest przeznaczony dla programistów, którzy chcą pisać aplikacje klienckie obsługujące Witryny Google.
To dokument referencyjny, Zakładamy, że znasz pojęcia przedstawione w przewodniku po protokołach i znasz ogólne zagadnienia dotyczące protokołu interfejsów API danych Google.
Typy kanałów Witryn Google
Interfejs API danych Witryn Google udostępnia następujące typy kanałów:
Karta aktywności
Kanał aktywności to kanał zawierający opisy wszystkich działań w witrynie.
Identyfikator URI GET tego kanału dla witryny w konkretnej domenie to:
https://sites.google.com/feeds/activity/domainName/siteName/[activityEntryID]
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
Ź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 w postaci wyświetlanej w adresie URL strony docelowej witryny: http://sites.google.com/a/domainName/siteName.
W zależności od ustawień (opublikowanej) witryny żądania wysyłane do tego kanału mogą wymagać uwierzytelnienia.
Obsługiwane typy żądań: GET, POST, PUT, DELETE
Oprócz standardowych parametrów zapytania w interfejsie Data API interfejs Sites Data API umożliwia stosowanie poniższych parametrów opcjonalnych:
wysyłanie żądania GET za pomocą źródła treści:
| Parametr | Opis | Typ | Uwagi |
|---|---|---|---|
ancestor |
Żąda tylko wpisów, które mają określonego elementu nadrzędnego. | ciąg znaków | Podaj identyfikator żądanego wpisu elementu nadrzędnego. Na przykład: 0123456789. Zwraca wszystkie wpisy, które mają określony element nadrzędny jako element nadrzędny, element nadrzędny elementu 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. Musisz być właścicielem lub autorem
wersji roboczej, aby ją wyświetlić. |
kind |
Określa rodzaj wpisów treści do zwrócenia. 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 |
Żąda 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 |
Żądanie treści w 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 wersji
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
Kanał witryny
Kanał witryn może służyć do tworzenia listy witryn Google należących do użytkownika lub do wyświetlania, do których ma uprawnienia do wyświetlania. Może być też służące do tworzenia nowych witryn, kopiowania witryn lub modyfikowania nazw istniejących.
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 wysyłane do tego kanału muszą być uwierzytelnione.
Obsługiwane typy żądań: GET, POST, PUT
W żądaniu GET listy witryn plik danych o witrynie obsługuje te (opcjonalne) parametry:
| Parametr | Opis | Typ | Uwagi |
|---|---|---|---|
include-all-sites |
Wymień wszystkie witryny, które może przynajmniej wyświetlić użytkownik w domenie G Suite. | wartość logiczna | Ten parametr ma zastosowanie tylko w przypadku wyświetlania listy witryn w domenie G Suite. Możliwe wartości to true
lub false. Wartość domyślna to false. |
with-mappings |
Uwzględnia mapowania adresów internetowych we wpisie witryny. | wartość logiczna | Możliwe wartości to true lub false. Wartość domyślna to false. |
Plik danych ACL
Kanału ACL można używać do tworzenia list i/lub modyfikacji uprawnień udostępniania (listy kontroli dostępu) witryny Google.
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 wysyłane do tego kanału muszą być uwierzytelnione.
Obsługiwane typy żądań: GET, POST, PUT, DELETE
Informacje o parametrach zapytań w Witrynach Google
Obsługiwane parametry zapytania z protokołu Google Data API:
max-resultspublished-max(tylko źródło treści)published-min(tylko źródło treści)start-indexupdated-maxupdated-minq(pełne zapytania tekstowe)
Lista parametrów charakterystycznych dla danego kanału znajduje się w każdym kanale powyżej.