Przewodnik informacyjny

Ten dokument zawiera szczegółową dokumentację dotyczącą surowego protokołu (XML i HTTP) interfejsu API danych Witryn Google.

Ten dokument nie zawiera informacji o bibliotekach klienta dla języka programowania. Więcej informacji o bibliotece klienta znajdziesz pod poniższymi linkami w sekcji podręcznika programisty poświęconych danym językom programowania.

Odbiorcy

Ten dokument jest przeznaczony dla programistów, którzy chcą tworzyć aplikacje klienckie umożliwiające współpracę z Witrynami Google.

Jest to dokument referencyjny. Zakładamy w nim, że rozumiesz pojęcia przedstawione w przewodniku po protokołach oraz ogólne założenia protokołu interfejsów API danych Google.

Typy kanałów w Witrynach Google

Interfejs API danych Witryn Google udostępnia następujące typy kanałów:

Karta aktywności

Kanał aktywności to miejsce, w którym znajdziesz opisy wszystkich aktywności w witrynie.

Identyfikator URI GET tego kanału dla witryny w określonej domenie to:

https://sites.google.com/feeds/activity/domainName/siteName/[activityEntryID]

domainName to „witryna” lub domena G Suite.

siteName to nazwa witryny wyświetlana w adresie URL jej strony docelowej: 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ą zawartość witryny.

Identyfikator URI GET tego kanału dla witryny w określonej domenie to:

https://sites.google.com/feeds/content/domainName/siteName/[contentEntryID]

domainName to „witryna” lub domena G Suite.

siteName to nazwa witryny wyświetlana w adresie URL jej strony docelowej: http://sites.google.com/a/domainName/siteName.

Żądania wysyłane do tego kanału mogą lub nie wymagać uwierzytelniania w zależności od ustawień witryny (opublikowanej).

Obsługiwane typy żądań: GET, POST, PUT, DELETE

Oprócz standardowych parametrów zapytania interfejsu Data API interfejs Sites Data API zezwala na wysyłanie żądań GET z użyciem tych opcjonalnych parametrów za pomocą pliku danych:

Parametr Opis Typ Uwagi
ancestor Żądanie dotyczy tylko wpisów, które mają określony element nadrzędny. ciąg znaków Podaj identyfikator żądanego wpisu elementu nadrzędnego. Na przykład: 0123456789. Zwraca wszystkie wpisy z określonym elementem nadrzędnym jako nadrzędnym, nadrzędnym itd.
include-deleted Określa, czy uwzględnić usunięte wpisy. boolean Możliwe wartości to true lub false. Wartość domyślna to false.
include-draft Określa, czy uwzględnić wersje robocze wpisów. boolean 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 z treścią do zwrócenia. Są one zgodne z typem strony w Witrynach Google. lista ciągów tekstowych oddzielonych przecinkami Możliwe wartości to announcement, announcementspage, attachment, comment, filecabinet, listitem, listpage, webpage, webattachment oraz template.
parent Żądanie dotyczy 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 podstrony w witrynie, dla której ma zostać pobrana treść. Na przykład: path=/path/to/page.

Plik danych wersji

Plik danych wersji to plik zawierający historyczne wersje treści witryny.

Identyfikator URI GET tego kanału dla witryny w określonej domenie to:

https://sites.google.com/feeds/revision/domainName/siteName/contentEntryID/[revisionEntryID]

domainName to „witryna” lub domena G Suite.

siteName to nazwa witryny wyświetlana w adresie URL jej strony docelowej: 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ł witryny może służyć do wyświetlania listy Witryn Google, które należą do użytkownika lub do których ma uprawnienia do wyświetlania. W usłudze tej można też utworzyć nowe witryny, skopiować witrynę lub zmienić nazwę istniejącej witryny.

Identyfikator URI kanału listy 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

Podczas wysyłania żądania GET dotyczącego wyświetlania listy witryn plik danych witryny obsługuje te (opcjonalne) parametry:

Parametr Opis Typ Uwagi
include-all-sites Lista wszystkich witryn, które mogą być co najmniej dostępne dla użytkownika w domenie G Suite. boolean Ten parametr ma zastosowanie tylko do listy 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 we wpisie witryny. boolean Możliwe wartości to true lub false. Wartość domyślna to false.

Plik danych listy kontroli dostępu

Za pomocą kanału listy kontroli dostępu można wyświetlać i/lub modyfikować uprawnienia do udostępniania (listy kontroli dostępu) witryny Google.

Identyfikator URI kanału listy 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

Odniesienie do parametrów zapytań w Witrynach Google

Obsługiwane parametry zapytania z protokołu Google Data API:

  • max-results
  • published-max (tylko źródło treści)
  • published-min (tylko źródło treści)
  • start-index
  • updated-max
  • updated-min
  • q (pełne zapytania tekstowe)

Listę parametrów charakterystycznych dla tego pliku znajdziesz powyżej w każdym pliku danych.

Powrót do góry