はじめに
こんにちは、KUDs です。
前回の記事では、YouTube Data api v3 の始め方やコーディング、クォータ制限と消費量についてお話ししました。
前回の記事でも言及した通り、クォータの消費量を削減するにはいくつか検討すべき事項があります。
- リクエストメソッドの最適化
- キャッシュの利用
- ページングの利用
ただ、これらを駆使してもサービスが順調に成長したら、クォータは足りなくなります。
こういう時は、クォータの上限緩和申請を検討しましょう。
この記事では、申請の手順や注意点について具体的に解説します。
誰でも、正しくアプリを使用しており、正しく申請すれば必ず通ります。
決してハードルが高いものではないので、ご安心ください。
API の上限緩和申請ってハードルが高いの？
KUDs 的感想としましては、ハードルは低いです。
申請ハードルが高いと思われがちな理由
そもそも、なぜ API 申請ハードルが高いと思われがちなのでしょうか。
以下のような意見をよく耳にします。
- 「申請は大体拒否されると聞きました。2回目以降、改めて申請するのが辛そうです。」
- 「申請時に満たしておく事項が多いと聞きました。OAuth 認証画面や Google ポリシーの記載、利用方法のデモ動画作成等、難しい内容が多そうです。」
- 「申請は英語が必須と聞きました。英語でのコミュニケーションは難しいです。」
上記は、一部正しい箇所もありますが、誤りもあります。
まず前提の認識を合わせておきましょう。
API 上限緩和申請は拒否されるのか？
はい。
申請に不備があったり、アプリの利用が不適ならもちろん拒否されます。
やっぱりそうなんですね。。
拒否されたら心折れそうです。。
2 回目申請する元気もあるかどうか。。
という感じでしょげてる方も多いかと思います。
でも、ご安心ください。
2 回目の申請を一から行う必要はありません！
申請後は、Google 担当者が、「～について教えて。～の部分はこんな風に修正して。」とメールしてくれます。
それに対して、「～はこういう意味です。～の部分は修正しました。」という感じで、直接やり取りしながら進められます。
なので、一から再申請する必要はなく、一個ずつ進められますのでご安心ください。
なお、もちろん一発で合格できる人もいます。
ただ、このような人は申請に慣れている人や、エキスパートの方です。
この記事を見る方は初めて申請する方が多いかと思いますので、直接やり取りしながら一個一個修正し、ゆっくり合格目指していくのがいいかと思います。
API 上限緩和申請の前提条件は多いのか？
いいえ。
少ないです。
え、でも、
- OAuth 認証画面 / OAuth 2.0 クライアントの作成？
- Google ポリシーの記載？
- 利用方法のデモ動画作成？
が必要って聞いたんですけど。。
という感じでしょげてる方も多いかと思います。
以下、それぞれ回答します。
OAuth 認証画面 / OAuth 2.0 クライアントの要否
アプリに依ります。
アクセスするデータが、パブリックオンリーなのか、ユーザーデータ含むのかに依るということです。
少なくとも言えることは、申請時の必須条件ではないです。
Google ポリシーの記載の要否
必要です。
アプリで API を使用しているなら、正しくプライバシーポリシーや利用規約を記載する必要があります。
但し、こちらも申請時の必須条件ではないです。
API 利用のデモ動画の作成
申請内容 & Google 担当者に依ります。
申請内容が十分に記載されておらず、API の利用手順がわかりづらい場合はデモ動画の作成が要求されることはあります。
しかし、こちらも申請時の必須条件ではないです。
API 上限緩和申請は英語でする必要があるか？
いいえ。
日本語で申請可能です。
。。。！！
という感じで喜ばせておいて申し訳ないのですが、Google 担当者からのメール返信は英語です。
メールは YouTube API Services Team から返信されますが、海外のため英語での返信となるわけです。
まとめると以下です。
- API 上限緩和申請 (Web 上) は日本語で可
- メール返信は英語
- 読めない場合は翻訳する必要があり
- Google 翻訳なり DeepL なり ChatGPT なり使いましょう
- メール送信は日本語可 (おそらく)
- 向こうは向こうで翻訳して対応してくれるはずです
- ただ、円滑なコミュニケーションのためには英語での連絡を推奨
結論: とりあえず申請してみよう
まとめると以下ですね。
- API 上限緩和申請は拒否されることはあるが、一から申請し直す必要はない
- API 上限緩和申請時の前提条件として以下は必須ではない
- OAuth 認証画面 / OAuth 2.0 クライアントの作成
- Google ポリシーの記載
- 利用方法のデモ動画作成
- API 上限緩和申請は日本語でも可能
上記の通り、そこまで API 上限緩和申請のハードルは高いものではありません。
加えて、担当チームは一つ一つ課題を教えてくれます。
そのため、とりあえず申請してみて、問題点があれば解消していくスタイルをお勧めします。
実際の申請手順
このでは、実際の申請手順を確認しましょう。
「YouTube API サービス – 監査と割り当て増加フォーム」から申請します。
以下では、具体的にどの項目にどのような記載をすればいいのかを解説します。
具体的な各項目の記載方法
申請フォームでは「* 必須項目」と記載がある通り、 * が付く項目は必ず記載する必要があります。
KUDs 自作アプリの Live Stream Calendar でも YouTube Data api v3 を利用しているため、以下 Live Stream Calendar の場合における記入例を赤字で記載します。
このフォームにご記入いただく理由 *
- 目的コンプライアンス監査を完了したいまたは追加の API 割り当てをリクエストしたい
- 定期監査の対象になった
追加の API 割り当てをリクエストしたいので、そちらを選択しましょう。
一般情報
このセクションでは YouTube に関する組織について記載します。
氏名 *
山田そし子
まず氏名を書きましょう。
組織名 *
KUDs
ここでは法人名なり、屋号なり、組織名を書きましょう。
組織のウェブサイト *
ここでは組織のウェブサイトの URL を記載しましょう。
組織の住所 *
東京都千代田区丸の内１丁目
ここでは組織の住所を記載しましょう。もちろん日本語で大丈夫です。
組織の連絡先メールアドレス *
ここでは組織のメールアドレスを記載しましょう。
YouTube に関連する、組織の業務を説明してください *
KUDs Co. ( 以下、当社 ) は、～ に対して ～ を行っています。当社は Web サイトにて ～ を提供しており、～等機能を提供しております。
ここでは組織がどんな業務やサービス提供を行っているかを簡潔に記載しましょう。
API クライアント情報
「API クライアント」とは、YouTube API サービスにアクセスまたはこれを使用するウェブサイトあるいはソフトウェア アプリケーションを指します。
2019 年 6 月以降に監査を受けましたか *
- はい
- いいえ
Live Stream Calendar の場合は「いいえ」です。監査を受けていない方がほとんどだと思いますが、受けた人は「はい」を選択しましょう。
前回の監査以降、クライアントによる YouTube API の使用状況になんらかの変化がありましたか *
- はい
- いいえ
先程の質問が「いいえ」だった人は、こちらでも「いいえ」を選択しましょう。
API クライアントをすべて記入してください *
Live Stream Calendar
アプリ名、もしくは Web サイト名を記載します。私の場合は Live Stream Calendar アプリで使用しているため、アプリ名を記載します。
各 API クライアントで使用するプロジェクト番号をすべて記入してください *
123456789012
プロジェクト番号は、Google Cloud Console でプロジェクト ID の横に表示される一連の数字です。
現時点では 12 桁の数字です。
プロジェクト ID とは異なるので注意してください。
この API クライアントは一般公開されていますか、それとも非公開ですか。 *
- 一般公開されている
- 社内専用
Live Stream Calendar の場合は、一般公開済みなので「一般公開」を選択します。
各 API クライアントを確認できる場所を記入してください *
https://kuds.win/live-stream-calendar
アプリの場所 (Web サイトなら URL) を記入しましょう。
API クライアントにアクセスするためにログインする必要がある場合は、デモアカウントと、API クライアントにアクセスする手順を指定してください
まず、アプリにアクセスします。次に、ユーザ名: SosikoUser, パスワード: SosikoPassword を入力し、サインインします。最後に、Fetch ボタンをクリックします。
Live Stream Calendar の場合はサインインする必要があるので、予め申請用のデモアカウントを作成した上で、ユーザ名・パスワードを共有しました。サインイン不要な場合は利用方法だけ記載しましょう。
API クライアントで YouTube データを商品化していますか *
- はい
- いいえ
Live Stream Calendar の場合は Live Highlight Finder の機能の一部として提供しております。また、Live Highlight Finder は有料プランが存在するため、この場合は「はい」を選択します。商品化していない場合は「いいえ」を選択しましょう。
API クライアントのユースケースに最も近いものを以下から選択してください *
- YouTube アナリティクス
- ソーシャル メディア分析
- YouTube 動画のアップロード
- 動画ストリーミング サイト / アプリ
- ライブ配信ツール
- 調査
- クリエイター向けツール
- その他
皆様の API クライアントのユースケースとして、適しているものを選びましょう。Live Highlight Finder の場合は、切り抜きアプリなので「クリエイター向けツール」でもいいかなと思いつつも、「調査」って割となんでも当てはまりそうだなーと思い「調査」にしても良いかと。
この API クライアントで使用する YouTube API サービスをすべて選択してください *
- Data API
- Analytics API
- Reporting API
- Content ID API
- 埋め込み
- Live Streaming API
今回は YouTube Data api v3 のお話なので、Data API を選択しましょう。
API クライアントの主なユーザー層を選択してください *
- クリエイター
- 閲覧者
- 広告主
- 企業
- 社内専用
皆様のアプリのユーザー層として適しているものを選択しましょう。 Live Stream Calendar はクリエイターや閲覧者向けサービスなので、それらを選択します。
API クライアントを使用しているユーザー数は、およそどのくらいですか *
5041
おおよそのアクティブユーザを記載しましょう。(上記例の数字に深い意図はありません)
ユーザーが API クライアントをどのように使用しているか説明してください *
1. ユーザは、Live Stream Calendar に遷移します
2. ユーザは、Email, Password を入力しサインインします
3. ユーザは、特定の YouTube チャンネルのハンドル名を指定できます (※有料会員の場合のみ)
4. ユーザは [Fetch] をクリックします
5. API クライアントは YouTube Data API v3 を利用し、対象の YouTube チャンネルの過去のライブ配信情報を検索します
6. ユーザは、表示された過去のライブ配信情報をカレンダー上で確認したり、タイトル検索することができます。また、YouTube 画面へ遷移し、ライブを視聴することも可能です
上記のように、ユーザーストーリーマッピングのような形で書くことをお勧めします。
API クライアントは複数のプロジェクトを使用して YouTube API にアクセスしていますか *
- はい
- いいえ
Live Stream Calendar の場合は単一のプロジェクトのため、「いいえ」を選択します。複数の人は「はい」を選択しましょう。
この API クライアントは、YouTube データから導き出した指標を作成、アクセス、または使用していますか *
- はい
- いいえ
Live Stream Calendar の場合は使用しているので「はい」を選択します。使用しない場合は「いいえ」を選択しましょう。
この API クライアントは、複数のプラットフォーム（Facebook や Twitter など）から取得したデータを表示したり、複数のプラットフォームに機能やサービスを提供したりしていますか *
- はい
- いいえ
Live Stream Calendar の場合は、アプリ上で Twitch から取得したデータも合わせて表示するため「はい」を選択します。もし複数プラットフォームの表示・提供がない場合は「いいえ」を選択しましょう。
YouTube API データを使用して、なんらかのレポートを作成、提供していますか *
- はい
- いいえ
Live Stream Calendar の場合は「いいえ」を選択しました。特にドキュメント生成等していなければ「いいえ」で良いかと。
YouTube API データをどのくらいの期間保存していますか *
- 12 か月を超える
- 3～12 か月
- 30～90 日
- 1～4 週間
- 1～7 日
- 24 時間未満
どの程度の期間保持しているかを記載します。キャッシュや DB の TTL を設定している方はその期間を記載しましょう。特保持せず、速攻破棄している方は 24 時間未満で大丈夫です。
どのくらいの頻度で YouTube API データを更新していますか *
- 24 時間
- 1 週間
- 1 か月
- 1 年
- 更新していない
定期的に(日次バッチ等で)データを更新している場合は、その頻度を書きます。更新していない場合は「更新していない」を選択しましょう。
この API クライアントは、ユーザーが Google 認証情報を使用して認証できるようにしていますか *
- はい
- いいえ
Live Stream Calendar の場合、パブリックデータへのアクセスのみでありユーザ認証はありません。そのため、「いいえ」を選択します。もしユーザデータ利用があり、Google 認証情報を使用している場合は「はい」を選択しましょう。
割り当てリクエスト フォーム
このセクションは、割り当て上限に近づいた場合のみ記入します。
今回は「追加の API 割り当てをリクエスト」が目的なので、多少冗長的になる部分もありますが、こちらのセクションも記入しましょう。
各 API クライアントによる YouTube API サービスの実装、アクセス、統合、使用に関連するドキュメント（設計ドキュメントなど）を送信してください。API クライアントが公開されていない場合は、各 YouTube API サービス機能の詳細なスクリーンショットと、この API クライアントで表示される、またはこれに統合される YouTube データ、コンテンツ、情報をアップロードしてください。 *
YouTube Data api v3 を利用しているサービスについて、設計書やコードを提供しましょう。API クライアントが公開されていない場合は、より詳細な情報提供が必要とのこと。 Live Stream Calendar の場合は公開しているので、実装したコーディングやアーキテクチャ図等を提供します。
割り当て増加のリクエストの対象となる API クライアントを記入してください *
Live Stream Calendar
再度 API クライアント名を記入します。
割り当て増加のリクエストの対象となる API プロジェクト番号を記入してください *
123456789012
再度プロジェクト番号を記入します。
割り当て増加のリクエストの対象となる YouTube API サービスを指定してください *
- Data API
先ほど選択した Data API が表示されるので、選択します。
リクエストする「追加割り当て」量を記入してください *
90000
注意点としては、「追加割り当て量」 = 「必要な総割り当て量」 – 「現在の割り当て量」であることです。デフォルトの割り当て量は 10,000 のため、もし 100,000 に引き上げたい場合は 90,000 を指定することになります。
追加割り当てをリクエストする理由を説明してください *
アプリの機能拡張 (1) 及び利用者数の増加 (2) に伴い、API クォータが枯渇することが懸念されるため、割り当て増加をお願いします。
(1). アプリの機能拡張について
当該アプリはキャッシュに YouTube API データを保持し、API の利用頻度を削減してます。
しかし、キャッシュの存続期間は ~ であり、この間はデータが更新されないためリアルタイム性が失われてしまいます。
今後はリアルタイム性向上のため、キャッシュの更新頻度を ~ 時間にしたいと考えています。
そのため、現在の API 使用量の ~ 倍になることが予想されます。
(2). アプリ利用者の増加について
現状アクティブユーザーが ~ 倍 / 月 で推移しており、今後 ~ カ月以内には ~ 倍になることが予想されます。
それに伴い、現在の API 使用量の ~ 倍になることが予想されます。
概算となりますが、上記 1, 2, を基に算出した結果は以下です。
・現在の API 使用量: X
・(1)に伴う API 使用量の増加率: Y
・(2)に伴う API 使用量の増加率: Z
X * Y * Z ≒ 100,000
ここではあくまで一例を記載してます。実際に記入する際は、実装のアプリに応じて具体性を持たせて記入することをお勧めします。
現在 YouTube API サービスをどのように使用しているか詳しく説明してください *
1. ユーザは、Live Stream Calendar に遷移します
2. ユーザは、Email, Password を入力しサインインします
3. ユーザは、特定の YouTube チャンネルのハンドル名を指定できます (※有料会員の場合のみ)
4. ユーザは [Fetch] をクリックします
5. API クライアントは YouTube Data API v3 を利用し、対象の YouTube チャンネルの過去のライブ配信情報を検索します
6. ユーザは、表示された過去のライブ配信情報をカレンダー上で確認したり、タイトル検索することができます。また、YouTube 画面へ遷移し、ライブを視聴することも可能です
ユーザーストーリーは上記の通りです。
API の利用について、処理の詳細は添付ファイルの XXX.txt をご参照ください。
あれ、これさっきも見たぞ？と思われた方、その通りです。手を抜きました決してめんどくさくなったわけではありません。既にアーキテクチャ図や実装コードを添付しているので、Google の担当者なら、私なんぞの説明よりもコード見た方が早いってなると思うので、「詳細はコード見て」と書きました。
割り当てを増やさないと API クライアントで使用できなくなるのはどのような機能ですか *
ユーザは、特定のチャンネルのハンドル名を指定し、Fetch をクリックするだけで、過去のライブ配信情報をカレンダー表示できます。
API 利用上限に抵触した場合は、上記の機能が使用できなくなります。
ユーザへの影響は具体的に以下です。
1. ユーザが特定のチャンネルのライブ配信履歴をカレンダー表示できなくなる
2. ユーザが特定のチャンネルのライブ配信履歴をカレンダー表示した際に、最新の情報を反映できなくなる
ここではあくまで一例を記載してます。主にユーザへの影響を記載すると良いかと思います（API クライアントがリクエストできなくなることは自明なので）。
割り当ての不足を補うためにどのような回避策を講じますか（例: 機能セットを減らす、推定する、サンプリングを削減する） *
キャッシュ保持期間・更新頻度の見直し
ユーザのカレンダー表示機能の利用回数制限の追加の検討
ここでは、クォータが枯渇しないような工夫はどうするかについて回答します。担当者側からすれば、「API クォータ上限緩和しない場合に、どのような対処が可能か、或いは対処不可能なのか」を判断する材料になります。
YouTube API サービス利用規約とデベロッパー ポリシーの確認
私は、YouTube API サービスの利用規約（デベロッパー ポリシーと Google プライバシー ポリシーを含む）を読み、内容に同意します。また、YouTube API サービスへの現在の、および提案するアクセスとその用途は、YouTube API サービスの利用規約を遵守しています。 *
はい
デモアカウントと、Google が API クライアントにアクセスするための手順を記載した場合、そのようなアカウントまたは API クライアントへのアクセスに適用される利用規約またはポリシーに Google は拘束されないことを理解し、これに同意します。 *
同意する
上記の事実は私の知る限り真実であり、上記の事実が真実でないことが判明した場合、YouTube は YouTube の利用規約とデベロッパー ポリシーに従って、API クライアントによる YouTube API サービスへのアクセスを終了する場合があることを理解しています *
同意する
送信
完了です！！お疲れ様でした！！
Google 担当者とのメールでのやり取り
無事申請フォームが送信出来たら、次にレビュー開始の連絡がメールで来ます。
レビューして指摘があれば連絡があるので、ゆったりと待ちましょう。
ここでは、 Live Stream Calendar の申請にて実際にメールで指摘された内容をざっくり紹介します。
「Live Highlight Finder のランキング決定基準は何？」
いきなりですが、「え？」となりました。
今回の API の上限緩和申請では、対象は Live Stream Calendar でした。つまり、 Live Highlight Finder についてのレビュー依頼はしていないにもかかわらず、仕様を問われたから驚いたのです。
（そこまでフルレビューしてくれるんだぁ）と内心驚きつつ、 Live Highlight Finder の簡単な仕様と、今回の申請とは無関係であることを強調し、回答しました。
「YouTube API サービスの利用規約とポリシーに準拠して」
多くの場合、おそらくここは指摘されます。
しかし、安心してください。
Google 担当者は、「どの辺りが準拠できていないのか」を具体的に示してくれます。
Live Stream Calendar の場合、プライバシーポリシーと利用規約に「YouTube API に関する記載」が無かったため指摘を受けました。そこで、修正・デプロイ後、メールにてスクショを張り付けつつ、「アプリを修正したよ。これは英語では～という意味だよ。」という説明をしました。
「審査しますね」
次に、ある程度 Google 担当者からの質疑に応答すると、審査フェーズに入ります。こちらは数日で
「審査完了です」
数日で審査完了しました！
お疲れ様です！
最後に、クォータの上限緩和がされたかは、GCP コンソール画面から確認可能です。
YouTube Data api v3 の QUOTAS & SYSTEM LIMITS から確認しましょう。
以下のリンクからでも確認可能かと思います。
さいごに
今回の記事のまとめを書こうかと思ったのですが、結論としては一言でした。
とりあえず申請してみよう
YouTube API Services Team は割と手取り足取り教えてくれます。
なので、「不備があれば担当者に一緒に直してもらおう」ぐらいの感覚で申請しちゃってもいいと思います。
申請の準備に時間をかけるのはもったいないですよね。。本当にやりたいことは申請ではないので。。
他に、「こんな発見があったよー」等あればコメントいただけますと幸いです！
以上
コメント