عناوين طلب واستجابة SOAP بتنسيق XML

توفر هذه الصفحة معلومات حول عناوين طلب SOAP XML المطلوبة، والعناوين التي يتم عرضها كاستجابة.

عناوين الطلبات المطلوبة

يجب أن تحتوي جميع طلبات SOAP على واجهة برمجة التطبيقات على عنصر <RequestHeader> في العنوان، ويتم تحديد هذا العنصر في جميع WSDLs للخدمة. توفر مكتبات العملاء طرقًا لإضافة هذا العنوان نيابةً عنك، وذلك باستخدام القيم التي تقدّمها. في ما يلي وصف لجميع عناصر <RequestHeader>:

عنصر الوصف
<networkCode>

رمز الشبكة التي تتم معالجتها يجب إدخال رموز الشبكة عند إرسال جميع الطلبات باستثناء NetworkService.getAllNetworks() وNetworkService.makeTestNetwork().

تأكد من أنك تستخدم فقط رمز شبكة متوفر لتسجيل الدخول إلى حسابك. يمكنك العثور على الرمز على موقع "مدير إعلانات Google" الإلكتروني لحسابك، في صفحة "المشرف" > إعدادات الشبكة بجانب "رمز الشبكة".
<applicationName> اسم سلسلة عشوائي يعرّف تطبيقك سيظهر ذلك في ملفات سجلّ Google. على سبيل المثال: "تطبيقي للمستودع" أو "App_1".

ملاحظة: يجب أن يتضمّن كل طلب يرسله تطبيقك إلى واجهة برمجة تطبيقات "مدير الإعلانات" رمز دخول عبر OAuth2. مرِّر الرمز المميّز في عنوان HTTP على النحو التالي: Authorization: Bearer YOUR_ACCESS_TOKEN.

مثال على الطلب

الرمز التالي هو مثال على استدعاء طلب SOAP لـ getAdUnitsByStatement() للبحث عن الجذر AdUnit.

<?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/v202402">
      <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/v202402">
      <filterStatement>
        <query>WHERE parentId IS NULL LIMIT 500</query>
      </filterStatement>
    </getAdUnitsByStatement>
  </soapenv:Body>
</soapenv:Envelope>

ملاحظة: إذا تسبب طلب SOAP في حدوث Unmarshalling error، يُرجى الاطّلاع على الأخطاء الشائعة للحصول على نصائح بشأن تحديد المشاكل وحلّها.

عناوين الاستجابة

تتضمن جميع الردود التي يتم عرضها من واجهة برمجة التطبيقات عناصر العنوان التالية. ومن بين أفضل الممارسات، ننصحك بتسجيل هذه القيم.

عنصر الوصف
<requestId> يحدِّد هذا الطلب بشكلٍ فريد. إذا واجهت أي مشاكل تتطلّب تدخُّل فريق الدعم، يمكنك إرسال هذا المعرّف إلينا، ما يتيح لنا العثور على طلبك بسهولة أكبر.
<responseTime> الوقت المنقضي بين تلقي خدمة الويب للطلب وإرسال الرد.

مثال على ردّ

يوضح الرمز البرمجي التالي مثالاً على استجابة SOAP للطلب السابق.

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <ResponseHeader xmlns="https://www.google.com/apis/ads/publisher/v202402">
      <requestId>xxxxxxxxxxxxxxxxxxxx</requestId>
      <responseTime>1063</responseTime>
    </ResponseHeader>
  </soap:Header>
  <soap:Body>
    <getAdUnitsByStatementResponse xmlns="https://www.google.com/apis/ads/publisher/v202402">
      <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>