Menangani error API

Saat Anda mengirim permintaan ke Google Ads API, permintaan tersebut mungkin gagal karena berbagai alasan. Misalnya, Anda mungkin memberikan argumen yang tidak valid, atau akun Anda mungkin telah mencapai batasnya untuk membuat kampanye baru. Dalam kasus seperti itu, API akan menampilkan error untuk memberi tahu Anda apa yang salah.

Panduan ini menjelaskan cara membaca dan menangani error API sehingga Anda dapat membuat aplikasi yang lebih andal.

Struktur error

Jika Anda menggunakan salah satu library klien kami, error API akan ditampilkan sebagai pengecualian. Pengecualian ini berisi detail yang membantu Anda memahami penyebab terjadinya error.

Google Ads API menampilkan informasi error dalam format standar. Jika terjadi kesalahan, respons akan berisi objek GoogleAdsFailure. Objek ini berisi daftar objek GoogleAdsError individual, yang masing-masing menjelaskan error tertentu.

Setiap objek GoogleAdsError menyediakan:

• error_code: Kode error spesifik yang memberi tahu Anda jenis error, seperti AuthenticationError.NOT_ADS_USER.
• message: Deskripsi yang dapat dibaca manusia tentang alasan terjadinya error.
• trigger: Nilai yang menyebabkan kesalahan, seperti "1234".
• location: Detail tentang bagian permintaan yang menyebabkan error, seperti nama kolom tertentu.

Selain daftar error, GoogleAdsFailure berisi requestId, yang merupakan ID unik untuk permintaan API yang menyebabkan error.

Contoh error

Berikut adalah contoh tampilan error dalam format JSON. Error ini menunjukkan bahwa kolom name dari ad_group pada indeks 0 tidak ada dalam permintaan.

{
  "code": 3,
  "message": "Request contains an invalid argument.",
  "details": [
    {
      "@type": "type.googleapis.com/google.ads.googleads.v22.errors.GoogleAdsFailure",
      "errors": [
        {
          "errorCode": {
            "requestError": "REQUIRED_FIELD_MISSING"
          },
          "message": "Required field is missing",
          "location": {
            "fieldPathElements": [
              {
                "fieldName": "ad_group",
                "index": 0
              },
              {
                "fieldName": "name"
              }
            ]
          }
        }
      ],
      "requestId": "unique_request_id_12345"
    }
  ]
}

Cara menangani error

Jika Anda mengalami error, berikut langkah-langkah yang harus dilakukan:

1. Periksa daftar errors: Lihat setiap GoogleAdsError dalam objek GoogleAdsFailure. error_code dan message akan memberi tahu Anda apa yang salah.
2. Periksa location: Kolom location dapat membantu Anda menentukan di bagian mana dalam permintaan Anda masalah terjadi.
3. Lihat dokumentasi: Untuk kode error tertentu, periksa halaman kesalahan umum atau referensi kode error lengkap untuk mengetahui detail selengkapnya tentang error dan cara memperbaikinya.
4. Sesuaikan permintaan Anda: Berdasarkan pesan error, perbaiki permintaan API Anda. Misalnya, jika Anda melihat REQUIRED_FIELD_MISSING, pastikan Anda memberikan kolom tersebut dalam permintaan Anda.
5. Mencatat request_id: Jika Anda tidak dapat mengetahui cara menyelesaikan error dan perlu menghubungi dukungan melalui forum, sertakan request_id. ID ini membantu engineer Google menyelidiki masalah Anda.

Langkah berikutnya

• Tinjau Error Umum untuk mengetahui daftar masalah yang sering terjadi dan solusinya.
• Untuk teknik penanganan error yang lebih canggih, termasuk logika coba lagi dan kegagalan sebagian, lihat Memahami Error API.