Developer Center - Yahoo! JAPAN プロモーション広告

認証およびアクセス

スポンサードサーチAPIシステムおよびYDN APIシステムへの認証およびアカウントの認証方法には、2つの認証方法があります。
・標準認証：Yahoo!プロモーション広告の正規代理店や広告主など自社で管理するアカウントにアクセスする場合
・代行認証：外部の運用ツールが別のユーザーの代わりにアカウントにアクセスする場合

それぞれアクセスするアカウントにより認証方法を区別する必要があります。

リクエストのSOAPヘッダー

APIシステムへの認証およびアカウントの認証情報は、リクエストのSOAPヘッダーに記載します。
ヘッダー情報の詳細は、SoapHeaderオブジェクトを参照ください。

標準認証

自社で管理するアカウントへAPIでアクセスする場合は、以下の認証情報をSOAPリクエストヘッダーに記載します。

フィールド	説明
license	Yahoo! JAPANが発行するライセンス番号です。「xxxx-xxxx-xxxx-xxxx」の形式で入力ください。
apiAccountId	Yahoo! JAPANが発行するAPIシステムに認証するためのIDです。「xxxx-xxxx-xxxx-xxxx」の形式で入力ください。
apiAccountPassword	APIアカウントIDにお客様自身がAPI管理ツールで設定したパスワードです。

リクエストサンプル
スポンサードサーチ API V201805をご利用の場合

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:ns1="http://ss.yahooapis.jp/V201805/Account">
    <SOAP-ENV:Header>
        <ns1:RequestHeader>
            <ns1:license>xxxxxxxxxxxxxxx</ns1:license>
            <ns1:apiAccountId>xxxxxxxxxxxxxxxxxx</ns1:apiAccountId>
            <ns1:apiAccountPassword>passwd</ns1:apiAccountPassword>
        </ns1:RequestHeader>
    </SOAP-ENV:Header>
    <SOAP-ENV:Body>
    ...
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

スポンサードサーチ API version 6.5以前をご利用の場合

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:ns1="http://ss.yahooapis.jp/V6">
      <SOAP-ENV:Header>
          <ns1:RequestHeader>
              <ns1:license>xxxxxxxxxxxxxxx</ns1:license>
              <ns1:apiAccountId>xxxxxxxxxxxxxxxxxx</ns1:apiAccountId>
              <ns1:apiAccountPassword>passwd</ns1:apiAccountPassword>
          </ns1:RequestHeader>
      </SOAP-ENV:Header>
      <SOAP-ENV:Body>
      ...
      </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

YDN API V201806をご利用の場合

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:ns1="http://im.yahooapis.jp/V201806/Account">
      <SOAP-ENV:Header>
          <ns1:RequestHeader>
              <ns1:license>xxxxxxxxxxxxxxx</ns1:license>
              <ns1:apiAccountId>xxxxxxxxxxxxxxxxxx</ns1:apiAccountId>
              <ns1:apiAccountPassword>passwd</ns1:apiAccountPassword>
          </ns1:RequestHeader>
      </SOAP-ENV:Header>
      <SOAP-ENV:Body>
      ...
      </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

YDN API version 6.1以前をご利用の場合

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:ns1="http://im.yahooapis.jp/V6">
      <SOAP-ENV:Header>
          <ns1:RequestHeader>
              <ns1:license>xxxxxxxxxxxxxxx</ns1:license>
              <ns1:apiAccountId>xxxxxxxxxxxxxxxxxx</ns1:apiAccountId>
              <ns1:apiAccountPassword>passwd</ns1:apiAccountPassword>
      </ns1:RequestHeader>
      </SOAP-ENV:Header>
      <SOAP-ENV:Body>
      ...
      </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

代行認証

外部の運用ツールが代理店や広告主などの代わりにアカウントにアクセスする場合は、APIアクセス専用のアカウント（アプリケーションアカウント）を利用したアカウント認証が必要です。
アプリケーションアカウントは、アクセス対象の広告主または代理店が発行します。

フィールド	説明
license	Yahoo! JAPANが発行するライセンス番号です。「xxxx-xxxx-xxxx-xxxx」の形式で入力ください。
apiAccountId	Yahoo! JAPANが発行するAPIシステムに認証するためのIDです。「xxxx-xxxx-xxxx-xxxx」の形式で入力ください。
apiAccountPassword	APIアカウントIDにお客様自身がAPI管理ツールで設定したパスワードです。
accountId	APIからアクセスするスポンサードサーチもしくはYahoo!ディスプレイアドネットワークのアカウントIDです。外部の運用ツールが代理店または広告主など別のユーザーの代わりにアクセスするために必要です。
onBehalfOfAccountId	アプリケーションからアカウントIDにアクセスするためのAPIアクセス専用のアカウントID（アプリケーションアカウントID）です。外部の運用ツールが代理店または広告主など別のユーザーの代わりにアクセスするために必要です。
onBehalfOfPassword	アプリケーションアカウントID（onBehalfOfAccountID）に設定されたパスワードです。外部の運用ツールが代理店または広告主など別のユーザーの代わりにアクセスするために必要です。

リクエストサンプル
スポンサードサーチ API version 201805をご利用の場合

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:ns1="http://ss.yahooapis.jp/V201805/Account">
      <SOAP-ENV:Header>
          <ns1:RequestHeader>
              <ns1:license>xxxxxxxxxxxxxxx</ns1:license>
              <ns1:apiAccountId>xxxxxxxxxxxxxxxxxx</ns1:apiAccountId>
              <ns1:apiAccountPassword>passwd</ns1:apiAccountPassword>
              <ns1:accountId>1000000001</ns1:accountId>
              <ns1:onBehalfOfAccountId>xxxxxxxxxxxxxx</ns1:onBehalfOfAccountId>
              <ns1:onBehalfOfPassword>passwd2</ns1:onBehalfOfPassword>
          </ns1:RequestHeader>
      </SOAP-ENV:Header>
      <SOAP-ENV:Body>
      ...
      </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

スポンサードサーチ API version 6.5以前をご利用の場合

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:ns1="http://ss.yahooapis.jp/V6">
      <SOAP-ENV:Header>
          <ns1:RequestHeader>
              <ns1:license>xxxxxxxxxxxxxxx</ns1:license>
              <ns1:apiAccountId>xxxxxxxxxxxxxxxxxx</ns1:apiAccountId>
              <ns1:apiAccountPassword>passwd</ns1:apiAccountPassword>
              <ns1:accountId>1000000001</ns1:accountId>
              <ns1:onBehalfOfAccountId>xxxxxxxxxxxxxx</ns1:onBehalfOfAccountId>
              <ns1:onBehalfOfPassword>passwd2</ns1:onBehalfOfPassword>
          </ns1:RequestHeader>
      </SOAP-ENV:Header>
      <SOAP-ENV:Body>
      ...
      </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

YDN API version 201806をご利用の場合

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:ns1="http://im.yahooapis.jp/V201806/Account">
      <SOAP-ENV:Header>
          <ns1:RequestHeader>
              <ns1:license>xxxxxxxxxxxxxxx</ns1:license>
              <ns1:apiAccountId>xxxxxxxxxxxxxxxxxx</ns1:apiAccountId>
              <ns1:apiAccountPassword>passwd</ns1:apiAccountPassword>
              <ns1:accountId>1000000001</ns1:accountId>
              <ns1:onBehalfOfAccountId>xxxxxxxxxxxxxx</ns1:onBehalfOfAccountId>
              <ns1:onBehalfOfPassword>passwd2</ns1:onBehalfOfPassword>
          </ns1:RequestHeader>
      </SOAP-ENV:Header>
      <SOAP-ENV:Body>
      ...
      </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

YDN API version 6.1以前をご利用の場合

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:ns1="http://im.yahooapis.jp/V6">
      <SOAP-ENV:Header>
          <ns1:RequestHeader>
              <ns1:license>xxxxxxxxxxxxxxx</ns1:license>
              <ns1:apiAccountId>xxxxxxxxxxxxxxxxxx</ns1:apiAccountId>
              <ns1:apiAccountPassword>passwd</ns1:apiAccountPassword>
              <ns1:accountId>1000000001</ns1:accountId>
              <ns1:onBehalfOfAccountId>xxxxxxxxxxxxxx</ns1:onBehalfOfAccountId>
              <ns1:onBehalfOfPassword>passwd2</ns1:onBehalfOfPassword>
          </ns1:RequestHeader>
      </SOAP-ENV:Header>
      <SOAP-ENV:Body>
      ...
      </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

サンドボックスでの認証について

サンドボックス環境での認証およびアクセスについてはサンドボックスページを参照してください。

関連サイト
お問い合わせ

プロモーション広告に関する技術的な情報が確認できない場合は、こちらよりお問い合わせください

お問い合わせページへ
サイト内検索

Search for:

認証およびアクセス

リクエストのSOAPヘッダー

標準認証

代行認証

サンドボックスでの認証について

関連サイト

お問い合わせ

サイト内検索