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

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

レスポンス ヘッダー

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

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

レスポンスの例

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

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