この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。
英語に切り替える

AppAnalyticsQueryRequest

AppExchange アプリケーションの Analytics データセットの要求を表します。

AppExchange アプリケーションの Analytics は、セキュリティレビューに合格し、ライセンス管理アプリケーション (LMA) に登録されているパッケージで使用できます。使用状況データは、パッケージ利用状況ログ、月次ベースパッケージ利用状況概要、またはある時点のサブスクライバーのスナップショットとして提供されます。利用状況ログ、月次利用状況概要、およびサブスクライバーのスナップショットはダウンロード可能なカンマ区切り値 (.csv) ファイルです。App Analytics を最適に使用する方法の詳細は、「AppExchange の App Analytics のベストプラクティス」を参照してください。

Government Cloud および Government Cloud Plus 組織からの使用状況データは、App Analytics では使用できません。

メモ

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

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

特別なアクセスルール

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

項目

項目名 詳細
AvailableSince
型
dateTime
プロパティ
Create、Filter、Nillable、Sort
説明

要求された結果ファイルのデータを、指定日時の後にデータレイクに新たに到着したデータに制限するために使用する値。省略可能です。この項目は、常に協定世界時 (UTC) に移行されます。AvailableSince 項目は、キャッチアップクエリ戦略の一部として使用します。

指定する場合、AvailableSince は、StartTime および EndTime より後にする必要があります。AvailableSince は、現在より前に設定する必要があります。クエリには、StartTime と AvailableSince のいずれかまたは両方を含める必要があります。

たとえば、日付範囲が次の場合に 2021-04-03T18:00:00Z にキャッチアップクエリをスケジュール設定するとします。
  • StartTime=2021-03-29T00:00:00Z
  • EndTime=2021-03-30T00:00:00Z

この場合、AvailableSince の有効な値の範囲は、2021-03-30T00:00:00Z to 2021-04-03T18:00:00Z となります。

AvailableSince およびキャッチアップクエリについての詳細は、「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 が有効でなくなる時間。有効期限は、クエリが完了してから 60 分です。

DownloadSize
型
Long
プロパティ
Filter、Group、Nillable、Sort
説明
AppExchange の App Analytics のダウンロード可能な結果ファイルのサイズ (バイト単位)。
DownloadUrl
型
textarea
プロパティ
Nillable
説明

ユーザがデータをダウンロードできる URL。要求が完了すると入力されます。有効期限に達すると、この URL は期限切れになり、削除されます。

EndTime
型
dateTime
プロパティ
Create、Filter、Nillable、Sort
説明
yyyy-MM-ddTHH:mm:ss 形式で終了時刻を入力します。

例:

2019-04-15T12:00:00

ErrorMessage
型
string
プロパティ
Filter、Group、Nillable、Sort
説明

このクエリから生成されたエラーメッセージテキストを保存します。

FileCompression
型
picklist
プロパティ
Create、Filter、Group、Nillable、Restricted picklist、Sort
説明

要求した結果ファイルのファイル圧縮形式。FileCompression と FileType の値は、適切に対応させる必要があります。FileType が csv の場合、FileCompression は、デフォルトでは none に設定されます。設定可能な値は、none または gzip です。FileType が parquet の場合、FileCompression は、デフォルトでは snappy に設定されます。設定可能な値は、snappy、gzip、または none です。

使用できる値は次のとおりです。
  • gzip
  • snappy
  • none
FileType
型
picklist
プロパティ
Create、Defaulted on create、Filter、Group、Nillable、Restricted picklist、Sort
説明

要求した結果ファイルのデータ形式。デフォルトは csv です。FileCompression と FileType の値は、適切に対応させる必要があります。FileType が csv の場合、FileCompression は、デフォルトでは none に設定されます。設定可能な値は、none または gzip です。FileType が parquet の場合、FileCompression は、デフォルトでは snappy に設定されます。設定可能な値は、snappy、gzip、または none です。

使用できる値は次のとおりです。
  • csv
  • parquet
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 を入力できます。

パッケージがインストールされているすべての組織のデータを要求するには、項目を空白のままにします。

PackageIds
型
string
プロパティ
Create、Filter、Group、Nillable、Sort
説明

省略可能。最大 16 個のパッケージ ID をカンマで区切って入力します。ID の間にスペースは入れません。または、ID 間にスペースを入れる場合は、15 個までのカンマ区切りのパッケージ ID を入力できます。033 から始まるサブスクライバーパッケージ ID を使用します。第二世代管理パッケージの ID のリストを取得するには、Salesforce CLI で sfdx force:package:list --verbose を実行します。

このライセンス管理アプリケーションに登録されているすべてのパッケージのデータを要求するには、項目を空白のままにします。

QuerySubmittedTime
型
dateTime
プロパティ
Filter、Nillable、Sort
説明

処理対象の App Analytics クエリ要求が受信された日時。協定世界時 (UTC) で示されます。QuerySubmittedTime は参照のみです。

RequestState
型
picklist
プロパティ
Defaulted on create、Filter、Group、Nillable、Restricted picklist、Sort
説明

クエリ要求の状況。有効な値は、次のとおりです。

  • New
  • Pending
  • Complete
  • Expired
  • Failed
  • NoData
StartTime
型
dateTime
プロパティ
Create、Filter、Nillable、Sort
説明
yyyy-MM-ddTHH:mm:ss 形式で開始時刻を入力します。すべての App Analytics クエリ要求には、StartTime と AvailableSince のいずれかまたは両方を含める必要があります。

例:

2019-04-14T12:00:00

使用方法

使用状況データを要求するには、パッケージのサブスクリプション先のライセンス管理組織 (LMO) にログインし、LMO から API 要求を開始します。24 時間以内に、AppExchange アプリケーションの Analytics データを最大 20 GB ダウンロードできます。

『ISVforce ガイド』の「パッケージのログファイル、利用状況概要、サブスクライバーのスナップショットのダウンロード」を参照してください。

パッケージ利用状況ログまたはサブスクライバーのスナップショットデータの表示要求が 90 日間アクティブでなかった場合、Salesforce はこのデータの収集を停止する権利を留保します。データ収集を再開するには、Salesforce パートナーコミュニティでサポートケースを登録します。商品の場合は、[Partner Programs & Benefits (パートナープログラムとメリット)] を指定します。トピックの場合は、[ISV Technology Request (ISV テクノロジ要求)] を指定します。