Заголовки запросов и ответов SOAP XML

На этой странице вы найдете информацию об обязательных заголовках запросов SOAP XML и заголовках, которые возвращаются в ответе.

Обязательные заголовки запросов

Все вызовы SOAP API должны содержать элемент <RequestHeader> в заголовке. Этот элемент определен во всех WSDL сервиса. В клиентских библиотеках есть методы, позволяющие добавлять этот заголовок с использованием указанных вами значений. Ниже приведено описание всех элементов <RequestHeader>.

Элемент Описание
<networkCode>

Код сети, к которой относится запрос. Коды сетей необходимы при выполнении всех запросов, кроме NetworkService.getAllNetworks() и NetworkService.makeTestNetwork().

Убедитесь, что вы используете только код сети, доступный для вашего аккаунта. Код можно найти на сайте Google Менеджера рекламы в вашем аккаунте на странице "Администрирование > Настройки размещения" рядом с пунктом "Код сети".
<applicationName> Произвольная строка, которая позволяет идентифицировать ваше приложение. Эта информация будет отражена в файлах журнала Google. Примеры: "Мое приложение для инвентаря" или "Приложение_1".

Примечание. Каждый запрос, отправляемый вашим приложением в 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/v202608">
      <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/v202608">
      <filterStatement>
        <query>WHERE parentId IS NULL LIMIT 500</query>
      </filterStatement>
    </getAdUnitsByStatement>
  </soapenv:Body>
</soapenv:Envelope>

Примечание. Если SOAP-запрос приводит к ошибке Unmarshalling error, ознакомьтесь с советами по устранению распространенных ошибок.

Заголовки ответов

Все ответы, возвращаемые API, включают следующие элементы заголовка. Рекомендуем регистрировать эти значения.

Элемент Описание
<requestId> Уникальный идентификатор запроса. Если у вас возникнут проблемы, отправьте нам этот идентификатор, чтобы мы могли быстрее найти ваш запрос.
<responseTime> Время, прошедшее между получением запроса веб-сервисом и отправкой ответа.

Пример ответа

Ниже приведен пример ответа SOAP на предыдущий запрос.

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