Package google.mybusiness.accountmanagement.v1

ดัชนี

AccessControl

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

AcceptInvitation

rpc AcceptInvitation(AcceptInvitationRequest) returns (Empty)

ยอมรับคำเชิญที่ระบุไว้

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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

ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมของ OAuth 2.0

CreateAccountAdmin

rpc CreateAccountAdmin(CreateAccountAdminRequest) returns (Admin)

เชิญผู้ใช้ที่ระบุให้เป็นผู้ดูแลระบบของบัญชีที่ระบุ ผู้ได้รับเชิญต้องยอมรับคำเชิญจึงจะได้รับสิทธิ์เข้าถึงบัญชี โปรดดูที่ [ยอมรับคำเชิญ] [google.mybusiness.accountmanagement.v1.ตอบรับคำเชิญ] เพื่อยอมรับคำเชิญทางโปรแกรม

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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

ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมของ OAuth 2.0

CreateLocationAdmin

rpc CreateLocationAdmin(CreateLocationAdminRequest) returns (Admin)

เชิญผู้ใช้ที่ระบุให้เป็นผู้ดูแลระบบสถานที่ที่ระบุ ผู้ได้รับเชิญต้องยอมรับคำเชิญจึงจะมีสิทธิ์เข้าถึงสถานที่ได้ ดู [ยอมรับคำเชิญ] [google.mybusiness.accountmangement.v1.ยอมรับคําเชิญ] เพื่อยอมรับคำเชิญทางโปรแกรม

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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

ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมของ OAuth 2.0

DeclineInvitation

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

TransferLocation

rpc TransferLocation(TransferLocationRequest) returns (Empty)

ย้ายสถานที่จากบัญชีที่ผู้ใช้เป็นเจ้าของไปยังบัญชีอื่นที่ผู้ใช้รายเดียวกันดูแลอยู่ ผู้ใช้ต้องเป็นเจ้าของบัญชีที่เชื่อมโยงกับสถานที่ตั้ง และอย่างน้อยต้องเป็นผู้จัดการของบัญชีปลายทาง

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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

ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมของ OAuth 2.0

UpdateAccountAdmin

rpc UpdateAccountAdmin(UpdateAccountAdminRequest) returns (Admin)

อัปเดตผู้ดูแลระบบสำหรับผู้ดูแลบัญชีที่ระบุ

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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

ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมของ OAuth 2.0

UpdateLocationAdmin

rpc UpdateLocationAdmin(UpdateLocationAdminRequest) returns (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

CreateAccount

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

UpdateAccount

rpc UpdateAccount(UpdateAccountRequest) returns (Account)

อัปเดตบัญชีธุรกิจที่ระบุ ทั้งนี้คุณจะอัปเดตบัญชีส่วนตัวโดยใช้วิธีนี้ไม่ได้

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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

ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมของ OAuth 2.0

AcceptInvitationRequest

ข้อความคำขอสำหรับ AccessControl.ตอบรับคำเชิญ

ช่อง
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

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

verification_state

VerificationState

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

vetted_state

VettedState

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

account_number

string

เอาต์พุตเท่านั้น หมายเลขอ้างอิงบัญชี หากมีการจัดสรร

permission_level

PermissionLevel

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

organization_info

OrganizationInfo

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

AccountRole

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

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

AccountType

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

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

OrganizationInfo

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

ช่อง
registered_domain

string

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

address

PostalAddress

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

phone_number

string

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

PermissionLevel

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

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

VerificationState

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

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

VettedState

ระบุสถานะที่ผ่านการตรวจสอบของบัญชี

Enum
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

เปลี่ยนแปลงไม่ได้ ชื่อของทรัพยากรบัญชีที่ผู้ดูแลระบบนี้อ้างถึง ใช้เมื่อเรียกใช้ location.admins.create เพื่อเชิญกลุ่มสถานที่ตั้งให้เป็นผู้ดูแลระบบ

หากตั้งค่าทั้งช่องนี้และ admin ในคำขอ CREATE ช่องนี้จะมีความสำคัญเหนือกว่า และอีเมลใน admin จะไม่มีผล

รูปแบบ: accounts/{account}

role

AdminRole

ต้องระบุ กำหนดบทบาทที่ผู้ดูแลระบบใช้กับบัญชีหรือสถานที่ที่ระบุ

pending_invitation

bool

เอาต์พุตเท่านั้น ระบุว่าผู้ดูแลระบบรายนี้มีคำเชิญที่รอดำเนินการสำหรับทรัพยากรที่ระบุหรือไม่

AdminRole

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

Enum
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.RejectedInvite

ช่อง
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

สถานที่เป้าหมายที่คำเชิญนี้ใช้

TargetLocation

แสดงสถานที่เป้าหมายสำหรับคำเชิญที่รอดำเนินการ

ช่อง
location_name

string

ชื่อของสถานที่ที่ผู้ใช้ได้รับเชิญ

address

string

ที่อยู่ของสถานที่ตั้งที่เชิญผู้ใช้ไป

TargetType

ประเภทของเป้าหมายที่คำเชิญมีไว้สำหรับ

Enum
TARGET_TYPE_UNSPECIFIED ตั้งค่าเมื่อไม่ได้ระบุประเภทเป้าหมาย
ACCOUNTS_ONLY แสดงคำเชิญสำหรับเป้าหมายประเภทบัญชีเท่านั้น
LOCATIONS_ONLY แสดงรายการคำเชิญสำหรับเป้าหมายประเภทสถานที่เท่านั้น

ListAccountAdminsRequest

ข้อความคำขอสำหรับ AccessControl.ListAccountAdmins

ช่อง
parent

string

ต้องระบุ ชื่อของบัญชีที่จะใช้เรียกข้อมูลรายการผู้ดูแลระบบ accounts/{account_id}/admins.

ListAccountAdminsResponse

ข้อความตอบกลับสำหรับ AccessControl.ListAccountAdmins

ช่อง
account_admins[]

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.ListInvites

ช่อง
invitations[]

Invitation

คอลเล็กชันของคำเชิญที่รอดำเนินการสำหรับบัญชี จำนวนคำเชิญที่แสดงที่นี่ต้องไม่เกิน 1,000 รายการ

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

ต้องระบุ ชื่อของทรัพยากรบัญชีที่จะโอนสถานที่ไป (เช่น "accounts/{account}")

UpdateAccountAdminRequest

ข้อความคำขอสำหรับ AccessControl.UpdateAccountAdmin

ช่อง
account_admin

Admin

ต้องระบุ Admin เวอร์ชันที่อัปเดตแล้ว

update_mask

FieldMask

ต้องระบุ ช่องเฉพาะที่ควรอัปเดต ช่องเดียวที่แก้ไขได้คือบทบาท

UpdateAccountRequest

ขอข้อความสำหรับ Accounts.UpdateAccount

ช่อง
account

Account

ต้องระบุ บัญชีที่อัปเดต

update_mask

FieldMask

ต้องระบุ ช่องเฉพาะที่ควรอัปเดต ฟิลด์ที่แก้ไขได้เพียงฟิลด์เดียวคือ accountName

validate_only

bool

ไม่บังคับ หากเป็น "จริง" คำขอจะได้รับการตรวจสอบโดยไม่อัปเดตบัญชีจริง

UpdateLocationAdminRequest

ข้อความคำขอสำหรับ AccessControl.UpdateLocationAdmin

ช่อง
location_admin

Admin

ต้องระบุ Admin เวอร์ชันที่อัปเดตแล้ว

update_mask

FieldMask

ต้องระบุ ช่องเฉพาะที่ควรอัปเดต ช่องเดียวที่แก้ไขได้คือบทบาท