REST Resource: projects.locations.dataExchanges

リソース: DataExchange

データ エクスチェンジは、データを共有するためのコンテナです。データ エクスチェンジに関する説明情報に加えて、共有データセットを参照するリストが含まれます。

JSON 表現
{
  "name": string,
  "displayName": string,
  "description": string,
  "primaryContact": string,
  "documentation": string,
  "listingCount": integer,
  "icon": string,
  "sharingEnvironmentConfig": {
    object (SharingEnvironmentConfig)
  }
}
フィールド
name

string

出力専用。データ エクスチェンジのリソース名。例: projects/myproject/locations/US/dataExchanges/123

displayName

string

必須。データ エクスチェンジの表示名(人が読める形式)。表示名には、Unicode の英字、数字(0~9)、アンダースコア(_)、ダッシュ(-)、スペース( )、アンパサンド(&)のみを含めることができます。先頭と末尾はスペースにできません。デフォルト値は空の文字列です。最大長: 63 バイト。

description

string

省略可。データ エクスチェンジの説明。説明には、Unicode の文字以外の文字、制御コードの C0 と C1(タブ(HT)、改行(LF)、キャリッジ リターン(CR)、改ページ(FF)を除く)を含めることはできません。デフォルト値は空の文字列です。最大長: 2,000 バイト

primaryContact

string

省略可。データ エクスチェンジに関するメインの連絡先のメールアドレスまたは URL。最大長: 1,000 バイト。

documentation

string

省略可。データ エクスチェンジについて説明するドキュメント。

listingCount

integer

出力専用。データ エクスチェンジに含まれるリスティングの数。

icon

string (bytes format)

省略可。データ エクスチェンジを表す Base64 エンコードされた画像。最大サイズ: 3.0 MiB 想定される画像の寸法は 512x512 ピクセルですが、API はエンコードされたデータのサイズの検証のみを行います。注: バイト フィールドの場合、転送時に JSON を使用すると、フィールドの内容が base64 エンコードされます(データサイズが 33~36% 増加します)。

Base64 でエンコードされた文字列。

sharingEnvironmentConfig

object (SharingEnvironmentConfig)

必須。データ エクスチェンジ用の構成可能なデータ共有環境オプション。

SharingEnvironmentConfig

共有環境は、データ エクスチェンジ内でデータを共有するための動作モデルです。このオプションは、データ エクスチェンジ用に構成できます。

JSON 表現
{

  // Union field environment can be only one of the following:
  "defaultExchangeConfig": {
    object (DefaultExchangeConfig)
  },
  "dcrExchangeConfig": {
    object (DcrExchangeConfig)
  }
  // End of list of possible types for union field environment.
}
フィールド

共用体フィールド environment

environment は次のいずれかになります。

defaultExchangeConfig

object (DefaultExchangeConfig)

デフォルトの Analytics Hub データ エクスチェンジ。安全なデータ共有に使用されます。

dcrExchangeConfig

object (DcrExchangeConfig)

データ クリーンルーム(DCR)。プライバシーに配慮した安全なデータ共有に使用されます。

DefaultExchangeConfig

この型にはフィールドがありません。

デフォルトの Analytics Hub データ エクスチェンジ。安全なデータ共有に使用されます。

DcrExchangeConfig

この型にはフィールドがありません。

データ クリーンルーム(DCR)。プライバシーに配慮した安全なデータ共有に使用されます。

メソッド

create

新しいデータ エクスチェンジを作成します。

delete

既存のデータ エクスチェンジを削除します。

get

データ エクスチェンジの詳細を取得します。

getIamPolicy

IAM ポリシーを取得します。

list

指定されたプロジェクトとロケーションのすべてのデータ エクスチェンジを一覧表示します。

listSubscriptions

指定したデータ エクスチェンジまたはリスティングのすべてのサブスクリプションを一覧表示します。

patch

既存のデータ エクスチェンジを更新します。

setIamPolicy

IAM ポリシーを設定します。

subscribe

データエクスチェンジへのサブスクリプションを作成します。

testIamPermissions

呼び出し元が持っている権限を返します。