На этой странице представлена информация о необходимых заголовках запроса SOAP XML и заголовках, возвращаемых в ответ.
Обязательные заголовки запросов
Все вызовы API SOAP должны иметь элемент <RequestHeader> в заголовке; этот элемент определен во всех WSDL-файлах службы. Клиентские библиотеки предоставляют методы для добавления этого заголовка, используя предоставленные вами значения. Вот описание всех элементов <RequestHeader> :
| Элемент | Описание |
|---|---|
<networkCode> | Сетевой код адресуемой сети. Сетевые коды требуются при выполнении всех запросов, кроме Убедитесь, что вы используете только сетевой код, доступный для входа в вашу учетную запись. Код можно найти на веб-сайте Google Ad Manager для вашего аккаунта на странице «Администратор» > «Настройки сети» рядом с пунктом «Код сети». |
<applicationName> | Произвольное строковое имя, идентифицирующее ваше приложение. Это будет показано в файлах журналов Google. Например: «Приложение My Inventory» или «App_1». |
Примечание. Каждый запрос, который ваше приложение отправляет в 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/v202408">
<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/v202408">
<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/v202408">
<requestId>xxxxxxxxxxxxxxxxxxxx</requestId>
<responseTime>1063</responseTime>
</ResponseHeader>
</soap:Header>
<soap:Body>
<getAdUnitsByStatementResponse xmlns="https://www.google.com/apis/ads/publisher/v202408">
<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>