SOAP-XML-Anfrage- und -Antwortheader

Diese Seite enthält Informationen zu den erforderlichen SOAP-XML-Anfrageheadern und zu den als Antwort zurückgegebenen Headern.

Erforderliche Anfrageheader

Alle API-SOAP-Aufrufe müssen ein <RequestHeader>-Element im Header haben. Dieses Element ist in allen Dienst-WSDLs definiert. Die Clientbibliotheken bieten Methoden, mit denen Sie diesen Header anhand der von Ihnen bereitgestellten Werte hinzufügen können. Hier ist eine Beschreibung aller Elemente von <RequestHeader>:

Element Beschreibung
<networkCode>

Der Netzwerkcode des Netzwerks, das angesprochen wird. Netzwerkcodes sind bei allen Anfragen außer NetworkService.getAllNetworks() und NetworkService.makeTestNetwork() erforderlich.

Achten Sie darauf, dass Sie nur einen Netzwerkcode verwenden, der für die Anmeldung in Ihrem Konto verfügbar ist. Sie finden den Code auf der Google Ad Manager-Website für Ihr Konto auf der Seite „Admin“ > „Werbenetzwerkeinstellungen“ neben „Netzwerkcode“.
<applicationName> Ein beliebiger Stringname, der Ihre Anwendung identifiziert. Dies wird in den Protokolldateien von Google angezeigt. Beispiel: „Meine Inventaranwendung“ oder „App_1“.

Hinweis:Jede Anfrage, die Ihre Anwendung an die Ad Manager API sendet, muss ein OAuth2-Zugriffstoken enthalten. Übergeben Sie das Token im HTTP-Header als Authorization: Bearer YOUR_ACCESS_TOKEN.

Beispielanfrage

Der folgende Code ist ein Beispiel für einen SOAP-Anfrageaufruf an getAdUnitsByStatement(), der nach dem Stamm-AdUnit sucht.

<?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>

Hinweis: Wenn Ihre SOAP-Anfrage einen Unmarshalling error verursacht, finden Sie unter Häufige Fehler Tipps zur Fehlerbehebung.

Antwortheader

Alle von der API zurückgegebenen Antworten enthalten die folgenden Kopfzeilenelemente. Als Best Practice empfehlen wir, diese Werte zu protokollieren.

Element Beschreibung
<requestId> Hiermit wird diese Anfrage eindeutig identifiziert. Falls Sie Unterstützung bei Problemen haben, können wir Ihre Anfrage leichter finden, wenn Sie uns diese ID senden.
<responseTime> Verstrichene Zeit vom Eingang der Anfrage beim Webdienst bis zum Senden der Antwort.

Beispielantwort

Der folgende Code zeigt ein Beispiel für eine SOAP-Antwort auf die vorherige Anfrage.

<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>