機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. キャンペーン・メンバー

キャンペーン・メンバーの取得

get

/crmRestApi/resources/11.13.18.05/campaignMembers/{campaignMembersUniqID}

リクエスト

パス・パラメータ
  • これは、キャンペーン・メンバー・リソースのコンポジット・キーを構成し、キャンペーン・メンバーのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、ハッシュ・キーを取得するためにキャンペーン・メンバーの特定のインスタンスに移動するために、キャンペーン・メンバー・コレクション・リソースを問い合せる必要があります。
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: 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
  • リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
ヘッダー・パラメータ
  • このヘッダーは文字列値を受け入れます。 この文字列は、セミコロンで区切られた=のリストです。 有効日範囲操作の実行に使用されます。 受け入れられるパラメータは、RangeMode、RangeSpan、RangeStartDate、RangeEndDate、RangeStartSequenceおよびRangeEndSequenceです。 パラメータ値は常に文字列です。 RangeModeに指定できる値は、SET_LOGICAL_START、SET_LOGICAL_END、END_DATE、SET_EFFECTIVE_START、SET_EFFECTIVE_END、REPLACE_CORRECTION、REPLACE_UPDATE、RECONCILE_CORRECTION、CORRECTION、RECONCILE_UPDATE、UPDATE、ZAPおよびDELETE_CHANGESです。 RangeSpanに指定できる値は、PHYSICAL_ROW_END_DATEおよびLOGICAL_ROW_END_DATEです。 RangeStartDateおよびRangeEndDateの値は、yyyy-MM-dd形式の日付の文字列表現である必要があります。 RangeStartSequenceおよびRangeEndSequenceの値は、解析時に正の整数が生成されるように文字列である必要があります。
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : campaignMembers-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
    ログイン・ユーザーがキャンペーン・メンバーを更新できるかどうかを示します。
リンク
CampaignStatusVA
パラメータ:
  • ファインダ: LookupTypeFinder%3BBindLookupType%3DORA_MKT_CAMPAIGN_STATUS
LOVリンク関連では、次のプロパティが定義されます:
  • ソース属性: CampaignStatus;ターゲット属性: LookupCode
  • 表示属性: 意味
CampaignTypeVA
パラメータ:
  • ファインダ: LookupTypeFinder%3BBindLookupType%3DORA_MKT_CAMPAIGN_TYPE
LOVリンク関連では、次のプロパティが定義されます:
  • ソース属性: CampaignType;ターゲット属性: LookupCode
  • 表示属性: 意味
CreatedByModuleVA
パラメータ:
  • ファインダ: LookupTypeFinder%3BBindLookupType%3DORA_MKT_CAMP_CREATED_BY_MOD
LOVリンク関連では、次のプロパティが定義されます:
  • ソース属性: CreatedByModule;ターゲット属性: LookupCode
  • 表示属性: 意味
CurrencyCodeVA
LOVリンク関連では、次のプロパティが定義されます:
  • ソース属性: CurrencyCode;ターゲット属性: CurrencyCode
  • 表示属性: 名前
MemberStatusVA
パラメータ:
  • ファインダ: LookupTypeFinder%3BBindLookupType%3DORA_MKT_CAMPMEMBER_STATUS
LOVリンク関連では、次のプロパティが定義されます:
  • ソース属性: MemberStatus;ターゲット属性: LookupCode
  • 表示属性: 意味
トップに戻る

例:

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

cURLコマンド

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

レスポンス本文の例

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

{
    "CampaignId": 300100182332573,
    "CampaignMemberId": 300100182466478,
    "CampaignMemberNumber": "CDRM_1",
    "ContactId": 300100182222633,
    "CreatedBy": "SALES_ADMIN",
    "CreatedByModule": "ORA_WS",
    "CreationDate": "2019-09-06T08:07:42+00:00",
    "CurrencyCode": "USD",
    "EmailAddress": null,
    "LastUpdateDate": "2019-09-06T08:07:43.534+00:00",
    "LastUpdateLogin": "915B97A3570215E0E053A15AF00AEA7B",
    "LastUpdatedBy": "SALES_ADMIN",
    "LeadId": 300100182222714,
    "MemberStatus": "ORA_RESPONDED",
    "SourceSystemCampMemberId": null,
    "ContactPartyName": "BIQA_ELQ_SA_CONTACT1 LAST_NAME1",
    "CampaignCampaignName": "BIQA_ELQ_CAMPAIGN1",
    "CampaignCampaignNumber": "CDRM_1",
    "LeadLeadName": "BIQA_ELQ_SA_LEAD1",
    "UpdateFlag": true,
    "DeleteFlag": true,
    "MemberStatusLookupMeaning": "Responded",
    "MemberResponseDate": "2019-09-06T00:00:00+00:00",
    "ContactPartyNumber": "CDRM_880751",
    "LeadLeadNumber": "CDRM_81800",
    "LeadAccountName": null,
    "LeadOwnerName": "Gabrielle   Lee",
    "LeadEmail": null,
    "ContactEmail": null,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/campaignMembers/CDRM_1",
            "name": "campaignMembers",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/campaignMembers/CDRM_1",
            "name": "campaignMembers",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/campaignMembers/CDRM_1/lov/CurrencyCodeVA",
            "name": "CurrencyCodeVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/campaignMembers/CDRM_1/lov/MemberStatusVA",
            "name": "MemberStatusVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/campaignMembers/CDRM_1/lov/CreatedByModuleVA",
            "name": "CreatedByModuleVA",
            "kind": "collection"
        }
    ]
}
「トップに戻る」