Header Respons dan Permintaan XML SOAP

Halaman ini menyediakan informasi tentang header permintaan XML SOAP yang diperlukan, dan header yang dihasilkan sebagai respons.

Header Permintaan yang Diperlukan

Semua panggilan SOAP API harus memiliki elemen <RequestHeader> di header; elemen ini didefinisikan di semua WSDL layanan. Library klien menyediakan menambahkan header ini untuk Anda, menggunakan nilai yang Anda berikan. Berikut adalah deskripsi semua elemen <RequestHeader>:

Elemen Deskripsi
<networkCode>

Kode jaringan dari jaringan yang akan ditangani. Kode jaringan diperlukan saat membuat semua permintaan kecuali NetworkService.getAllNetworks() dan NetworkService.makeTestNetwork().

Pastikan bahwa Anda hanya menggunakan kode jaringan yang tersedia untuk login akun Anda. Anda dapat menemukan kode tersebut di situs Google Ad Manager untuk akun Anda, di Admin > Halaman Setelan Jaringan di samping "Kode jaringan".
<applicationName> Nama string arbitrer yang mengidentifikasi aplikasi Anda. Nama ini akan ditampilkan di file log Google. Misalnya: "Inventaris Saya Aplikasi" atau "App_1".

Catatan: Setiap permintaan yang dikirimkan aplikasi Anda ke Ad Manager API harus menyertakan token akses OAuth2. Teruskan token di header HTTP sebagai: Authorization: Bearer YOUR_ACCESS_TOKEN.

Contoh Permintaan

Kode berikut adalah contoh panggilan permintaan SOAP ke getAdUnitsByStatement() yang mencari AdUnit root.

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope
        xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
        xmlns:xsd="http://www.w3.org/2001/XMLSchema"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soapenv:Header>
    <ns1:RequestHeader
         soapenv:actor="http://schemas.xmlsoap.org/soap/actor/next"
         soapenv:mustUnderstand="0"
         xmlns:ns1="https://www.google.com/apis/ads/publisher/v202408">
      <ns1:networkCode>123456</ns1:networkCode>
      <ns1:applicationName>DfpApi-Java-2.1.0-dfp_test</ns1:applicationName>
    </ns1:RequestHeader>
  </soapenv:Header>
  <soapenv:Body>
    <getAdUnitsByStatement xmlns="https://www.google.com/apis/ads/publisher/v202408">
      <filterStatement>
        <query>WHERE parentId IS NULL LIMIT 500</query>
      </filterStatement>
    </getAdUnitsByStatement>
  </soapenv:Body>
</soapenv:Envelope>

Catatan: Jika permintaan SOAP Anda menyebabkan Unmarshalling error, lihat Error Umum untuk mengetahui tips pemecahan masalah.

Header Respons

Semua respons yang ditampilkan dari API menyertakan elemen header berikut. Sebagai praktik terbaik, kami menyarankan Anda mencatat nilai-nilai tersebut.

Elemen Deskripsi
<requestId> Secara unik mengidentifikasi permintaan ini. Jika Anda mengalami masalah dukungan, mengirim ID ini akan memudahkan kami menemukan permintaan Anda.
<responseTime> Waktu berlalu antara layanan web yang menerima permintaan dan mengirim yang dihasilkan.

Contoh Respons

Kode berikut menunjukkan contoh respons SOAP untuk permintaan sebelumnya.

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <ResponseHeader xmlns="https://www.google.com/apis/ads/publisher/v202408">
      <requestId>xxxxxxxxxxxxxxxxxxxx</requestId>
      <responseTime>1063</responseTime>
    </ResponseHeader>
  </soap:Header>
  <soap:Body>
    <getAdUnitsByStatementResponse xmlns="https://www.google.com/apis/ads/publisher/v202408">
      <rval>
        <totalResultSetSize>1</totalResultSetSize>
        <startIndex>0</startIndex>
        <results>
          <id>2372</id>
          <name>RootAdUnit</name>
          <description></description>
          <targetWindow>TOP</targetWindow>
          <status>ACTIVE</status>
          <adUnitCode>1002372</adUnitCode>
          <inheritedAdSenseSettings>
            <value>
              <adSenseEnabled>true</adSenseEnabled>
              <borderColor>FFFFFF</borderColor>
              <titleColor>0000FF</titleColor>
              <backgroundColor>FFFFFF</backgroundColor>
              <textColor>000000</textColor>
              <urlColor>008000</urlColor>
              <adType>TEXT_AND_IMAGE</adType>
              <borderStyle>DEFAULT</borderStyle>
              <fontFamily>DEFAULT</fontFamily>
              <fontSize>DEFAULT</fontSize>
            </value>
          </inheritedAdSenseSettings>
        </results>
      </rval>
    </getAdUnitsByStatementResponse>
  </soap:Body>
</soap:Envelope>