כותרות תגובה ובקשת SOAP XML

בדף הזה מפורט מידע על הכותרות הנדרשות של בקשות XML ל-SOAP, ועל הכותרות שמוחזרות בתגובה.

כותרות נדרשות של בקשות

כל קריאות SOAP ל-API חייבות לכלול רכיב <RequestHeader> בכותרת. הרכיב הזה מוגדר בכל שירות ה-WSDL. ספריות הלקוח מספקות שיטות להוסיף את הכותרת הזו בשבילכם, על סמך הערכים שאתם מספקים. הנה תיאור של כל הרכיבים של <RequestHeader>:

הערה:כל בקשה שהאפליקציה שולחת ל-Ad Manager API חייבת לכלול אסימון גישה מסוג 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, כדאי לעיין בטיפים לפתרון בעיות שמפורטים במאמר שגיאות נפוצות.

כותרות של תשובות

כל התגובות שמוחזרות מה-API כוללות את רכיבי הכותרת הבאים. בתור מומלץ לתעד את הערכים האלה.

דוגמה לתשובה

הקוד הבא מציג דוגמה לתגובת 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>