REST Resource: accounts

منبع: حساب کاربری

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

نمایندگی 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)
  }
}
فیلدها
name

string

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

accountName

string

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

primaryOwner

string

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

type

enum ( AccountType )

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

role

enum ( AccountRole )

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

verificationState

enum ( VerificationState )

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

vettedState

enum ( VettedState )

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

accountNumber

string

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

permissionLevel

enum ( PermissionLevel )

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

organizationInfo

object ( OrganizationInfo )

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

نوع حساب

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

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

نقش حساب

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

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

Verification State

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

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

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

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

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

سطح مجوز

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

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

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

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

نمایندگی JSON 
{
  "registeredDomain": string,
  "address": {
    object (PostalAddress)
  },
  "phoneNumber": string
}
فیلدها
registeredDomain

string

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

address

object ( PostalAddress )

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

phoneNumber

string

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

آدرس پستی

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

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

توصیه‌هایی در مورد ورودی/ویرایش آدرس: - از ویجت آدرس آماده بین‌المللی‌سازی مانند https://github.com/google/libaddressinput استفاده کنید - به کاربران نباید عناصر رابط کاربری برای ورودی یا ویرایش فیلدها در خارج از کشورهایی که آن فیلد وجود دارد ارائه شود. استفاده می شود.

برای راهنمایی بیشتر در مورد نحوه استفاده از این طرح، لطفاً به این آدرس مراجعه کنید: https://support.google.com/business/answer/6397478

نمایندگی JSON 
{
  "revision": integer,
  "regionCode": string,
  "languageCode": string,
  "postalCode": string,
  "sortingCode": string,
  "administrativeArea": string,
  "locality": string,
  "sublocality": string,
  "addressLines": [
    string
  ],
  "recipients": [
    string
  ],
  "organization": string
}
فیلدها
revision

integer

بازبینی طرحواره PostalAddress . این باید روی 0 تنظیم شود که آخرین ویرایش است.

همه ویرایش‌های جدید باید با نسخه‌های قبلی سازگار باشند.

regionCode

string

مورد نیاز. کد منطقه CLDR کشور/منطقه آدرس. این هرگز استنباط نمی شود و اطمینان از صحیح بودن مقدار به عهده کاربر است. برای جزئیات به https://cldr.unicode.org/ و https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html مراجعه کنید. مثال: "CH" برای سوئیس.

languageCode

string

اختیاری. کد زبان BCP-47 محتویات این آدرس (در صورت شناخته شدن). این اغلب زبان رابط کاربری فرم ورودی است یا انتظار می‌رود با یکی از زبان‌های مورد استفاده در کشور/منطقه آدرس یا معادل‌های نویسه‌گردانی شده آنها مطابقت داشته باشد. این می‌تواند بر قالب‌بندی در برخی کشورها تأثیر بگذارد، اما برای صحت داده‌ها حیاتی نیست و هرگز بر روی اعتبارسنجی یا سایر عملیات مرتبط با قالب‌بندی تأثیر نمی‌گذارد.

اگر این مقدار مشخص نیست، باید حذف شود (به جای تعیین یک پیش فرض احتمالاً نادرست).

مثال: "zh-Hant"، "ja"، "ja-Latn"، "en".

postalCode

string

اختیاری. کد پستی آدرس همه کشورها از وجود کدهای پستی استفاده نمی‌کنند یا نیاز به وجود کد پستی ندارند، اما در جایی که از آنها استفاده می‌شود، ممکن است اعتبار سنجی اضافی را با سایر قسمت‌های آدرس (مثلاً اعتبارسنجی ایالت/زیپ در ایالات متحده آمریکا) ایجاد کنند.

sortingCode

string

اختیاری. کد مرتب‌سازی اضافی، خاص کشور. این در اکثر مناطق استفاده نمی شود. در جایی که از آن استفاده می‌شود، مقدار یا رشته‌ای مانند «CEDEX» است، که به صورت اختیاری با یک عدد دنبال می‌شود (مثلاً «CEDEX 7»)، یا فقط یک عدد به تنهایی، نشان‌دهنده «کد بخش» (جامائیکا)، «نشانگر ناحیه تحویل» است. (مالاوی) یا «نشانگر اداره پست» (مثلاً ساحل عاج).

administrativeArea

string

اختیاری. بالاترین بخش اداری که برای آدرس های پستی یک کشور یا منطقه استفاده می شود. به عنوان مثال، این می تواند یک ایالت، یک استان، یک استان یا یک استان باشد. به طور خاص، برای اسپانیا این استان است و نه جامعه خودمختار (مثلاً "بارسلونا" و نه "کاتالونیا"). بسیاری از کشورها از یک منطقه اداری در آدرس های پستی استفاده نمی کنند. به عنوان مثال در سوئیس این باید خالی از سکنه بماند.

locality

string

اختیاری. عموماً به بخش شهر/شهرک آدرس اشاره دارد. مثال: شهر ایالات متحده، کمون فناوری اطلاعات، شهر پست بریتانیا. در مناطقی از جهان که محلی ها به خوبی تعریف نشده اند یا به خوبی در این ساختار قرار نمی گیرند، محلی را خالی بگذارید و از خطوط آدرس استفاده کنید.

sublocality

string

اختیاری. موقعیت فرعی آدرس به عنوان مثال، این می تواند محله، محله، منطقه باشد.

addressLines[]

string

خطوط آدرس بدون ساختار که سطوح پایین یک آدرس را توصیف می کند.

از آنجایی که مقادیر در addressLines اطلاعات نوع ندارند و گاهی اوقات ممکن است حاوی چندین مقدار در یک فیلد واحد باشند (به عنوان مثال "Austin, TX")، واضح بودن ترتیب خطوط مهم است. ترتیب خطوط آدرس باید "سفارش پاکت" برای کشور/منطقه آدرس باشد. در جاهایی که ممکن است متفاوت باشد (مثلاً ژاپن)، address_language برای صریح‌تر کردن آن استفاده می‌شود (مثلاً "ja" برای سفارش بزرگ به کوچک و "ja-Latn" یا "en" برای کوچک به بزرگ). به این ترتیب، مشخص ترین خط یک آدرس را می توان بر اساس زبان انتخاب کرد.

حداقل نمایش ساختاری مجاز یک آدرس شامل یک RegionCode با تمام اطلاعات باقیمانده در خطوط آدرس است. قالب بندی چنین آدرسی تقریباً بدون کدگذاری جغرافیایی امکان پذیر است، اما هیچ استدلال معنایی در مورد هیچ یک از اجزای آدرس نمی توان تا حداقل تا حدی حل شود.

ایجاد آدرسی که فقط شامل یک regionCode و addressLines باشد و سپس geocoding روشی توصیه شده برای مدیریت آدرس‌های کاملاً بدون ساختار است (برخلاف حدس زدن اینکه کدام قسمت‌های آدرس باید محل‌ها یا مناطق اداری باشند).

recipients[]

string

اختیاری. گیرنده در آدرس این فیلد تحت شرایط خاصی ممکن است حاوی اطلاعات چند خطی باشد. به عنوان مثال، ممکن است حاوی اطلاعات "مراقبت از" باشد.

organization

string

اختیاری. نام سازمان در آدرس.

روش ها

create

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

get

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

list

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

patch

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