Method: projects.locations.estimateDataSize

お客様が使用するデータサイズを推定します。

HTTP リクエスト

POST https://discoveryengine.googleapis.com/v1alpha/{location=projects/*/locations/*}:estimateDataSize

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

パスパラメータ

パラメータ
location

string

必須。ロケーションの完全なリソース名（例: projects/{project}/locations/{location}）。

リクエストの本文

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

JSON 表現 
{

  // Union field data_source can be only one of the following:
  "websiteDataSource": {
    object (WebsiteDataSource)
  },
  "fileDataSource": {
    object (FileDataSource)
  }
  // End of list of possible types for union field data_source.
}
Fields
共用体フィールド data_source。サイズを推定するデータソース。data_source は次のいずれかになります。
websiteDataSource

object (WebsiteDataSource)

ウェブサイトのデータ。
fileDataSource

object (FileDataSource)

構造化データまたは非構造化データ。

レスポンスの本文

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

認可スコープ

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

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

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

IAM 権限

location リソースに対する次の IAM 権限が必要です。

  • discoveryengine.locations.estimateDataSize

詳細については、IAM のドキュメントをご覧ください。

WebsiteDataSource

データソースは、ウェブサイトの総数を取得するためにクロールするウェブサイト パターンのセットです。

JSON 表現 
{
  "estimatorUriPatterns": [
    {
      object (EstimatorUriPattern)
    }
  ]
}
フィールド
estimatorUriPatterns[]

object (EstimatorUriPattern)

必須。データサイズを推定する URI パターン。パターンは最大 10 個まで指定できます。それ以外の場合は、INVALID_ARGUMENT エラーがスローされます。

EstimatorUriPattern

クロールに使用する URI パターン。

JSON 表現 
{
  "providedUriPattern": string,
  "exactMatch": boolean,
  "exclusive": boolean
}
フィールド
providedUriPattern

string

ユーザーが指定した URI パターン。例: foo.com/bar/*
exactMatch

boolean

生成された URI を推測するか、指定された URI をそのまま使用するか。
exclusive

boolean

パターンが排他的かどうか。true に設定すると、パターンは排他的と見なされます。未設定の場合、または false に設定した場合、パターンはデフォルトで包括的と見なされます。

FileDataSource

データソースには、Cloud Storage または BigQuery のファイルが含まれています。

JSON 表現 
{

  // Union field source can be only one of the following:
  "gcsSource": {
    object (GcsSource)
  },
  "bigquerySource": {
    object (BigQuerySource)
  }
  // End of list of possible types for union field source.
}
Fields
共用体フィールド source。使用するファイルが含まれているソース。source は次のいずれかになります。
gcsSource

object (GcsSource)

入力コンテンツの Cloud Storage のロケーション。
bigquerySource

object (BigQuerySource)

BigQuery 入力ソース。