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

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

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

يجب أن تحتوي جميع طلبات البيانات من واجهة برمجة التطبيقات باستخدام بروتوكول SOAP على عنصر <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/v202505">
      <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/v202505">
      <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/v202505">
      <requestId>xxxxxxxxxxxxxxxxxxxx</requestId>
      <responseTime>1063</responseTime>
    </ResponseHeader>
  </soap:Header>
  <soap:Body>
    <getAdUnitsByStatementResponse xmlns="https://www.google.com/apis/ads/publisher/v202505">
      <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>