すべてのプロダクト
Search

このプロダクト

    :AddWatermark

    ドキュメントセンター

    :AddWatermark

    最終更新日:Dec 15, 2025

    イメージまたはテキストのウォーターマークテンプレートを作成します。ApsaraVideo VOD では、ウォーターマークテンプレートを作成して、ウォーターマークの位置、サイズ、フォント、色などのパラメーター構成を再利用できます。各ウォーターマークテンプレートには一意の ID が割り当てられます。これにより、ウォーターマークタスクの処理が簡素化されます。

    操作説明

    • この操作を呼び出して、Image ウォーターマークテンプレートまたは Text ウォーターマークテンプレートを作成できます。イメージウォーターマークとして、PNG フォーマットの静止画、または GIF、APNG、MOV フォーマットの動画を使用できます。

    • この操作を呼び出してウォーターマークテンプレートを作成した後、AddTranscodeTemplateGroup または UpdateTranscodeTemplateGroup 操作を呼び出して、ウォーターマークテンプレートをトランスコーディングテンプレートグループに関連付ける必要があります。これにより、トランスコード中に動画にウォーターマークを追加できます。

    • 詳細については、「動画のウォーターマーク」をご参照ください。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    vod:AddWatermark

    create

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Type

    string

    必須

    ウォーターマークテンプレートのタイプ。有効な値：

    • Image (デフォルト)：イメージウォーターマークテンプレート

    • Text：テキストウォーターマークテンプレート

    Text
    Name

    string

    必須

    ウォーターマークテンプレートの名前。

    • 英数字のみをサポートします。

    • 名前は 128 バイトを超えることはできません。

    • 値は UTF-8 でエンコードする必要があります。

    watermark
    WatermarkConfig

    string

    必須

    表示位置や特殊効果などのウォーターマークの構成情報。値は JSON 文字列である必要があります。イメージウォーターマークとテキストウォーターマークでは、構成パラメーターが異なります。パラメーター構造の詳細については、「WatermarkConfig」をご参照ください。

    {"Width":"55","Height":"55","Dx":"9","Dy":"9","ReferPos":"BottonLeft"}
    FileUrl

    string

    任意

    ウォーターマークファイルの URL。URL は Object Storage Service (OSS) の URL である必要があり、URL 署名に使用される情報を含めることはできません。

    説明

    • Type を Image に設定した場合、このパラメーターは必須です。

    • この URL は、CreateUploadAttachedMedia 操作を呼び出してウォーターマークイメージを ApsaraVideo VOD にアップロードした際の応答に含まれる FileURL パラメーターから取得できます。

    http://outin-326268*****63e1403e7.oss-cn-shanghai.aliyuncs.com/image/cover/C99345*****E7FDEC-6-2.png
    AppId

    string

    任意

    アプリケーションの ID。デフォルト値：app-1000000。マルチアプリケーションサービスを有効化している場合は、ウォーターマークテンプレートを追加するアプリケーションの ID を指定します。詳細については、「概要」をご参照ください。

    app-****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエストの ID。

    25818875-5F78-4A*****F6-D7393642CA58
    WatermarkInfo

    object

    ウォーターマークテンプレートの情報。

    CreationTime

    string

    ウォーターマークテンプレートが作成された時刻。時刻は、yyyy-MM-ddTHH:mm:ssZ 形式の ISO 8601 規格に準拠しています。時刻は UTC で表示されます。

    2018-11-07T09:05:52Z
    Type

    string

    ウォーターマークテンプレートのタイプ。

    • Image：イメージウォーターマークテンプレート

    • Text：テキストウォーターマークテンプレート

    Text
    IsDefault

    string

    ウォーターマークテンプレートがデフォルトであるかどうかを示します。有効な値：

    • Default

    • NotDefault

    NotDefault
    FileUrl

    string

    ウォーターマークファイルの URL。URL は Object Storage Service (OSS) の URL または Alibaba Cloud CDN の URL です。

    説明

    このパラメーターは、イメージウォーターマークテンプレートの場合にのみ返されます。

    https://outin-3262*****9f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/E6C3448CC8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=****&Signature=gmf1eYMoDVg%2BHQCb4UGozBW****
    WatermarkConfig

    string

    表示位置や特殊効果などのウォーターマークの構成情報。値は JSON 文字列です。イメージウォーターマークとテキストウォーターマークでは、構成パラメーターが異なります。パラメーター構造の詳細については、「WatermarkConfig」をご参照ください。

    {"FontColor": "Blue","FontSize": 80, "Content": "watermark test" }
    Name

    string

    ウォーターマークテンプレートの名前。

    text watermark test
    WatermarkId

    string

    ウォーターマークテンプレートの ID。

    9bcc8bfadb84*****109a2671d0df97

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "25818875-5F78-4A*****F6-D7393642CA58",
  "WatermarkInfo": {
    "CreationTime": "2018-11-07T09:05:52Z",
    "Type": "Text",
    "IsDefault": "NotDefault",
    "FileUrl": "https://outin-3262*****9f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/E6C3448CC8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=****&Signature=gmf1eYMoDVg%2BHQCb4UGozBW****",
    "WatermarkConfig": "{\"FontColor\": \"Blue\",\"FontSize\": 80, \"Content\": \"watermark test\" }",
    "Name": " text watermark test",
    "WatermarkId": "9bcc8bfadb84*****109a2671d0df97"
  }
}

    エラーコード

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。