Google Ads API では、YouTube 動画を Google 広告アカウントにリンクできます。このガイドでは、API を使用してアカウントへのリンクを追加、削除する方法について説明します。
動画をリンクする
動画をアカウントにリンクするには、次の 2 つの方法があります。どちらの方法を使用するかは、プロセスを開始するユーザーによって異なります。
- 動画をアカウントにリンクするようリクエストします。この場合、クリエイターにリクエストを送信し、クリエイターがリクエストを承認すると、動画へのリンクが確立されます。リクエストが承認される前に取り消すことも、承認された後にリンクされた動画を削除することもできます。
- 動画のクリエイターが、自分の動画を Google 広告アカウントにリンクするようリクエストします。このリクエストを承認するか拒否するかを選択できます。
各シナリオでは、次のメソッドが使用されます。
| シナリオ | アクション | 備考 |
|---|---|---|
| シナリオ 1 | YouTube API から動画情報を取得する | YouTube API
を使用して、動画リンク リクエストの送信先となる channel_id と、リンクする動画の video_id
を取得します。video_id は、YouTube 動画の URL に含まれる 11 文字の文字列です（例: www.youtube.com/watch?v=VIDEO_ID の v パラメータ、youtu.be/VIDEO_ID のパス）。 |
| リンク リクエストを作成する |
DataLinkService.CreateDataLink メソッド
を使用してリンク リクエストを作成します。動画とその関連チャンネルを識別するために、
youtube_video.channel_id と youtube_video.video_id
の両方を指定します。v24 以降では、
youtube_link_metadata.brand_channel_id
を指定して、リンクされた YouTube ブランド チャンネルの ID を提供し、クリエイターが
お客様のブランドを理解できるようにすることもできます。
status
の DataLink は設定しないでください。API 呼び出しが正常に完了すると、Google Ads API サーバーによって REQUESTED に設定されます。 |
|
| リクエストのステータスを確認する | GoogleAdsService.SearchStream または GoogleAdsService.Search を使用して data_link
リソースをクエリし、その
status を確認します。 |
|
| リクエストを取り消す |
DataLinkService.UpdateDataLink メソッドを使用して、
DataLink の status を REQUESTED から REVOKED に変更することで、リンク リクエストを取り消します。 |
|
| リンクを削除する |
DataLinkService.RemoveDataLink を使用して、リンクされた動画を削除します。 |
|
| シナリオ 2 | 招待状を取得する | GoogleAdsService.Search
または GoogleAdsService.SearchStream
を使用して data_link
リソースをクエリします。
status = PENDING_APPROVAL でフィルタして、承認または拒否するリンク リクエストを見つけます。 |
| リンク リクエストを承認または拒否する |
DataLinkService.UpdateDataLink メソッドを使用して、DataLink
のステータスを ENABLED に更新してリクエストを承認するか、REJECTED に更新してリクエストを拒否します。 |
リンクの詳細を取得する
GoogleAdsService.Search
または
GoogleAdsService.SearchStream
を使用してdata_linkリソースをクエリできます。次のクエリでは、YouTube 動画 ID やチャンネル ID など、YouTube 動画リンクの詳細を取得します。
SELECT
data_link.resource_name,
data_link.status,
data_link.youtube_video.video_id,
data_link.youtube_video.channel_id
FROM data_link
WHERE data_link.type = 'VIDEO'
このワークフローでは、次の一般的なエラーが発生する可能性があります。
| エラーコード | 説明 |
|---|---|
DataLinkError.PERMISSION_DENIED |
お客様には、この操作を行う権限がありません。 |
DataLinkError.YOUTUBE_VIDEO_ID_INVALID |
動画 ID が無効なため、動画リンクを作成できませんでした。 |
DataLinkError.INVALID_STATUS |
データリンクの現在のステータスが、リクエストされた操作に対して無効な場合に発生します。 |
DataLinkError.INVALID_UPDATE_STATUS |
更新中にサポートされていないステータスの移行（REVOKED から ENABLED への直接移行など）を試みた場合に発生します。 |
MutateError.RESOURCE_ALREADY_EXISTS |
動画のデータリンクがすでに存在する場合に発生します。 |