Ta strona zawiera informacje na temat wymaganych nagłówków żądań XML SOAP oraz nagłówków zwracanych w odpowiedzi.
Wymagane nagłówki żądań
Wszystkie wywołania SOAP interfejsu API muszą mieć w nagłówku element <RequestHeader>
. Ten element jest zdefiniowany we wszystkich plikach WSDL usługi. Biblioteki klienta udostępniają metody dodania tego nagłówka za pomocą podanych przez Ciebie wartości. Oto opis wszystkich elementów <RequestHeader>
:
Element | Opis |
---|---|
<networkCode> |
Kod sieci objętej adresatem. Kody sieci są wymagane do wysyłania wszystkich żądań z wyjątkiem Upewnij się, że używasz tylko kodu sieci dostępnego do logowania na konto. Kod znajdziesz na stronie Google Ad Managera swojego konta, na stronie Administracja > Ustawienia sieci obok pozycji „Kod sieci”. |
<applicationName> |
Dowolny ciąg znaków identyfikujący Twoją aplikację. Będzie to widoczne w plikach dziennika Google. np. „Aplikacja dotycząca moich zasobów reklamowych” lub „Aplikacja_1”. |
Uwaga: każde żądanie wysyłane przez aplikację do interfejsu Ad Manager API musi zawierać token dostępu OAuth2. Przekaż token w nagłówku HTTP jako Authorization: Bearer YOUR_ACCESS_TOKEN
.
Poniżej znajduje się przykład wywołania żądania SOAP wysłanego do funkcji getAdUnitsByStatement()
z wykorzystaniem katalogu głównego 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/v202405"> <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/v202405"> <filterStatement> <query>WHERE parentId IS NULL LIMIT 500</query> </filterStatement> </getAdUnitsByStatement> </soapenv:Body> </soapenv:Envelope>
Uwaga: jeśli żądanie SOAP powoduje błąd Unmarshalling error
, zapoznaj się ze wskazówkami dotyczącymi rozwiązywania problemów w sekcji Typowe błędy.
Nagłówki odpowiedzi
Wszystkie odpowiedzi zwracane przez interfejs API zawierają poniższe elementy nagłówka. Sprawdzoną metodą jest zapisywanie tych wartości.
Element | Opis |
---|---|
<requestId> |
Jednoznacznie identyfikuje żądanie. Jeśli masz problemy z pomocą, prześlij nam ten identyfikator, aby łatwiej nam było znaleźć Twoją prośbę. |
<responseTime> |
Czas, który upływa między odbiorem żądania przez usługę internetową a wysłaniem odpowiedzi. |
Przykładowa odpowiedź
Poniższy kod zawiera przykład odpowiedzi SOAP na poprzednie żądanie.
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Header> <ResponseHeader xmlns="https://www.google.com/apis/ads/publisher/v202405"> <requestId>xxxxxxxxxxxxxxxxxxxx</requestId> <responseTime>1063</responseTime> </ResponseHeader> </soap:Header> <soap:Body> <getAdUnitsByStatementResponse xmlns="https://www.google.com/apis/ads/publisher/v202405"> <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>