機械翻訳について

キャンペーンの取得

get

/crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}

リクエスト

パス・パラメータ
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2

    フォーマット: <attr1>=<val1>,<attr2>=<value2>
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
  • このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。

    フォーマット : ?fields=Attribute1,Attribute2

    子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

    例:
    self,canonical
  • リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

この操作にはリクエスト本文がありません。

トップに戻る

応答

サポートされるメディア・タイプ

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : campaigns-item-response
タイプ: object
ソースを表示
  • タイトル: Actual Cost
    キャンペーンの実際の費用。
  • タイトル: Budgeted Cost
    キャンペーンの予算費用。
  • Campaign Account Attribution Criteria
    タイトル: Campaign Account Attribution Criteria
    キャンペーン・アカウント属性基準リソースは、販売ターゲット・キャンペーンに関連付けられたキャンペーン・アカウント属性基準を表示、作成、更新および削除するために使用されます。
  • Campaign Accounts
    タイトル: Campaign Accounts
    キャンペーン・アカウント・リソースは、販売ターゲット・キャンペーンに関連付けられたアカウントの表示、作成、更新および削除に使用されます。
  • タイトル: Category
    最大長: 30
    デフォルト値: ORA_MARKETING
    キャンペーンのカテゴリ。
  • タイトル: Campaign Created By
    最大長: 64
    キャンペーン・レコードを作成したユーザー。
  • タイトル: Campaign Creation Date
    キャンペーン・レコードが作成された日付。
  • タイトル: Campaign ID
    キャンペーンの一意の識別子。
  • タイトル: Campaign Last Update Date
    キャンペーン・レコードが最後に更新された日付。
  • タイトル: Campaign Last Updated By
    最大長: 64
    キャンペーン・レコードを最後に更新したユーザー。
  • タイトル: Name
    最大長: 100
    キャンペーンの名前。
  • タイトル: Campaign Number
    最大長: 30
    キャンペーンの代替キー識別子。
  • タイトル: Origin
    最大長: 30
    デフォルト値: MKT_CAMPAIGN
    キャンペーンの発生元。
  • Campaign Products
    タイトル: Campaign Products
    キャンペーン製品リソースは、販売ターゲット・キャンペーンに関連付けられている製品または製品グループを表示、作成、更新および削除するために使用されます。
  • Campaign Rollups
    タイトル: Campaign Rollups
    キャンペーン・ロールアップ・リソースは、キャンペーン・ロールアップの表示に使用されます。
  • Campaign Teams
    タイトル: Campaign Teams
    キャンペーン・チーム・リソースは、販売ターゲット・キャンペーンに関連付けられたリソースを表示、作成、更新および削除するために使用されます。
  • タイトル: Type
    最大長: 30
    キャンペーンのタイプ。
  • タイトル: Type
    読取り専用: true
    最大長: 80
    キャンペーンのタイプの表示値。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    キャンペーンを作成したユーザー。
  • タイトル: Created by Module
    最大長: 60
    デフォルト値: ORA_WS
    キャンペーンの作成に使用されたモジュール。
  • タイトル: Creation Date
    読取り専用: true
    キャンペーンが作成された日付。
  • タイトル: Currency
    最大長: 15
    USDやGBPなど、キャンペーンに関連付けられた通貨を示すコード。
  • タイトル: Can Be Deleted
    読取り専用: true
    ログイン・ユーザーがキャンペーンを削除できるかどうかを示します。
  • タイトル: Description
    最大長: 2000
    キャンペーンの簡単な説明。
  • タイトル: End Date
    キャンペーンが終了した日付。
  • タイトル: Last Updated
    読取り専用: true
    キャンペーンが最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    キャンペーンを最後に更新したユーザー。
  • タイトル: Last Updated Login
    読取り専用: true
    最大長: 32
    キャンペーンを最後に更新したユーザーのログイン。
  • Links
  • Campaign Members
    タイトル: Campaign Members
    キャンペーン・メンバー・リソースは、営業キャンペーンに関連付けられているメンバーを表示するために使用されます。
  • タイトル: Number of Accounts
    販売ターゲット・キャンペーンに関連付けられているアカウントの数。
  • タイトル: Number of Lead Generation Errors
    特定の営業ターゲット・キャンペーンでエラーが発生したリードの数。
  • タイトル: Number of Leads Generated
    特定の販売ターゲット・キャンペーンに対して生成されたリードの数。
  • タイトル: Owner ID
    キャンペーンの所有者の一意の識別子。
  • タイトル: Owner
    最大長: 360
    キャンペーン所有者に関連付けられたパーティの名前。
  • タイトル: Owner Number
    読取り専用: true
    最大長: 30
    キャンペーンの所有者の一意の代替識別子。
  • タイトル: Parent Campaign ID
    親キャンペーンの一意の識別子。
  • タイトル: Parent Campaign Name
    読取り専用: true
    最大長: 100
    キャンペーンの親の名前。
  • タイトル: Parent Campaign Number
    読取り専用: true
    最大長: 30
    キャンペーンの親の一意の代替識別子。
  • タイトル: Product Description
    最大長: 100
    キャンペーンの製品の簡単な説明。
  • タイトル: Region Code
    最大長: 100
    キャンペーンのリージョンを示すコード。
  • Sales Contents
    タイトル: Sales Contents
    販売コンテンツ・リソースは、販売ターゲット・キャンペーンに関連付けられている販売コンテンツの表示、作成、更新および削除に使用されます。
  • タイトル: Validation Period in Days
    生成された営業ターゲット・リードを検証する必要がある期間(日数)。
  • タイトル: Last Sync to Marketing Date
    この営業ターゲット・キャンペーンが初めてEloquaに同期される日付。
  • タイトル: Stage
    最大長: 32
    営業ターゲット・キャンペーンのステージを示すコード。
  • タイトル: Last Lead Generation Date
    このキャンペーンのセールス・ターゲット見込み客が最後に生成された日付。
  • Smart Actions
    タイトル: Smart Actions
    スマート・アクション・リソースは、スマート・アクションの名前、セキュリティ、コンテキスト・オブジェクト、REST操作、確認メッセージおよびその他のグローバル・プロパティを表示するために使用されます。 レスポンス・ペイロードで返されたスマート・アクション・アイテムまたはコレクション・リンクは、RESTリクエストが処理された時点で有効です。 親オブジェクト・コンテキストを変更すると、以前に有効なスマート・アクションが無効になる可能性があります。
  • タイトル: Source System Campaign ID
    最大長: 100
    ソース・システム内のキャンペーンの一意の識別子。
  • ソース・システム内のEメールの一意の識別子。
  • ソース・システム内のランディング・ページの一意の識別子。
  • ソース・システム内のセグメントの一意の識別子。
  • ソース・システム内の共有リストの一意の識別子。
  • タイトル: Start Date
    キャンペーンが開始された日付。
  • タイトル: Status
    最大長: 30
    デフォルト値: ORA_DRAFT
    キャンペーンのステータス。
  • タイトル: Status
    読取り専用: true
    最大長: 80
    キャンペーンのステータスの表示ラベル。
  • タイトル: Can Be Updated
    読取り専用: true
    ログイン・ユーザーがキャンペーンを更新できるかどうかを示します。
ネストされたスキーマ : キャンペーン・アカウント属性基準
タイプ: array
タイトル: Campaign Account Attribution Criteria
キャンペーン・アカウント属性基準リソースは、販売ターゲット・キャンペーンに関連付けられたキャンペーン・アカウント属性基準を表示、作成、更新および削除するために使用されます。
ソースを表示
ネストされたスキーマ : キャンペーン・アカウント
タイプ: array
タイトル: Campaign Accounts
キャンペーン・アカウント・リソースは、販売ターゲット・キャンペーンに関連付けられたアカウントの表示、作成、更新および削除に使用されます。
ソースを表示
ネストされたスキーマ : キャンペーン製品
タイプ: array
タイトル: Campaign Products
キャンペーン製品リソースは、販売ターゲット・キャンペーンに関連付けられている製品または製品グループを表示、作成、更新および削除するために使用されます。
ソースを表示
ネストされたスキーマ : キャンペーン・ロールアップ
タイプ: array
タイトル: Campaign Rollups
キャンペーン・ロールアップ・リソースは、キャンペーン・ロールアップの表示に使用されます。
ソースを表示
ネストされたスキーマ : キャンペーン・チーム
タイプ: array
タイトル: Campaign Teams
キャンペーン・チーム・リソースは、販売ターゲット・キャンペーンに関連付けられたリソースを表示、作成、更新および削除するために使用されます。
ソースを表示
ネストされたスキーマ : キャンペーン・メンバー
タイプ: array
タイトル: Campaign Members
キャンペーン・メンバー・リソースは、営業キャンペーンに関連付けられているメンバーを表示するために使用されます。
ソースを表示
ネストされたスキーマ : 販売コンテンツ
タイプ: array
タイトル: Sales Contents
販売コンテンツ・リソースは、販売ターゲット・キャンペーンに関連付けられている販売コンテンツの表示、作成、更新および削除に使用されます。
ソースを表示
ネストされたスキーマ : スマートなアクション
タイプ: array
タイトル: Smart Actions
スマート・アクション・リソースは、スマート・アクションの名前、セキュリティ、コンテキスト・オブジェクト、REST操作、確認メッセージおよびその他のグローバル・プロパティを表示するために使用されます。 レスポンス・ペイロードで返されたスマート・アクション・アイテムまたはコレクション・リンクは、RESTリクエストが処理された時点で有効です。 親オブジェクト・コンテキストを変更すると、以前に有効なスマート・アクションが無効になる可能性があります。
ソースを表示
ネストされたスキーマ : campaigns-CampaignAccountAttributionCriteria-item-response
タイプ: object
ソースを表示
  • タイトル: Campaign Attribution Criteria ID
    キャンペーン・アカウント属性基準の一意の識別子。
  • タイトル: Campaign Attribution Criteria Number
    最大長: 30
    アカウント属性基準の代替キー識別子。
  • タイトル: Campaign Number
    読取り専用: true
    最大長: 30
    キャンペーン・アカウント属性基準が属するキャンペーンの一意の識別子。
  • タイトル: Campaign Identifier
    キャンペーン・アカウントの一意の識別子。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    キャンペーン・アカウント属性基準を作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    キャンペーン・アカウント属性基準が作成された日付。
  • タイトル: Criteria Expression
    これには、UIで選択した基準の問合せ式が含まれます。
  • タイトル: Criteria Type
    最大長: 30
    定義されている基準が包含か除外かを示します。
  • タイトル: Is Exclusion Criteria
    最大長: 1
    デフォルト値: false
    アカウント属性基準がアカウントを除外するかどうかを示します。
  • タイトル: Last Updated Date
    読取り専用: true
    キャンペーン・アカウント属性基準が最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    キャンペーン・アカウント属性基準を最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    レコードを最後に更新したユーザーのログイン。
  • Links
  • タイトル: Source Object Attribute
    最大長: 150
    ソース・オブジェクトID値を保持する属性。
  • タイトル: Source Object
    最大長: 30
    オブジェクト名の言語非依存コード。
ネストされたスキーマ : campaigns-CampaignAccounts-item-response
タイプ: object
ソースを表示
  • タイトル: Country
    読取り専用: true
    取引先の国。
  • タイトル: Campaign Account Party ID
    キャンペーン・アカウントに関連付けられたアカウントの一意の識別子。
  • タイトル: Primary Industry
    読取り専用: true
    アカウントのプライマリ産業区分コード。
  • タイトル: Name
    読取り専用: true
    最大長: 360
    キャンペーン・アカウントに関連付けられているアカウント・パーティの名前。
  • タイトル: Registry ID
    読取り専用: true
    最大長: 30
    キャンペーン・アカウントに関連付けられたアカウントの一意の代替識別子。
  • タイトル: State
    読取り専用: true
    最大長: 60
    取引先の状態。
  • タイトル: Company Size
    読取り専用: true
    取引先の従業員の合計数。
  • タイトル: Campaign Account ID
    キャンペーン・アカウントの一意の識別子。
  • タイトル: Campaign Account Number
    最大長: 30
    キャンペーン・アカウントの代替キー識別子。
  • タイトル: Campaign Identifier
    キャンペーンの一意の識別子。
  • タイトル: Campaign Number
    最大長: 30
    キャンペーン・アカウントが属するキャンペーンの一意の識別子。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    キャンペーン・アカウントを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    キャンペーン・アカウントが作成された日付。
  • タイトル: Error Description
    最大長: 2000
    このアカウントのリード生成中に生成されたエラー・メッセージが含まれています。
  • タイトル: Last Updated
    読取り専用: true
    キャンペーン・アカウントが最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    キャンペーン・アカウントを最後に更新したユーザー。
  • タイトル: Lead ID
    キャンペーン・アカウントに関連付けられたリードの一意の識別子。
  • タイトル: Lead Name
    読取り専用: true
    最大長: 250
    キャンペーン取引先に関連付けられた見込み客の名前。
  • タイトル: Lead Number
    最大長: 30
    キャンペーン・アカウントに関連付けられたリードの一意の代替識別子。
  • Links
  • タイトル: Query Criteria Type
    最大長: 10
    デフォルト値: MANUAL
    これは、アカウントが問合せビルダーによって追加されたか、手動で追加されたかを示します。
ネストされたスキーマ : campaigns-CampaignProducts-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : campaigns-CampaignRollup-item-response
タイプ: object
ソースを表示
  • タイトル: Campaign Identifier
    読取り専用: true
    キャンペーンの一意の識別子。
  • タイトル: Corporate Currency Code
    読取り専用: true
    最大長: 15
    キャンペーン・ロールアップの企業通貨コード。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    行を作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    行が作成された日時。
  • タイトル: Last Updated Date
    読取り専用: true
    行が最後に更新された日時。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    レコードを最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    レコードを最後に更新したユーザーのログイン。
  • Links
  • タイトル: Total Converted Leads
    読取り専用: true
    キャンペーンに関連付けられた変換済リードの合計数。
  • タイトル: Total Leads
    読取り専用: true
    キャンペーンに関連付けられたリードの合計数。
  • タイトル: Total Hot Open Leads
    読取り専用: true
    キャンペーンに関連付けられた、ホットとしてランク付けされた不適格または適格なリードの合計数。
  • タイトル: Total Open Leads
    読取り専用: true
    キャンペーンに関連付けられた不適格または適格なオープン・リードの合計数。
  • タイトル: Total Open Opportunities
    読取り専用: true
    キャンペーンに関連付けられたオープン商談の合計数。
  • タイトル: Total Opportunities
    読取り専用: true
    キャンペーンに関連付けられた商談の合計数。
  • タイトル: Total Won Opportunities
    読取り専用: true
    キャンペーンに関連付けられた受注済商談の合計。
  • タイトル: Total Revenue from Opportunities
    読取り専用: true
    キャンペーンに関連付けられた商談の合計売上。
  • タイトル: Total Revenue from Open Leads
    読取り専用: true
    キャンペーンに関連付けられた不適格および適格リードの合計金額。
  • タイトル: Total Revenue from Open Opportunities
    読取り専用: true
    キャンペーンに関連付けられたオープン商談の合計売上。
  • タイトル: Total Revenue from Won Opportunities
    読取り専用: true
    キャンペーンに関連付けられた受注済商談の合計売上。
ネストされたスキーマ : campaigns-CampaignTeam-item-response
タイプ: object
ソースを表示
  • タイトル: Campaign Team Member Access Level Code
    最大長: 30
    デフォルト値: 300
    チーム・メンバーのアクセス・レベルを示すコード。
  • タイトル: Is Approver
    最大長: 1
    デフォルト値: false
    チーム・メンバーがキャンペーンの承認者であるかどうかを示します。
  • タイトル: Campaign ID
    キャンペーンの一意の識別子。
  • タイトル: Campaign Number
    最大長: 30
    キャンペーン・リソースが属するキャンペーンの一意の識別子。
  • タイトル: Campaign Team Member ID
    キャンペーン・リソースの一意の識別子。
  • タイトル: Campaign Team Member Number
    最大長: 30
    キャンペーン・リソースの代替キー識別子。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    キャンペーン・リソースを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    キャンペーン・リソースが作成された日付。
  • タイトル: Primary Email
    読取り専用: true
    最大長: 320
    キャンペーン・チーム・リソースに関連付けられたEメール・アドレス。
  • タイトル: Primary Phone
    読取り専用: true
    キャンペーン・リソースの書式設定された電話番号。
  • タイトル: Last Updated
    読取り専用: true
    キャンペーン・リソースが最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    キャンペーン・リソースを最後に更新したユーザー。
  • Links
  • タイトル: Campaign Team Member Function Code
    最大長: 30
    このキャンペーンのコンテキストにおけるリード担当者のロール。
  • タイトル: Owner
    このリソースがこのキャンペーンのプライマリ・リソースかどうかを示します。
  • タイトル: Campaign Team Member Party ID
    この営業キャンペーン・リソースに関連付けられた一意の識別子。
  • タイトル: Name
    読取り専用: true
    最大長: 360
    キャンペーン・リソースに関連付けられたパーティの名前。
  • タイトル: Registry ID
    読取り専用: true
    最大長: 30
    このキャンペーン・リソースに関連付けられた代替キー識別子。
  • タイトル: Role Name
    読取り専用: true
    最大長: 60
    営業リードに関連付けられたキャンペーン・リソースのロールの名前。
ネストされたスキーマ : campaigns-MktCampaignMembers-item-response
タイプ: object
ソースを表示
  • タイトル: Is Active
    読取り専用: true
    最大長: 1
    デフォルト値: Y
    キャンペーン・メンバーがアクティブかどうかを示します。
  • タイトル: Name
    読取り専用: true
    最大長: 100
    キャンペーン・メンバーが属するキャンペーンの名前。
  • タイトル: Campaign Number
    最大長: 30
    キャンペーン・メンバーが属するキャンペーンの一意の識別子。
  • タイトル: End Date
    読取り専用: true
    マーケティング統合キャンペーンが終了する日付。
  • タイトル: Campaign Identifier
    キャンペーン・メンバーの一意の識別子。
  • タイトル: Campaign Member ID
    キャンペーンの一意の識別子。
  • タイトル: Campaign Member Number
    最大長: 30
    キャンペーン・メンバーの代替キー識別子。
  • タイトル: Start Date
    読取り専用: true
    マーケティング統合キャンペーンが開始する日付。
  • タイトル: Status
    読取り専用: true
    最大長: 30
    デフォルト値: ORA_DRAFT
    マーケティング統合キャンペーンのステータス。
  • タイトル: Type
    読取り専用: true
    最大長: 30
    マーケティング統合キャンペーンのタイプ。
  • タイトル: Contact Email
    読取り専用: true
    最大長: 320
    キャンペーン・メンバーに関連付けられた担当者の電子メール・アドレス。
  • タイトル: Contact ID
    キャンペーン・メンバーに関連付けられたパーティの一意の識別子。
  • タイトル: Contact Name
    読取り専用: true
    最大長: 360
    キャンペーン・メンバーに関連付けられた担当者パーティの名前。
  • タイトル: Contact Number
    読取り専用: true
    最大長: 30
    キャンペーン・メンバーに関連付けられた担当者の一意の代替識別子。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    キャンペーン・メンバーを作成したユーザー。
  • タイトル: Created by Module
    最大長: 60
    デフォルト値: ORA_WS
    キャンペーン・メンバーを作成できるモジュール。
  • タイトル: Creation Date
    読取り専用: true
    キャンペーン・メンバーが作成された日付。
  • タイトル: Currency
    最大長: 15
    USDやGBPなど、キャンペーン・メンバーに関連付けられた通貨を示すコード。
  • タイトル: Can Be Deleted
    読取り専用: true
    ログイン・ユーザーがキャンペーン・メンバーを削除できるかどうかを示します。
  • タイトル: Email
    最大長: 320
    キャンペーン・メンバーの電子メール・アドレス。
  • タイトル: Last Updated Date
    読取り専用: true
    キャンペーン・メンバーが最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    キャンペーン・メンバーを最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    キャンペーン・メンバーを最後に更新したユーザーのログイン。
  • タイトル: Lead Account
    読取り専用: true
    最大長: 360
    キャンペーン・メンバーに関連付けられた見込み客の取引先名。
  • タイトル: Lead Email
    読取り専用: true
    最大長: 320
    キャンペーン・メンバーに関連付けられたリードのEメール・アドレス。
  • タイトル: Lead ID
    キャンペーン・メンバーに関連付けられたリードの一意の識別子。
  • タイトル: Lead Name
    読取り専用: true
    最大長: 250
    キャンペーン・メンバーに関連付けられている見込み客の名前。
  • タイトル: Lead Number
    最大長: 30
    キャンペーン・メンバーに関連付けられたリードの一意の代替識別子。
  • タイトル: Lead Owner
    読取り専用: true
    最大長: 360
    キャンペーン・メンバーに関連付けられたリードの所有者名。
  • Links
  • タイトル: Response Date
    キャンペーン・メンバーのレスポンスを受信した日付。
  • タイトル: Member Status
    最大長: 30
    デフォルト値: ORA_SENT
    キャンペーン・メンバーのステータス。
  • タイトル: Member Status
    読取り専用: true
    最大長: 80
    キャンペーン・メンバーのステータスに対する表示ラベル。
  • タイトル: Source System Campaign Member ID
    最大長: 100
    ソース・システム内のキャンペーン・メンバーの一意の識別子。
  • タイトル: Can Be Updated
    読取り専用: true
    ログイン・ユーザーがキャンペーン・メンバーを更新できるかどうかを示します。
ネストされたスキーマ : campaigns-SalesContents-item-response
タイプ: object
ソースを表示
  • 読取り専用: true
    デフォルト値: Y
    ユーザーがコンテンツ・アイテムを削除できるかどうかを示します。
  • 読取り専用: true
    デフォルト値: Y
    ユーザーがコンテンツ・アイテムを更新できるかどうかを示します。
  • タイトル: Content ID
    最大長: 64
    ソース・システムからの内部コンテンツ・アイテム識別子。
  • タイトル: Content Name
    最大長: 4000
    販売コンテンツ・アイテムの名前。
  • 読取り専用: true
    コンテンツのタイプを示します。たとえば、pdf、pngなどです。
  • 最大長: 50
    デフォルト値: OCE
    コンテンツ・アイテムのソース元を示します。
  • タイトル: Content Deleted in Source
    最大長: 1
    デフォルト値: false
    参照販売コンテンツ・アイテムがソース・システムで削除されるかどうかを示します。
  • タイトル: Display Sequence
    販売コンテンツがページに表示される順序を示します。
  • Links
  • タイトル: Parent Object ID
    販売コンテンツ行に関連付けられたオブジェクトの一意の識別子。
  • 最大長: 128
    販売コンテンツ行に関連付けられた親オブジェクト・タイプ。たとえば、アカウント、担当者、リードなどです。
  • タイトル: Public Content ID
    最大長: 64
    ソース・システムからの公開コンテンツ・アイテム識別子。
  • タイトル: Public Content Name
    最大長: 4000
    公開販売コンテンツ・アイテムの名前。
  • タイトル: Customer Name
    最大長: 4000
    公開コンテンツが公開された顧客の名前。
  • タイトル: Publish Date
    公開コンテンツ・アイテムが公開された日付。
  • タイトル: Sales Content ID
    読取り専用: true
    販売コンテンツの一意の識別子。
ネストされたスキーマ : campaigns-smartActions-item-response
タイプ: object
ソースを表示
  • タイトル: Action Intent
    アクションの実行内容、およびアクションに渡すことができるコンテキスト・データを記述するJSONオブジェクト。
  • タイトル: Confirmation Message
    最大長: 1024
    実行中のアクションの確認を求めるメッセージ。
  • タイトル: Content Type
    最大長: 50
    RESTエンドポイントの呼出し時に使用するコンテンツ・タイプ。
  • タイトル: Action Name
    最大長: 256
    コンシューマ・フレンドリなアクション名。
  • タイトル: Parent Entity
    最大長: 150
    アクションが属するRESTリソース。
  • タイトル: REST Endpoint
    最大長: 150
    アクションを実行するRESTエンドポイント。
  • タイトル: Included in Application
    最大長: 512
    このアクションを使用できるアプリケーションのリスト。
  • Links
  • タイトル: HTTP Method
    最大長: 15
    スマート・アクションREST操作のHTTPメソッド。
  • タイトル: Object Function
    最大長: 64
    スマート・アクションに関連付けられたオブジェクト関数。
  • タイトル: Page Type
    最大長: 256
    このアクションを使用できるページのリスト。
  • タイトル: Smart Suggest
    最大長: 1
    処理に対してスマート提案が使用可能かどうかを示します。
  • タイトル: System Action
    最大長: 1
    処理がシード済かカスタムかを示します。
  • タイトル: Attributes to Update
    最大長: 512
    処理UIの起動時に更新される属性。
  • タイトル: User Action ID
    スマート処理定義の一意のシステム割当識別子。
  • タイトル: Action Name
    最大長: 256
    名前を持つ処理を一意に識別します。 内部使用。
  • Smart Action User Interface Definitions
    タイトル: Smart Action User Interface Definitions
    ユーザー・インタフェース定義リソースは、スマート処理に関連付けられたユーザー・インタフェースを表示するために使用されます。 各ユーザー・インタフェースをクライアント・アプリケーションにマッピングできます。 レスポンス・ペイロードで返されたスマート・アクション・アイテムまたはコレクション・リンクは、RESTリクエストが処理された時点で有効です。 親オブジェクト・コンテキストを変更すると、以前に有効なスマート・アクションが無効になる可能性があります。
  • タイトル: Priority
    処理の優先度を示す番号。
  • Smart Action REST Payload Definitions
    タイトル: Smart Action REST Payload Definitions
    ペイロード定義リソースは、スマート・アクションのRESTリクエスト・ペイロードの名前と値のペア定義を表示するために使用されます。 レスポンス・ペイロードで返されたスマート・アクション・アイテムまたはコレクション・リンクは、RESTリクエストが処理された時点で有効です。 親オブジェクト・コンテキストを変更すると、以前に有効なスマート・アクションが無効になる可能性があります。
  • Smart Action REST Path Parameter Definitions
    タイトル: Smart Action REST Path Parameter Definitions
    パス・パラメータ定義リソースは、スマート・アクションのRESTリクエスト・パス・パラメータの名前と値のペア定義を表示するために使用されます。 レスポンス・ペイロードで返されたスマート・アクション・アイテムまたはコレクション・リンクは、RESTリクエストが処理された時点で有効です。 親オブジェクト・コンテキストを変更すると、以前に有効なスマート・アクションが無効になる可能性があります。
ネストされたスキーマ : スマート処理ユーザー・インタフェース定義
タイプ: array
タイトル: Smart Action User Interface Definitions
ユーザー・インタフェース定義リソースは、スマート処理に関連付けられたユーザー・インタフェースを表示するために使用されます。 各ユーザー・インタフェースをクライアント・アプリケーションにマッピングできます。 レスポンス・ペイロードで返されたスマート・アクション・アイテムまたはコレクション・リンクは、RESTリクエストが処理された時点で有効です。 親オブジェクト・コンテキストを変更すると、以前に有効なスマート・アクションが無効になる可能性があります。
ソースを表示
ネストされたスキーマ : スマート・アクションのRESTペイロード定義
タイプ: array
タイトル: Smart Action REST Payload Definitions
ペイロード定義リソースは、スマート・アクションのRESTリクエスト・ペイロードの名前と値のペア定義を表示するために使用されます。 レスポンス・ペイロードで返されたスマート・アクション・アイテムまたはコレクション・リンクは、RESTリクエストが処理された時点で有効です。 親オブジェクト・コンテキストを変更すると、以前に有効なスマート・アクションが無効になる可能性があります。
ソースを表示
ネストされたスキーマ : スマート処理RESTパス・パラメータ定義
タイプ: array
タイトル: Smart Action REST Path Parameter Definitions
パス・パラメータ定義リソースは、スマート・アクションのRESTリクエスト・パス・パラメータの名前と値のペア定義を表示するために使用されます。 レスポンス・ペイロードで返されたスマート・アクション・アイテムまたはコレクション・リンクは、RESTリクエストが処理された時点で有効です。 親オブジェクト・コンテキストを変更すると、以前に有効なスマート・アクションが無効になる可能性があります。
ソースを表示
ネストされたスキーマ : campaigns-smartActions-UserActionNavigation-item-response
タイプ: object
ソースを表示
  • Links
  • タイトル: System Action
    最大長: 1
    デフォルト値: false
    スマート処理がシード済かカスタムかを示すシステム割当値。 Trueは、スマート処理がシードされていることを示します。 値は、smartActions.SystemActionFlagから自動的に導出されます。
  • タイトル: Application Usage
    最大長: 50
    UserActionNavIdで識別されるスマート・アクション・ユーザー・インタフェース・エンドポイント定義に関連付けられたクライアント・アプリケーション。
  • タイトル: Navigation Metadata
    最大長: 1000
    スマート・アクションのユーザー・インタフェース・エンドポイントのメタデータ定義。
  • タイトル: Primary Key
    スマート処理がシード済かカスタムかを示すシステム割当値。 Trueは、スマート処理がシードされていることを示します。 値は、smartActions.SystemActionFlagから自動的に導出されます。
  • タイトル: Navigation Type
    最大長: 100
    起動するユーザー・インタフェースを決定するためにアプリケーションで使用されるテキスト値。
ネストされたスキーマ : campaigns-smartActions-UserActionRequestPayload-item-response
タイプ: object
ソースを表示
  • タイトル: Payload Value Binding Type
    最大長: 64
    名前と値のペアの値プロパティの分類。 バインディング値RUNTIMEは、割り当てられる値がオブジェクト属性の実行時値であることを示します。 値STATICは、割り当てられる値が単純な文字列であることを示します。 NULL値は、値タイプがJSON_ARRAY_STRINGであることを示します。
  • Links
  • タイトル: Mandatory
    最大長: 1
    RESTペイロード本文のパラメータ値が必須かどうかを示します。 Trueの場合、ランタイム検証によって値が確実に定義されます。
  • スマート・アクションRESTペイロード本文パラメータの名前と値のペア定義の一意のシステム割当識別子。
  • タイトル: Request Payload Attribute Name
    最大長: 256
    名前と値のペアの名前プロパティに割り当てられた値。
  • タイトル: Smart Suggest Path
    最大長: 2048
    スマート候補に使用されるパス。
  • タイトル: System Action
    最大長: 1
    デフォルト値: false
    スマート処理がシード済かカスタムかを示すシステム割当値。 Trueは、スマート処理がシードされていることを示します。 値は、smartActions.SystemActionFlagから自動的に導出されます。
  • タイトル: Request Payload Attribute Value
    最大長: 250
    名前と値のペアの値プロパティに割り当てられた値。
  • タイトル: Payload Value Structure
    最大長: 20
    値JSON_ARRAY_STRINGは、名前と値のペアの値プロパティが、オブジェクト属性名や単純なテキスト文字列などの単一エンティティではなく、データの配列を表すことを示します。 配列文字列は、名前と値のペア、およびバインディングと必須プロパティの定義です。 配列文字列は、[{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]などの特定のパターンに従います。 null値は、値プロパティが、オブジェクト属性名や単純なテキスト文字列などの単純な単一エンティティを表すことを示します。
ネストされたスキーマ : campaigns-smartActions-UserActionURLBinding-item-response
タイプ: object
ソースを表示
  • タイトル: URL Binding Type
    最大長: 64
    名前と値のペアの値プロパティの分類。 UserActionURLBindingインスタンスのバインディング値は、RUNTIMEである必要があります。 バインディング値RUNTIMEは、割り当てられる値がオブジェクト属性の実行時値であることを示します。
  • Links
  • タイトル: System Action
    最大長: 1
    デフォルト値: false
    スマート処理がシード済かカスタムかを示すシステム割当値。 Trueは、スマート処理がシードされていることを示します。 値は、smartActions.SystemActionFlagから自動的に導出されます。
  • スマート・アクションRESTパス・パラメータの名前と値のペア定義の一意のシステム割当識別子。
  • タイトル: URL Binding Parameter Name
    最大長: 50
    名前と値のペアの名前プロパティに割り当てられた値。
  • タイトル: URL Binding Parameter Value
    最大長: 80
    名前と値のペアの値プロパティに割り当てられた値。
トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対する取得リクエストを発行することによって、キャンペーンを取得する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}

レスポンス本文の例

次に、JSON形式のレスポンス本文の例を示します。

{
    "ActualCost": 1235234.23,
    "BudgetedCost": 34234.23,
    "CampaignId": 300100182332573,
    "CampaignName": "BIQA_ELQ_CAMPAIGN1",
    "CampaignNumber": "CDRM_1",
    "CampaignType": "ORA_NURTURE",
    "CreatedBy": "SALES_ADMIN",
    "CreatedByModule": "ORA_WS",
    "CreationDate": "2019-09-06T08:02:59+00:00",
    "CurrencyCode": "USD",
    "Description": "ELQ Campaign1",
    "EndDate": "2030-12-31T00:00:00+00:00",
    "LastUpdateDate": "2019-09-06T08:02:59.978+00:00",
    "LastUpdateLogin": "910A1D8F02C29F6FE053A15AF00A6378",
    "LastUpdatedBy": "SALES_ADMIN",
    "OwnerId": 100010025532672,
    "ParentCampaignId": null,
    "ProductDescription": null,
    "RegionCode": null,
    "SourceSystemCampaignId": null,
    "StartDate": "2019-09-05T00:00:00+00:00",
    "Status": "ORA_ACTIVE",
    "OwnerPartyName": "Gabrielle   Lee",
    "UpdateFlag": true,
    "DeleteFlag": true,
    "StatusLookupMeaning": "Active",
    "CampaignTypeMeaning": "Nurture",
    "OwnerPartyNumber": "100010025532672",
    "ParentCampaignName": null,
    "ParentCampaignNumber": null,
    "CampaignCreationDate": "2019-09-06T08:02:59+00:00",
    "CampaignCreatedBy": "SALES_ADMIN",
    "CampaignLastUpdateDate": "2019-09-06T08:02:59.978+00:00",
    "CampaignLastUpdatedBy": "SALES_ADMIN",
    "CampaignOrigin": "MKT_CAMPAIGN",
    "NumberOfAssociatedAccounts": null,
    "NumberOfLeadsErrored": null,
    "NumberOfLeadsGenerated": null,
    "SalesTargetCampaignStage": null,
    "SourceSystemEmailId": null,
    "SourceSystemLandingPageId": null,
    "SourceSystemSegmentId": null,
    "SourceSystemSharedListId": null,
    "SalesTargetLeadsCreationDate": null,
    "SalesTargetCampaignEloquaSyncDate": null,
    "SalesTargetCampaignDaysToVerify": null,
    "CampaignCategory": "ORA_MARKETING",
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/campaigns/CDRM_1",
            "name": "campaigns",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/campaigns/CDRM_1",
            "name": "campaigns",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/campaigns/CDRM_1/lov/OwnerPickerVA",
            "name": "OwnerPickerVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/campaigns/CDRM_1/lov/CampaignCategoryVA",
            "name": "CampaignCategoryVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/campaigns/CDRM_1/lov/CampaignTypeVA",
            "name": "CampaignTypeVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/campaigns/CDRM_1/lov/CurrencyCodeVA",
            "name": "CurrencyCodeVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/campaigns/CDRM_1/lov/CampaignOriginVA",
            "name": "CampaignOriginVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/campaigns/CDRM_1/lov/CreatedByModuleVA",
            "name": "CreatedByModuleVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/campaigns/CDRM_1/lov/CampaignStageVA",
            "name": "CampaignStageVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/campaigns/CDRM_1/lov/StatusVA",
            "name": "StatusVA",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/campaigns/CDRM_1/child/CampaignAccountAttributionCriteria",
            "name": "CampaignAccountAttributionCriteria",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/campaigns/CDRM_1/child/CampaignAccounts",
            "name": "CampaignAccounts",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/campaigns/CDRM_1/child/CampaignProducts",
            "name": "CampaignProducts",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/campaigns/CDRM_1/child/CampaignTeam",
            "name": "CampaignTeam",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/campaigns/CDRM_1/child/MktCampaignMembers",
            "name": "MktCampaignMembers",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/campaigns/CDRM_1/child/SalesContents",
            "name": "SalesContents",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/campaigns/CDRM_1/child/smartActions",
            "name": "smartActions",
            "kind": "collection"
        }
    ]
}
「トップに戻る」