MCP Tools Reference: paydeveloper.googleapis.com

Alat: list_principals

Mencantumkan prinsipal (pengguna) yang memiliki akses ke penjual tertentu. Operasi ini memerlukan akses Admin untuk penjual.

Contoh kode berikut menunjukkan cara menggunakan curl untuk memanggil alat MCP list_principals.

Permintaan Curl 
curl --location 'https://paydeveloper.googleapis.com/mcp' \
--header 'content-type: application/json' \
--header 'accept: application/json, text/event-stream' \
--data '{
  "method": "tools/call",
  "params": {
    "name": "list_principals",
    "arguments": {
      // Provide these details according to the MCP tool specification.
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

Skema Input

Pesan permintaan untuk mencantumkan prinsipal penjual.

ListPrincipalsRequest

Representasi JSON 
{
  "merchantId": string
}
Kolom
merchantId

string

Wajib. ID penjual yang akan mencantumkan prinsipal.

Skema Output

Pesan respons untuk mencantumkan pemegang akun penjual.

ListPrincipalsResponse

Representasi JSON 
{
  "principals": [
    {
      object (Principal)
    }
  ]
}
Kolom
principals[]

object (Principal)

Akun utama yang memiliki akses ke penjual.

Akun utama

Representasi JSON 
{
  "email": string,
  "displayName": string,
  "role": enum (PrincipalRole),
  "state": enum (State)
}
Kolom
email

string

Wajib. Alamat email kepala sekolah.
displayName

string

Hanya output. Nama tampilan kepala sekolah.
role

enum (PrincipalRole)

Peran akun utama di penjual.
state

enum (State)

Hanya output. Status akses prinsipal di penjual.

PrincipalRole

Peran yang dapat diberikan kepada pokok (pengguna) di penjual.

Enum
PRINCIPAL_ROLE_UNSPECIFIED Peran tidak ditentukan.
ADMIN Akses penuh ke penjual, termasuk mengelola pengguna.
DEVELOPER Akses yang ditujukan untuk developer yang terintegrasi dengan penjual.

Negara bagian/Provinsi

Status akses prinsipal pada penjual.

Enum
STATE_UNSPECIFIED Status akses tidak ditentukan.
ACTIVE Akun utama memiliki akses yang aktif dan diterima.
PENDING Akun utama telah diundang, tetapi belum menerima undangan.
EXPIRED Masa berlaku undangan kepala sekolah telah berakhir.

Anotasi Alat

Anotasi alat dikirim ke klien MCP untuk menjelaskan risiko dasar alat tertentu. Sebagian besar klien memperlakukan petunjuk ini sebagai tidak tepercaya, tetapi petunjuk ini dapat digunakan untuk memutuskan kapan perintah konfirmasi dapat dikirim ke pengguna.

Selain string judul, petunjuk boolean berikut ditentukan sebagai berikut:

  • readOnlyHint: Jika benar, alat tidak akan mengubah lingkungannya. Default: false.
  • destructiveHint: Jika benar (true), alat dapat melakukan tindakan merusak. Jika salah (false), alat hanya dapat melakukan tindakan tambahan. Default: true.
  • idempotentHint: Jika benar (true), memanggil alat berulang kali dengan argumen yang sama tidak akan memberikan efek tambahan pada lingkungannya. Default: false.
  • openWorldHint: Jika benar, alat dapat berinteraksi dengan 'dunia terbuka' entitas eksternal. Jika salah (false), alat hanya dapat berinteraksi dengan entitas internal. Misalnya, alat penelusuran web akan menjadi open world, sedangkan alat memori tidak akan menjadi open world.

Petunjuk Destruktif: ❌ | Petunjuk Idempoten: ✅ | Petunjuk Hanya Baca: ✅ | Petunjuk Dunia Terbuka: ❌