ドキュメントCampaignCampaign v8 ドキュメント

追加操作 additional-operations

Last update: Mon Apr 06 2026 00:00:00 GMT+0000 (Coordinated Universal Time)
  • 適用対象：
  • Campaign v8 Client Console

作成対象：

  • 経験者
  • 開発者

並べ替え sorting

並べ替えは、デフォルトで昇順で使用できます。 降順で並べ替えるには、%20desc​を​_order パラメーターの値に追加します。

フィールドを並べ替えることができるかどうかを確認するには、「sortable」パラメーターをリソースメタデータに確認します。 詳しくは、この節を参照してください。

リクエストのサンプル

  • データベース内の電子メールをアルファベット順に取得するためのGET リクエストのサンプル。

    code language-none 
    -X GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/profile/email?_order=email \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Cache-Control: no-cache' \
-H 'X-Api-Key: <API_KEY>'

    リクエストへの応答。

    code language-none 
    {
"content": [
    "adam@email.com",
    "allison.durance@example.com",
    "amy.dakota@mail.com",
    "andrea.johnson@mail.com",
    ...
]
...
}

  • GET リクエストをサンプルして、データベース内のメールを降順アルファ順で取得します。

    code language-none 
    -X GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/profile/email?_order=email%20desc \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Cache-Control: no-cache' \
-H 'X-Api-Key: <API_KEY>'

    リクエストへの応答。

    code language-none 
    {
"content": [
    "tombinder@example.com",
    "tombinder@example.com",
    "timross@example.com",
    "john.smith@example.com",
    ...
]
}

フィルタリング filtering

フィルターのメタデータの取得

各リソースにフィルターを使用できます。 リソースに関連付けられているフィルターを特定するには、リソースメタデータに対してGET リクエストを実行する必要があります。 このリクエストは、特定のリソースに対してすべてのフィルターが定義されているURLを返します。 メタデータについて詳しくは、この節を参照してください。

フィルターのメタデータを特定し、その使用方法を決定するには、以前に返されたURLに対してGET リクエストを実行する必要があります。

サンプルリクエスト

以下のペイロードのサンプルは、「profile」リソースの「byText」フィルターメタデータを取得する方法を示しています。 最初に、「profile」リソースメタデータに対してGET リクエストを実行します。

-X GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/resourceType/profile \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Cache-Control: no-cache' \
-H 'X-Api-Key: <API_KEY>'

フィルターが記述されているURLを返します。

{
"filters": {
        "href": "https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/resourceType/<PKEY>/filters/"
    }
  }

URLに対してGET リクエストを実行します。 プロファイルリソースのフィルターのリストと、各フィルターに関連付けられたメタデータを返します。

{
"birthday": {
        "PKey": "@FL-CbDFXbnHbXcVpeCGWL46VXJLn1LqxLMPagt2vz8sCxQ52lvB15KiUaxXkxJYQw-tZXYrgUWG6K8QcB4gxVY9RKoba5bRFY3294YFshDmorRr8",
        "category": "0150_profile",
        "condition": ...,
        "data": "https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/profile/birthday?type=$value&precision=$value&operator=$value&day=$value&month=$value&includeStart=$value&endDay=$value&endMonth=$value&includeEnd=$value&relativeValue=$value&nextUnitsValue=$value&previousUnitsValue=$value",
        "formType": "webPage",
        "fragmentName": "",
        "label": "Birthday",
}

フィルターのメタデータ構造

各フィルターで同じメタデータ構造を使用できます。

  • @formType​および​@webPage フィールドは技術フィールドです。
  • data フィールドには、フィルターの使用方法に関するサンプルが表示されます。
  • メタデータ ノードは、フィルターパラメーターを記述します。
  • 条件 ノードは、フィルターが何を行うかを記述します。 メタデータノードで説明されているフィルターパラメーターを使用して、フィルター条件を作成します。 各フィルター条件について、enabledIf​がtrueの場合、expr​が適用されます。

フィルターのメタデータ構造のサンプル：

"byText": {
        "PKey": "...",
        "category": "99_none",
        "condition": ...,
        "data": "/profileAndServices/profile/byText?text=$value",
        "formType": "none",
        "fragmentName": "",
        "label": "By name or email",
    }

フィルターの使用

フィルタリングは、次のリクエストで実行されます。

GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/<resourceName>/by<filterName>?<filterParam>=<filterValue>

1つのリクエストで複数のフィルターを組み合わせることができます。

GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/<resourceName>/<filter1name>/<filter2name>?<filter1param>=<filter1value>&<filter2param>=<filter2value>

リクエストのサンプル

  • GET リクエストをサンプルして、「email」タイプの「service」リソースを取得します。

    code language-none 
    -X GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/service/byChannel?channel=email \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Cache-Control: no-cache' \
-H 'X-Api-Key: <API_KEY>'

    リクエストへの応答。

    code language-none 
    {
    "content": [
        {
            "PKey": "<PKEY>",
            "created": "2019-09-25 23:20:35.000Z",
            "href": "https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/service/@I_FIiDush4OQPc0mbOVR9USoh36Tt5CsD35lATvQjdWlXrYc0lFkvle2XIwZUbD8GqTVvSp8AfWFUvjkGMe1fPe5nok",
            "label": "Marketing Newsletter",
            "lastModified": "2019-09-25 23:20:35.000Z",
            "limitedDuration": false,
            "messageType": "email",
            "mode": "newsletter",
            ...
        },
        ...
    ],
    ...
}

  • で「Doe」を含む「profile」リソースを取得するためのGET リクエストのサンプル
    電子メールまたは姓のフィールド（byText フィルターは、電子メールと姓の両方のフィールドを検索します）。

    code language-none 
    -X GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/profile/byText?text=Doe \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Cache-Control: no-cache' \
-H 'X-Api-Key: <API_KEY>'

    リクエストへの応答。

    code language-none 
    {
    "content": [
        {
            "PKey": "<PKEY>",
            "firstName": "John",
            "lastName":"Doe",
            "birthDate": "1980-10-24",
            ...
        }
        ...
    ],
    ...
}

  • GET リクエストをサンプルして、「email」と「sport」というラベルが付いたサービスリソースを取得します。

    code language-none 
    -X GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/service/byChannel/byText?channel=email&text=sport \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Cache-Control: no-cache' \
-H 'X-Api-Key: <API_KEY>'

    リクエストへの応答。

    code language-none 
    {
    "content": [
        {
            "PKey": "<PKEY>",
            "created": "2019-09-26 09:36:01.014Z",
            "href": "https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/service/<PKEY>",
            "label": "sport",
            "lastModified": "2019-09-26 09:36:01.014Z",
            "limitedDuration": false,
            "messageType": "email",
            "mode": "newsletter",
            "name": "SVC13",
            ...
        }
    ],
    ...
}

カスタムフィルター

カスタムフィルターを使用する場合は、Adobe Campaign Standard インターフェイスでカスタムフィルターを作成してカスタマイズする必要があります。 カスタムフィルターは、標準搭載のフィルターと同じ動作になります。

GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServicesExt/<resourceName>/by<customFilterName>?<customFilterparam>=<customFilterValue>

詳しくは、Campaign Standardのドキュメントを参照してください。

サンプルリクエスト

トランザクション金額が100$以上の「profile」リソースを取得するためのGET リクエストのサンプル。 「byAmount」フィルターは、最初にAdobe Campaign Standard インターフェイスで定義され、「Transaction」カスタムテーブルにリンクされています。

-X GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServicesExt/profile/byAmount?amount_parameter=100 \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Cache-Control: no-cache' \
-H 'X-Api-Key: <API_KEY>'

カウント counting

Adobe Campaign REST APIは、リクエスト内のレコード数をカウントできます。 これを行うには、count ノードで返されるURLを使用します。

サンプルリクエスト

messageType​値が「sms」に等しいすべてのサービスをカウントするには、byChannel フィルターを使用してGET リクエストを実行します。

-X GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/service/byChannel?channel=sms \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Cache-Control: no-cache' \
-H 'X-Api-Key: <API_KEY>'

フィルターに対応するサービスが返されます。

{
    "content": [
        {
            ...
            "messageType": "sms",
            "mode": "newsletter",
            "name": "SVC6",
            ...
        },
        ...
    ],
    "count": {
        "href": "https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/service/byChannel/_count?channel=sms&_lineStart=@iKTZ2q3IiSEDqZ5Nw1vdoGnQCqF-8DAUJRaVwR9obqqTxhMy"
    },
    "serverSidePagination": true
}

count ノードのURLに対してGET リクエストを実行し、結果の数を取得します。

-X GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/service/byChannel/_count?channel=sms&_lineStart=@iKTZ2q3IiSEDqZ5Nw1vdoGnQCqF-8DAUJRaVwR9obqqTxhMy \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Cache-Control: no-cache' \
-H 'X-Api-Key: <API_KEY>'

レコード数を返します。

{
    "count": 26
}

ページネーション pagination

デフォルトでは、25個のリソースがリストに読み込まれます。

_lineCount パラメーターを使用すると、応答にリストされるリソースの数を制限できます。 次に、next ノードを使用して、次の結果を表示できます。

NOTE
ページネーション要求を実行するには、常に​next ノードで返されるURL値を使用してください。
_lineStart リクエストは計算され、next ノードで返されるURL内で常に使用する必要があります。

サンプルリクエスト

プロファイルリソースの1つのレコードを表示するためのGET リクエストのサンプル。

-X GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/profile?_lineCount=1 \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Cache-Control: no-cache' \
-H 'X-Api-Key: <API_KEY>'

リクエストに応答し、next ノードを使用してページネーションを実行します。

{
    "content": [
        {
            "PKey": "<PKEY>",
            "firstName": "John",
            "lastName":"Doe",
            "birthDate": "1980-10-24",
            ...
        }
    ],
    "next": {
        "href": "https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/profile/email?_lineCount=10&_
        lineStart=@Qy2MRJCS67PFf8soTf4BzF7BXsq1Gbkp_e5lLj1TbE7HJKqc"
    }
    ...
}

デフォルトでは、大量のデータを含むテーブルを操作する場合、next ノードは使用できません。 ページネーションを実行するには、呼び出しURLに​_forcePagination=true パラメーターを追加する必要があります。

-X GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/profile?_forcePagination=true \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Cache-Control: no-cache' \
-H 'X-Api-Key: <API_KEY>'
NOTE
テーブルが大きいと見なされるレコードの数は、Campaign Standard XtkBigTableThreshold オプションで定義されています。 デフォルト値は100,000 レコードです。
recommendation-more-help
35662671-8e3d-4f04-a092-029a056c566b