すべてのプロダクト
Search

このプロダクト

    :GetChatappTemplateMetric

    ドキュメントセンター

    :GetChatappTemplateMetric

    最終更新日:Jul 07, 2026

    マーケティングタイプテンプレートに関連するメトリックを取得します。

    操作説明

    • この操作では、WhatsApp チャンネルのマーケティングテンプレートのメトリックのみをクエリできます。

    • この操作を呼び出す前に、 EnableWhatsAppROIMetric 操作を呼び出して WhatsApp ROI メトリック収集を有効にしてください。有効化後、統計データが利用可能になるまで少なくとも 1 日かかります。有効化前に送信されたマーケティングテンプレートのメトリックは収集されません。

    • WhatsApp ROI メトリック収集を有効にした後、作成したチャンネルのマーケティングテンプレートでメッセージが正常に送信されていることを確認してください。メッセージは、チャンネル管理 > 管理 > メッセージ送信 ページで送信するか、 SendChatappMessage または SendChatappMassMessage 操作を呼び出して送信できます。

    QPS 制限

    この操作の単一ユーザー QPS 制限は、1 秒あたり 50 回の呼び出しです。この制限を超えるリクエストはスロットリングされ、ビジネスに影響を与える可能性があります。この操作は適切に呼び出してください。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    cams:GetChatappTemplateMetric

    get

    *すべてのリソース。

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    TemplateCode

    string

    必須

    テンプレートコード。テンプレートコードは、チャンネル管理 > 管理 > テンプレートデザイン コンソールで確認できます。

    1100***************

    Language

    string

    任意

    テンプレートの言語。その他の言語については、「言語コード」をご参照ください。

    en
    IsvCode

    string

    任意

    ISV 検証コード。RAM ユーザーが ISV によって承認されているかどうかを検証するために使用されます。

    skdi3kksloslikd****
    CustSpaceId

    string

    任意

    ISV サブ顧客のスペース ID またはインスタンス ID。チャンネル ID としても使用されます。チャンネル管理 コンソールで確認できます。

    cams-************

    TemplateType

    string

    任意

    テンプレートタイプ。有効な値:

    • WHATSAPP

    説明

    このパラメーターが指定されていない場合、デフォルト値は WHATSAPP です。

    WHATSAPP
    Granularity

    string

    任意

    メトリックの粒度。有効な値:

    • DAILY: 毎日メトリックを収集します。

    • HALF_HOUR: 30 分ごとにメトリックを収集します。

    DAILY
    Start

    integer

    必須

    クエリの開始時刻。この値はミリ秒単位のタイムスタンプです。

    1693107714687
    End

    integer

    必須

    クエリの終了時刻。この値はミリ秒単位のタイムスタンプです。

    1693407714687

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスパラメーター。

    AccessDeniedDetail

    string

    アクセス拒否の詳細。

    None
    RequestId

    string

    リクエスト ID。

    608F9CCA-B5EB-3D72-8047-B25D6D75BDEC

    Message

    string

    エラーメッセージ。

    None
    Data

    array<object>

    返されたデータのリスト。

    array<object>

    返されたデータ。

    TemplateCode

    string

    テンプレートコード。

    1100***************
    DeliveredCount

    integer

    配信されたメッセージの数。

    6
    Language

    string

    テンプレートの言語。

    en
    Cliented

    array<object>

    ボタンクリック統計のリスト。

    object

    ボタンクリック統計。

    Type

    string

    ボタンのタイプ。有効な値:

    • phone_number_button: 通話ボタン。

    • url_button: URL ボタン。

    • quick_reply_button: 自動返信ボタン。

    quick_reply_button
    ButtonContent

    string

    ボタンのテキスト。

    reply
    Count

    integer

    クリック数。

    20
    Start

    integer

    メトリック収集期間の開始時刻。この値はミリ秒単位のタイムスタンプです。

    1673919240001
    End

    integer

    メトリック収集期間の終了時刻。この値はミリ秒単位のタイムスタンプです。

    1668138331485
    SentCount

    integer

    送信されたメッセージの数。

    10
    ReadCount

    integer

    読み取られたメッセージの数。

    3
    Code

    string

    リクエスト状態コード。有効な値:

    • OK: リクエストが成功しました。

    • その他のエラーコードについては、「エラーコード」をご参照ください。

    OK

    例

    成功レスポンス

    JSONJSON

    {
  "AccessDeniedDetail": "None",
  "RequestId": "608F9CCA-B5EB-3D72-8047-B25D6D75BDEC\n",
  "Message": "None",
  "Data": [
    {
      "TemplateCode": "1100***************",
      "DeliveredCount": 6,
      "Language": "en",
      "Cliented": [
        {
          "Type": "quick_reply_button",
          "ButtonContent": "reply",
          "Count": 20
        }
      ],
      "Start": 1673919240001,
      "End": 1668138331485,
      "SentCount": 10,
      "ReadCount": 3
    }
  ],
  "Code": "OK"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 Product.Unsubscript You have not subscribed to the specified product.
    400 Ram.PermissionDeny You are not authorized to perform the operation.
    400 System.LimitControl The system is under flow control.
    400 Unknown.ResourceOwnerId The resource does not belong to the current user.

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

    変更履歴

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