SOAP XML のリクエスト ヘッダーとレスポンス ヘッダー

このページでは、必要な SOAP XML リクエスト ヘッダーと、レスポンスで返されるヘッダーについて説明します。

必須のリクエスト ヘッダー

すべての API SOAP 呼び出しには、ヘッダーに <RequestHeader> 要素が必要です。この要素は、すべてのサービス WSDL で定義されています。クライアント ライブラリには、指定した値を使用してこのヘッダーを自動的に追加するメソッドが用意されています。以下は、<RequestHeader> のすべての要素の説明です。

要素 説明
<networkCode>

アドレス指定されるネットワークのネットワーク コード。NetworkService.getAllNetworks() と NetworkService.makeTestNetwork() を除くすべてのリクエストでネットワーク コードが必要です。

アカウントのログインに使用できるネットワーク コードのみを使用してください。コードは、アカウントの Google アド マネージャーのウェブサイトの [管理] > [ネットワーク設定] ページの [ネットワーク コード] の横で確認できます。
<applicationName> アプリケーションを識別する任意の文字列名。これは Google のログファイルに表示されます。例: 「My Inventory Application」、「App_1」。

注: アプリケーションから Ad Manager API に送信するすべてのリクエストには、OAuth2 アクセス トークンが含まれている必要があります。トークンを HTTP ヘッダーで Authorization: Bearer YOUR_ACCESS_TOKEN として渡します。

リクエストの例

次のコードは、ルート AdUnit を検索する getAdUnitsByStatement() への SOAP リクエスト呼び出しの例です。

<?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/v202508">
      <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/v202508">
      <filterStatement>
        <query>WHERE parentId IS NULL LIMIT 500</query>
      </filterStatement>
    </getAdUnitsByStatement>
  </soapenv:Body>
</soapenv:Envelope>

注: SOAP リクエストで Unmarshalling error が発生した場合は、一般的なエラーでトラブルシューティングのヒントをご覧ください。

レスポンス ヘッダー

API から返されるすべてのレスポンスには、次のヘッダー要素が含まれます。ベスト プラクティスとして、これらの値をログに記録することをおすすめします。

要素 説明
<requestId> このリクエストを一意に識別します。サポートに関して問題が発生した場合は、 この ID を使用すると、リクエストを簡単に見つけられるようになります。
<responseTime> ウェブサービスがリクエストを受信してからレスポンスを送信するまでの経過時間。

レスポンスの例

次のコードは、前のリクエストの SOAP レスポンスの例を示しています。

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