Reminder: v201708 will be sunset on August 31, 2018.

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

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

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

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

要素 説明
<networkCode>

対象のネットワークのネットワーク コードです。NetworkService.getAllNetworks()NetworkService.makeTestNetwork() を除き、すべてのリクエストにはネットワーク コードが必要になります。

お持ちのアカウント ログインで使用可能なネットワーク コードのみを使ってください。DFP のウェブサイトで、ご自分のアカウント用のコードを確認できます。[管理] > [ネットワーク設定] ページにアクセスし、[ネットワーク コード] の横に表示されるコードを確認します。

<applicationName> アプリケーションを識別する名前を表す任意の文字列です。Google のログファイルにはこの名前が表示されます。たとえば、「My Inventory Application」、「App_1」といった名前になります。

注: アプリケーションから DFP API に送信するすべてのリクエストには、OAuth 2.0 アクセス トークンを含める必要があります。ヘッダーでは、「Authorization: Bearer YOUR_ACCESS_TOKEN」のようにトークンを渡します。

リクエストの例

以下は、getAdUnitsByStatement() を呼び出してルート AdUnit を取得する 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/v201802">
      <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/v201802">
      <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/v201802">
      <requestId>xxxxxxxxxxxxxxxxxxxx</requestId>
      <responseTime>1063</responseTime>
    </ResponseHeader>
  </soap:Header>
  <soap:Body>
    <getAdUnitsByStatementResponse xmlns="https://www.google.com/apis/ads/publisher/v201802">
      <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>

フィードバックを送信...

DoubleClick for Publishers API
DoubleClick for Publishers API
ご不明な点がありましたら、Google のサポートページをご覧ください。