Package google.mybusiness.accountmanagement.v1

Dizin

AccessControl

Bu hizmet, hesaplara ve konumlara erişimi olan kullanıcıların yönetilmesine olanak tanır.

AcceptInvitation

rpc AcceptInvitation(AcceptInvitationRequest) returns (Empty)

Belirtilen davetiyeyi kabul eder.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

  • https://www.googleapis.com/auth/business.manage

Daha fazla bilgi için OAuth 2.0'a Genel Bakış başlıklı makaleye bakın.
CreateAccountAdmin

rpc CreateAccountAdmin(CreateAccountAdminRequest) returns (Admin)

Belirtilen kullanıcıyı belirtilen hesabın yöneticisi olmaya davet eder. Hesaba erişim izni verilmesi için davetlinin daveti kabul etmesi gerekir. Bir daveti programlı olarak kabul etmek için [Kabul Ediyorum] [google.isletme.hesapmanagement.v1.Kabul Ettiniz] adresine bakın.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

  • https://www.googleapis.com/auth/business.manage

Daha fazla bilgi için OAuth 2.0'a Genel Bakış başlıklı makaleye bakın.
CreateLocationAdmin

rpc CreateLocationAdmin(CreateLocationAdminRequest) returns (Admin)

Belirtilen kullanıcıyı belirtilen konumda yönetici olmaya davet eder. Davetlinin konuma erişim izni vermesi için davetiyeyi kabul etmesi gerekir. Bir davetiyeyi programlı olarak kabul etmek için [Kabul Ediyorum] [google.isletme.hesapmangement.v1.Kabul Etti] sayfasına bakın.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

  • https://www.googleapis.com/auth/business.manage

Daha fazla bilgi için OAuth 2.0'a Genel Bakış başlıklı makaleye bakın.
DeclineInvitation

rpc DeclineInvitation(DeclineInvitationRequest) returns (Empty)

Belirtilen davetiyeyi reddeder.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

  • https://www.googleapis.com/auth/business.manage

Daha fazla bilgi için OAuth 2.0'a Genel Bakış başlıklı makaleye bakın.
DeleteAccountAdmin

rpc DeleteAccountAdmin(DeleteAccountAdminRequest) returns (Empty)

Belirtilen yöneticiyi belirtilen hesaptan kaldırır.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

  • https://www.googleapis.com/auth/business.manage

Daha fazla bilgi için OAuth 2.0'a Genel Bakış başlıklı makaleye bakın.
DeleteLocationAdmin

rpc DeleteLocationAdmin(DeleteLocationAdminRequest) returns (Empty)

Belirtilen yöneticiyi belirtilen konumun yöneticisi olarak kaldırır.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

  • https://www.googleapis.com/auth/business.manage

Daha fazla bilgi için OAuth 2.0'a Genel Bakış başlıklı makaleye bakın.
ListAccountAdmins

rpc ListAccountAdmins(ListAccountAdminsRequest) returns (ListAccountAdminsResponse)

Belirtilen hesabın yöneticilerini listeler.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

  • https://www.googleapis.com/auth/business.manage

Daha fazla bilgi için OAuth 2.0'a Genel Bakış başlıklı makaleye bakın.
ListInvitations

rpc ListInvitations(ListInvitationsRequest) returns (ListInvitationsResponse)

Belirtilen hesap için bekleyen davetiyeleri listeler.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

  • https://www.googleapis.com/auth/business.manage

Daha fazla bilgi için OAuth 2.0'a Genel Bakış başlıklı makaleye bakın.
ListLocationAdmins

rpc ListLocationAdmins(ListLocationAdminsRequest) returns (ListLocationAdminsResponse)

Belirtilen konumdaki tüm yöneticileri listeler.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

  • https://www.googleapis.com/auth/business.manage

Daha fazla bilgi için OAuth 2.0'a Genel Bakış başlıklı makaleye bakın.
TransferLocation

rpc TransferLocation(TransferLocationRequest) returns (Empty)

Konumu, kullanıcıya ait bir hesaptan aynı kullanıcının yönettiği başka bir hesaba taşır. Kullanıcı, konumun ilişkili olduğu hesabın sahibi olmalı ve ayrıca en azından hedef hesabın yöneticisi olmalıdır.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

  • https://www.googleapis.com/auth/business.manage

Daha fazla bilgi için OAuth 2.0'a Genel Bakış başlıklı makaleye bakın.
UpdateAccountAdmin

rpc UpdateAccountAdmin(UpdateAccountAdminRequest) returns (Admin)

Belirtilen Hesap Yöneticisi için Yönetici'yi günceller.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

  • https://www.googleapis.com/auth/business.manage

Daha fazla bilgi için OAuth 2.0'a Genel Bakış başlıklı makaleye bakın.
UpdateLocationAdmin

rpc UpdateLocationAdmin(UpdateLocationAdminRequest) returns (Admin)

Yöneticiyi belirtilen konumla günceller. Yalnızca AdminRole güncellenebilir.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

  • https://www.googleapis.com/auth/business.manage

Daha fazla bilgi için OAuth 2.0'a Genel Bakış başlıklı makaleye bakın.

Hesaplar

Bu API, Google'daki işletme hesaplarının yönetilmesine olanak tanır. Aşağıdaki kaynak modelini tanımlar:

  • API'de accounts/* adlı Hesap kaynakları koleksiyonu bulunur.

  • Kolaylık sağlaması açısından, kimliği doğrulanmış arayanın kişisel hesabına ait hesap kimliği yerine "ben" eş anlamlısını kullanabilirsiniz. Örnekler: GET /v1/accounts/me GET /v1/accounts/me/locations

CreateAccount

rpc CreateAccount(CreateAccountRequest) returns (Account)

Belirtilen üst öğe altında belirtilen ad ve türle bir hesap oluşturur.

  • Kişisel hesaplar ve Kuruluşlar oluşturulamaz.
  • Birincil sahip olarak Kişisel bir hesapla Kullanıcı Grupları oluşturulamaz.
  • Kişisel hesap bir Kuruluştaysa Konum Grupları bu Kişisel hesabın birincil sahibiyle oluşturulamaz.
  • Yer Grupları, Konum Gruplarının sahibi olamaz.
Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

  • https://www.googleapis.com/auth/business.manage

Daha fazla bilgi için OAuth 2.0'a Genel Bakış başlıklı makaleye bakın.
GetAccount

rpc GetAccount(GetAccountRequest) returns (Account)

Belirtilen hesabı alır. Hesap yoksa veya arayanın hesaba erişim hakları yoksa NOT_FOUND değerini döndürür.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

  • https://www.googleapis.com/auth/business.manage

Daha fazla bilgi için OAuth 2.0'a Genel Bakış başlıklı makaleye bakın.
ListAccounts

rpc ListAccounts(ListAccountsRequest) returns (ListAccountsResponse)

Kimliği doğrulanmış kullanıcının tüm hesaplarını listeler. Kullanıcının sahip olduğu tüm hesapların yanı sıra kullanıcının yönetim haklarına sahip olduğu tüm hesaplar da buna dahildir.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

  • https://www.googleapis.com/auth/business.manage

Daha fazla bilgi için OAuth 2.0'a Genel Bakış başlıklı makaleye bakın.
UpdateAccount

rpc UpdateAccount(UpdateAccountRequest) returns (Account)

Belirtilen işletme hesabını günceller. Kişisel hesaplar bu yöntemle güncellenemez.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

  • https://www.googleapis.com/auth/business.manage

Daha fazla bilgi için OAuth 2.0'a Genel Bakış başlıklı makaleye bakın.

AcceptInvitationRequest

AccessControl.AcceptInvite için ileti isteyin.

Alanlar
name

string

Zorunlu. Kabul edilen davetin adı. accounts/{account_id}/invitations/{invitation_id}

Hesap

Hesap, konumunuz için bir kapsayıcıdır. İşletmeniz için konumları yöneten tek kullanıcı sizseniz kişisel Google Hesabınızı kullanabilirsiniz. Konumların yönetimini birden çok kullanıcıyla paylaşmak için bir işletme hesabı oluşturun.

Alanlar
name

string

Sabit. accounts/{account_id} biçimindeki kaynak adı.
account_name

string

Zorunlu. Hesabın adı. PERSONAL türündeki bir hesap için bu, kullanıcı hesabının adı ve soyadıdır.
primary_owner

string

Zorunlu. Yalnızca giriş. Oluşturulan hesabın birincil sahibi olacak hesabın kaynak adı. Hedef, accounts/{account_id} biçiminde olmalıdır.
type

AccountType

Zorunlu. Hesap türünü içerir. Bu API kullanılarak PERSONAL ve Kuruluş türündeki hesaplar oluşturulamaz.
role

AccountRole

Yalnızca çıkış. Bu hesabın AccountRole değerini belirtir.
verification_state

VerificationState

Yalnızca çıkış. Doğrulanırsa, gelecekte oluşturulacak konumlar otomatik olarak Google Haritalar'a bağlanır ve denetleme gerektirmeden Google+ sayfaları oluşturulur.
vetted_state

VettedState

Yalnızca çıkış. Hesabın Google tarafından incelenip incelenmediğini belirtir. Doğrulanmış hesaplar, VETTED_PARTNER yöntemi aracılığıyla konumları doğrulayabilir.
account_number

string

Yalnızca çıkış. Temel hazırlığı yapıldıysa hesap referans numarası.
permission_level

PermissionLevel

Yalnızca çıkış. Kullanıcının bu hesap için sahip olduğu izin düzeyini belirtir.
organization_info

OrganizationInfo

Yalnızca çıkış. Kuruluşla ilgili ek bilgiler. Bu alan yalnızca kurumsal hesap için doldurulur.

AccountRole

Kimliği doğrulanan kullanıcının bu hesap için sahip olduğu erişim düzeyini belirtir. Daha fazla bilgi için yardım merkezi makalesini inceleyin

Sıralamalar
ACCOUNT_ROLE_UNSPECIFIED Belirtilmedi.
PRIMARY_OWNER Kullanıcı, bu hesabın birincil sahibidir.
OWNER Hesabın kullanıcı sahibi.
MANAGER Kullanıcı bu hesabı yönetebilir.
SITE_MANAGER Kullanıcı, hesaba ait sınırlı bir özellik grubunu yönetebilir.

AccountType

Bunun ne tür bir hesap olduğunu belirtir: kişisel/kullanıcı hesabı veya işletme hesabı.

Sıralamalar
ACCOUNT_TYPE_UNSPECIFIED Belirtilmedi.
PERSONAL Son kullanıcı hesabı.
LOCATION_GROUP Konum grubu. Daha fazla bilgi için yardım merkezi makalesini inceleyin
USER_GROUP Kurum personelini gruplar halinde ayırmak için bir Kullanıcı Grubu. Daha fazla bilgi için yardım merkezi makalesini inceleyin
ORGANIZATION Bir şirketi temsil eden kuruluş. Daha fazla bilgi için yardım merkezi makalesini inceleyin

OrganizationInfo

Kuruluş için depolanan ek bilgiler.

Alanlar
registered_domain

string

Yalnızca çıkış. Hesabın kayıtlı alanı.
address

PostalAddress

Yalnızca çıkış. Hesabın posta adresi.
phone_number

string

Yalnızca çıkış. Kuruluşun iletişim numarası.

PermissionLevel

Kimliği doğrulanan kullanıcının bu hesap için sahip olduğu erişim düzeyini belirtir.

Sıralamalar
PERMISSION_LEVEL_UNSPECIFIED Belirtilmedi.
OWNER_LEVEL Kullanıcının sahip düzeyinde izni var.
MEMBER_LEVEL Kullanıcı, üye düzeyinde izne sahip.

VerificationState

Hesabın doğrulama durumunu belirtir.

Sıralamalar
VERIFICATION_STATE_UNSPECIFIED Belirtilmedi.
VERIFIED Doğrulanmış hesap.
UNVERIFIED Doğrulanmamış hesap ve doğrulama isteğinde bulunulmadı.
VERIFICATION_REQUESTED Doğrulanmamış ancak doğrulama isteğinde bulunulan hesap.

VettedState

Hesabın incelenme durumunu gösterir.

Sıralamalar
VETTED_STATE_UNSPECIFIED Belirtilmedi
NOT_VETTED Hesap, Google tarafından incelenmemiştir.
VETTED Hesap, Google tarafından onaylanmış ve geçerli bir durumdadır. Doğrulanmış bir grup hesabına doğrudan erişimi olan hesaplar otomatik olarak incelenir.
INVALID Hesap incelendi ancak geçersiz durumda. Hesap, incelenmemiş bir hesap gibi davranır.

Yönetici

Bir hesabın veya konumun yöneticisi.

Alanlar
name

string

Sabit. Kaynak adı. Hesap yöneticileri için bu form şu şekildedir: accounts/{account_id}/admins/{admin_id}

Konum yöneticileri için bu form şu şekildedir: locations/{location_id}/admins/{admin_id}

Bu alan, yönetici oluşturma sırasında ayarlanırsa yoksayılır.
admin

string

İsteğe bağlı. Yöneticinin adı. İlk davetiyeyi oluştururken bu adres davetlinin e-posta adresidir. GET aramalarında, davetiye hâlâ beklemedeyse kullanıcının e-posta adresi döndürülür. Aksi takdirde, kullanıcının adını ve soyadını içerir.

Bu alanın yalnızca yönetici hesabı oluşturulurken ayarlanması gerekir.
account

string

Sabit. Bu Yöneticinin atıfta bulunduğu Hesap kaynağının adı. Bir LocationGroup öğesini yönetici olarak davet etmek için locations.admins.create çağrılırken kullanılır.

Hem bu alan hem de admin, CREATE isteklerinde ayarlanırsa bu alan öncelikli olur ve admin içindeki e-posta adresi yoksayılır.

Biçim: accounts/{account}.
role

AdminRole

Zorunlu. Bu yöneticinin belirtilen Hesap veya Konum ile kullandığı rolü belirtir.
pending_invitation

bool

Yalnızca çıkış. Bu yöneticinin belirtilen kaynak için bekleyen bir davetiyesi olup olmadığını belirtir.

AdminRole

Yöneticinin sahip olduğu erişim düzeyini belirtir. Daha fazla bilgi için yardım merkezi makalesini inceleyin

Sıralamalar
ADMIN_ROLE_UNSPECIFIED Belirtilmedi.
PRIMARY_OWNER Yönetici, sahip düzeyinde erişime sahiptir ve birincil sahiptir. (Kullanıcı arayüzünde "Birincil Sahip" olarak görünür).
OWNER Yönetici, sahip düzeyinde erişime sahiptir. (Kullanıcı arayüzünde "Sahip" olarak görünür).
MANAGER Yönetici, yönetim erişimine sahiptir.
SITE_MANAGER Yönetici, sosyal medya (Google+) sayfalarını yönetebilir. (Kullanıcı arayüzünde "Site Yöneticisi" olarak görüntülenir.) Bu API, SITE_MANAGER rolüne sahip hesap yöneticisi oluşturulmasına izin vermiyor.

CreateAccountAdminRequest

AccessControl.CreateAccountAdmin için istekte bulunun.

Alanlar
parent

string

Zorunlu. Bu yöneticinin oluşturulduğu hesabın kaynak adı. accounts/{account_id}.
admin

Admin

Zorunlu. Oluşturulan yönetici. Rol SITE_MANAGER olamaz

CreateAccountRequest

Accounts.CreateAccount için mesaj isteyin.

Alanlar
account

Account

Zorunlu. Oluşturulacak hesaba ilişkin hesap bilgileri. Yalnızca hesap ve tür alanlarına izin verilir.

CreateLocationAdminRequest

AccessControl.CreateLocationAdmin için ileti isteyin.

Alanlar
parent

string

Zorunlu. Bu yöneticinin oluşturulduğu konumun kaynak adı. locations/{location_id}/admins.
admin

Admin

Zorunlu. Oluşturulacak yönetici.

DeclineInvitationRequest

AccessControl.reddetmek için ileti isteyin.

Alanlar
name

string

Zorunlu. Reddedilen hesap davetiyesinin adı. accounts/{account_id}/invitations/{invitation_id}

DeleteAccountAdminRequest

AccessControl.DeleteAccountAdmin için ileti isteyin.

Alanlar
name

string

Zorunlu. Hesaptan kaldırılacak yöneticinin kaynak adı. accounts/{account_id}/admins/{admin_id}.

DeleteLocationAdminRequest

AccessControl.DeleteLocationAdmin için ileti isteyin.

Alanlar
name

string

Zorunlu. Konumdan kaldırılacak yöneticinin kaynak adı.

GetAccountRequest

Accounts.GetAccount için mesaj isteyin.

Alanlar
name

string

Zorunlu. Getirilecek hesabın adı.

Davetiye

Beklemedeki bir davetiyeyi temsil eder.

Alanlar
name

string

Zorunlu. Davetiyenin kaynak adı. accounts/{account_id}/invitations/{invitation_id}.
role

AdminRole

Yalnızca çıkış. Hesapta davet edilen rol.
target_type

TargetType

Yalnızca çıkış. Yanıtta hangi hedef türlerinin görünmesi gerektiğini belirtir.
target alanı. Bu davetiyenin hangi hedef için olduğunu belirtir. target şunlardan yalnızca biri olabilir:
target_account

Account

Bu davetiye için geçerli olan seyrek nüfuslu hesap.
target_location

TargetLocation

Bu davetiyenin hedef konumu.

TargetLocation

Bekleyen bir davetiye için hedef konumu temsil eder.

Alanlar
location_name

string

Kullanıcının davet edildiği konumun adı.
address

string

Kullanıcının davet edildiği konumun adresi.

TargetType

Davetiyenin hedef türü.

Sıralamalar
TARGET_TYPE_UNSPECIFIED Hedef türü belirtilmediyse ayarlayın.
ACCOUNTS_ONLY Yalnızca Hesap türündeki hedefler için davetiyeleri listeler.
LOCATIONS_ONLY Yalnızca Konum türündeki hedefler için davetiyeleri listeler.

ListAccountAdminsRequest

AccessControl.ListAccountAdmins için ileti isteyin.

Alanlar
parent

string

Zorunlu. Yönetici listesinin alınacağı hesabın adı. accounts/{account_id}/admins.

ListAccountAdminsResponse

AccessControl.ListAccountAdmins için yanıt iletisi.

Alanlar
account_admins[]

Admin

Yönetici örneklerinden oluşan bir koleksiyon.

ListAccountsRequest

Accounts.ListAccounts için mesaj isteyin.

Alanlar
parent_account

string

İsteğe bağlı. Doğrudan erişilebilir hesaplar listesinin alınacağı hesabın kaynak adı. Bu, yalnızca Kuruluşlar ve Kullanıcı Grupları için anlamlıdır. Boş bırakılırsa kimliği doğrulanmış kullanıcı için ListAccounts döndürülür. accounts/{account_id}.
page_size

int32

İsteğe bağlı. Sayfa başına getirilecek hesap sayısı. Varsayılan ve maksimum değer 20'dir.
page_token

string

İsteğe bağlı. Belirtilmişse sonraki hesap sayfası alınır. accounts.list için yapılan bir çağrı, istenen sayfa boyutuna sığabilecek daha fazla sonuç döndürdüğünde pageToken döndürülür.
filter

string

İsteğe bağlı. Döndürülecek hesapları sınırlayan bir filtre. Yanıt yalnızca filtreyle eşleşen girişleri içerir. filter boşsa hiçbir kısıtlama uygulanmaz ve istenen hesap için tüm hesaplar (sayfalara ayrılır) alınır.

Örneğin, type=USER_GROUP filtresi içeren bir istek yalnızca kullanıcı gruplarını döndürür.

type alanı, desteklenen tek filtredir.

ListAccountsResponse

Accounts.ListAccounts için yanıt mesajı.

Alanlar
accounts[]

Account

Kullanıcının erişebildiği hesaplar koleksiyonu. Sorguyu yapan kullanıcının kişisel hesabı filtrelenmediği sürece her zaman sonucun ilk öğesi olur.
next_page_token

string

Hesap sayısı istenen sayfa boyutunu aşıyorsa bu alan, sonraki bir accounts.list çağrısında hesapların sonraki sayfasını getirmek için bir jetonla doldurulur. Başka hesap yoksa bu alan yanıtta bulunmaz.

ListInvitationsRequest

AccessControl.ListInvites için ileti isteyin.

Alanlar
parent

string

Zorunlu. Davetiye listesinin alındığı hesabın adı. accounts/{account_id}/invitations
filter

string

İsteğe bağlı. Yanıtın filtrelenmesi Invite.target_type alanı aracılığıyla desteklenir.

ListInvitationsResponse

AccessControl.ListInvites için yanıt iletisi.

Alanlar
invitations[]

Invitation

Hesap için bekleyen davetiyelerin bir koleksiyonu. Burada listelenen davetiye sayısı 1.000'i aşamaz.

ListLocationAdminsRequest

AccessControl.ListLocationAdmins için ileti isteyin.

Alanlar
parent

string

Zorunlu. Yöneticilerinin listeleneceği konumun adı. locations/{location_id}/admins.

ListLocationAdminsResponse

AccessControl.ListLocationAdmins için yanıt iletisi.

Alanlar
admins[]

Admin

Yöneticilerden oluşan bir koleksiyon.

TransferLocationRequest

AccessControl.TransferLocation için ileti.

Alanlar
name

string

Zorunlu. Aktarılacak konumun adı. locations/{location_id}.
destination_account

string

Zorunlu. Konumun aktarılacağı hesap kaynağının adı (ör. "accounts/{account}").

UpdateAccountAdminRequest

AccessControl.UpdateAccountAdmin için ileti isteyin.

Alanlar
account_admin

Admin

Zorunlu. Yöneticinin güncellenmiş sürümü.
update_mask

FieldMask

Zorunlu. Güncellenmesi gereken belirli alanlar. Düzenlenebilir tek alan roldür.

UpdateAccountRequest

Accounts.UpdateAccount için mesaj isteyin.

Alanlar
account

Account

Zorunlu. Güncellenen Hesap.
update_mask

FieldMask

Zorunlu. Güncellenmesi gereken belirli alanlar. Düzenlenebilir tek alan: accountName.
validate_only

bool

İsteğe bağlı. Doğru ise istek, hesap gerçekten güncellenmeden doğrulanır.

UpdateLocationAdminRequest

AccessControl.UpdateLocationAdmin için ileti isteyin.

Alanlar
location_admin

Admin

Zorunlu. Yöneticinin güncellenmiş sürümü.
update_mask

FieldMask

Zorunlu. Güncellenmesi gereken belirli alanlar. Düzenlenebilir tek alan roldür.