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)

เอาต์พุตเท่านั้น ระบุบทบาทของบัญชีของบัญชีนี้
verificationState

enum (VerificationState)

เอาต์พุตเท่านั้น หากได้รับการยืนยัน สถานที่ในอนาคตที่สร้างขึ้นจะเชื่อมต่อกับ Google Maps โดยอัตโนมัติ และมีการสร้าง Google+ เพจโดยไม่ต้องมีการกลั่นกรอง
vettedState

enum (VettedState)

เอาต์พุตเท่านั้น ระบุว่าบัญชีได้รับการตรวจสอบโดย Google แล้วหรือไม่ บัญชีที่ผ่านการตรวจสอบแล้วจะสามารถยืนยันสถานที่ตั้งโดยใช้วิธีการ VETTED_PARTNER
accountNumber

string

เอาต์พุตเท่านั้น หมายเลขอ้างอิงบัญชี (หากมี)
permissionLevel

enum (PermissionLevel)

เอาต์พุตเท่านั้น ระบุระดับสิทธิ์ที่ผู้ใช้มีสำหรับบัญชีนี้
organizationInfo

object (OrganizationInfo)

เอาต์พุตเท่านั้น ข้อมูลเพิ่มเติมสำหรับองค์กร ข้อมูลนี้เป็นข้อมูลสำหรับบัญชีขององค์กรเท่านั้น

AccountType

ระบุประเภทของบัญชีนี้ อันได้แก่ บัญชีส่วนตัว/บัญชีผู้ใช้ หรือบัญชีธุรกิจ

Enum
ACCOUNT_TYPE_UNSPECIFIED ไม่ได้ระบุ
PERSONAL บัญชีผู้ใช้ปลายทาง
LOCATION_GROUP กลุ่มสถานที่ตั้ง ดูข้อมูลเพิ่มเติมได้ที่บทความในศูนย์ช่วยเหลือ
USER_GROUP กลุ่มผู้ใช้สำหรับแยกเจ้าหน้าที่ขององค์กรเป็นกลุ่ม ดูข้อมูลเพิ่มเติมได้ที่บทความในศูนย์ช่วยเหลือ
ORGANIZATION องค์กรที่เป็นตัวแทนของบริษัท ดูข้อมูลเพิ่มเติมได้ที่บทความในศูนย์ช่วยเหลือ

AccountRole

ระบุระดับการเข้าถึงที่ผู้ใช้ซึ่งผ่านการตรวจสอบสิทธิ์แล้วมีสำหรับบัญชีนี้ ดูข้อมูลเพิ่มเติมได้ที่บทความในศูนย์ช่วยเหลือ

Enum
ACCOUNT_ROLE_UNSPECIFIED ไม่ได้ระบุ
PRIMARY_OWNER ผู้ใช้เป็นเจ้าของหลักของบัญชีนี้
OWNER ผู้ใช้ที่เป็นเจ้าของบัญชี
MANAGER ผู้ใช้จัดการบัญชีนี้ได้
SITE_MANAGER ผู้ใช้จะจัดการชุดฟีเจอร์ที่จำกัดในบัญชีได้

VerificationState

ระบุสถานะการยืนยันของบัญชี

Enum
VERIFICATION_STATE_UNSPECIFIED ไม่ได้ระบุ
VERIFIED บัญชีที่ได้รับการยืนยัน
UNVERIFIED บัญชีที่ไม่ได้รับการยืนยัน และยังไม่มีคำขอการยืนยัน
VERIFICATION_REQUESTED บัญชีที่ไม่ได้รับการยืนยัน แต่ได้รับคำขอการยืนยัน

VettedState

ระบุสถานะการตรวจสอบแล้วของบัญชี

Enum
VETTED_STATE_UNSPECIFIED ไม่ได้ระบุ
NOT_VETTED บัญชีไม่ได้ผ่านการตรวจสอบโดย Google
VETTED บัญชีได้รับการตรวจสอบโดย Google และอยู่ในสถานะที่ถูกต้อง บัญชีจะได้รับการตรวจสอบโดยอัตโนมัติหากบัญชีมีสิทธิ์เข้าถึงโดยตรงในบัญชีกลุ่มที่ได้รับการตรวจสอบแล้ว
INVALID บัญชีผ่านการตรวจสอบแล้วแต่อยู่ในสถานะที่ไม่ถูกต้อง บัญชีจะมีลักษณะการทำงานเหมือนบัญชีที่ยังไม่ได้ตรวจสอบ

PermissionLevel

ระบุระดับการเข้าถึงที่ผู้ใช้ซึ่งผ่านการตรวจสอบสิทธิ์แล้วมีสำหรับบัญชีนี้

Enum
PERMISSION_LEVEL_UNSPECIFIED ไม่ได้ระบุ
OWNER_LEVEL ผู้ใช้มีสิทธิ์ระดับเจ้าของ
MEMBER_LEVEL ผู้ใช้มีสิทธิ์ระดับสมาชิก

OrganizationInfo

ข้อมูลเพิ่มเติมที่จัดเก็บไว้สำหรับองค์กร

การแสดง JSON 
{
  "registeredDomain": string,
  "address": {
    object (PostalAddress)
  },
  "phoneNumber": string
}
ช่อง
registeredDomain

string

เอาต์พุตเท่านั้น โดเมนที่ลงทะเบียนสำหรับบัญชี
address

object (PostalAddress)

เอาต์พุตเท่านั้น ที่อยู่ไปรษณีย์ของบัญชี
phoneNumber

string

เอาต์พุตเท่านั้น หมายเลขติดต่อขององค์กร

PostalAddress

แสดงที่อยู่ไปรษณีย์ เช่น สำหรับที่อยู่ไปรษณีย์หรือที่อยู่การชำระเงิน หากใช้ที่อยู่ไปรษณีย์ บริการไปรษณีย์จะนำส่งสินค้าไปยังสถานที่ตั้งของ P.O ได้ กล่องหรือสิ่งอื่นที่คล้ายกัน ไม่ได้มีไว้เพื่อสร้างแบบจำลองตำแหน่งทางภูมิศาสตร์ (ถนน เมือง ภูเขา)

ในการใช้งานโดยทั่วไป ที่อยู่จะสร้างขึ้นผ่านข้อมูลจากผู้ใช้หรือจากการนำเข้าข้อมูลที่มีอยู่ ทั้งนี้ขึ้นอยู่กับประเภทของกระบวนการ

คำแนะนำเกี่ยวกับการป้อน / การแก้ไขที่อยู่: - ใช้วิดเจ็ตที่อยู่ที่รองรับการปรับให้เป็นสากล เช่น https://github.com/google/libaddressinput) - ผู้ใช้ไม่ควรแสดงองค์ประกอบ UI สำหรับการป้อนหรือแก้ไขช่องนอกประเทศที่ใช้ช่องนั้น

ดูคำแนะนำเพิ่มเติมเกี่ยวกับวิธีใช้สคีมานี้ได้ที่ 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 ของเนื้อหาในที่อยู่นี้ (หากทราบ) ซึ่งมักเป็นภาษา UI ของแบบฟอร์มอินพุต หรือคาดว่าจะตรงกับภาษาใดภาษาหนึ่งที่ใช้ในที่อยู่ ประเทศ/ภูมิภาค หรือคำทับศัพท์ที่เทียบเท่า ซึ่งอาจส่งผลต่อการจัดรูปแบบในบางประเทศ แต่ไม่สำคัญต่อความถูกต้องของข้อมูล และจะไม่ส่งผลต่อการตรวจสอบความถูกต้องหรือการดำเนินการอื่นๆ ที่ไม่เกี่ยวข้องกับการจัดรูปแบบ

หากไม่ทราบค่านี้ ก็ควรละเว้น (แทนที่จะระบุค่าเริ่มต้นที่อาจไม่ถูกต้อง)

เช่น "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" สำหรับเล็กไปใหญ่) วิธีนี้จะช่วยให้เลือกบรรทัดของที่อยู่ที่เจาะจงที่สุดตามภาษาได้

การแสดงโครงสร้างต่ำสุดที่ได้รับอนุญาตของที่อยู่ประกอบด้วยรหัสภูมิภาคพร้อมกับข้อมูลที่เหลืออยู่ทั้งหมดในบรรทัดที่อยู่ รูปแบบที่อยู่เช่นนี้สามารถทำได้อย่างคร่าวๆ โดยไม่ต้องมีการเข้ารหัสพิกัดภูมิศาสตร์ แต่ไม่มีการให้เหตุผลเชิงความหมายเกี่ยวกับองค์ประกอบที่อยู่ใดๆ จนกว่าจะได้รับการแก้ไขบางส่วนเป็นอย่างน้อย

การสร้างที่อยู่ที่มีเพียงรหัสภูมิภาคและบรรทัดที่อยู่ การใช้รหัสพิกัดภูมิศาสตร์เป็นวิธีที่แนะนำในการจัดการที่อยู่ที่ไม่มีโครงสร้างโดยสิ้นเชิง (แทนที่จะคาดเดาว่าส่วนใดของที่อยู่ควรเป็นย่านหรือเขตบริหาร)
recipients[]

string

ไม่บังคับ ผู้รับในที่อยู่ ในบางกรณี ช่องนี้อาจมีข้อมูลหลายบรรทัด เช่น อาจมีคำว่า "ดูแล"

organization

string

ไม่บังคับ ชื่อขององค์กรตามที่อยู่

เมธอด

create

 สร้างบัญชีที่มีชื่อและประเภทที่ระบุภายใต้รายการหลักที่ระบุ

get

 รับบัญชีที่ระบุ

list

 แสดงบัญชีทั้งหมดของผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว

patch

 อัปเดตบัญชีธุรกิจที่ระบุ