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

تقدّم هذه الصفحة معلومات عن عناوين طلبات SOAP XML المطلوبة والعناوين التي يتم عرضها استجابةً.

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

يجب أن تتضمّن جميع طلبات البيانات من واجهة برمجة التطبيقات العنصر <RequestHeader> في العنوان. يتم تحديد هذا العنصر في جميع نطاقات WSDL الخاصة بالخدمة. توفر مكتبات البرامج لإضافة هذا العنوان من أجلك، باستخدام القيم التي توفرها. إليك وصف لكل عناصر <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/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>

ملاحظة: إذا تسبب طلب 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/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>