Intestazioni di richieste e risposte XML SOAP

Questa pagina fornisce informazioni sulle intestazioni delle richieste XML SOAP richieste e sulle intestazioni restituite in risposta.

Intestazioni delle richieste obbligatorie

Tutte le chiamate SOAP dell'API devono avere un elemento <RequestHeader> nell'intestazione; questo elemento è definito in tutti i WSDL del servizio. Le librerie client forniscono metodi per aggiungere automaticamente questa intestazione utilizzando i valori che fornisci. Ecco una descrizione di tutti gli elementi di <RequestHeader>:

Elemento Descrizione
<networkCode>

Il codice di rete della rete a cui viene indirizzato il messaggio. I codici di rete sono obbligatori per tutte le richieste, ad eccezione di NetworkService.getAllNetworks() e NetworkService.makeTestNetwork().

Assicurati di utilizzare esclusivamente un codice di rete disponibile per l'accesso all'account. Puoi trovare il codice sul sito web di Google Ad Manager per il tuo account, nella pagina Amministrazione > Impostazioni di rete accanto a "Codice di rete".
<applicationName> Un nome stringa arbitrario che identifica l'applicazione. Verrà visualizzato nei file di log di Google. Ad esempio: "Il mio inventario Applicazione" o "App_1".

Nota: ogni richiesta che la tua applicazione invia all'API Ad Manager deve includere un token di accesso OAuth2. Passa il token nell'intestazione HTTP come: Authorization: Bearer YOUR_ACCESS_TOKEN.

Richiesta di esempio

Di seguito è riportato un esempio di chiamata di richiesta SOAP a getAdUnitsByStatement() che cerca il AdUnit principale.

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

Nota: se la richiesta SOAP determina un Unmarshalling error, consulta la sezione Errori comuni per suggerimenti sulla risoluzione dei problemi.

Intestazioni della risposta

Tutte le risposte restituite dall'API includono i seguenti elementi di intestazione. Come una best practice, ti consigliamo di registrare questi valori.

Elemento Descrizione
<requestId> Identifica in modo univoco questa richiesta. Se hai problemi di assistenza, inviaci questo ID per consentirci di trovare più facilmente la tua richiesta.
<responseTime> Tempo trascorso tra la ricezione della richiesta da parte del servizio web e l'invio della richiesta la risposta corretta.

Esempio di risposta

Il seguente codice mostra un esempio di risposta SOAP per la richiesta precedente.

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