AppAnalyticsQueryRequest | Salesforce および Lightning プラットフォームのオブジェクトリファレンス

AppExchange アプリケーションの Analytics は、セキュリティレビューに合格し、ライセンス管理アプリケーションに登録されているパッケージで使用できます。使用状況データは、ログファイル、月次ベースの使用量サマリー、またはある時点の登録者のスナップショットとして提供されます。ログファイル、月次サマリー、および登録者のスナップショットはダウンロード可能なカンマ区切り値 (.csv) ファイルです。

サポートされているコール

create()、delete()、describeSObjects()、getDeleted()、getUpdated()、query()、retrieve()、undelete()、update()、upsert()

特別なアクセスルール

『ISVForce ガイド』の「Request AppExchange App Analytics (AppExchange の App Analytics の要求)」を参照してください。

項目

項目名	詳細
DataType	型 picklist プロパティ Create、Filter、Group、Restricted picklist、Sort 説明要求される使用状況データの種別。使用できる値は次のとおりです。 `PackageUsageLog` `PackageUsageSummary` `SubscriberSnapshot` Summer ’20 で、列挙名が `CustomObjectUsageSummary` と `CustomObjectUsageLog` から `PackageUsageSummary` と `PackageUsageLog` に変更されました。 `CustomObjectUsageSummary` または `CustomObjectUsageLog` を使用してインテグレーションを記述した場合は、v47 以前でのみ引き続き機能します。V48 にアップグレードしたら、`DataType` を `PackageUsageSummary` と `PackageUsageLog` に更新する必要があります。メモ
DownloadExpirationTime	型 dateTime プロパティ Filter、Nillable、Sort 説明ダウンロード URL が有効でなくなる時間。
DownloadSize	型 Long プロパティ Filter、Group、Nillable、Sort 説明 AppExchange の App Analytics のダウンロード可能な結果ファイルのサイズ (バイト単位)。
DownloadUrl	型 textarea プロパティ Nillable 説明要求されたデータをダウンロードできる URL。要求が完了すると入力されます。
EndTime	型 dateTime プロパティ Create、Filter、Nillable、Sort 説明 yyyy-MM-ddTHH:mm:ss 形式で終了時刻を入力します。例 2019-04-15T12:00:00 24 時間以内に、最大 7 日間のログファイルを要求できます。メモ
ErrorMessage	型 string プロパティ Filter、Group、Nillable、Sort 説明このクエリから生成されたエラーメッセージテキストを保存します。
LastReferencedDate	型 dateTime プロパティ Filter、Nillable、Sort 説明現在のユーザがこのレコードに関連するレコードを最後に表示したときのタイムスタンプ。
LastViewedDate	型 dateTime プロパティ Filter、Nillable、Sort 説明現在のユーザがこのレコードを最後に表示したときのタイムスタンプ。この値が null の場合、このレコードは表示ではなく参照 (LastReferencedDate) された可能性があります。
Name	型 string プロパティ Autonumber、Defaulted on create、Filter、idLookup、Sort 説明 App Analytics クエリ要求の自動生成名。
OrganizationIds	型 string プロパティ Create、Filter、Group、Nillable、Sort 説明省略可能。最大 16 個の組織 ID をカンマで区切って入力します。ID の間にスペースは入れません。または、ID 間にスペースを入れる場合は、15 個までのカンマ区切りの組織 ID を入力できます。パッケージがインストールされているすべての組織のデータを要求するには、項目を空白のままにします。少なくとも 1 つのパッケージ ID または 1 つの組織 ID を入力します。両方の項目を空白のままにすることはできません。メモ
PackageIds	型 string プロパティ Create、Filter、Group、Nillable、Sort 説明省略可能。最大 16 個のパッケージ ID をカンマで区切って入力します。ID の間にスペースは入れません。または、ID 間にスペースを入れる場合は、15 個までのカンマ区切りのパッケージ ID を入力できます。この LMA に登録されているすべてのパッケージのデータを要求するには、項目を空白のままにします。少なくとも 1 つのパッケージ ID または 1 つの組織 ID を入力します。両方の項目を空白のままにすることはできません。メモ
RequestState	型 picklist プロパティ Defaulted on create、Filter、Group、Nillable、Restricted picklist、Sort 説明クエリ要求の状況。有効な値は、次のとおりです。 `New` `Pending` `Complete` `Expired` `Failed` `NoData`
StartTime	型 dateTime プロパティ Create、Filter、Sort 説明必須。yyyy-MM-ddTHH:mm:ss 形式で開始時刻を入力します。例 2019-04-14T12:00:00 24 時間以内に、最大 7 日間のログファイルを要求できます。メモ

使用方法

使用状況データを要求するには、パッケージの登録先のライセンス管理組織 (LMO) にログインし、LMO から API 要求を開始します。

『ISVforce ガイド』の「Download Package Log Files, Usage Summaries, and Subscriber Snapshots (パッケージのログファイル、使用量サマリー、登録者のスナップショットのダウンロード)」を参照してください。

パッケージに関するデータの表示要求が 90 日間アクティブでなかった場合、ログファイルデータの収集が停止されます。パッケージのログファイルのデータ収集を再開するには、パートナーコミュニティで AppExchange アプリケーションの Analytics を要求します。