Nagłówki żądań i odpowiedzi XML SOAP

Ta strona zawiera informacje na temat wymaganych nagłówków żądań SOAP XML oraz nagłówków zwracanych w odpowiedzi.

Wymagane nagłówki żądania

Wszystkie wywołania SOAP interfejsu API muszą zawierać w nagłówku element <RequestHeader>. ten element jest zdefiniowany we wszystkich plikach WSDL usługi. Biblioteki klienta udostępniają aby dodać ten nagłówek za Ciebie, używając podanych przez Ciebie wartości. Oto opis wszystkich elementów <RequestHeader>:

Element Opis
<networkCode>

Kod sieci, do której adres jest adresowany. W przypadku wszystkich żądań oprócz NetworkService.getAllNetworks() i NetworkService.makeTestNetwork() wymagane są kody sieci.

Upewnij się, że używasz tylko kodu sieci dostępnego dla logowania na Twoje konto. Kod możesz znaleźć w witrynie Google Ad Managera swojego konta, w sekcji Administracja > Ustawienia sieci obok pozycji „Kod sieci”.
<applicationName> Nazwa dowolnego ciągu znaków identyfikująca aplikację. Będzie ona widoczna w plikach dzienników Google. Na przykład: „Moje zasoby reklamowe Aplikacja lub „App_1”.

Uwaga: każde żądanie wysyłane przez aplikację do interfejsu API Ad Managera musi zawierać token dostępu OAuth2. Przekaż token w nagłówku HTTP jako: Authorization: Bearer YOUR_ACCESS_TOKEN.

Przykładowe żądanie

Poniższy kod jest przykładowym wywołaniem żądania SOAP pod adresem getAdUnitsByStatement(), które wyszukuje katalog główny 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>

Uwaga: jeśli żądanie SOAP powoduje błąd Unmarshalling error, przeczytaj artykuł Typowe błędy, w którym znajdziesz wskazówki dotyczące rozwiązywania problemów.

Nagłówki odpowiedzi

Wszystkie odpowiedzi zwracane przez interfejs API zawierają poniższe elementy nagłówka. Jako sprawdzoną metodą, zalecamy rejestrowanie tych wartości.

Element Opis
<requestId> Jednoznacznie identyfikuje to żądanie. W przypadku jakichkolwiek problemów z zespołem pomocy, Identyfikator pozwoli nam łatwiej znaleźć Twoją prośbę.
<responseTime> Czas, który upłynął między otrzymaniem żądania przez usługę internetową a wysłaniem żądania .

Przykładowa odpowiedź

Poniższy kod zawiera przykładową odpowiedź SOAP dla poprzedniego żądania.

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