Encabezados de respuesta y solicitud XML de SOAP

Esta página proporciona información sobre los encabezados obligatorios de la solicitud SOAP XML y los encabezados que se muestran en respuesta.

Encabezados de solicitud obligatorios

Todas las llamadas de SOAP a la API deben tener un elemento <RequestHeader> en el encabezado, que se define en todos los WSDL del servicio. Las bibliotecas cliente proporcionan métodos para agregar este encabezado por ti con los valores que proporcionas. A continuación, se incluye una descripción de todos los elementos de <RequestHeader>:

Elemento Descripción
<networkCode>

El código de red de la red a la que se está dirigiendo. Los códigos de red son obligatorios cuando se realizan todas las solicitudes, excepto NetworkService.getAllNetworks() y NetworkService.makeTestNetwork().

Asegúrate de utilizar solo un código de red disponible para acceder a tu cuenta. Puede encontrar el código en el sitio web de Google Ad Manager para su cuenta, en la página Administrador > Configuración de red, junto a "Código de red".
<applicationName> Un nombre de string arbitrario que identifica tu aplicación. Esto se mostrará en los archivos de registro de Google. Por ejemplo, "My Inventory Application" o "App_1".

Nota: Cada solicitud que tu aplicación envíe a la API de Ad Manager debe incluir un token de acceso de OAuth2. Pasa el token en el encabezado HTTP como: Authorization: Bearer YOUR_ACCESS_TOKEN.

Ejemplo de solicitud

El siguiente código es un ejemplo de una llamada de solicitud de SOAP a getAdUnitsByStatement() que busca la raíz 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/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>

Nota: Si tu solicitud de SOAP genera una Unmarshalling error, consulta Errores comunes y obtén sugerencias para solucionar problemas.

Encabezados de respuesta

Todas las respuestas que muestra la API incluyen los siguientes elementos de encabezado. Como práctica recomendada, te sugerimos que registres estos valores.

Elemento Descripción
<requestId> Identifica esta solicitud de forma única. Si tienes problemas de asistencia, envíanos este ID para que podamos encontrar tu solicitud con más facilidad.
<responseTime> Tiempo transcurrido entre el servicio web que recibe la solicitud y el envío de la respuesta.

Respuesta de ejemplo

El siguiente código muestra un ejemplo de una respuesta SOAP para la solicitud anterior.

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