動画をアップロード

YouTubeVideoUploadService を使用すると、Google Ads API を介して YouTube に動画を直接アップロードできます。これらの動画は、P-MAX キャンペーンデマンド ジェネレーション キャンペーンなど、さまざまな広告タイプの動画アセットの作成に使用できます。

このサービスは、YouTube のアップロード プロセスを処理し、動画がアカウントに正しく関連付けられるようにすることで、動画広告の作成ワークフローを効率化します。

主なコンセプト

始める前に、動画のアップロードがどのように管理され、どのような状態になる可能性があるかを理解しておくことが重要です。

チャンネルの所有権

動画をアップロードするときに、YouTubeVideoUpload リソースの channel_id フィールドを使用して、アップロード先の YouTube チャンネルを指定できます。

  • 広告主所有の(ブランド)チャンネル: 広告主が所有する既存の YouTube チャンネルの channel_id を指定します。これはユーザー認証フローでのみサポートされており、サービス アカウントでは使用できません。
  • Google 管理チャンネル: channel_id が省略されている場合、動画は Google 広告アカウントに関連付けられている Google 管理の YouTube チャンネルにアップロードされます。

アップロード ステータス

YouTube 動画のアップロードのライフサイクルは、state フィールドで追跡されます。YouTubeVideoUploadState 列挙型は次の状態を定義します。

説明
PENDING 動画をアップロードしています。
UPLOADED 動画は正常にアップロードされ、YouTube で処理中です。
PROCESSED 動画が正常に処理され、使用できる状態になりました。
FAILED アップロードまたは処理に失敗し、完了できません。
REJECTED 検証またはポリシー上の理由により動画が不承認になった。
UNAVAILABLE 動画の状態は利用できません。YouTube から削除された可能性があります。

プライバシー設定

video_privacy フィールドで、アップロードした動画を視聴できるユーザーを制御します。YouTubeVideoPrivacy 列挙型は以下をサポートしています。

  • PUBLIC: YouTube のすべてのユーザーが視聴できる動画。(ブランド チャンネルでのみ許可されます)。
  • UNLISTED: 動画は検索できませんが、リンクを知っているユーザーは誰でも視聴できます。これは、Google 管理チャネルのデフォルトかつ唯一のオプションです。

動画をアップロード

動画をアップロードするには、CreateYouTubeVideoUpload メソッドへのマルチパート リクエストを使用する必要があります。リクエストには、アップロードのメタデータと動画ファイルの両方が含まれます。

1. アップロードを開始する

次のものを指定して CreateYouTubeVideoUploadRequest を作成します。

  • customer_id: Google 広告のお客様 ID。
  • you_tube_video_upload: video_titlevideo_description、必要に応じて channel_idvideo_privacy を含む YouTubeVideoUpload オブジェクト。

クライアント ライブラリを使用している場合は、動画ファイルを渡して CreateYouTubeVideoUpload メソッドを呼び出すと、動画のアップロードが内部で処理されます。

Java

This example is not yet available in Java; you can take a look at the other languages.
    

C#

YouTubeVideoUploadServiceClient ytService = client.GetService(
    Services.V25.YouTubeVideoUploadService);

CreateYouTubeVideoUploadRequest createUploadRequest =
    new CreateYouTubeVideoUploadRequest()
    {
        CustomerId = customerId.ToString(),
        YouTubeVideoUpload = new YouTubeVideoUpload()
        {
            VideoTitle = "Test Video",
            VideoDescription = "Test Video Description",
            VideoPrivacy = YouTubeVideoPrivacy.Unlisted
        }
    };

string videoUploadResourceName;
using (FileStream stream = File.OpenRead(videoFilePath))
{
    ResumableUploadSession<CreateYouTubeVideoUploadRequest, CreateYouTubeVideoUploadResponse> session =
        ytService.CreateYouTubeVideoUpload();
    CreateYouTubeVideoUploadResponse response =
        session.BeginUploadAsync(createUploadRequest, stream).Result;

    videoUploadResourceName = response.ResourceName;
    Console.WriteLine($"Created YouTube video upload: {videoUploadResourceName}");
}
      

PHP

$youTubeVideoUploadServiceClient = $googleAdsClient->getYouTubeVideoUploadServiceClient();

$youTubeVideoUpload = new YouTubeVideoUpload([
    'video_title' => 'Test Video',
    'video_description' => 'Test Video Description',
    'video_privacy' => YouTubeVideoPrivacy::UNLISTED
]);

$createYouTubeVideoUploadRequest = CreateYouTubeVideoUploadRequest::build(
    $customerId,
    $youTubeVideoUpload
);

/** @var ResumableUpload $resumableUpload */
$resumableUpload = $youTubeVideoUploadServiceClient->createYouTubeVideoUpload(
    $createYouTubeVideoUploadRequest
);

$stream = Utils::streamFor(fopen($videoFilePath, 'rb'));
/** @var CreateYouTubeVideoUploadResponse $response */
$response = $resumableUpload->startUpload($stream);

$videoUploadResourceName = $response->getResourceName();
printf("Created YouTube video upload: '%s'%s", $videoUploadResourceName, PHP_EOL);
      

Python

yt_service: YouTubeVideoUploadServiceClient = client.get_service(
    "YouTubeVideoUploadService"
)

create_upload_request: CreateYouTubeVideoUploadRequest = (
    youtube_video_upload_service.CreateYouTubeVideoUploadRequest()
)
create_upload_request.customer_id = customer_id
create_upload_request.you_tube_video_upload.video_title = "Test Video"
create_upload_request.you_tube_video_upload.video_description = (
    "Test Video Description"
)
create_upload_request.you_tube_video_upload.video_privacy = (
    client.enums.YouTubeVideoPrivacyEnum.UNLISTED
)

video_upload_resource_name: str
with open(video_file_path, "rb") as stream:
    response: CreateYouTubeVideoUploadResponse = (
        yt_service.create_you_tube_video_upload(
            stream=stream,
            request=create_upload_request,
            retry=None,
        )
    )
    video_upload_resource_name = response.resource_name
    print(f"Created YouTube video upload: {video_upload_resource_name}")
      

Ruby

This example is not yet available in Ruby; you can take a look at the other languages.
    

Perl

This example is not yet available in Perl; you can take a look at the other languages.
    

curl

# 
# Use the --i curl parameter to capture response headers in the $RESPONSE
# variable.
FILE_SIZE=$(wc -c < "${VIDEO_FILE_NAME}" | tr -d '\r')
RESPONSE=$(curl -i -f -v -s --request POST \
"https://googleads.googleapis.com/resumable/upload/v${API_VERSION}/customers/${CUSTOMER_ID}/youTubeVideoUploads:create" \
--header "Content-Type: application/json" \
--header "login-customer-id: ${MANAGER_CUSTOMER_ID}" \
--header "Authorization: Bearer ${OAUTH2_ACCESS_TOKEN}" \
--header "X-Goog-Upload-Protocol: resumable" \
--header "X-Goog-Upload-Command: start" \
--header "X-Goog-Upload-Header-Content-Length: ${FILE_SIZE}" \
--data @- <<EOF
{
  "customer_id": "${CUSTOMER_ID}",
  "you_tube_video_upload": {
    "video_title": "${VIDEO_TITLE}",
    "video_description": "${VIDEO_DESCRIPTION}",
    "video_privacy": "UNLISTED"
  }
}
EOF
)

# Extract the value of the "x-goog-upload-url" header from the HTTP response.
UPLOAD_URL=$(echo "${RESPONSE}" \
  | grep -i '^x-goog-upload-url' \
  | awk '{print $2}' \
  | tr -d '\r')
CHUNK_SIZE=$(echo "${RESPONSE}" \
  | grep -i '^x-goog-upload-chunk-granularity' \
  | awk '{print $2}' \
  | tr -d '\r')
      

REST を使用している場合は、次のセクションで動画のアップロードを管理する方法について説明します。

2. 動画をアップロードする

CreateYouTubeVideoUpload メソッドに REST リクエストを送信すると、レスポンスには、Google の標準の再開可能なアップロード プロトコルに従って、x-goog-upload-url HTTP レスポンス ヘッダーで動画バイトのアップロードに使用する URL と、チャンク アップロードの各チャンクの想定サイズなどの他のメタデータが含まれます。

x-goog-upload-header-content-length HTTP リクエスト ヘッダーを使用して、プロセスを開始するときに、アップロードする動画のサイズを最初に宣言することもできます。

動画アップロード プロトコルで使用される HTTP ヘッダーの詳細については、次のコード例をご覧ください。

# Take the first ${CHUNK_SIZE} bytes of the video file and upload them.
head -c ${CHUNK_SIZE} ${VIDEO_FILE_NAME} | curl -i -v -X PUT "${UPLOAD_URL}" \
--header "Authorization: Bearer ${OAUTH2_ACCESS_TOKEN}" \
--header "X-Goog-Upload-Offset: 0" \
--header "X-Goog-Upload-Command: upload" \
--header "Content-Length: ${CHUNK_SIZE}" \
--data-binary @-

# Query the status of the upload.
QUERY_RESPONSE=$(curl -i -s -X POST "${UPLOAD_URL}" \
--header "Authorization: Bearer ${OAUTH2_ACCESS_TOKEN}" \
--header "X-Goog-Upload-Command: query")

# Extract the value of the "x-goog-upload-size-received" header from the HTTP
# response.
UPLOADED_BYTES=$(echo "${QUERY_RESPONSE}" \
  | grep -i '^x-goog-upload-size-received' \
  | awk '{print $2}' \
  | tr -d '\r')

echo "Uploaded ${UPLOADED_BYTES} bytes."

REMAINING_BYTES=$((FILE_SIZE - UPLOADED_BYTES))
echo "${REMAINING_BYTES} bytes remaining to upload."

FINALIZE_RESPONSE=$(tail -c ${REMAINING_BYTES} ${VIDEO_FILE_NAME} | curl -v -X PUT "${UPLOAD_URL}" \
--header "Authorization: Bearer ${OAUTH2_ACCESS_TOKEN}" \
--header "X-Goog-Upload-Offset: ${UPLOADED_BYTES}" \
--header "X-Goog-Upload-Command: upload, finalize" \
--data-binary @-)
UPLOADED_VIDEO_RESOURCE_NAME=$(echo $FINALIZE_RESPONSE | jq -r '.resourceName')
      

3. 動画のアップロード状態を取得する

動画のアップロードを開始した後、GAQL で you_tube_video_upload リソースをクエリして、その状態を取得できます。

Java

This example is not yet available in Java; you can take a look at the other languages.
    

C#

// Retrieve the metadata of the newly uploaded video.
string query = $@"
    SELECT
      you_tube_video_upload.resource_name,
      you_tube_video_upload.video_id,
      you_tube_video_upload.state
    FROM you_tube_video_upload
    WHERE you_tube_video_upload.resource_name = '{videoUploadResourceName}'";

GoogleAdsServiceClient gaService = client.GetService(
    Services.V25.GoogleAdsService);

gaService.SearchStream(customerId.ToString(), query,
    delegate (SearchGoogleAdsStreamResponse resp)
    {
        foreach (GoogleAdsRow row in resp.Results)
        {
            Console.WriteLine(
                $"Video with ID {row.YouTubeVideoUpload.VideoId} was found in " +
                $"state {row.YouTubeVideoUpload.State}.");
        }
    }
);
      

PHP

// Retrieve the metadata of the newly uploaded video.
$query = sprintf(
    "SELECT you_tube_video_upload.resource_name, "
    . "you_tube_video_upload.video_id, "
    . "you_tube_video_upload.state "
    . "FROM you_tube_video_upload "
    . "WHERE you_tube_video_upload.resource_name = '%s'",
    $videoUploadResourceName
);

$googleAdsServiceClient = $googleAdsClient->getGoogleAdsServiceClient();
$stream = $googleAdsServiceClient->searchStream(
    SearchGoogleAdsStreamRequest::build($customerId, $query)
);

foreach ($stream->iterateAllElements() as $googleAdsRow) {
    /** @var GoogleAdsRow $googleAdsRow */
    printf(
        "Video with ID '%s' was found in state '%s'.%s",
        $googleAdsRow->getYouTubeVideoUpload()->getVideoId(),
        YouTubeVideoUploadState::name($googleAdsRow->getYouTubeVideoUpload()->getState()),
        PHP_EOL
    );
}
      

Python

# Retrieve the metadata of the newly uploaded video.
query: str = f"""
    SELECT
      you_tube_video_upload.resource_name,
      you_tube_video_upload.video_id,
      you_tube_video_upload.state
    FROM you_tube_video_upload
    WHERE you_tube_video_upload.resource_name = '{video_upload_resource_name}'"""

ga_service: GoogleAdsServiceClient = client.get_service("GoogleAdsService")
stream: Iterator[SearchGoogleAdsStreamResponse] = ga_service.search_stream(
    customer_id=customer_id, query=query
)

for row in itertools.chain.from_iterable(batch.results for batch in stream):
    video = row.you_tube_video_upload
    print(
        f"Video with ID {row.you_tube_video_upload.video_id} was found in state {row.you_tube_video_upload.state}."
    )
      

Ruby

This example is not yet available in Ruby; you can take a look at the other languages.
    

Perl

This example is not yet available in Perl; you can take a look at the other languages.
    

curl

curl -i -v -X POST \
"https://qa-prod-googleads.sandbox.googleapis.com/v${API_VERSION}/customers/${CUSTOMER_ID}/googleAds:search" \
--header "Content-Type: application/json" \
  --header "Developer-Token: ${DEVELOPER_TOKEN}" \
  --header "login-customer-id: ${MANAGER_CUSTOMER_ID}" \
  --header "Authorization: Bearer ${OAUTH2_ACCESS_TOKEN}" \
  --data @- <<EOF
{
  "query": "SELECT you_tube_video_upload.resource_name, you_tube_video_upload.video_id, you_tube_video_upload.state FROM you_tube_video_upload WHERE you_tube_video_upload.resource_name = '$UPLOADED_VIDEO_RESOURCE_NAME'"
}
EOF
      

アップロードを管理

動画のアップロードが完了すると、動画アセットとして使用できるようになります。

アップロードした動画を使用する

動画が PROCESSED 状態になると、YouTubeVideoUpload リソースの video_id フィールドで YouTube 動画 ID を確認できます。

この video_id を使用して、MutateAssets を含む YoutubeVideoAsset を作成するか、動画 ID を参照して YouTube 動画をサポートする広告タイプに直接リンクします。

メタデータを更新

この API を通じてアップロードされた動画のメタデータは、UpdateYouTubeVideoUpload メソッドを使用して更新できます。video_titlevideo_descriptionvideo_privacy フィールドのみ更新できます。

アップロードを削除する

Google Ads API でアップロードした動画を削除する必要がある場合は、RemoveYouTubeVideoUpload メソッドを使用します。これにより、Google 広告のアセット ライブラリと YouTube の両方から動画が削除されます。