En-têtes de requête et de réponse XML SOAP

Cette page fournit des informations sur les en-têtes de requête XML SOAP requis et les en-têtes renvoyés en réponse.

En-têtes de requête obligatoires

Tous les appels SOAP d'API doivent comporter un élément <RequestHeader> dans l'en-tête. Cet élément est défini dans tous les fichiers WSDL de service. Les bibliothèques clientes fournissent pour ajouter cet en-tête automatiquement, à l'aide des valeurs que vous fournissez. Voici une description de tous les éléments de <RequestHeader> :

Élément Description
<networkCode>

Code de réseau du réseau auquel l'adresse est destinée. Les codes réseau sont obligatoires pour toutes les requêtes, à l'exception de NetworkService.getAllNetworks() et NetworkService.makeTestNetwork().

Assurez-vous d'utiliser uniquement un code réseau disponible pour la connexion à votre compte. Vous trouverez le code sur le site Web Google Ad Manager de votre compte, dans la page Administration > page "Paramètres des réseaux" à côté de "Code de réseau".
<applicationName> Nom de chaîne arbitraire identifiant votre application. Cette information s'affiche dans les fichiers journaux de Google. Par exemple, "Mon application d'inventaire" ou "App_1".

Remarque:Chaque demande que votre application envoie à l'API Ad Manager doit inclure un jeton d'accès OAuth2. Transmettez le jeton dans l'en-tête HTTP sous la forme : Authorization: Bearer YOUR_ACCESS_TOKEN.

Exemple de requête

Le code suivant est un exemple d'appel de demande SOAP de getAdUnitsByStatement() qui recherche la racine 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/v202508">
      <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/v202508">
      <filterStatement>
        <query>WHERE parentId IS NULL LIMIT 500</query>
      </filterStatement>
    </getAdUnitsByStatement>
  </soapenv:Body>
</soapenv:Envelope>

Remarque : Si votre requête SOAP génère une Unmarshalling error, consultez la section Erreurs courantes pour obtenir des conseils de dépannage.

En-têtes de réponse

Toutes les réponses renvoyées par l'API incluent les éléments d'en-tête suivants. Nous vous recommandons de consigner ces valeurs.

Élément Description
<requestId> Identifie de manière unique cette requête. En cas de problème, envoyez cet identifiant nous permettra de trouver plus facilement votre demande.
<responseTime> Temps écoulé entre la réception de la requête par le service Web et l'envoi de la de réponse.

Exemple de réponse

Le code suivant montre un exemple de réponse SOAP pour la requête précédente.

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