Method: projects.locations.collections.engines.analytics.exportMetrics

指標をエクスポートします。

HTTP リクエスト


POST https://discoveryengine.googleapis.com/v1alpha/{analytics=projects/*/locations/*/collections/*/engines/*/analytics}:exportMetrics

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
analytics

string

必須。指標が作成されるエンジンのアナリティクス リソース名。形式は projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/analytics です。

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "outputConfig": {
    object (OutputConfig)
  },
  "startDate": {
    object (Date)
  }
}
フィールド
outputConfig

object (OutputConfig)

必須。データの出力場所。
startDate

object (Date)

省略可。エクスポートに含まれる指標の最も古い日付（包括的）。UTC タイムゾーンで解釈されます。

設定しない場合、デフォルトは現在の UTC 日付の 30 日前になります。値は、将来の日付ではなく、180 日（ソースデータの保持期間）より古い日付でもない有効なカレンダーの日付である必要があります。そうでない場合、リクエストは INVALID_ARGUMENT で失敗します。

レスポンスの本文

成功した場合、レスポンスの本文には Operation のインスタンスが含まれます。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

詳細については、Authentication Overview をご覧ください。

OutputConfig

出力構成の設定。

JSON 表現 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "bigqueryDestination": {
    object (BigQueryDestination)
  }
  // End of mutually exclusive fields.
}
フィールド
出力データを保持する宛先の構成。以下は、相互に排他的なフィールドのリストです。レスポンスに設定されるフィールドは、最大 1 つです。
bigqueryDestination

object (BigQueryDestination)

出力の書き込み先となる BigQuery のロケーション。
相互に排他的なフィールドの終わり。

BigQueryDestination

BigQuery 出力先の構成。

JSON 表現 
{
  "datasetId": string,
  "tableId": string
}
フィールド
datasetId

string

必須。BigQuery データセットの ID。
tableId

string

必須。エクスポートされた BigQuery テーブルの tableId。