Integrasi API dan Toolkit Code Assist

Gunakan Toolkit Integrasi API dan Code Assist untuk mempercepat migrasi Anda ke Merchant API dan membangun integrasi baru dengan alat pengembangan yang didukung AI.

Ringkasan

Saat bermigrasi dari Content API for Shopping ke Merchant API atau membuat integrasi baru, Anda perlu memahami struktur layanan, nama resource, dan metode baru. Alat pengembangan yang didukung AI sangat cocok untuk membantu operasi berikut:

  • Terjemahan dan migrasi kode: Membantu Anda memahami dan mengonversi kode Content API for Shopping lama ke format Merchant API baru. Hal ini mencakup memetakan atribut produk ke struktur baru dan memperbarui file pengelolaan dependensi.
  • Keahlian dokumentasi API: Memberikan penjelasan yang jelas tentang resource, metode, kolom, kuota, dan praktik terbaik Merchant API berdasarkan konteks tepercaya dari dokumentasi API resmi Google.
  • Pembuatan kode: Membuat cuplikan kode untuk berbagai tugas Merchant API dalam bahasa termasuk Python, Java, PHP, dan bahasa lainnya.
  • Pemecahan masalah: Membantu mendiagnosis dan memperbaiki error API umum.

Pilih opsi yang paling sesuai dengan lingkungan pengembangan dan kasus penggunaan spesifik Anda. Gunakan Toolkit Integrasi API dan Code Assist untuk menyesuaikan penyiapan dengan alur kerja pilihan Anda:

Diagram berikut mengilustrasikan opsi penyiapan untuk migrasi kode yang dibantu AI di seluruh Lingkungan Pengembangan Terintegrasi (IDE) yang paling umum digunakan seperti Antigravity, Visual Studio Code, Cursor, atau Copilot. Anda dapat menyiapkan asisten coding seperti Gemini, Claude, ChatGPT, Grok, dan memberdayakannya dengan server MCP Dokumentasi Developer Merchant API atau Keterampilan Agen Merchant API agar lebih kredibel sekaligus meningkatkan kecepatan integrasi.

(Merchant API) Diagram AI Integration Code Assist

Dokumentasi Developer Merchant API MCP Server

Dapatkan kecerdasan kontekstual tentang Merchant API dari asisten coding pilihan Anda. Dalam IDE, Anda kini dapat mengakses dokumentasi developer menggunakan layanan Model Context Protocol (MCP). Layanan ini menyediakan informasi penting dari dokumentasi resmi Google API ke asisten coding Anda. Untuk mengetahui informasi selengkapnya tentang protokol itu sendiri, lihat standar Model Context Protocol.

Cara kerjanya

Saat Anda mengajukan pertanyaan tentang Merchant API kepada asisten coding IDE yang mendukung MCP, layanan akan mengambil cuplikan teks dan kode yang paling relevan dari sumber resmi dan menampilkannya sebagai konteks kepada asisten coding Anda menggunakan backend Pembuatan yang Didukung Pengambilan (RAG) khusus. Sistem RAG adalah sistem yang meningkatkan kualitas respons dari LLM dengan menghubungkannya ke sumber pengetahuan eksternal yang terbaru. Hal ini memungkinkan asisten Anda memberikan jawaban yang akurat dan terbaru tanpa Anda perlu keluar dari lingkungan pengembangan.

Contoh alur kerja:

  1. Anda mengajukan pertanyaan di asisten coding atau Agen yang kompatibel dengan MCP (misalnya, pertanyaan bahasa alami, permintaan contoh kode, atau terjemahan kode).
  2. Asisten coding Anda mengirimkan permintaan konteks ke endpoint MCP.
  3. Layanan MCP menelusuri kumpulan dokumentasi, panduan, dan contoh kode Merchant API resmi yang diindeksnya.
  4. Layanan ini menampilkan cuplikan resmi sebagai konteks untuk asisten pengodean Anda.
  5. Asisten coding Anda memanfaatkan konteks ini untuk menghasilkan jawaban yang berdasar atau tugas terjemahan kode.

Memulai

Untuk mengintegrasikan dan menggunakan MCP, ikuti langkah-langkah berikut:

1. Menggunakan alat yang kompatibel

Buka IDE atau asisten coding yang mendukung Model Context Protocol dengan transportasi HTTP yang dapat di-streaming.

2. Mengonfigurasi endpoint

Untuk menghubungkan IDE atau asisten coding Anda ke MCP, gunakan detail endpoint jarak jauh yang disediakan yang mungkin mengharuskan Anda memasukkan URL layanan langsung atau definisi MCP, bergantung pada konfigurasi alat Anda:

Penyiapan konfigurasi:

Antigravity

Ikuti petunjuk di dokumentasi Antigravity.

"mcpServers": {
  "mapi-devdocs": {
    "command": "npx",
    "args": [
      "-y",
      "mcp-remote",
      "https://merchantapi.googleapis.com/devdocs/mcp"
    ]
  }
}

Visual Studio Code

Ikuti petunjuk di dokumentasi Visual Studio Code.

"servers": {
"mapi-devdocs": {
  "type": "http",
  "url": "https://merchantapi.googleapis.com/devdocs/mcp/"
  }
}

3. Menambahkan petunjuk agen (opsional)

Untuk memungkinkan agen Anda menerjemahkan kode secara langsung menggunakan MCP, berikan Petunjuk Sistem: Merchant Integrator Agent Protocol. Petunjuk ini memandu agen tentang cara menggunakan MCP dengan benar untuk terjemahan kode. Bergantung pada alat Anda, Anda dapat memberikan petunjuk ini baik dalam konfigurasi petunjuk sistem atau sebagai file konteks tambahan untuk agen.

Contoh skenario penggunaan

MCP dapat mempercepat alur kerja Anda dalam kasus penggunaan umum berikut:

Skenario 1: Memigrasikan kode products.insert

Anda dapat meminta agen untuk langsung memigrasikan kode integrasi Content API for Shopping products.insert ke Merchant API.

Perintah pengguna:

"Migrasikan kode products.insert ke Merchant API"

Dengan memberikan petunjuk sistem dan akses ke MCP kepada agen, agen Anda dapat menerjemahkan kode Content API for Shopping ke kode Merchant API langsung di IDE Anda. Dalam hal ini, productInputs.insert akan diidentifikasi sebagai panggilan yang setara dan memetakan atribut produk dari format lama ke format baru yang diperlukan oleh Merchant API. Agen ini juga dapat memperbarui impor yang diperlukan dan file pengelolaan dependensi (misalnya requirements.txt, pom.xml, atau package.json). Anda dapat menginstruksikan agen untuk melakukan perubahan di tempat atau membuat folder baru.

Skenario 2: Menemukan fungsi yang setara

Anda memiliki aplikasi yang sudah ada menggunakan Content API for Shopping dan perlu mengupdatenya. Anda dapat bertanya tentang metode lama tertentu untuk mendapatkan detail tentang penerapan baru dan contoh kode yang relevan.

Perintah pengguna:

"Apa padanan Merchant API untuk metode accountstatuses.get di Content API for Shopping?"

Layanan MCP memberikan konteks dari panduan migrasi resmi dan dokumentasi referensi, sehingga asisten Anda dapat merespons dengan jawaban mendetail, termasuk nama API baru, accounts.issues.

Skenario 3: Menemukan contoh kode

Anda sedang menerapkan fitur baru dan memerlukan contoh praktis untuk diikuti.

Perintah pengguna:

"Tunjukkan contoh kode Python untuk menambahkan layanan pengiriman baru menggunakan Merchant API."

Layanan MCP mengambil contoh kode yang relevan dari repositori dan panduan developer Google GitHub resmi. Kemudian, asisten Anda dapat menyajikan blok kode yang lengkap dan siap disesuaikan.

Skenario 4: Memahami konsep API

Anda menemukan konsep baru atau ingin memahami struktur resource atau pola Merchant API secara keseluruhan.

Perintah pengguna:

"Bagaimana cara memperbarui inventaris produk menggunakan Merchant API?"

Layanan MCP menampilkan konteks dari dokumentasi resource produk dan panduan yang relevan. Kemudian, asisten Anda dapat menjelaskan cara menggunakan metode accounts.productInputs.insert dan memberikan resource produk parsial yang hanya berisi productId dan kolom terkait inventaris yang perlu Anda perbarui.

"Bagaimana cara mengizinkan panggilan aplikasi saya dengan Merchant API?"

Layanan MCP mengambil konteks dari panduan autentikasi resmi, yang mencakup berbagai metode otorisasi. Kemudian, asisten Anda dapat menjelaskan opsi utama yang tersedia, seperti menggunakan akun layanan untuk interaksi server ke server atau ID klien OAuth 2.0 saat bertindak atas nama pengguna.

Skenario 5: Beradaptasi dengan perubahan API

Merchant API memperkenalkan pola baru — seperti permintaan batch — yang berbeda dari Content API for Shopping. Content API for Shopping menggunakan metode custombatch tertentu, sedangkan Merchant API menggunakan fitur batching HTTP generik bawaan.

Perintah pengguna:

"Apa cara baru untuk melakukan products.custombatch di Merchant API?"

Layanan MCP mengambil konteks dari Refactor code for concurrent requests yang menjelaskan bahwa metode custombatch khusus tidak ada di Merchant API. Sebagai gantinya, dokumen ini memberikan dokumentasi tentang penggunaan batch HTTP dengan Content-Type multipart. Kemudian, asisten Anda dapat menjelaskan cara membuat satu permintaan HTTP yang berisi beberapa panggilan API, yang dikirim ke endpoint https://merchantapi.googleapis.com/batch/{sub-api}/v1, dan memberikan contoh cara menyusun permintaan multipart. Hal ini mengubah tugas migrasi yang berpotensi membingungkan menjadi proses terpandu.

Skenario 6: Menerjemahkan kueri pelaporan

Anda dapat meminta agen untuk menerjemahkan kueri pelaporan dari Content API for Shopping ke Merchant API.

Perintah pengguna:

"Migrasikan kueri pelaporan ini dari Content API ke Merchant API: SELECT metrics.impressions, metrics.clicks, metrics.ctr FROM MerchantPerformanceView WHERE segments.date BETWEEN '2020-12-01' AND '2020-12-30'"

Layanan MCP mengambil dokumentasi referensi pelaporan, panduan developer, dan panduan migrasi terbaru. Berdasarkan informasi ini, kueri diubah ke struktur baru dan kolom diperbarui ke nama dan nilai barunya.

Keahlian Agen Merchant API

Spesifikasi Keterampilan Agen adalah standar terbuka yang diterapkan di seluruh alat pengembangan AI. Gunakan Keterampilan Agen untuk meningkatkan pengalaman developer Anda dan mengoptimalkan keduanya, dengan bermigrasi dari Content API for Shopping dan membangun integrasi baru. Paket Keterampilan Agen Merchant API menggabungkan pengetahuan dan alat khusus domain untuk meningkatkan kemampuan agen AI dan memberikan bantuan pakar sesuai permintaan untuk kueri dokumentasi, pembuatan kode, dan pemecahan masalah.

Keterampilan Agen Merchant API kompatibel dengan berbagai alat dan IDE command line yang didukung AI seperti Gemini dan Claude Code.

Cara kerjanya

Keahlian Agen Merchant API menyediakan paket keahlian khusus yang dibangun berdasarkan standar Keahlian Agen terbuka. Keterampilan agen kami mapi-developer-assistant berfungsi sebagai lapisan cerdas antara alat pengembangan AI Anda dan Server MCP Dokumen Dev API Merchant yang mendasarinya. Panduan ini menyematkan keahlian domain dan panduan prosedural, dengan properti berikut:

  • Konfigurasi Nol: Mengelola koneksi Server MCP secara otomatis, sehingga tidak perlu penyiapan endpoint secara manual.
  • Alur Kerja Pakar: Memperbaiki perintah pengguna menjadi kueri yang dioptimalkan untuk mengambil informasi yang paling relevan secara efektif.
  • Pengelolaan Konteks & Efisiensi Token: Menggunakan "Pengungkapan Progresif" untuk memuat informasi sesuai permintaan dan mempertahankan jendela konteks AI.
  • Peningkatan Pemformatan Output: Memberikan petunjuk untuk memformat dan menyusun output agar respons dapat ditindaklanjuti, mudah dibaca, dan konsisten.

Contoh alur kerja:

  1. Anda mengajukan pertanyaan tentang Merchant API di alat pengembangan AI.
  2. Keahlian Agen Merchant API menganalisis maksud Anda, merumuskan kueri yang tepat, dan menerapkan pengetahuan proseduralnya pada permintaan.
  3. Agent Skill mengirim permintaan konteks ke Server MCP Dokumen Dev API Penjual yang berada di merchantapi.googleapis.com/devdocs/mcp/.
  4. Layanan MCP menelusuri kumpulan dokumentasi, panduan, dan contoh kode Merchant API resmi yang diindeksnya.
  5. Agen AI Anda memanfaatkan informasi ini untuk memberikan respons yang disintesis dan dapat ditindaklanjuti.

Memulai

README Keterampilan Agen Merchant API memberikan panduan langkah demi langkah tentang:

  • Prasyarat untuk alat seperti alat command line Gemini.
  • Mengaktifkan dukungan Kemampuan Agen di alat pilihan Anda.
  • Menginstal skill mapi-developer-assistant dari repositori GitHub seperti yang dijelaskan dalam README.
  • Memverifikasi penginstalan.
  • Perintah pengelolaan keahlian dasar.

Untuk petunjuk penginstalan dan penyiapan mendetail untuk berbagai alat AI, termasuk alat command line Gemini, Claude Code, dan lainnya, ikuti panduan dari file README.

Contoh perintah

Setelah diinstal dan diaktifkan di alat pengembangan AI Anda, skill mapi-developer-assistant biasanya diaktifkan secara otomatis saat Anda mengajukan pertanyaan terkait Merchant API.

"Bagaimana cara menyisipkan produk menggunakan Merchant API di Python?"

"Apa metode Merchant API yang setara dengan metode Content API accountstatuses.get ?"

"Tunjukkan contoh Java untuk menangani autentikasi dengan Merchant API."

"Saya mendapatkan '400 Bad Request' dengan error validasi saat memanggil productInputs.insert. Bagaimana cara memperbaikinya?"

"Apa perbedaan antara ProductInput dan Product di Merchant API?"

Sumber pusat informasi

Layanan MCP membangun pusat informasinya secara eksklusif dari sumber publik dan resmi untuk memastikan konteks yang diberikannya akurat dan andal. Layanan ini mengindeks seluruh konten situs developer resmi dan repositori contoh kode, termasuk: