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

Data Cloud Segments

セグメントの取得または作成を行います。

リソース

1/ssot/segments

使用可能なバージョン

55.0

HTTP のメソッド

GET、POST

GET の要求パラメーター

パラメーター名	種別	説明	必須か省略可能	使用可能なバージョン
`batchSize`	Integer	返される項目の数。値の範囲は 1 ～ 200 です。指定されていない場合、デフォルト値は `20` です。	省略可能	56.0
`dataspace`	String	アクションを実行するデータスペースの名前。ユーザーはこのデータスペースへの権限を持っている必要があります。セグメントを一括でリストする場合は省略可能です。指定しない場合、デフォルトは `default` データスペースです。	省略可能	58.0
`offset`	Integer	結果を返す前にスキップする行数。指定されていない場合、行はスキップされません。	省略可能	56.0
`orderby`	String	結果セットの並べ替え順 (例: `Name ASC` または `MarketSegmentType DESC`.)。指定されていない場合、項目は ID の昇順で返されます。	省略可能	56.0

GET のレスポンスボディ

Data Cloud Segment Container Output

POST のリクエストボディ

ルート XML タグ

<cdpSegment>

JSON の例

1{
2"developerName": "ConnectSegment20",
3"description": "This is a connect API segment",
4"includeDbt": {
5   "models": {
6      "models": [
7         {
8         "name": "m1",
9         "sql": "select ssot__Individual__dlm.ssot__Id__c from ssot__Individual__dlm where ssot__Individual__dlm.ssot__FirstName__c='john'"
10         }
11      ]
12   }
13   },
14"segmentType": "Dbt"
15}

プロパティ

名前	型	説明	必須か省略可能	使用可能なバージョン
`additionalMetadata`	Map<String, String>	追加のメタデータの対応付け。	POST では省略可能 PATCH では非サポート	55.0
`dataSpace`	String	セグメントのデータスペース。API バージョン 59.0 以降、このプロパティは使用できません。代わりに `dataspace` 要求パラメーターを使用します。	省略可能	57.0 ～ 58.0
`description`	String	セグメントの説明。	省略可能	55.0
`developerName`	String	セグメントの開発者名。	POST では必須 PATCH では非サポート	55.0
`displayName`	String	セグメント表示名。	省略可能	57.0
`includeDbt`	Data Cloud Segment Dbt Input	セグメントのデータビルドツール。	必須	55.0
`publishSchedule`	String	更新スケジュールを公開します。値は次のとおりです。 `One` — 1 時間ごとに更新します。UI ベースと DBT ベースのセグメントを迅速に公開するために使用されます。 `Four` — 4 時間ごとに更新します。UI ベースと DBT ベースのセグメントを迅速に公開するために使用されます。 `Twelve` — 12 時間ごとに更新します。 `TwentyFour` — 24 時間ごとに更新します。	省略可能	55.0
`publishScheduleEndDate`	String	公開スケジュールの終了を示す日付。	`publishSchedule` が指定されていない場合は省略可能	55.0
`publishScheduleStartDateTime`	String	公開スケジュールの開始を示す日時。	`publishSchedule` が指定されていない場合は省略可能	55.0
`segmentOnApiName`	String	SegmentOn エンティティの API 参照名。	省略可能	57.0
`segmentType`	String	セグメントの種別。値は次のとおりです。 `Dbt` — データビルドツールセグメントの作成後にセグメントの種別を変更することはできません。	POST では必須 PATCH では非サポート	55.0

POST の要求パラメーター

パラメーター名	種別	説明	必須か省略可能	使用可能なバージョン
`dataspace`	String	アクションを実行するデータスペースの名前。ユーザーはこのデータスペースへの権限を持っている必要があります。デフォルトは `default` データスペースです。 API バージョン 58.0 では、指定された場合、このパラメーターは `dataSpace` リクエストボディプロパティを上書きします。このパラメーターが指定されていない場合、`dataSpace` リクエストボディプロパティが使用されます。 API バージョン 58.0 では、このパラメーターと `dataSpace` リクエストボディプロパティのいずれも指定されていない場合、`default` データスペースが使用されます。 API バージョン 59.0 以降では、このパラメーターを使用します。`dataSpace` リクエストボディプロパティは使用できません。	省略可能	58.0

POST のレスポンスボディ

Data Cloud Segment Output

Connect REST API 開発者ガイド

Data Cloud Segments