VOD 構成の作成と管理

このページでは、VOD 構成を管理する方法について説明します。VOD 構成は、VOD セッションの構成に使用されます。詳細については、REST のドキュメントをご覧ください。

始める前に

VOD セッションを作成するには、まず VOD アセットのソース HLS または DASH マニフェストを生成するエンコーダを構成する必要があります。これらのマニフェストには、広告合成のために Video Stitcher API で識別されるミッドロール挿入点の境界に特定の広告マーカーが含まれています。Transcoder API を使用してコード変換ジョブを作成し、MP4 または MOV などのメディア ファイル形式からマニフェスト ファイルを生成できます。

サポートされている HLS と DASH の広告マーカーについて詳しくは、広告マーカーのドキュメントをご覧ください。

VOD 構成を定義する

VOD 構成を定義する際に、次の項目は必須です。

• sourceUri
• adTagUri

sourceUri では、広告を挿入するソース VOD アセットの HLS または DASH マニフェストの URL を指定します。指定された URL が DASH マニフェストを参照している場合で、指定された URL が HLS マニフェストと DASH 再生 URL を参照している場合、Video Stitcher API は HLS 再生 URL を返します。

adTagUri には、広告メタデータを返す広告サーバーの URL を指定します。

VOD 構成を登録する

VOD 構成を登録するには、projects.locations.vodConfigs.create メソッドを使用します。

REST

リクエストのデータを使用する前に、次のように置き換えます。

• PROJECT_NUMBER: IAM 設定ページの [プロジェクト番号] フィールドにある Google Cloud プロジェクト番号
• LOCATION: VOD 構成を作成するロケーション。サポートされているリージョンのいずれかを使用します。
  3～7 つの店舗を表示
  • us-central1
  • us-east1
  • us-west1
  • asia-east1
  • asia-south1
  • asia-southeast1
  • europe-west1
  • southamerica-east1
• VOD_CONFIG_ID: VOD 構成のユーザー定義の識別子。この ID に使用できるのは、小文字、数字、ハイフンに限られます。 最初の文字は英字で、最後の文字は英字または数字で、ID 全体は最大 63 文字です。
• VOD_URI: 合成するメディアの URI。この URI は、MPEG-DASH マニフェスト（MPD）ファイルまたは HLS マニフェスト（M3U8）ファイルを参照する必要があります。CDN キーを登録した公開 URI または署名なし URI を使用します。
  注: Transcoder API を使用して、これらのマニフェスト ファイルを作成できます。詳しくは、既成のテンプレートを使用したジョブの作成をご覧ください。マニフェスト ファイルを公開して、Video Stitcher API がアクセスできるようにする必要があります。
• AD_TAG_URI: 広告タグの公開 URI。ない場合は、VMAP プレロールサンプルを使用できます。

JSON 本文のリクエスト:

{
  "sourceUri": "VOD_URI",
  "adTagUri": "AD_TAG_URI"
}

リクエストを送信するには、次のいずれかのオプションを展開します。

curl（Linux、macOS、Cloud Shell）

注: 次のコマンドは、gcloud init または gcloud auth login を実行して、ユーザー アカウントで gcloud CLI にログインしているか、Cloud Shell を使用して自動的に gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

リクエスト本文を request.json という名前のファイルに保存します。ターミナルで次のコマンドを実行して、このファイルを現在のディレクトリに作成または上書きします。

cat > request.json << 'EOF'
{
  "sourceUri": "VOD_URI",
  "adTagUri": "AD_TAG_URI"
}
EOF

その後、次のコマンドを実行して REST リクエストを送信します。

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://videostitcher.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION/vodConfigs?vodConfigId=VOD_CONFIG_ID"

PowerShell（Windows）

注: 次のコマンドは、gcloud init または gcloud auth login を実行してユーザー アカウントで gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

リクエスト本文を request.json という名前のファイルに保存します。ターミナルで次のコマンドを実行して、このファイルを現在のディレクトリに作成または上書きします。

@'
{
  "sourceUri": "VOD_URI",
  "adTagUri": "AD_TAG_URI"
}
'@  | Out-File -FilePath request.json -Encoding utf8

その後、次のコマンドを実行して REST リクエストを送信します。

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://videostitcher.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION/vodConfigs?vodConfigId=VOD_CONFIG_ID" | Select-Object -Expand Content

次のような JSON レスポンスが返されます。

{
  "name": "projects/PROJECT_NUMBER/locations/LOCATION/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.common.OperationMetadata",
    "createTime": CREATE_TIME,
    "target": "projects/PROJECT_NUMBER/locations/LOCATION/vodConfigs/VOD_CONFIG_ID",
    "verb": "create",
    "cancelRequested": false,
    "apiVersion": "v1"
  },
  "done": false
}

このコマンドは、進行状況を追跡するためにクエリできる長時間実行オペレーション（LRO）を作成します。次のセクションで使用するために、返された OPERATION_ID（name フィールドの最後の部分）をコピーします。

結果を確認する

VOD 構成が作成されたかどうかを確認するには、projects.locations.operations.get メソッドを使用します。レスポンスに "done: false" が含まれている場合は、レスポンスに "done: true" が含まれるまでコマンドを繰り返します。

リクエストのデータを使用する前に、次のように置き換えます。

• PROJECT_NUMBER: IAM 設定ページの [プロジェクト番号] フィールドにある Google Cloud プロジェクト番号
• LOCATION: データのロケーション。サポートされているリージョンのいずれかを使用します。
  3～7 つの店舗を表示
  • us-central1
  • us-east1
  • us-west1
  • asia-east1
  • asia-south1
  • asia-southeast1
  • europe-west1
  • southamerica-east1
• OPERATION_ID: オペレーションの ID。

リクエストを送信するには、次のいずれかのオプションを展開します。

curl（Linux、macOS、Cloud Shell）

注: 次のコマンドは、gcloud init または gcloud auth login を実行して、ユーザー アカウントで gcloud CLI にログインしているか、Cloud Shell を使用して自動的に gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

次のコマンドを実行します。

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://videostitcher.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION/operations/OPERATION_ID"

PowerShell（Windows）

注: 次のコマンドは、gcloud init または gcloud auth login を実行してユーザー アカウントで gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

次のコマンドを実行します。

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://videostitcher.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION/operations/OPERATION_ID" | Select-Object -Expand Content

次のような JSON レスポンスが返されます。

{
  "name": "projects/PROJECT_NUMBER/locations/LOCATION/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.common.OperationMetadata",
    "createTime": CREATE_TIME,
    "endTime": END_TIME,
    "target": "projects/PROJECT_NUMBER/locations/LOCATION/vodConfigs/VOD_CONFIG_ID",
    "verb": "create"
  },
  "done": true,
  "response": {
    "@type": "type.googleapis.com/google.cloud.video.stitcher.v1.VodConfig",
    "name": "projects/PROJECT_NUMBER/locations/LOCATION/vodConfigs/VOD_CONFIG_ID",
    "sourceUri": "VOD_URI",
    "adTagUri": "AD_TAG_URI",
    "state": "READY"
  }
}

VOD 構成を取得する

特定の VOD 構成ファイルの詳細を取得するには、projects.locations.vodConfigs.get メソッドを使用します。

REST

リクエストのデータを使用する前に、次のように置き換えます。

• PROJECT_NUMBER: IAM 設定ページの [プロジェクト番号] フィールドにある Google Cloud プロジェクト番号
• LOCATION: VOD 構成ファイルのロケーション。サポートされているリージョンのいずれかを使用します。
  3～7 つの店舗を表示
  • us-central1
  • us-east1
  • us-west1
  • asia-east1
  • asia-south1
  • asia-southeast1
  • europe-west1
  • southamerica-east1
• VOD_CONFIG_ID: VOD 構成ファイルのユーザー定義の識別子。

リクエストを送信するには、次のいずれかのオプションを展開します。

curl（Linux、macOS、Cloud Shell）

注: 次のコマンドは、gcloud init または gcloud auth login を実行して、ユーザー アカウントで gcloud CLI にログインしているか、Cloud Shell を使用して自動的に gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

次のコマンドを実行します。

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://videostitcher.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION/vodConfigs/VOD_CONFIG_ID"

PowerShell（Windows）

注: 次のコマンドは、gcloud init または gcloud auth login を実行してユーザー アカウントで gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

次のコマンドを実行します。

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://videostitcher.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION/vodConfigs/VOD_CONFIG_ID" | Select-Object -Expand Content

次のような JSON レスポンスが返されます。

{
  "name": "projects/PROJECT_NUMBER/locations/LOCATION/vodConfigs/VOD_CONFIG_ID",
  "sourceUri": "VOD_URI",
  "adTagUri": "AD_TAG_URI",
  "state": "READY"
}

VOD 構成を更新する

VOD 構成を更新するには、projects.locations.vodConfigs.patch メソッドを使用します。次の例では、sourceUri フィールドを更新します。

REST

リクエストのデータを使用する前に、次のように置き換えます。

• PROJECT_NUMBER: IAM 設定ページの [プロジェクト番号] フィールドにある Google Cloud プロジェクト番号
• LOCATION: VOD 構成ファイルのロケーション。サポートされているリージョンのいずれかを使用します。
  3～7 つの店舗を表示
  • us-central1
  • us-east1
  • us-west1
  • asia-east1
  • asia-south1
  • asia-southeast1
  • europe-west1
  • southamerica-east1
• VOD_CONFIG_ID: VOD 構成ファイルのユーザー定義の識別子。
• VOD_URI: 合成するメディアの更新された URI。

リクエストの本文（JSON）:

{
  "sourceUri": "VOD_URI"
}

リクエストを送信するには、次のいずれかのオプションを展開します。

curl（Linux、macOS、Cloud Shell）

注: 次のコマンドは、gcloud init または gcloud auth login を実行して、ユーザー アカウントで gcloud CLI にログインしているか、Cloud Shell を使用して自動的に gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

リクエスト本文を request.json という名前のファイルに保存します。ターミナルで次のコマンドを実行して、このファイルを現在のディレクトリに作成または上書きします。

cat > request.json << 'EOF'
{
  "sourceUri": "VOD_URI"
}
EOF

その後、次のコマンドを実行して REST リクエストを送信します。

curl -X PATCH \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://videostitcher.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION/vodConfigs/VOD_CONFIG_ID?updateMask=sourceUri"

PowerShell（Windows）

注: 次のコマンドは、gcloud init または gcloud auth login を実行してユーザー アカウントで gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

リクエスト本文を request.json という名前のファイルに保存します。ターミナルで次のコマンドを実行して、このファイルを現在のディレクトリに作成または上書きします。

@'
{
  "sourceUri": "VOD_URI"
}
'@  | Out-File -FilePath request.json -Encoding utf8

その後、次のコマンドを実行して REST リクエストを送信します。

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method PATCH `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://videostitcher.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION/vodConfigs/VOD_CONFIG_ID?updateMask=sourceUri" | Select-Object -Expand Content

次のような JSON レスポンスが返されます。

{
  "name": "projects/PROJECT_NUMBER/locations/LOCATION/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.common.OperationMetadata",
    "createTime": CREATE_TIME,
    "target": "projects/PROJECT_NUMBER/locations/LOCATION/vodConfigs/VOD_CONFIG_ID",
    "verb": "update"
  },
  "done": false
}

このコマンドは、進行状況を追跡するためにクエリできる長時間実行オペレーション（LRO）を作成します。詳細については、結果を確認するをご覧ください。

登録されているすべての VOD 構成を一覧表示する

プロジェクト内の特定のロケーションに登録されているすべての VOD 構成ファイルを一覧表示するには、projects.locations.vodConfigs.list メソッドを使用します。

REST

リクエストのデータを使用する前に、次のように置き換えます。

• PROJECT_NUMBER: IAM 設定ページの [プロジェクト番号] フィールドにある Google Cloud プロジェクト番号
• LOCATION: VOD 構成ファイルのロケーション。サポートされているリージョンのいずれかを使用します。
  3～7 つの店舗を表示
  • us-central1
  • us-east1
  • us-west1
  • asia-east1
  • asia-south1
  • asia-southeast1
  • europe-west1
  • southamerica-east1

リクエストを送信するには、次のいずれかのオプションを展開します。

curl（Linux、macOS、Cloud Shell）

注: 次のコマンドは、gcloud init または gcloud auth login を実行して、ユーザー アカウントで gcloud CLI にログインしているか、Cloud Shell を使用して自動的に gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

次のコマンドを実行します。

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://videostitcher.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION/vodConfigs"

PowerShell（Windows）

注: 次のコマンドは、gcloud init または gcloud auth login を実行してユーザー アカウントで gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

次のコマンドを実行します。

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://videostitcher.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION/vodConfigs" | Select-Object -Expand Content

次のような JSON レスポンスが返されます。

{
  "vodConfigs": [
    {
      "name": "projects/PROJECT_NUMBER/locations/LOCATION/vodConfigs/VOD_CONFIG_ID",
      "sourceUri": "VOD_URI",
      "adTagUri": "AD_TAG_URI",
      "state": "READY"
    },
    {
      "name": "projects/PROJECT_NUMBER/locations/LOCATION/vodConfigs/my-other-vod-config",
      "sourceUri": "my-other-vod-stream-uri",
      "adTagUri": "my-other-ad-tag-uri",
      "state": "READY"
    }
}

その他の成果

curl レスポンスには nextPageToken が含まれている場合があります。これを使用して、追加の結果を取得できます。

{
  "vodConfigs": [
    ...
  ],
  "nextPageToken": "NEXT_PAGE_TOKEN"
}

追加の構成ファイルを一覧表示するには、NEXT_PAGE_TOKEN の値を含む別の curl リクエストを送信します。前述の API 呼び出しの URL に次を追加します。

?pageToken=NEXT_PAGE_TOKEN

このトークンの使用について詳しくは、関連するクライアント ライブラリをご覧ください。

VOD 構成を削除する

登録した VOD 構成ファイルが不要になった場合は、projects.locations.vodConfigs.delete メソッドを使用して削除します。

REST

リクエストのデータを使用する前に、次のように置き換えます。

• PROJECT_NUMBER: IAM 設定ページの [プロジェクト番号] フィールドにある Google Cloud プロジェクト番号
• LOCATION: VOD 構成ファイルのロケーション。サポートされているリージョンのいずれかを使用します。
  3～7 つの店舗を表示
  • us-central1
  • us-east1
  • us-west1
  • asia-east1
  • asia-south1
  • asia-southeast1
  • europe-west1
  • southamerica-east1
• VOD_CONFIG_ID: VOD 構成ファイルのユーザー定義の識別子。

リクエストを送信するには、次のいずれかのオプションを展開します。

curl（Linux、macOS、Cloud Shell）

注: 次のコマンドは、gcloud init または gcloud auth login を実行して、ユーザー アカウントで gcloud CLI にログインしているか、Cloud Shell を使用して自動的に gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

次のコマンドを実行します。

curl -X DELETE \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://videostitcher.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION/vodConfigs/VOD_CONFIG_ID"

PowerShell（Windows）

注: 次のコマンドは、gcloud init または gcloud auth login を実行してユーザー アカウントで gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

次のコマンドを実行します。

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method DELETE `
    -Headers $headers `
    -Uri "https://videostitcher.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION/vodConfigs/VOD_CONFIG_ID" | Select-Object -Expand Content

次のような JSON レスポンスが返されます。

{
  "name": "projects/PROJECT_NUMBER/locations/LOCATION/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.common.OperationMetadata",
    "createTime": CREATE_TIME,
    "target": "projects/PROJECT_NUMBER/locations/LOCATION/vodConfigs/VOD_CONFIG_ID",
    "verb": "delete"
  },
  "done": false
}

このコマンドは、進行状況を追跡するためにクエリできる長時間実行オペレーション（LRO）を作成します。詳細については、結果を確認するをご覧ください。