REST Resource: accounts

Zasób: Konto

Konto to kontener 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

Niezmienne. Nazwa zasobu w formacie accounts/{account_id}.
accountName

string

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

string

To pole jest 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)

To pole jest wymagane. Zawiera typ konta. Za pomocą tego interfejsu API nie można tworzyć kont typu PERSONAL i ORGANIZACJA.
role

enum (AccountRole)

Tylko dane wyjściowe. Określa AccountRole na tym koncie.
verificationState

enum (VerificationState)

Tylko dane wyjściowe. Jeśli lokalizacja zostanie potwierdzona, nowo utworzone lokalizacje będą automatycznie łączone z Mapami Google, a ich strony Google+ będą tworzone bez konieczności moderowania.
vettedState

enum (VettedState)

Tylko dane wyjściowe. Wskazuje, czy konto zostało zweryfikowane przez Google. Sprawdzone konto może weryfikować lokalizacje, korzystając z 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 do tego konta.
organizationInfo

object (OrganizationInfo)

Tylko dane wyjściowe. Dodatkowe informacje dla organizacji. Pole jest wypełniane tylko w przypadku konta organizacji.

AccountType

Wskazuje, jakiego rodzaju jest to konto: konto osobiste/użytkownika 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 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 artykule w Centrum pomocy
ORGANIZATION Organizacja reprezentująca firmę. Więcej informacji znajdziesz w artykule w Centrum pomocy

AccountRole

Wskazuje poziom dostępu uwierzytelnionego użytkownika do tego konta. Więcej informacji znajdziesz w 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 konta.

VerificationState

Wskazuje stan weryfikacji konta.

Wartości w polu enum
VERIFICATION_STATE_UNSPECIFIED Nie określono.
VERIFIED Konto zweryfikowane.
UNVERIFIED To konto nie zostało zweryfikowane i nie wysłano prośby o weryfikację.
VERIFICATION_REQUESTED Konto nie zostało zweryfikowane, ale zażądano weryfikacji.

VettedState

Wskazuje zweryfikowany stan konta.

Wartości w polu enum
VETTED_STATE_UNSPECIFIED Nie określono
NOT_VETTED Konto nie zostało zweryfikowane przez Google.
VETTED Konto zostało sprawdzone przez Google i ma prawidłowe stan. Jeśli konto ma bezpośredni dostęp do zweryfikowanego konta grupowego, jest ono automatycznie sprawdzane.
INVALID Konto zostało sprawdzone, ale ma nieprawidłowy stan. Konto będzie działać jak niezweryfikowane.

PermissionLevel

Wskazuje poziom dostępu uwierzytelnionego użytkownika do tego konta.

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 potrzeby 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 konta.
phoneNumber

string

Tylko dane wyjściowe. Numer kontaktowy organizacji.

PostalAddress

Reprezentuje adres pocztowy, na przykład adres dostawy lub płatności. Podany adres pocztowy pozwala na dostarczenie przesyłek do lokalu, skrytki pocztowej itp. Nie służy do modelowania lokalizacji geograficznych (dróg, miast, gór).

W typowym użyciu adres jest tworzony na podstawie danych wejściowych użytkownika lub importu istniejących danych, w zależności od typu procesu.

Wskazówki dotyczące wpisywania / edytowania adresu: – Używaj widżetu adresu gotowego do internacjonalizacji, np. https://github.com/google/libaddressinput). – Użytkownicy nie powinni widzieć elementów interfejsu do wprowadzania lub edytowania pól poza krajami, w których to pole jest używane.

Więcej wskazówek dotyczących korzystania z tego schematu znajdziesz na 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 elementu PostalAddress. Musi być ustawiona wartość 0, czyli najnowsza wersja.

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

string

To pole jest wymagane. Kod regionu CLDR kraju lub regionu adresu. Nigdy nie jest to wywnioskowane i to użytkownik decyduje o tym, czy wartość jest poprawna. Szczegółowe informacje znajdziesz na stronach https://cldr.unicode.org/ i https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html. Przykład: „CH” w przypadku Szwajcarii.
languageCode

string

Opcjonalnie. Kod języka BCP-47 treści tego adresu (jeśli jest znany). Jest to często język interfejsu formularza do wprowadzania danych lub powinien odpowiadać jednemu z języków używanych w kraju/regionie adresu lub ich transliteracji. Może to wpływać na formatowanie w niektórych krajach, ale nie jest niezbędne dla poprawności danych oraz nie ma wpływu na weryfikację ani inne operacje związane z formatowaniem.

Jeśli ta wartość jest nieznana, pomiń ją (zamiast określać potencjalnie nieprawidłową wartość domyślną).

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

string

Opcjonalnie. Kod pocztowy adresu. Nie we wszystkich krajach stosuje się kod pocztowy lub go nie wymaga, ale tam, gdzie są one używane, mogą wymagać dodatkowej weryfikacji w innych częściach adresu (np. w Stanach Zjednoczonych).
sortingCode

string

Opcjonalnie. Dodatkowy kod rozliczeniowy zależny od kraju. Ta funkcja nie jest używana w większości regionów. Ta wartość jest ciągiem znaków typu „CEDEX”, opcjonalnie po którym następuje liczba (np. „CEDEX 7”), lub sama liczba reprezentująca „kod sektora” (Jamajka), „wskaźnik obszaru dostawy” (malawi) lub „wskaźnik poczty” (np. Wybrzeże Kości Słoniowej).
administrativeArea

string

Opcjonalnie. Najwyższy podział administracyjny używany w przypadku adresów pocztowych w kraju lub regionie. Może to być na przykład stan, prowincja, obwód lub prefektura. W przypadku Hiszpanii jest to prowincja, a nie społeczność autonomiczna (np. „Barcelona”, a nie „Katalonia”). W wielu krajach nie używa się obszaru administracyjnego w adresach pocztowych. Na przykład w Szwajcarii to pole powinno pozostać puste.
locality

string

Opcjonalnie. Zwykle odnosi się do miasta/miasta adresu. Przykłady: miasto w USA, gmina IT, brytyjska poczta. W regionach świata, gdzie miejscowości nie są dobrze zdefiniowane lub nie mieszczą się w tej strukturze, pozostaw pole rejonu puste i użyj pola addressLines.
sublocality

string

Opcjonalnie. Dzielnica adresu. Mogą to być dzielnice, dystrykty, dzielnice.
addressLines[]

string

Nieuporządkowane wiersze adresu opisujące niższe poziomy adresu.

Ponieważ wartości w wierszach addressLines nie mają informacji o typie i czasami mogą zawierać wiele wartości w jednym polu (np. „Austin, TX”), kolejność wierszy musi być jasna. Kolejność wierszy adresu powinna być określona jako „kolejność kopert” dla kraju lub regionu adresu. Tam, gdzie może się to różnić (np. w Japonii), używany jest atrybut „address_language”, aby był zrozumiały (np. „ja” to małe i duże uporządkowanie oraz „ja-Latn” lub „pl” w przypadku małych i dużych rozmiarów). Dzięki temu można wybrać najwęższy wiersz adresu na podstawie języka.

Minimalna dozwolona reprezentacja strukturalna adresu składa się z kodu regionCode, a wszystkie pozostałe informacje są umieszczone w wierszach adresu. Taki adres można sformatować mniej więcej bez użycia geokodowania, ale nie można myśleć semantycznie na temat żadnego elementu adresu, dopóki nie zostanie rozwiązany przynajmniej częściowo.

Utworzenie adresu zawierającego tylko kod regionu i pole adresowe, a następnie geokodowanie jest zalecanym sposobem obsługi całkowicie nieuporządkowanych adresów (zamiast zgadywania, które części adresu powinny być miejscowością lub obszarem administracyjnych).
recipients[]

string

Opcjonalnie. Odbiorca pod tym adresem. W pewnych okolicznościach to pole może zawierać informacje wielowierszowe. Na przykład może zawierać informacje związane z dbaniem o nie.
organization

string

Opcjonalnie. Nazwa organizacji pod adresem.

Metody

create

 Tworzy konto o określonej nazwie i typie w ramach danego elementu nadrzędnego.

get

 Pobiera określone konto.

list

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

patch

 Aktualizuje określone konto firmowe.