Ten dokument zawiera szczegółową dokumentację referencyjną protokołu RAW (XML i HTTP) interfejsu Google Sites Data API.
Ten dokument nie zawiera informacji o bibliotekach klienta w językach programowania. Informacje referencyjne o bibliotekach klienta znajdziesz w sekcjach przewodnika programisty poświęconych konkretnym językom programowania.
Odbiorcy
Ten dokument jest przeznaczony dla programistów, którzy chcą pisać aplikacje klienckie, które mogą wchodzić w interakcje z Witrynami Google.
Jest to dokument referencyjny. Zakłada się w nim, że rozumiesz koncepcje przedstawione w przewodniku po protokole oraz ogólne założenia protokołu interfejsów API danych Google.
Typy plików danych Witryn Google
Interfejs Google Sites Data API udostępnia te typy plików danych:
Karta aktywności
Plik danych o aktywności to plik danych zawierający opisy wszystkich działań w witrynie.
GETIdentyfikator URI witryny w określonej domenie w tym pliku danych to:
https://sites.google.com/feeds/activity/domainName/siteName/[activityEntryID]
domainName to „site” lub domena G Suite.
siteName to nazwa witryny, która pojawia się w adresie URL strony docelowej witryny: http://sites.google.com/a/domainName/siteName/.
Wszystkie żądania dotyczące tego pliku danych muszą być uwierzytelnione.
Obsługiwane typy żądań: GET
Źródło treści
Źródło treści to źródło zawierające bieżącą zawartość witryny, którą można edytować.
GETIdentyfikator URI witryny w określonej domenie w tym pliku danych to:
https://sites.google.com/feeds/content/domainName/siteName/[contentEntryID]
domainName to „site” lub domena G Suite.
siteName to nazwa witryny, która pojawia się w adresie URL strony docelowej witryny: http://sites.google.com/a/siteName/siteName.domainName
Żądania wysyłane do tego pliku danych mogą wymagać uwierzytelniania lub nie, w zależności od (opublikowanych) ustawień witryny.
Obsługiwane typy żądań: GET, POST, PUT, DELETE
Oprócz standardowych parametrów zapytania interfejsu Data API interfejs Sites Data API umożliwia używanie tych opcjonalnych parametrów podczas wysyłania żądania GET za pomocą źródła treści:
| Parametr | Opis | Typ | Uwagi |
|---|---|---|---|
ancestor |
Żąda tylko wpisów, które mają określonego przodka. | ciąg znaków | Podaj identyfikator elementu nadrzędnego. 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 uwzględniać usunięte wpisy. | Wartość logiczna | Możliwe wartości to true lub false. Wartość domyślna to false. |
include-draft |
Określa, czy uwzględniać 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 typy wpisów treści, które mają być zwracane. Są one zgodne z typem strony w Witrynach Google. | lista ciągów znaków rozdzielonych przecinkami | 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. Przykład: 0123456789. |
path |
Żądania treści w ramach określonej hierarchii stron | ciąg znaków | Ścieżka do podstrony w witrynie, z której mają być pobierane treści. Przykład: path=/path/to/page. |
Plik danych z wersjami
Plik danych z wersjami to plik danych zawierający historyczne wersje treści witryny.
GET Identyfikator URI pliku danych witryny w określonej domenie to:
https://sites.google.com/feeds/revision/domainName/siteName/contentEntryID/[revisionEntryID]
domainName to „site” lub domena G Suite.
siteName to nazwa witryny, która pojawia się w adresie URL strony docelowej witryny: http://sites.google.com/a/siteName/siteName.domainName
Wszystkie żądania dotyczące tego pliku danych muszą być uwierzytelnione.
Obsługiwane typy żądań: GET
Kanał witryny
Plik danych o witrynach może służyć do wyświetlania listy witryn Google, których użytkownik jest właścicielem lub do których ma uprawnienia do wyświetlania. Możesz też używać go do tworzenia nowych witryn, kopiowania witryn lub modyfikowania nazwy istniejącej witryny.
Identyfikator URI pliku danych dla informacji o witrynie to:
https://sites.google.com/feeds/site/domainName/[siteName]
domainName to „site” lub domena G Suite.
Wszystkie żądania dotyczące tego pliku danych muszą być uwierzytelnione.
Obsługiwane typy żądań: GET, POST, PUT
Podczas wysyłania GETżądania dotyczącego witryn z informacjami plik danych o witrynach obsługuje te (opcjonalne) parametry:
| Parametr | Opis | Typ | Uwagi |
|---|---|---|---|
include-all-sites |
Wyświetl listę wszystkich witryn, które użytkownik może wyświetlić w domenie G Suite. | Wartość logiczna | Ten parametr ma zastosowanie 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 |
Zawiera 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
Plik danych ACL może służyć do wyświetlania lub modyfikowania uprawnień do udostępniania (list kontroli dostępu) witryny Google.
Identyfikator URI pliku danych dla informacji o witrynie to:
https://sites.google.com/feeds/acl/site/domainName/siteName/[aclEntryID]
domainName to „site” lub domena G Suite.
Wszystkie żądania dotyczące tego pliku danych muszą być uwierzytelnione.
Obsługiwane typy żądań: GET, POST, PUT, DELETE
Omówienie parametrów zapytania 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(zapytania pełnotekstowe)
Listę parametrów specyficznych dla danego pliku danych znajdziesz w każdym z plików danych powyżej.