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

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

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

คำแนะนำเกี่ยวกับการป้อน / แก้ไขที่อยู่: - ใช้วิดเจ็ตที่อยู่ที่พร้อมสำหรับการใช้งานให้เป็นสากล เช่น 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

ไม่บังคับ โดยทั่วไปจะหมายถึงส่วนของเมือง/จังหวัดของที่อยู่ ตัวอย่าง: เมืองในสหรัฐอเมริกา ชุมชนด้านไอที เมืองตามเขตไปรษณีย์ของสหราชอาณาจักร ในภูมิภาคของโลกซึ่งมีการกำหนดย่านไม่ถูกต้องหรือไม่อยู่ในโครงสร้างนี้ ให้ปล่อยตำแหน่งว่างไว้และใช้ addressLines
sublocality

string

ไม่บังคับ สถานที่ตั้งย่อยของที่อยู่ ซึ่งอาจเป็นย่านใกล้เคียง เขตเมือง เขต
addressLines[]

string

บรรทัดที่อยู่ที่ไม่มีโครงสร้างซึ่งอธิบายถึงที่อยู่ในระดับที่ต่ำกว่า

เนื่องจากค่าใน addressLines ไม่มีข้อมูลประเภท และบางครั้งอาจมีค่าหลายค่าในช่องเดียว (เช่น "Austin, TX") จึงจำเป็นต้องมีลำดับบรรทัดที่ชัดเจน ลำดับของบรรทัดที่อยู่ควรเป็น "ลำดับเอนเวโลป" สำหรับประเทศ/ภูมิภาคของที่อยู่ ซึ่งในที่ต่างๆ ที่อาจแตกต่างกัน (เช่น ญี่ปุ่น) address_language จะใช้เพื่อทำให้ชัดเจน (เช่น "ja" สำหรับลำดับจากขนาดใหญ่ไปเล็ก และ "ja-Latn" หรือ "en" สำหรับขนาดเล็กไปใหญ่) วิธีนี้จะทำให้บรรทัดของที่อยู่ที่เฉพาะเจาะจงมากที่สุดสามารถเลือกตามภาษาได้

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

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

string

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

string

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

วิธีการ

create

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

get

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

list

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

patch

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