Package google.mybusiness.accountmanagement.v1

فهرست مطالب

AccessControl

این سرویس امکان مدیریت کاربرانی که به حساب ها و مکان ها دسترسی دارند را می دهد.

قبول دعوت

rpc AcceptInvitation( AcceptInvitationRequest ) returns ( Empty )

دعوت مشخص شده را می پذیرد.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.

CreateAccountAdmin

rpc CreateAccountAdmin( CreateAccountAdminRequest ) returns ( Admin )

کاربر مشخص شده را دعوت می کند تا مدیر حساب مشخص شده شود. دعوت‌شونده باید دعوتنامه را بپذیرد تا بتواند به حساب خود دسترسی داشته باشد. به [AcceptInvitation] [google.mybusiness.accountmanagement.v1.AcceptInvitation] مراجعه کنید تا به صورت برنامه‌ریزی یک دعوت را بپذیرید.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.

CreateLocationAdmin

rpc CreateLocationAdmin( CreateLocationAdminRequest ) returns ( Admin )

کاربر مشخص شده را دعوت می کند تا مدیر مکان مشخص شده شود. دعوت‌کننده باید دعوت‌نامه را بپذیرد تا به آن مکان دسترسی پیدا کند. به [AcceptInvitation] [google.mybusiness.accountmangement.v1.AcceptInvitation] مراجعه کنید تا به صورت برنامه‌ریزی یک دعوت را بپذیرید.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.

رد دعوت

rpc DeclineInvitation( DeclineInvitationRequest ) returns ( Empty )

دعوت مشخص شده را رد می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.

DeleteAccountAdmin

rpc DeleteAccountAdmin( DeleteAccountAdminRequest ) returns ( Empty )

ادمین مشخص شده را از حساب مشخص شده حذف می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.

DeleteLocationAdmin

rpc DeleteLocationAdmin( DeleteLocationAdminRequest ) returns ( Empty )

ادمین مشخص شده را به عنوان مدیر مکان مشخص شده حذف می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.

ListAccountAdmins

rpc ListAccountAdmins( ListAccountAdminsRequest ) returns ( ListAccountAdminsResponse )

ادمین های حساب مشخص شده را لیست می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.

ListInvitations

rpc ListInvitations( ListInvitationsRequest ) returns ( ListInvitationsResponse )

دعوت‌نامه‌های معلق را برای حساب مشخص‌شده فهرست می‌کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.

ListLocationAdmins

rpc ListLocationAdmins( ListLocationAdminsRequest ) returns ( ListLocationAdminsResponse )

همه ادمین ها را برای مکان مشخص شده لیست می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.

انتقال مکان

rpc TransferLocation( TransferLocationRequest ) returns ( Empty )

مکان را از حسابی که کاربر دارد به حساب دیگری که همان کاربر مدیریت می کند منتقل می کند. کاربر باید مالک حسابی باشد که مکان در حال حاضر با آن مرتبط است و همچنین باید حداقل مدیر حساب مقصد باشد.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.

UpdateAccountAdmin

rpc UpdateAccountAdmin( UpdateAccountAdminRequest ) returns ( Admin )

Admin را برای مدیریت حساب مشخص شده به روز می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.

UpdateLocationAdmin

rpc UpdateLocationAdmin( UpdateLocationAdminRequest ) returns ( Admin )

ادمین را برای مکان مشخص شده به روز می کند. فقط AdminRole Admin را می توان به روز کرد.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.

حساب ها

این API امکان مدیریت حساب های تجاری در Google را فراهم می کند. مدل منبع زیر را تعریف می کند:

  • API مجموعه‌ای از منابع حساب، به نام accounts/* دارد.

  • به عنوان یک راحتی، می توانید از مترادف "من" به جای شناسه حساب برای حساب شخصی تماس گیرنده احراز هویت شده استفاده کنید. مثالها: GET /v1/accounts/me GET /v1/accounts/me/locations

ایجاد حساب کاربری

rpc CreateAccount( CreateAccountRequest ) returns ( Account )

یک حساب کاربری با نام و نوع مشخص شده در زیر والد داده شده ایجاد می کند.

  • حساب های شخصی و سازمان ها را نمی توان ایجاد کرد.
  • گروه های کاربری را نمی توان با یک حساب شخصی به عنوان مالک اصلی ایجاد کرد.
  • اگر حساب شخصی در یک سازمان باشد، نمی‌توان گروه‌های مکان را با مالک اصلی یک حساب شخصی ایجاد کرد.
  • گروه‌های مکان نمی‌توانند گروه‌های مکان را داشته باشند.
محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.

GetAccount

rpc GetAccount( GetAccountRequest ) returns ( Account )

حساب مشخص شده را دریافت می کند. اگر حساب موجود نباشد یا تماس‌گیرنده حقوق دسترسی به آن را نداشته باشد، NOT_FOUND برمی‌گرداند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.

ListAccounts

rpc ListAccounts( ListAccountsRequest ) returns ( ListAccountsResponse )

همه اکانت ها را برای کاربر احراز هویت شده فهرست می کند. این شامل تمام حساب‌هایی است که کاربر مالک آن است، و همچنین هر حسابی که کاربر برای آن حقوق مدیریت دارد.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.

به روز رسانی حساب کاربری

rpc UpdateAccount( UpdateAccountRequest ) returns ( Account )

حساب تجاری مشخص شده را به روز می کند. حساب های شخصی را نمی توان با استفاده از این روش به روز کرد.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.

AcceptInvitationRequest

درخواست پیام برای AccessControl.AcceptInvitation.

زمینه های
name

string

ضروری. نام دعوت نامه ای که پذیرفته می شود. accounts/{account_id}/invitations/{invitation_id}

حساب

حساب یک ظرف برای موقعیت مکانی شما است. اگر تنها کاربری هستید که مکان‌های کسب و کارتان را مدیریت می‌کنید، می‌توانید از حساب شخصی Google خود استفاده کنید. برای اشتراک‌گذاری مدیریت مکان‌ها با چند کاربر، یک حساب تجاری ایجاد کنید .

زمینه های
name

string

تغییرناپذیر. نام منبع، در قالب accounts/{account_id} .

account_name

string

ضروری. نام اکانت. برای حسابی از نوع PERSONAL ، این نام و نام خانوادگی حساب کاربری است.

primary_owner

string

ضروری. فقط ورودی نام منبع حسابی که مالک اصلی حساب در حال ایجاد خواهد بود. باید از شکل accounts/{account_id} باشد.

type

AccountType

ضروری. شامل نوع حساب است. حساب‌های نوع PERSONAL و ORGANIZATION نمی‌توانند با استفاده از این API ایجاد شوند.

role

AccountRole

فقط خروجی AccountRole این حساب را مشخص می کند.

verification_state

VerificationState

فقط خروجی در صورت تأیید، مکان‌های آینده ایجاد شده به‌طور خودکار به Google Maps متصل می‌شوند و صفحات Google+‎ ایجاد می‌شوند، بدون نیاز به نظارت.

vetted_state

VettedState

فقط خروجی نشان می دهد که آیا حساب توسط Google بررسی شده است یا خیر. یک حساب تأیید شده می‌تواند مکان‌ها را از طریق روش VETTED_PARTNER تأیید کند.

account_number

string

فقط خروجی شماره مرجع حساب در صورت ارائه

permission_level

PermissionLevel

فقط خروجی سطح مجوزی که کاربر برای این حساب دارد را مشخص می کند.

organization_info

OrganizationInfo

فقط خروجی اطلاعات اضافی برای یک سازمان این فقط برای یک حساب سازمانی پر شده است.

نقش حساب

سطح دسترسی کاربر احراز هویت شده برای این حساب را نشان می دهد. برای اطلاعات بیشتر، به مقاله مرکز راهنمایی مراجعه کنید

Enums
ACCOUNT_ROLE_UNSPECIFIED مشخص نشده است.
PRIMARY_OWNER کاربر مالک اصلی این حساب است.
OWNER مالک کاربر حساب.
MANAGER کاربر می تواند این حساب را مدیریت کند.
SITE_MANAGER کاربر می تواند مجموعه محدودی از ویژگی ها را برای حساب مدیریت کند.

نوع حساب

نشان می دهد که این چه نوع حسابی است: یا یک حساب شخصی/کاربر یا یک حساب تجاری.

Enums
ACCOUNT_TYPE_UNSPECIFIED مشخص نشده است.
PERSONAL یک حساب کاربری نهایی
LOCATION_GROUP گروهی از مکان ها برای اطلاعات بیشتر، به مقاله مرکز راهنمایی مراجعه کنید
USER_GROUP یک گروه کاربری برای تفکیک کارکنان سازمان در گروه ها. برای اطلاعات بیشتر، به مقاله مرکز راهنمایی مراجعه کنید
ORGANIZATION سازمانی که نماینده یک شرکت است. برای اطلاعات بیشتر، به مقاله مرکز راهنمایی مراجعه کنید

اطلاعات سازمان

اطلاعات اضافی ذخیره شده برای یک سازمان

زمینه های
registered_domain

string

فقط خروجی دامنه ثبت شده برای حساب کاربری

address

PostalAddress

فقط خروجی آدرس پستی حساب

phone_number

string

فقط خروجی شماره تماس سازمان

سطح مجوز

سطح دسترسی کاربر احراز هویت شده برای این حساب را نشان می دهد.

Enums
PERMISSION_LEVEL_UNSPECIFIED مشخص نشده است.
OWNER_LEVEL کاربر دارای مجوز سطح مالک است.
MEMBER_LEVEL کاربر دارای مجوز سطح عضو است.

Verification State

وضعیت تأیید حساب را نشان می دهد.

Enums
VERIFICATION_STATE_UNSPECIFIED مشخص نشده است.
VERIFIED حساب تایید شده.
UNVERIFIED حسابی که تأیید نشده است و تأیید درخواست نشده است.
VERIFICATION_REQUESTED حسابی که تأیید نشده است، اما تأیید درخواست شده است.

ایالت بررسی شده

وضعیت بررسی شده یک حساب را نشان می دهد.

Enums
VETTED_STATE_UNSPECIFIED مشخص نشده است
NOT_VETTED این حساب توسط Google تأیید نشده است.
VETTED حساب توسط Google تأیید شده و در وضعیت معتبری قرار دارد. اگر یک حساب به طور مستقیم به یک حساب گروه تأیید شده دسترسی داشته باشد، به طور خودکار بررسی می شود.
INVALID حساب بررسی شده است اما در وضعیت نامعتبر است. حساب کاربری مانند یک حساب تایید نشده رفتار خواهد کرد.

مدیر

مدیر یک حساب یا یک مکان.

زمینه های
name

string

تغییرناپذیر. نام منبع برای مدیران حساب، این به این شکل است: accounts/{account_id}/admins/{admin_id}

برای مدیران مکان، این به این شکل است: locations/{location_id}/admins/{admin_id}

اگر در حین ایجاد مدیر تنظیم شود، این فیلد نادیده گرفته می شود.

admin

string

اختیاری. نام ادمین. هنگام انجام دعوت اولیه، این آدرس ایمیل دعوت شده است. در تماس‌های GET ، اگر دعوت‌نامه هنوز معلق باشد، آدرس ایمیل کاربر برگردانده می‌شود. در غیر این صورت، شامل نام و نام خانوادگی کاربر است.

این فیلد فقط باید در حین ایجاد ادمین تنظیم شود.

account

string

تغییرناپذیر. نام منبع حسابی که این مدیر به آن اشاره دارد. هنگام تماس با locations.admins.create برای دعوت از LocationGroup به عنوان سرپرست استفاده می شود.

اگر این فیلد و admin هر دو روی درخواست‌های CREATE تنظیم شده باشند، این فیلد اولویت دارد و آدرس ایمیل موجود در admin نادیده گرفته می‌شود.

قالب: accounts/{account} .

role

AdminRole

ضروری. نقشی را که این سرپرست با حساب یا مکان مشخص شده استفاده می‌کند، مشخص می‌کند.

pending_invitation

bool

فقط خروجی نشان می دهد که آیا این سرپرست دعوت نامه معلقی برای منبع مشخص شده دارد یا خیر.

نقش مدیر

سطح دسترسی یک مدیر را نشان می دهد. برای اطلاعات بیشتر، به مقاله مرکز راهنمایی مراجعه کنید

Enums
ADMIN_ROLE_UNSPECIFIED مشخص نشده است.
PRIMARY_OWNER ادمین دسترسی در سطح مالک دارد و مالک اصلی است. (به عنوان "مالک اصلی" در UI نمایش داده می شود).
OWNER ادمین دسترسی در سطح مالک دارد. (به عنوان "مالک" در UI نمایش داده می شود).
MANAGER ادمین دسترسی مدیریتی دارد.
SITE_MANAGER ادمین می تواند صفحات اجتماعی (Google+) را مدیریت کند. (به عنوان "مدیر سایت" در UI نمایش داده می شود). این API اجازه ایجاد یک سرپرست حساب با نقش SITE_MANAGER را نمی دهد.

CreateAccountAdminRequest

درخواست پیام برای AccessControl.CreateAccountAdmin.

زمینه های
parent

string

ضروری. نام منبع حسابی که این مدیر برای آن ایجاد شده است. accounts/{account_id} .

admin

Admin

ضروری. مدیر برای ایجاد. نقش نمی تواند SITE_MANAGER باشد

CreateAccountRequest

درخواست پیام برای Accounts.CreateAccount.

زمینه های
account

Account

ضروری. اطلاعات حساب برای حسابی که قرار است ایجاد شود. تنها فیلدهای مجاز حساب و نوع هستند.

CreateLocationAdminRequest

درخواست پیام برای AccessControl.CreateLocationAdmin.

زمینه های
parent

string

ضروری. نام منبع مکانی که این مدیر برای آن ایجاد شده است. locations/{location_id}/admins .

admin

Admin

ضروری. مدیر برای ایجاد.

DeclineInvitationRequest

درخواست پیام برای AccessControl.DeclineInvitation.

زمینه های
name

string

ضروری. نام دعوت حسابی که رد می شود. accounts/{account_id}/invitations/{invitation_id}

DeleteAccountAdminRequest

درخواست پیام برای AccessControl.DeleteAccountAdmin.

زمینه های
name

string

ضروری. نام منبع مدیر برای حذف از حساب. accounts/{account_id}/admins/{admin_id} .

DeleteLocationAdminRequest

درخواست پیام برای AccessControl.DeleteLocationAdmin.

زمینه های
name

string

ضروری. نام منبع مدیر برای حذف از مکان.

GetAccountRequest

درخواست پیام برای Accounts.GetAccount.

زمینه های
name

string

ضروری. نام حسابی که باید واکشی شود.

دعوت

نشان دهنده یک دعوت در حال انتظار است.

زمینه های
name

string

ضروری. نام منبع برای دعوت نامه accounts/{account_id}/invitations/{invitation_id} .

role

AdminRole

فقط خروجی نقش دعوت شده در حساب کاربری.

target_type

TargetType

فقط خروجی مشخص می کند که کدام نوع هدف باید در پاسخ ظاهر شود.

target میدانی اتحادیه نشان می دهد که این دعوت برای چه هدفی است. target فقط می تواند یکی از موارد زیر باشد:
target_account

Account

حساب کم جمعیتی که این دعوت برای آن است.

target_location

TargetLocation

مکان مورد نظر این دعوت نامه برای آن است.

محل مورد نظر

یک مکان هدف را برای یک دعوت معلق نشان می دهد.

زمینه های
location_name

string

نام مکانی که کاربر به آن دعوت شده است.

address

string

آدرس مکانی که کاربر به آن دعوت شده است.

TargetType

نوع هدفی که یک دعوت نامه برای آن است.

Enums
TARGET_TYPE_UNSPECIFIED زمانی تنظیم شود که نوع هدف مشخص نشده باشد.
ACCOUNTS_ONLY دعوت‌نامه‌ها را فقط برای اهدافی از نوع حساب فهرست کنید.
LOCATIONS_ONLY دعوت‌نامه‌ها را فقط برای اهدافی از نوع مکان فهرست کنید.

ListAccountAdminsRequest

درخواست پیام برای AccessControl.ListAccountAdmins.

زمینه های
parent

string

ضروری. نام اکانتی که از آن لیستی از مدیران بازیابی می شود. accounts/{account_id}/admins .

ListAccountAdminsResponse

پیام پاسخ برای AccessControl.ListAccountAdmins.

زمینه های
account_admins[]

Admin

مجموعه ای از نمونه های Admin.

ListAccountsRequest

درخواست پیام برای Accounts.ListAccounts.

زمینه های
parent_account

string

اختیاری. نام منبع حسابی که قرار است فهرست حساب‌های قابل دسترسی مستقیم برای آن بازیابی شود. این فقط برای سازمان ها و گروه های کاربری منطقی است. اگر خالی باشد، ListAccounts برای کاربر احراز هویت شده برمی گرداند. accounts/{account_id} .

page_size

int32

اختیاری. چند حساب برای واکشی در هر صفحه. پیش فرض و حداکثر 20 است.

page_token

string

اختیاری. اگر مشخص شده باشد، صفحه بعدی حساب ها بازیابی می شود. pageToken زمانی برمی گردد که فراخوانی به accounts.list نتایج بیشتری را نسبت به اندازه صفحه درخواستی نشان دهد.

filter

string

اختیاری. فیلتری که حساب ها را برای بازگشت محدود می کند. پاسخ فقط شامل ورودی هایی می شود که با فیلتر مطابقت دارند. اگر filter خالی باشد، هیچ محدودیتی اعمال نمی شود و همه حساب ها (صفحه بندی شده) برای حساب درخواستی بازیابی می شوند.

برای مثال، درخواستی با type=USER_GROUP فقط گروه های کاربری را برمی گرداند.

فیلد type تنها فیلتر پشتیبانی شده است.

ListAccountsResponse

پیام پاسخ برای Accounts.ListAccounts.

زمینه های
accounts[]

Account

مجموعه ای از حساب هایی که کاربر به آنها دسترسی دارد. حساب شخصی کاربری که پرس و جو را انجام می دهد همیشه اولین مورد نتیجه خواهد بود، مگر اینکه فیلتر شود.

next_page_token

string

اگر تعداد حساب‌ها از اندازه صفحه درخواستی بیشتر شود، این فیلد با رمزی برای واکشی صفحه بعدی حساب‌ها در تماس بعدی با accounts.list پر می‌شود. اگر حساب دیگری وجود نداشته باشد، این قسمت در پاسخ وجود ندارد.

ListInvitationsRequest

درخواست پیام برای AccessControl.ListInvitations.

زمینه های
parent

string

ضروری. نام حسابی که فهرست دعوت‌ها از آن بازیابی می‌شود. accounts/{account_id}/invitations

filter

string

اختیاری. فیلتر کردن پاسخ از طریق فیلد Invitation.target_type پشتیبانی می شود.

ListInvitationsResponse

پیام پاسخ برای AccessControl.ListInvitations.

زمینه های
invitations[]

Invitation

مجموعه ای از دعوت نامه هایی که برای حساب در انتظار هستند. تعداد دعوت نامه های فهرست شده در اینجا نمی تواند از 1000 بیشتر باشد.

ListLocationAdminsRequest

درخواست پیام برای AccessControl.ListLocationAdmins.

زمینه های
parent

string

ضروری. نام مکان برای لیست کردن مدیران. locations/{location_id}/admins .

ListLocationAdminsResponse

پیام پاسخ برای AccessControl.ListLocationAdmins.

زمینه های
admins[]

Admin

مجموعه ای از ادمین ها

TransferLocationRequest

درخواست پیام برای AccessControl.TransferLocation.

زمینه های
name

string

ضروری. نام محل انتقال locations/{location_id} .

destination_account

string

ضروری. نام منبع حساب برای انتقال مکان به (به عنوان مثال، "حساب/{حساب}").

UpdateAccountAdminRequest

درخواست پیام برای AccessControl.UpdateAccountAdmin.

زمینه های
account_admin

Admin

ضروری. نسخه به روز شده ادمین.

update_mask

FieldMask

ضروری. فیلدهای خاصی که باید به روز شوند. تنها قسمت قابل ویرایش نقش است.

UpdateAccountRequest

درخواست پیام برای Accounts.UpdateAccount.

زمینه های
account

Account

ضروری. حساب به روز شده

update_mask

FieldMask

ضروری. فیلدهای خاصی که باید به روز شوند. تنها قسمت قابل ویرایش accountName است.

validate_only

bool

اختیاری. اگر درست باشد، درخواست بدون به‌روزرسانی واقعی حساب تأیید می‌شود.

UpdateLocationAdminRequest

درخواست پیام برای AccessControl.UpdateLocationAdmin.

زمینه های
location_admin

Admin

ضروری. نسخه به روز شده ادمین.

update_mask

FieldMask

ضروری. فیلدهای خاصی که باید به روز شوند. تنها قسمت قابل ویرایش نقش است.