REST Resource: accounts

Zasób: konto

Konto jest kontenerem dla Twojej lokalizacji. Jeśli jesteś jedynym użytkownikiem, który zarządza lokalizacjami Twojej firmy, możesz użyć osobistego konta Google. Aby umożliwić zarządzanie lokalizacjami wielu użytkownikom, utwórz konto firmowe.

Zapis JSON 
{
  "name": string,
  "accountName": string,
  "primaryOwner": string,
  "type": enum (AccountType),
  "role": enum (AccountRole),
  "verificationState": enum (VerificationState),
  "vettedState": enum (VettedState),
  "accountNumber": string,
  "permissionLevel": enum (PermissionLevel),
  "organizationInfo": {
    object (OrganizationInfo)
  }
}
Pola
name

string

Stały. Nazwa zasobu w formacie accounts/{account_id}.
accountName

string

Wymagane. Nazwa konta. W przypadku konta typu PERSONAL jest to imię i nazwisko konta użytkownika.
primaryOwner

string

Wymagane. Tylko dane wejściowe. Nazwa zasobu konta, które będzie głównym właścicielem tworzonego konta. Powinien mieć format accounts/{account_id}.
type

enum (AccountType)

Wymagane. Zawiera typ konta. Za pomocą tego interfejsu API nie można tworzyć kont typu PERSONAL i ORGANIZATION.
role

enum (AccountRole)

Tylko dane wyjściowe. Określa wartość AccountRole tego konta.
verificationState

enum (VerificationState)

Tylko dane wyjściowe. Jeśli lokalizacje zostaną zweryfikowane, będą automatycznie łączone z Mapami Google i będą tworzone strony Google+ bez konieczności moderacji.
vettedState

enum (VettedState)

Tylko dane wyjściowe. Wskazuje, czy konto zostało sprawdzone przez Google. Zweryfikowane konto może zweryfikować lokalizacje za pomocą metody VETTED_PARTNER.
accountNumber

string

Tylko dane wyjściowe. Numer referencyjny konta, jeśli został udostępniony.
permissionLevel

enum (PermissionLevel)

Tylko dane wyjściowe. Określa poziom uprawnień użytkownika na tym koncie.
organizationInfo

object (OrganizationInfo)

Tylko dane wyjściowe. Dodatkowe informacje o organizacji. To pole jest wypełniane tylko w przypadku konta organizacji.

AccountType

Wskazuje rodzaj tego konta: konto osobiste/użytkownik lub konto firmowe.

Wartości w polu enum
ACCOUNT_TYPE_UNSPECIFIED Nie określono.
PERSONAL Konto użytkownika.
LOCATION_GROUP Grupa lokalizacji. Więcej informacji znajdziesz w tym artykule w Centrum pomocy.
USER_GROUP Grupa użytkowników służąca do podziału pracowników organizacji na grupy. Więcej informacji znajdziesz w tym artykule w Centrum pomocy.
ORGANIZATION Organizacja reprezentująca firmę. Więcej informacji znajdziesz w tym artykule w Centrum pomocy.

AccountRole

Wskazuje poziom dostępu do tego konta, jaki ma uwierzytelniony użytkownik. Więcej informacji znajdziesz w tym artykule w Centrum pomocy.

Wartości w polu enum
ACCOUNT_ROLE_UNSPECIFIED Nie określono.
PRIMARY_OWNER Użytkownik jest głównym właścicielem tego konta.
OWNER Właściciel konta.
MANAGER Użytkownik może zarządzać tym kontem.
SITE_MANAGER Użytkownik może zarządzać ograniczonym zestawem funkcji na koncie.

VerificationState

Wskazuje stan weryfikacji konta.

Wartości w polu enum
VERIFICATION_STATE_UNSPECIFIED Nie określono.
VERIFIED Konto zweryfikowane.
UNVERIFIED Konto, które nie jest zweryfikowane, a prośba o weryfikację nie została wysłana.
VERIFICATION_REQUESTED Konto, które nie jest zweryfikowane, ale wysłano prośbę o weryfikację.

VettedState

Wskazuje zweryfikowany stan konta.

Wartości w polu enum
VETTED_STATE_UNSPECIFIED Nie określono
NOT_VETTED Konto nie jest sprawdzane przez Google.
VETTED Konto zostało sprawdzone przez Google i jest w prawidłowym stanie. Konto jest automatycznie weryfikowane, jeśli ma bezpośredni dostęp do zweryfikowanego konta grupy.
INVALID Konto zostało sprawdzone, ale jego stan jest nieprawidłowy. Konto będzie działać jak niesprawdzone.

PermissionLevel

Wskazuje poziom dostępu do tego konta, jaki ma uwierzytelniony użytkownik.

Wartości w polu enum
PERMISSION_LEVEL_UNSPECIFIED Nie określono.
OWNER_LEVEL Użytkownik ma uprawnienia na poziomie właściciela.
MEMBER_LEVEL Użytkownik ma uprawnienia na poziomie członkowskim.

OrganizationInfo

Dodatkowe informacje przechowywane na poziomie organizacji.

Zapis JSON 
{
  "registeredDomain": string,
  "address": {
    object (PostalAddress)
  },
  "phoneNumber": string
}
Pola
registeredDomain

string

Tylko dane wyjściowe. Zarejestrowana domena konta.
address

object (PostalAddress)

Tylko dane wyjściowe. Adres pocztowy powiązany z kontem.
phoneNumber

string

Tylko dane wyjściowe. Numer kontaktowy organizacji.

PostalAddress

Reprezentuje adres pocztowy, np. adresów dostawy lub płatności. Jeśli podasz adres pocztowy, firma pocztowa może dostarczyć przesyłki do placówki Twojej firmy. Box lub podobnego. Nie służy on do modelowania lokalizacji geograficznych (dróg, miast, gór).

W większości przypadków adres jest tworzony na podstawie danych wejściowych użytkownika lub importowanych istniejących danych, w zależności od typu procesu.

Porady dotyczące wpisywania / edytowania adresu: – skorzystaj z widżetu z adresem do internacjonalizacji, np. https://github.com/google/libaddressinput – nie należy wyświetlać użytkownikom elementów interfejsu do wprowadzania lub edytowania pól spoza krajów, w których takie pole jest używane.

Więcej wskazówek dotyczących korzystania z tego schematu znajdziesz na stronie https://support.google.com/business/answer/6397478

Zapis JSON 
{
  "revision": integer,
  "regionCode": string,
  "languageCode": string,
  "postalCode": string,
  "sortingCode": string,
  "administrativeArea": string,
  "locality": string,
  "sublocality": string,
  "addressLines": [
    string
  ],
  "recipients": [
    string
  ],
  "organization": string
}
Pola
revision

integer

Wersja schematu tabeli PostalAddress. Wartość ta musi wynosić 0, co jest najnowszą wersją.

Wszystkie nowe wersje muszą być zgodne wstecznie ze starymi.
regionCode

string

Wymagane. Kod regionu CLDR kraju lub regionu adresu. Nie są one nigdy wnioskowane i to użytkownik musi upewnić się, że wartość jest prawidłowa. Szczegółowe informacje można znaleźć na stronach https://cldr.unicode.org/ i https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html. Przykład: „CH”. dla Szwajcarii.
languageCode

string

Opcjonalnie: Kod języka BCP-47 treści adresu (jeśli jest znany). Często jest to język interfejsu formularza wejściowego lub prawdopodobnie jeden z języków używanych w adresie kraj/region lub ich transliterowane odpowiedniki. Może to wpłynąć na formatowanie w niektórych krajach, ale nie ma wpływu na prawidłowość danych i nigdy nie wpływa na weryfikację ani inne operacje związane z nieformatowaniem.

Jeśli ta wartość nie jest znana, należy ją pominąć (zamiast określać potencjalnie nieprawidłową wartość domyślną).

Przykłady: „zh-Hant”, „ja”, „ja-Latn”, „pl”.
postalCode

string

Opcjonalnie: Kod pocztowy adresu. Nie wszystkie kraje używają kodów pocztowych lub ich wymagają, ale tam, gdzie są używane, mogą powodować dodatkową weryfikację innych części adresu (np. stan lub kod pocztowy w Stanach Zjednoczonych).
sortingCode

string

Opcjonalnie: Dodatkowy kod sortowniczy specyficzny dla kraju. Nie jest on używany w większości regionów. Ta wartość jest ciągiem znaków takim jak „CEDEX”, po którym może występować liczba (np. „CEDEX 7”), lub samej liczby reprezentującej „kod sektora” (Jamajka), „wskaźnik obszaru dostawy” (Malawi) lub „wskaźnik urzędu pocztowego” (np. Wybrzeże Kości Słoniowej).
administrativeArea

string

Opcjonalnie: Najwyższy podział administracyjny stosowany w przypadku adresów pocztowych kraju lub regionu. Na przykład stan, prowincja, obwód lub prefektura. W przypadku Hiszpanii jest to prowincja, a nie wspólnota autonomiczna (np. „Barcelona”, nie „Katalonia”). Wiele krajów nie używa regionu w adresach pocztowych. Na przykład: w Szwajcarii pole musi być puste.
locality

string

Opcjonalnie: Zasadniczo odnosi się do części miejscowości lub miejscowości. Przykłady: USA, gmina IT, poczta polska. W regionach, w których miejscowości nie są dobrze zdefiniowane lub nie pasują do tej struktury, zostaw pole Rejon puste, a następnie użyj addressLines.
sublocality

string

Opcjonalnie: Okręg, w którym znajduje się adres. Na przykład mogą to być dzielnice, dystrykty, okręgi.
addressLines[]

string

Nieuporządkowane wiersze adresu opisujące dolne poziomy adresu.

Wartości w addressLine nie mają informacji o typie i czasami mogą zawierać wiele wartości w jednym polu (np. „Austin, TX”), ważne jest, aby kolejność wierszy była jasna. Kolejność wierszy adresu powinna być określona jako „kolejność danych koperty”. zgodnie z krajem/regionem adresu. Tam, gdzie może być to inne (np. w Japonii), słowo address_language jest używane do jednoznacznego określenia (np. „ja” dla sortowania w dużym i małym porządku oraz „ja-Latn” lub „en” dla małych i dużych). Dzięki temu można wybrać najbardziej precyzyjny wiersz adresu na podstawie języka.

Minimalna dozwolona reprezentacja strukturalna adresu składa się z kodu regionu RegionCode, a wszystkie pozostałe informacje są umieszczane w elemencie addressLines. Sformatowanie takiego adresu w przybliżeniu bez geokodowania byłoby możliwe, ale semantyczne rozumowanie nie byłoby możliwe w odniesieniu do żadnego ze składników adresu, dopóki nie zostanie przynajmniej częściowo rozpatrzone.

Zalecanym sposobem obsługi adresów całkowicie nieuporządkowanych
recipients[]

string

Opcjonalnie: Adresat pod adresem. W pewnych okolicznościach to pole może zawierać informacje obejmujące wiele wierszy. Może na przykład zawierać hasło „opieka” i informacjami o nich.
organization

string

Opcjonalnie: Nazwa organizacji pod adresem.

Metody

create

 Tworzy konto o określonej nazwie i typie pod podanym elementem nadrzędnym.

get

 Pobiera podane konto.

list

 Wyświetla listę wszystkich kont uwierzytelnionego użytkownika.

patch

 Aktualizuje podane konto firmowe.