Yahoo!広告 API | Developer Center

よくある質問

・お申し込み関連
・運用
・その他

お申し込み関連

Yahoo!広告 APIの管理者を追加したいです。

Yahoo!ビジネスマネージャーから追加できます。
Yahoo!広告 APIに申し込んだYahoo! JAPANビジネスID（以下、ビジネスID）に、管理権限が付与されています。
同じビジネスIDでログインして、企業内のユーザー（ビジネスID保持者）を「Yahoo!広告 API管理ツール」の管理者に追加してください。
詳しい手順は以下のヘルプをご参照ください。
- ツール管理者の追加、交代（変更）（Yahoo!ビジネスマネージャーヘルプ）

Yahoo!広告 APIを利用していた事業の管轄部署が変更になりました。再度契約が必要ですか。

Yahoo!広告 APIの利用契約は、企業単位で締結しています。
このため、管轄部署を変更した場合でも、再契約の必要なくご利用を継続できます。

アプリケーション開発を外部に委託する際に、注意するべきことはありますか。

アプリケーション開発を外部企業などに委託する場合は、以下の手続きが必要です。
・Yahoo!広告API 利用約款 第18条に定める秘密保持義務と同等の契約を委託先の開発会社と締結する。
・LINEヤフーが開発委託先の情報の開示を請求した場合、開発委託先の社名などの通知が必要です。
詳細については、Yahoo!広告API 利用約款をご確認ください。

開発委託会社へ認証情報を共有したいです。

Yahoo!広告API 利用約款の第7条をご確認ください。

取引先のクライアントからAPIを利用した開発依頼をいただきました。
APIの申し込みは、クライアントから行うべきでしょうか。それとも弊社からでしょうか。

クライアント様と開発会社様の契約形態によって対応が異なります。
例えば、受託契約のケースなどの場合、システムの資産としてはクライアント様側となるため、クライアント側で発行するのが望ましいです。
ご不明点などございましたら、こちらのページ下部のお問い合わせフォームよりご連絡ください。

運用

Yahoo!広告 APIの管理権限と利用権限の違いはありますか。

管理権限と利用権限では、Yahoo!広告 API管理ツールで操作できる範囲が異なります。
各権限における操作については、以下の表をご確認ください。

どのような技術サポートを受けられますか。

サポート可能なお問い合わせの種類は、以下のとおりです。
こちらのページ下部のお問い合わせフォームよりご連絡ください。
・インターフェースレベルでの実装に関するお問い合わせ
・Yahoo!広告 APIの仕様に関するお問い合わせ
・弊社に起因する不具合に関するお問い合わせ

以下のお問い合わせはサポートできません。
・Yahoo!広告の仕様に関するお問い合わせ　※Yahoo!広告ヘルプからお問い合わせください。
・Yahoo!広告 API利用者が開発したアプリケーションのソースコードに関する問い合わせ
・特定の開発言語に特化した内容のお問い合わせ
・インストール環境やサーバー、ネットワークなど利用環境に起因する不具合
・サンプルプログラムの動作に関するお問い合わせ
・サンプルプログラムのカスタマイズ
・外部ツールとの連携について

テストアカウントで、本番環境と同等の機能を利用できますか。

利用できます。ただし、テストアカウントで入稿した内容は配信されないため、レポートなどの実績値は取得できません。
テストアカウントについては、以下をご参照ください。
- テストアカウントについて

テストアカウントの情報や入稿した内容を、広告管理ツールから確認できますか。

できません。

テストアカウントに入稿した内容がリセットされることはありますか。

ありません。

レポートのサンプルはもらえますか。

レポートのサンプルは提供しておりません。
レポートの詳細については、APIリファレンス（GitHub）からレポート定義をダウンロードしてご確認ください。
・Yahoo!広告 検索広告 API
・Yahoo!広告 ディスプレイ広告 API

リクエストの制約（QPS）はアプリケーション単位ですか。

はい、アプリケーション単位で、APIサービスの種類（グループ）ごとに「最大5件/秒」が上限です。
ただし、本番用アカウントとテストアカウント、検索広告 APIとディスプレイ広告 APIは、同一サービスのリクエストでも別々に計上します。
詳細はリクエストの制約（QPS）をご参照ください。

クライアントシークレットを再発行したいです。

Yahoo!広告 APIの担当者が変わった、クライアントシークレットが流出したなどの場合、再発行が可能です。
詳しい手順は以下のページをご参照ください。
- アプリケーションの編集、削除

OpenAPI SpecificationのYAMLファイルはダウンロードできますか。

以下のリンクからダウンロード可能です。
・Yahoo!広告 検索広告 API
・Yahoo!広告 ディスプレイ広告 API

APIエラーが発生しました。どうすればいいですか。

以下APIリファレンスに記載されているエラーコードをご確認ください。
・Yahoo!広告 検索広告 API
・Yahoo!広告 ディスプレイ広告 API

エラーレスポンスのサンプルや、Yahoo!広告 APIのエラーの考え方については、以下GitHubの記事をご覧ください。
・ベストプラクティス：エラーコード

エラーが解消されない場合は、こちらのページ下部のお問い合わせフォームよりお問い合わせください。
その際、以下の情報を入力してください。
・クライアントID
・ご利用のAPIの種類とバージョン
・エラーの詳細
　※発生している事象やお問い合わせの詳細、発生日時（タイムゾーン含む）や発生頻度、
　　アカウントID、各エンティティのIDなど、可能な限り詳細を入力してください。
・APIのリクエスト/レスポンス
・画像ファイル
・その他の添付ファイル

Yahoo!広告 APIで障害などが発生している場合、どこで情報を確認できますか。

Yahoo!広告 APIに関する障害等のお知らせは、Developer Center（本サイト）の「お知らせ」をご確認ください。

開発したアプリケーションで、利用者に承認画面を表示せずに利用できるようにする方法はありますか。

アプリケーションの利用時は、必ず承認画面が表示されます。同画面の表示は回避できません。

リフレッシュトークンが失効するのはどのような場合ですか。

以下のいずれかに該当する場合に失効します。
・アプリケーションの削除
・アプリケーションの利用者による認可の解除（アクセスの解除）
・トークンの無効化（revoke）を実行
・Yahoo!広告API 利用約款 第20条第1項に該当

同じクライアントIDで複数のリフレッシュトークンを発行した場合、以前発行したリフレッシュトークンは有効でしょうか。

以前発行したリフレッシュトークンを含めて、どちらのリフレッシュトークンも有効です。

リフレッシュトークンの発行条件はありますか。

有効時間および発行数は無制限です。
またその他の条件も特にありません。

アクセストークンが失効するのはどのような場合ですか。

以下のいずれかに該当する場合に失効します。
・有効期限（発行から1時間以内）を超過
・アプリケーションを削除
・ Yahoo! JAPAN ビジネスIDで認可したアプリケーションを利用者が承認を解除
・トークンの無効化（revoke）を実行
・Yahoo!広告API 利用約款 第20条第1項に該当
アクセストークンの再取得については、以下をご参照ください。
- APIコールを実施する

機能改善やバージョンアップなどの通知はどうなりますか。

Yahoo!広告 APIに申し込んだYahoo! JAPANビジネスIDに設定したメールアドレスあてにメールをお送りしています。
また、Developer Center（本サイト）の「お知らせ」にも掲載しています。あわせてご確認ください。

通貨は選択可能ですか。

円（YEN）のみの対応となります。

タイムゾーンはどの地域のものになりますか。

日本時間（JST）のみの対応となります。

各APIの利用例・利用方法・運用についての参照資料はありますか。

以下のベストプラクティスをご参照ください。
・Yahoo!広告 検索広告 API
・Yahoo!広告 ディスプレイ広告 API

API開発にあたっての推奨している環境や言語等について詳細を教えてください。

特に推奨の環境や言語はありません。
サンプルプログラムは、Java、PHP、Python、Rubyにて提供しております。
- サンプルプログラム

（Yahoo!広告 ディスプレイ広告 API）
StatsService/get において、日付変更後、statsPeriodを「REALTIME_TODAY」にしてリクエストすると空の実績が返却されますか。

はい。statsPeriodを「REALTIME_TODAY」にしてリクエストしても、日付変更後、統計情報の更新処理が完了するまでは空の実績が返却されます。

テストアカウントで認証するには、どのビジネスIDを使えばいいですか。

テストアカウントは、Yahoo!広告 APIに申し込んだビジネスIDで利用できます。
Yahoo!広告 APIのお申し込み後、APIの利用が可能になった時点でお送りするお申し込み完了メールに、テストアカウントを記載していますのでご確認ください。
Yahoo!広告 APIに申し込んだビジネスIDが分からない場合は、テストアカウントについての「テストアカウントを忘れた」をご覧ください。

レポートの「動作区分/Behavior Type」は、どのような項目ですか。

【Segment】
年月日やデバイスなど、レポートの集計単位となるフィールドです。
指定したSegment項目のフィールドごとにデータ分割が発生します。
広告管理ツールのレポート作成画面「分割項目」にあたります。
例1）アカウントレポートで「DAY（Segment項目）」を指定した場合

【Attribute】
広告名や広告タイプなど、設定内容のEnumや文字列が入るフィールドです。

【Metric】
コストやインプレッションなど、実績の数値が入るフィールドです。

Attribute項目とSegment項目の組み合わせでレポート内の行は一意となります。

OfflineConversionService/uploadのリクエスト自体はできますが、取り込みはできません。
OfflineConversionService/getで取得した際、processStatusはDONE_WITH_ERRORが返却されます。

v12からディスプレイ広告でも対応しました。

以下の3点が考えられます。
1. 認可コードに抜け漏れがある、または有効期限が切れている（失効している）
　認可コードは10分経過すると無効化されるので、「APIコールを実施する」の「4. 認可コードを使って、認可APIへリクエストを送信します。」は、認可コード取得後10分以内に実施してください。
2. アプリケーション登録時に設定したリダイレクトURIと、認可リクエストで用いたリダ イレクトURIが一致していない
3. 他のクライアントに対して発行された認可コードである

ある日突然特定の広告アカウントで認証エラーになりました。どのような理由が考えられますか。

以下の3点が考えられます。

1.認証したYahoo! JAPANビジネスIDがYahoo! JAPAN IDとの連携を解除した場合
　リフレッシュトークンが無効になりますので、再度認可認証が必要となります。
　[対応方法]
　はじめにの「パターン別のご案内」でご自身がどのパターンかご確認いただき、各パターンの「3.認証」から実施ください。

2.認証したYahoo! JAPANビジネスIDに各種変更が発生した場合
　例） 退職や異動によるYahoo! JAPANビジネスIDの削除があった場合
　　　 Yahoo! JAPANビジネスIDの持つ広告管理ツールの権限変更（管理権限→利用権限など）があった場合
　　　 アカウント移管により操作対象の広告アカウントとYahoo! JAPANビジネスIDの関係が変わった場合
　リフレッシュトークンは無効となりませんが、APIコール時に403エラーとなります。
　[対応方法]
　別のYahoo! JAPANビジネスIDをお使いになる場合は、はじめにの「パターン別のご案内」でご自身がどのパターンかご確認いただき、
　各パターンの「3.認証」から別のYahoo! JAPANビジネスIDをで再認証してください。
　同じYahoo! JAPANビジネスIDをお使いになる場合は、操作対象の広告アカウントの権限を付与してください。

3.アクセス可能なアプリケーションの一覧からアクセス解除を行った場合
　リフレッシュトークンが無効になりますので、再度認可認証が必要となります。
　[対応方法]
　はじめにの「パターン別のご案内」でご自身がどのパターンかご確認いただき、各パターンの「3.認証」から実施ください。

1つのアプリケーションで複数のアカウントを利用者別に分けて管理するには、どうすればよいでしょうか？現在発行しているトークンでは、すべてのアカウントにアクセスできてしまいます。

以下に、利用者別に分けて管理する方法についてまとめていますのでご参照ください。
1つのクライアントIDで複数の顧客グループを管理する方法

その他

Yahoo!広告 検索広告 APIとYahoo!広告 ディスプレイ広告 APIの統合の予定はありますか。

現時点では統合の予定はありません。

Yahoo!広告 APIの契約締結について、プレスリリースを出したいです。

弊社サービスに関するプレスリリースの発表には、弊社にて掲載内容などの確認が必要です。
事前にこちらのページ下部のお問い合わせフォームよりご連絡ください。

事業譲渡・移管を予定しています。譲渡・移管後もAPIを継続して利用できますか。

こちらのページ下部のお問い合わせフォームより詳細をお知らせください。
内容をご確認のうえ、担当者よりご連絡いたします。
なお継続の検討に際して、Yahoo!広告 API利用約款に基づき、秘密情報の開示が必要となる場合があります。

お知らせメールの配信を停止/受信したいです。

Yahoo!広告 APIのお知らせメールは、以下のYahoo! JAPANビジネスID（以下、ビジネスID）の登録メールアドレスに配信されます。
・Yahoo!広告 APIの契約者
・Yahoo!広告 API管理ツールの管理者、および利用者
上記に当てはまる場合、お知らせメールの配信停止はできません。ご了承ください。

お知らせメールを受信する場合は、受信する方のビジネスIDを、Yahoo!広告 API管理ツールに追加してください。
管理ツールへの追加手順は、以下を参照してください。
・ツール利用権限を付与する（ツール利用者の追加）（Yahoo!ビジネスマネージャーヘルプ）
・従業員のメールアドレスを変更する（Yahoo!ビジネスマネージャーヘルプ）

API管理ツールにアクセスしたとき、「API管理ツールを使用できるビジネスIDでログインしてください」というエラーが表示されます。

当該のビジネスIDでYahoo!ビジネスセンターにログインした際に、「ご利用中のサービス」欄に「Yahoo!広告 API管理ツール」が表示されていなければ、そのビジネスIDにAPI管理ツールを使用可能な権限（管理権限または利用権限）は付与されておりません。
管理権限または利用権限が必要な場合、管理者へ権限付与をご依頼ください。

解約をしたいのですがどのような手続きが必要でしょうか。

こちらのページ下部のお問い合わせフォームより「対象API」に「Yahoo!広告 API 全般」を選択し、「お問い合わせ内容詳細」に現在Yahoo!広告 APIを契約中の以下の項目を入力しお問い合わせください。
弊社で内容を確認した上でご連絡させていただきます。確認後5営業日程度で解約手続きを完了いたします。

【項目】
・会社名
・「Yahoo!広告 API ツール管理権限」と「法人管理権限」を保有しているYahoo! JAPANビジネスID、登録担当者名（フルネーム）
・解約を申請される担当者様のお名前（フルネーム）、連絡先メールアドレス

お問い合わせ

FAQを見ても解決しない場合は、以下のお問い合わせフォームをご利用ください。

・Yahoo!広告 APIをお申込み前のお客様
・Yahoo!広告 APIをご利用中のお客様　※API管理ツールを利用できるYahoo! JAPANビジネスIDでのログインが必要です。

※お問い合わせフォームにアクセスできない場合はこちらをご確認ください。