REST Resource: projects.locations.dataExchanges.listings

リソース: リスティング

リスティングは、サブスクライバーがサブスクライブできるデータ エクスチェンジに公開されたものです。これには、データソースへの参照と、サブスクライバーがデータを見つけてサブスクライブするために役立つ説明情報が含まれます。

JSON 表現 
{
  "name": string,
  "displayName": string,
  "description": string,
  "primaryContact": string,
  "documentation": string,
  "state": enum (State),
  "icon": string,
  "dataProvider": {
    object (DataProvider)
  },
  "categories": [
    enum (Category)
  ],
  "publisher": {
    object (Publisher)
  },
  "requestAccess": string,
  "restrictedExportConfig": {
    object (RestrictedExportConfig)
  },

  // Union field source can be only one of the following:
  "bigqueryDataset": {
    object (BigQueryDatasetSource)
  }
  // End of list of possible types for union field source.
}
フィールド
name

string

出力専用。リスティングのリソース名。例: projects/myproject/locations/US/dataExchanges/123/listings/456
displayName

string

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

string

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

string

省略可。リスティングのメインの連絡先のメールアドレスまたは URL。最大長: 1,000 バイト。
documentation

string

省略可。リスティングを説明するドキュメント。
state

enum (State)

出力専用。リスティングの現在の状態。
icon

string (bytes format)

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

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

object (DataProvider)

省略可。ソースデータを所有するデータ プロバイダの詳細。
categories[]

enum (Category)

省略可。リスティングのカテゴリ。カテゴリは 2 つまで指定できます。
publisher

object (Publisher)

省略可。リスティングを所有し、ソースデータを共有できるパブリッシャーの詳細。
requestAccess

string

省略可。リスティングへのアクセス権リクエストのメールアドレスまたは URL。サブスクライバーは、この参照情報を使用してアクセスをリクエストできます。最大長: 1,000 バイト。
restrictedExportConfig

object (RestrictedExportConfig)

省略可。設定すると、制限付きエクスポートの構成がリンクされたデータセットに反映され、適用されます。
共用体フィールド source。リスティングのソース。source は次のいずれかになります。
bigqueryDataset

object (BigQueryDatasetSource)

必須。共有データセット（BigQuery データセット ソースなど）

BigQueryDatasetSource

共有データセットへの参照。これは、サブスクライバーと共有するテーブルやビューなどのオブジェクトのコレクションを含む、既存の BigQuery データセットです。サブスクライバーがリスティングにサブスクライブすると、Analytics Hub によって、サブスクライバーのプロジェクト内にリンクされたデータセットが作成されます。リンクされたデータセットは、読み取り専用の不透明な BigQuery データセットです。これは、共有データセットへのシンボリック リンクとして機能します。

JSON 表現 
{
  "dataset": string
}
フィールド
dataset

string

このリスティングのデータセット ソースのリソース名。例: projects/myproject/datasets/123

State

リスティングの状態。

列挙型
STATE_UNSPECIFIED デフォルト値。この値は使用されません。
ACTIVE サブスクライブ可能な状態。dataexchange.listings.subscribe 権限を持つユーザーは、このリスティングにサブスクライブできます。

DataProvider

データ プロバイダの詳細が含まれます。

JSON 表現 
{
  "name": string,
  "primaryContact": string
}
フィールド
name

string

省略可。データ プロバイダの名前。
primaryContact

string

省略可。データ プロバイダのメールアドレスまたは URL。最大長: 1,000 バイト。

Category

リスティングのカテゴリ。

列挙型
CATEGORY_UNSPECIFIED
CATEGORY_OTHERS
CATEGORY_ADVERTISING_AND_MARKETING
CATEGORY_COMMERCE
CATEGORY_CLIMATE_AND_ENVIRONMENT
CATEGORY_DEMOGRAPHICS
CATEGORY_ECONOMICS
CATEGORY_EDUCATION
CATEGORY_ENERGY
CATEGORY_FINANCIAL
CATEGORY_GAMING
CATEGORY_GEOSPATIAL
CATEGORY_HEALTHCARE_AND_LIFE_SCIENCE
CATEGORY_MEDIA
CATEGORY_PUBLIC_SECTOR
CATEGORY_RETAIL
CATEGORY_SPORTS
CATEGORY_SCIENCE_AND_RESEARCH
CATEGORY_TRANSPORTATION_AND_LOGISTICS
CATEGORY_TRAVEL_AND_TOURISM

Publisher

リスティング パブリッシャーの詳細が含まれます。

JSON 表現 
{
  "name": string,
  "primaryContact": string
}
フィールド
name

string

省略可。リスティング パブリッシャーの名前。
primaryContact

string

省略可。リスティング パブリッシャーのメールアドレスまたは URL。最大長: 1,000 バイト。

RestrictedExportConfig

リンクされたデータセットで制限付きエクスポートを構成するために使用される制限付きエクスポート構成。

JSON 表現 
{
  "enabled": boolean,
  "restrictDirectTableAccess": boolean,
  "restrictQueryResult": boolean
}
フィールド
enabled

boolean

省略可。true の場合、制限付きエクスポートを有効にします。
restrictDirectTableAccess

boolean

出力専用。true の場合、リンクされたテーブルへの直接的なテーブル アクセス（api/tabledata.list の読み取り）を制限します。
restrictQueryResult

boolean

省略可。true の場合、制限付きリンク データセット テーブルから取得したクエリ結果のエクスポートを制限します。

メソッド

create

 新しいリスティングを作成します。

delete

 リスティングを削除します。

get

 リスティングの詳細を取得します。

getIamPolicy

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

list

 指定されたプロジェクトとロケーションのすべてのリスティングを一覧表示します。

listSubscriptions

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

patch

 既存のリスティングを更新します。

setIamPolicy

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

subscribe

 リスティングにサブスクライブします。

testIamPermissions

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