Ten dokument zawiera szczegółową dokumentację dotyczącą nieprzetworzonego protokołu (XML i HTTP) interfejsu API Witryn Google.
Ten dokument nie zawiera informacji o bibliotekach klienta służących do programowania. Więcej informacji o bibliotece klienta znajdziesz w linkach w sekcji poświęconej językowi programowania w przewodniku dla programistów.
Odbiorcy
Ten dokument jest przeznaczony dla programistów, którzy chcą tworzyć aplikacje klienckie obsługujące interakcje z Witrynami Google.
Jest to dokument referencyjny. Zakładamy, że rozumiesz zagadnienia przedstawione w przewodniku po protokołach i ogólne zagadnienia związane z protokołem interfejsów API danych Google.
Typy plików danych Witryn Google
Interfejs API danych Witryn Google udostępnia następujące typy plików danych:
Strumień aktywności
Kanał aktywności to kanał zawierający opisy wszystkich działań w witrynie.
Ten identyfikator URI kanału GET dla witryny w określonej domenie to:
https://sites.google.com/feeds/activity/domainName/siteName/[activityEntryID]
domainName to domena "site" lub domena G Suite.
siteName to nazwa witryny wyświetlana w adresie URL strony docelowej: http://sites.google.com/a/domainName/siteName/.
Wszystkie żądania wysyłane do tego pliku danych muszą być uwierzytelnione.
Obsługiwane typy żądań: GET
Źródło treści
Plik danych to kanał zawierający bieżącą, możliwą do edytowania treść witryny.
Ten identyfikator URI kanału GET dla witryny w określonej domenie to:
https://sites.google.com/feeds/content/domainName/siteName/[contentEntryID]
domainName to domena "site" lub domena G Suite.
siteName to nazwa witryny wyświetlana w adresie URL strony docelowej: http://sites.google.com/a/domainName/siteName.
Żądania do tego kanału mogą, ale nie muszą, być uwierzytelnione w zależności od ustawień witryny (opublikowanej).
Obsługiwane typy żądań: GET, POST, PUT, DELETE
Oprócz standardowych parametrów zapytania dotyczącego interfejsu Data API interfejs API danych witryn umożliwia stosowanie tych opcjonalnych parametrów wykonujących żądanie GET za pomocą pliku z treścią:
| Parametr | Opis | Typ | Uwagi |
|---|---|---|---|
ancestor |
Służy do przesyłania tylko wpisów, które mają określony element nadrzędny. | tekst | Podaj identyfikator odpowiedniego 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 i tak dalej. |
include-deleted |
Określa, czy chcesz uwzględnić usunięte wpisy. | wartość logiczna | Możliwe wartości: true lub false. Wartość domyślna to false. |
include-draft |
Określa, czy chcesz uwzględnić wersje robocze wpisów. | wartość logiczna | Możliwe wartości: true lub false. Wartość domyślna to false. Aby wyświetlić wersję roboczą, musisz być jej właścicielem lub autorem. |
kind |
Określa rodzaj wpisów treści do zwrócenia. Są one zgodne z typem strony w Witrynach Google. | rozdzielona przecinkami lista ciągów tekstowych | Możliwe wartości: announcement, announcementspage, attachment, comment, filecabinet, listitem, listpage, webpage, webattachment, template. |
parent |
Służy tylko do zgłaszania wpisów, które mają określony element nadrzędny. | tekst | Podaj identyfikator wpisu nadrzędnego. Na przykład: 0123456789. |
path |
Żąda treści w określonej hierarchii strony | tekst | Ścieżka do podstrony w witrynie, na którą mają zostać pobrane treści. Na przykład: path=/path/to/page. |
Plik danych wersji
Kanał wersji to kanał zawierający historyczne wersje treści witryny.
Ten identyfikator URI kanału GET dla witryny w określonej domenie to:
https://sites.google.com/feeds/revision/domainName/siteName/contentEntryID/[revisionEntryID]
domainName to domena "site" lub domena G Suite.
siteName to nazwa witryny wyświetlana w adresie URL strony docelowej: http://sites.google.com/a/domainName/siteName.
Wszystkie żądania wysyłane do tego pliku danych muszą być uwierzytelnione.
Obsługiwane typy żądań: GET
Kanał witryny
Kanał witryny może służyć do wyświetlania listy Witryn Google, których właścicielem jest użytkownik lub które ma uprawnienia do wyświetlania. Można jej również używać do tworzenia nowych witryn, kopiowania i modyfikowania nazw istniejących.
Identyfikator URI kanału informacji o witrynie to:
https://sites.google.com/feeds/site/domainName/[siteName]
domainName to domena "site" lub domena G Suite.
Wszystkie żądania wysyłane do tego pliku danych muszą być uwierzytelnione.
Obsługiwane typy żądań: GET, POST, PUT
Kanał witryny obsługuje te (opcjonalne) parametry podczas wysyłania żądania GET z listą witryn:
| Parametr | Opis | Typ | Uwagi |
|---|---|---|---|
include-all-sites |
Lista wszystkich witryn, które mogą być wyświetlane przez użytkownika w domenie G Suite. | wartość logiczna | Ten parametr ma zastosowanie tylko do wizytówek stron w domenie G Suite. Możliwe wartości: true lub false. Wartość domyślna to false. |
with-mappings |
Obejmuje mapowanie adresów internetowych we wpisie witryny. | wartość logiczna | Możliwe wartości: true lub false. Wartość domyślna to false. |
Plik danych ACL
Kanał ACL może służyć do wyświetlania lub modyfikowania uprawnień do udostępniania (list kontroli dostępu) w witrynie Google.
Identyfikator URI kanału informacji o witrynie to:
https://sites.google.com/feeds/acl/site/domainName/siteName/[aclEntryID]
domainName to domena "site" lub domena G Suite.
Wszystkie żądania wysyłane do tego pliku danych muszą być uwierzytelnione.
Obsługiwane typy żądań: GET, POST, PUT, DELETE
Informacje o parametrach zapytania Witryn 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)
Szczegóły dotyczące konkretnego parametru znajdziesz w sekcji Każdy plik danych powyżej.