スケジュールAPI

スケジュールREST APIを実装して、タグを発火するための指示を指定できます。スケジュールにより、コンテナからサードパーティ・タグが発火される場所、時間および対象が指定されます。スケジュールを作成するには、以前に作成したタグ、コンテナおよびターゲットを選択した後、タグの最大ロード時間、優先度およびその他のサービス品質の制御を構成する必要があります。

ノート: ユーザーがOracle Data CloudプラットフォームUIでキャンペーンを作成することはなくなりました。キャンペーン・ワークフローは、オーディエンス・ワークフローの一部になりました。ただし、プラットフォームでは引き続きキャンペーンを使用して、オーディエンス・データ配信を管理できます。キャンペーンは、UIユーザーがオーディエンスを配信する際に自動的に作成されます。APIでは、以前と同様にキャンペーンを作成して使用します。

このトピックの内容  

APIについて知る

次の埋込みI/Oドキュメントを参照して、APIについての理解を深めることができます。I/Oドキュメントでは、各メソッドのパラメータについて説明し、コールのテンプレートを提供しています。ただし、ツールからライブAPIコールを実行することはできません。

次のリンクを新しいタブで開くと、I/Oドキュメントが3つのペインの形式で表示されます。

https://schedules7.docs.apiary.io

このAPIの詳細は、My Oracle Support (MOS)にお問い合せください。

サービスURI

スケジュールAPIのURIは、次のとおりです。

services.bluekai.com/rest/schedules

スキーマ

スケジュールAPIスキーマのURIは、次のとおりです。

services.bluekai.com/rest/schedules.schema

{
  "$schema" : "https://json-schema.org/draft-04/schema#",
  "id" : "#schedule",
  "type" : "object",
  "title" : "Schedule schema",
  "description" : "This schema describes inner structure of a schedule resource"                    ,
  "additionalProperties" : false,
  "properties" : {
    "id" : {
      "type" : "integer",
      "description" : "Reference ID within a resource collection",
      "minimum" : 1,
      "o:sortable" : true,
      "o:queryable" : true
    },
    "name" : {
      "type" : "string",
      "description" : "Name of the Resource",
      "minLength" : 1,
      "o:sortable" : true
    },
    "partner" : {
      "type" : "object",
      "description" : "This schema describes inner structure of a stub resource with id and name",
      "additionalProperties" : false,
      "properties" : {
        "id" : {
          "type" : "integer",
          "description" : "ID of the associated partner"
        },
        "name" : {
          "type" : "string",
          "description" : "Name of the Resource",
          "minLength" : 1
        }
      },
      "required" : [ "id" ]
    },
    "status" : {
      "enum" : [ "active", "deleted", "disabled", "creating", "updating" ],
      "description" : "Describes status of current resource",
      "default" : "active",
      "o:queryable" : true,
      "o:sortable" : true
    },
    "targetUser" : {
      "$ref" : "#stub"
    },
    "targetSite" : {
      "$ref" : "#stub"
    },
    "targetPhints" : {
      "type" : "array",
      "items" : {
        "type" : "object",
        "description" : "This schema describes inner structure of a phint resource of a schedule target",
        "additionalProperties" : false,
        "properties" : {
          "id" : {
            "type" : "integer",
            "description" : "Reference ID of the resource"
          },
          "key" : {
            "type" : "string",
            "description" : "phint key for targeting"
          },
          "operator" : {
            "type" : "string",
            "description" : "phint operator for targeting"
          },
          "value" : {
            "type" : "string",
            "description" : "phint value for targeting"
          }
        },
        "required" : [ "key", "operator", "value" ]
      }
    },
    "tags" : {
      "type" : "array",
      "items" : {
        "$ref" : "#stub"
      },
      "minItems" : 1
    },
    "sites" : {
      "type" : "array",
      "items" : {
        "$ref" : "#stub"
      }
    },
    "priority" : {
      "type" : "integer",
      "default" : 100,
      "description" : "Priority of the schedule resource",
      "o:sortable" : true
    },
    "createdAt" : {
      "type" : "string",
      "format" : "date-time",
      "description" : "Schedule created date and time in the format yyyy-MM-ddTHH:mm:ssZ",
      "minLength" : 20,
      "maxLength" : 29,
      "o:sortable" : true,
      "o:queryable" : true
    },
    "updatedAt" : {
      "type" : "string",
      "format" : "date-time",
      "description" : "Schedule updated date and time in the format yyyy-MM-ddTHH:mm:ssZ",
      "minLength" : 20,
      "maxLength" : 29,
      "o:sortable" : true,
      "o:queryable" : true
    },
    "startDate" : {
      "type" : "string",
      "format" : "date-time",
      "description" : "Schedule start date in the format yyyy-MM-ddTHH:mm:ssZ",
      "minLength" : 20,
      "maxLength" : 29,
      "o:sortable" : true,
      "o:queryable" : true
    },
    "endDate" : {
      "type" : "string",
      "format" : "date-time",
      "description" : "Schedule end date in the format yyyy-MM-ddTHH:mm:ssZ",
      "minLength" : 20,
      "maxLength" : 29,
      "o:sortable" : true,
      "o:queryable" : true
    },
    "maxLoadTime" : {
      "type" : "integer",
      "description" : "Max load time of schedule in milliseconds"
    },
    "periodDays" : {
      "type" : "integer",
      "description" : "Number of days while specifying frequency"
    },
    "frequency" : {
      "type" : "integer",
      "description" : "Frequency of the schedule per periodDays"
    },
    "insideIframe" : {
      "type" : "boolean",
      "default" : true,
      "description" : "Flag denoting if inside iframe or not"
    },
    "isAlwaysOn" : {
      "type" : "boolean",
      "default" : true,
      "description" : "Flag denoting if it's always on or not"
    },
    "maxAvgTagExecTime" : {
      "type" : "integer",
      "default" : 5000,
      "description" : "Maximum average tag execution time in milliseconds"
    },
    "labels" : {
      "type" : "array",
      "uniqueItems" : true,
      "items" : {
        "type" : "string"
      }
    },
    "adminState" : {
      "type" : "string"
    },
    "note" : {
      "type" : "string"
    },
    "hidden" : {
      "type" : "boolean",
      "default" : false,
      "o:queryable" : true,
      "description" : "Flag denoting if schedule is system generated or not"
    }
  },
  "required" : [ "name", "startDate", "tags" ],
  "links" : [ {
    "rel" : "search",
    "href" : "#",
    "schema" : {
      "type" : "object",
      "properties" : {
        "q" : {
          "type" : "string",
          "format" : "scim"
        },
        "since" : {
          "type" : "string",
          "format" : "date-time",
          "description" : "Query parameter to return resources created after this date in the format yyyy-MM-ddTHH:mm:ssZ"
        },
        "until" : {
          "type" : "string",
          "format" : "date-time",
          "description" : "Query parameter to return resources created before this date in the format yyyy-MM-ddTHH:mm:ssZ"
        },
        "nameOrId" : {
          "type" : "string",
          "description" : "Filter by Name or ID of the resource"
        },
        "label" : {
          "type" : "string",
          "description" : "Filter by label of the resource"
        }
      }
    }
  } ]
}

プロパティ

スケジュールのレスポンスには、返される各スケジュールについての次の情報が含まれます。

プロパティ タイプ 説明
createdAt 日付 キャンペーンが作成された時間を示す、ISO 8601の日時書式(yyyy-MM-dd'T'HH:mm:ssZ)のタイムスタンプ。例: 2016-06-18T17:46:32-05:00
このパラメータでの問合せおよびソートが可能です。
endDate 日付 スケジュールの実行が停止した時間を示す、ISO 8601の日時書式(yyyy-MM-dd'T'HH:mm:ssZ)のタイムスタンプ。例: 2016-08-18T17:00:00-05:00
このパラメータでの問合せおよびソートが可能です。
frequency 整数 periodDaysごとに、各ユーザーに対してタグを発火できるスケジュールの頻度。たとえば、1のfrequencyと30のperiodDaysを指定すると、サードパーティ・タグは、30日の期間内にユーザーごとに1回発火されます。
id 整数 タグ・スケジュールのユニークID。このパラメータでのソートおよび問合せが可能です。
insideIframe ブール セキュリティ強化のためにタグがiframeで発火されるようにスケジュールされている(デフォルトはtrue)か、されていない(false)かを示します。 falseの値は、特殊なコンテナ・タグを必要とするファーストパーティ・ページにタグを直接配置できることを示します。
isAlwaysOn ブール スケジュールが常にオン(true)かどうかを示します。isAlwaysOnがtrue (デフォルト)に設定されている場合、frequencyとperiodDaysは無視され、ターゲッティング条件が満たされているかぎり、スケジュールのタグが発火されます。
labels 配列 スケジュールのラベルとして使用されるカンマ区切り文字列のリスト
maxAvgTagExecTime 整数 スケジュールされたタグがレンダリングされるか、タグがシャットダウンされるかの基準となる、最大平均タグ実行時間(ミリ秒)。デフォルト値は5000 (5秒)です。maxAvgTagExecTimeがタグのレイテンシ設定と異なる場合、より制限の厳しい設定が適用されます。たとえば、タグのレイテンシ設定で1000のグローバル最大タグ実行時間が使用されて、maxAvgTagExecTimeが900に設定される場合、900が使用されます。
maxLoadTime 整数 スケジュールされたタグがレンダリングされるか、タグがシャットダウンされるかの基準となる、最大ロード時間(ミリ秒)。maxLoadTimeの値がタグのレイテンシ設定と異なる場合、より制限の厳しい設定が適用されます。たとえば、タグのレイテンシ設定で5000の最大ロード時間が使用されて、maxLoadTimeが6000に設定される場合、5000が使用されます。
name 文字列 タグ・スケジュールの名前。この必須パラメータでソートできます。
note 文字列 スケジュールに対して入力された任意のノート
partner オブジェクト タグに関連付けられているパートナを記述するオブジェクト
periodDays 整数 指定されたfrequencyに使用される日数。たとえば、frequencyが1に設定され、periodDaysが30に設定された場合、サードパーティ・タグは、30日の期間内にユーザーごとに1回発火されます。
priority 整数 発火されるコンテナが複数ある場合に、発火の順序を決定するために使用されるタグ・スケジュールの相対的優先度。値が小さいほど、優先度は高くなります。デフォルト値は100です。
このフィールドでソートできます。
sites 配列 タグが発火されるサイトの名前とIDのリスト 
startDate 日付 スケジュールがアクティブ化された時間を示す、ISO 8601の日時書式(yyyy-MM-dd'T'HH:mm:ssZ)のタイムスタンプ。例: 2016-06-18T17:00:00-05:00
この必須パラメータでの問合せおよびソートが可能です。
status 文字列 スケジュールが次のいずれに該当するかを示します。
  • active (デフォルト): スケジュールに基づいてタグを発火できます。
  • creating: スケジュールは、作成処理中です。
  • disabled: スケジュールは保留中で、スケジュールが有効になるまでタグは発火しません。
  • updating: スケジュールは、更新処理中です。
このパラメータでの問合せおよびソートが可能です。
tags 配列 スケジュールによって発火されるタグの名前とIDのリスト
targetPhints 配列

条件付きでタグを発火するために使用されるphintオブジェクトの配列。指定されている場合、各オブジェクトには次のものが含まれます。

  • key
  • value
  • operator: 条件付き演算子。デフォルト値はeq (等しい)です
  • id (オプション): phintのユニークID
phintターゲッティングの詳細は、ターゲットの作成および管理を参照してください。
targetSite オブジェクト スケジュールに関連付けられているサイト・ターゲットについて記述するオブジェクト
サイト・ターゲットの詳細は、ターゲットの作成および管理を参照してください。
targetUser オブジェクト スケジュールに関連付けられているユーザー・ターゲットについて記述するオブジェクト
ユーザー・ターゲットの詳細は、ターゲットの作成および管理を参照してください。
updatedAt 日付 スケジュールが更新された時間を示す、ISO 8601の日時書式(yyyy-MM-dd'T'HH:mm:ssZ)のタイムスタンプ。例: 2016-06-18T17:46:32-05:00
このパラメータでの問合せおよびソートが可能です。

スケジュールのリスト

複数のスケジュールを表示するには、GET https://services.bluekai.com/rest/schedulesをコールします

サンプルGETリクエスト: https://services.bluekai.com/rest/schedules?size=5&offset=0

{
  "items" : [ {
    "id" : 1,
    "name" : "Company1 US",
    "partner" : {
      "id" : 12,
      "name" : "Company1"
    },
    "status" : "active",
    "targetPhints" : [ ],
    "tags" : [ {
      "id" : 3009,
      "name" : "MediaTargeting Company Global Sync Pixel"
    }, {
      "id" : 3020,
      "name" : "Company1 - US - Retargeting"
    } ],
    "sites" : [ {
      "id" : 17001,
      "name" : "Company1 - US Priority"
    }, {
      "id" : 17002,
      "name" : "Company1 - US Priority_mobile"
    }, {
      "id" : 24212,
      "name" : "Company1 US - mWeb"
    }, {
      "id" : 50,
      "name" : "Company1 - US"
    } ],
    "priority" : 100,
    "createdAt" : "2016-01-28T14:47:52+00:00",
    "updatedAt" : "2016-06-11T20:44:04+00:00",
    "maxLoadTime" : 2000,
    "periodDays" : 30,
    "frequency" : 1,
    "insideIframe" : true,
    "maxAvgTagExecTime" : 1000,
    "labels" : [ ]
  }, {
    "id" : 2,
    "name" : "Company1 US Motors",
    "partner" : {
      "id" : 12,
      "name" : "Company1"
    },
    "status" : "disabled",
    "targetPhints" : [ ],
    "tags" : [ ],
    "sites" : [ {
      "id" : 2202,
      "name" : "Company1 test 1"
    }, {
      "id" : 20,
      "name" : "Company1 Motors"
    }, {
      "id" : 10371,
      "name" : "Company1 Motors_mobile"
    }, {
      "id" : 10402,
      "name" : "Company1 test 1_mobile"
    } ],
    "priority" : 1,
    "createdAt" : "2016-01-28T14:49:00+00:00",
    "updatedAt" : "2016-10-21T15:39:29+00:00",
    "maxLoadTime" : 1000,
    "periodDays" : 30,
    "frequency" : 1,
    "insideIframe" : true,
    "maxAvgTagExecTime" : 2000,
    "labels" : [ ]
  }, {
    "id" : 3,
    "name" : "Company1 CA",
    "partner" : {
      "id" : 12,
      "name" : "Company1"
    },
    "status" : "active",
    "targetPhints" : [ ],
    "tags" : [ {
      "id" : 2825,
      "name" : "Company2 - CA"
    }, {
      "id" : 5552,
      "name" : "Company2 - CA (eCommerce)"
    }, null, {
      "id" : 3009,
      "name" : "MediaTargeting Company Global Sync Pixel"
    }, {
      "id" : 4137,
      "name" : "CA - Company3 - All"
    }, {
      "id" : 4138,
      "name" : "CA - Company4 - All"
    } ],
    "sites" : [ {
      "id" : 725,
      "name" : "Company1 - CA"
    }, {
      "id" : 10386,
      "name" : "Company1 - CA_mobile"
    } ],
    "priority" : 1,
    "createdAt" : "2016-01-28T14:49:59+00:00",
    "updatedAt" : "2016-11-11T18:26:05+00:00",
    "maxLoadTime" : 1000,
    "periodDays" : 30,
    "frequency" : 1,
    "insideIframe" : true,
    "maxAvgTagExecTime" : 2000,
    "labels" : [ ]
  }, {
    "id" : 4,
    "name" : "Company1 CA Motors",
    "partner" : {
      "id" : 12,
      "name" : "Company1"
    },
    "status" : "disabled",
    "targetPhints" : [ ],
    "tags" : [ ],
    "sites" : [ {
      "id" : 922,
      "name" : "Company1 - CA Motors"
    }, {
      "id" : 10390,
      "name" : "Company1 - CA Motors_mobile"
    } ],
    "priority" : 1,
    "createdAt" : "2016-01-28T14:50:42+00:00",
    "updatedAt" : "2016-10-21T15:38:47+00:00",
    "maxLoadTime" : 1000,
    "periodDays" : 30,
    "frequency" : 1,
    "insideIframe" : true,
    "maxAvgTagExecTime" : 2000,
    "labels" : [ ]
  }, {
    "id" : 5,
    "name" : "Company1  UK",
    "partner" : {
      "id" : 12,
      "name" : "Company1"
    },
    "status" : "active",
    "targetPhints" : [ ],
    "tags" : [ null, null, {
      "id" : 3009,
      "name" : "MediaTargeting Company Global Sync Pixel"
    } ],
    "sites" : [ {
      "id" : 723,
      "name" : "Company1 - UK"
    }, {
      "id" : 10384,
      "name" : "Company1 - UK_mobile"
    } ],
    "priority" : 1,
    "createdAt" : "2016-01-28T14:51:14+00:00",
    "updatedAt" : "2016-02-25T07:48:46+00:00",
    "maxLoadTime" : 1000,
    "periodDays" : 30,
    "frequency" : 1,
    "insideIframe" : true,
    "maxAvgTagExecTime" : 1000,
    "labels" : [ ]
  } ],
  "totalResults" : 3373,
  "limit" : 5,
  "offset" : 0,
  "count" : 5,
  "hasMore" : true
}

スケジュールのGET

スケジュールのIDを所有している場合は、GET https://services.bluekai.com/rest/schedules/<id>をコールすることによって、その情報をリクエストできます

{
  "id" : 1,
  "name" : "Company1 US",
  "partner" : {
    "id" : 12,
    "name" : "Company1"
  },
  "status" : "active",
  "targetPhints" : [],
  "tags" : [ {
    "id" : 3009,
    "name" : "MediaTargeting Company Global Sync Pixel"
  }, {
    "id" : 3020,
    "name" : "Company2 - US - Retargeting"
  } ],
  "sites" : [ {
    "id" : 17001,
    "name" : "Company1 - US Priority"
  }, {
    "id" : 17002,
    "name" : "Company1 - US Priority_mobile"
  }, {
    "id" : 24212,
    "name" : "Company1 US - mWeb"
  }, {
    "id" : 50,
    "name" : "Company1 - US"
  } ],
  "priority" : 100,
  "createdAt" : "2016-01-28T14:47:52+00:00",
  "updatedAt" : "2016-06-11T20:44:04+00:00",
  "maxLoadTime" : 2000,
  "periodDays" : 30,
  "frequency" : 1,
  "insideIframe" : true,
  "maxAvgTagExecTime" : 1000,
  "labels" : [ ]
}

スケジュールの作成

タグ・スケジュールを作成するには、POST https://services.bluekai.com/rest/schedulesをコールして、リクエスト本文でその必須プロパティを指定します。

{
  "status": "active",
  "periodDays": 30,
  "endDate": "2016-08-01T00:00:00-00:00",
  "tags": [
    {
      "id": 1575
    }
  ],
  "labels": [
    "label1",
    "label2"
  ],
  "frequency": 5,
  "insideIframe": true,
  "targetPhints": [
    {
      "operator": "eq",
      "key": "make",
      "value": "Chevy"
    }
  ],
  "name": "test-123456789",
  "maxLoadTime": 5000,
  "targetUser": {
    "id": 24
  },
  "sites": [
    {
      "id": 2206
    }
  ],
  "priority": 1,
  "maxAvgTagExecTime": 500,
  "startDate": "2016-06-12T00:00:00-00:00"
}
{
    "status": "active",
    "startDate": "2016-06-12T00:00:00+00:00",
    "endDate": "2016-07-01T00:00:00+00:00",
    "targetPhints": [
        {
            "operator": "eq",
            "value": "Chevy",
            "id": 883,
            "key": "make"
        }
    ],
    "maxLoadTime": 5000,
    "tags": [
        {
            "id": 1575,
            "name": "Sample tag"
        }
    ],
    "periodDays": 30,
    "labels": [
        "label1",
        "label2"
    ],
    "sites": [
        {
            "id": 2206,
            "name": "Buyer site"
        }
    ],
    "priority": 1,
    "frequency": 5,
    "updatedAt": "2016-05-29T00:42:57+00:00",
    "insideIframe": true,
    "partner": {
        "id": 486,
        "name": "Buyer"
    },
    "maxAvgTagExecTime": 500,
    "id": 3840,
    "createdAt": "2016-05-29T00:42:57+00:00",
    "name": "test-123456789"
}

スケジュールの更新

特定のスケジュールを更新するには、PUT https://services.bluekai.com/rest/schedules/<id>をコールして、リクエスト本文で更新対象のプロパティを指定します。

{
  "status": "active",
  "startDate": "2016-06-12T00:00:00+00:00",
  "endDate": "2016-07-01T00:00:00+00:00",
  "targetPhints": [
    {
      "operator": "eq",
      "value": "Chevy",
      "id": 883,
      "key": "Make"
    }
  ],
  "maxLoadTime": 5000,
  "tags": [
    {
      "id": 1575,
      "name": "Sample tag"
    }
  ],
  "targetUser": {
    "id": 24,
    "name": "Target ABCD"
  },
  "periodDays": 30,
  "labels": [
    "label3"
  ],
  "targetSite": {
    "id": 96
  },
  "sites": [
    {
      "id": 2206,
      "name": "Buyer site"
    }
  ],
  "priority": 1,
  "frequency": 5,
  "updatedAt": "2016-06-29T00:42:57+00:00",
  "insideIframe": true,
  "partner": {
    "id": 486,
    "name": "Buyer"
  },
  "maxAvgTagExecTime": 500,
  "id": 3840,
  "createdAt": "2016-06-29T00:42:57+00:00",
  "name": "test-123456789"
}
{
    "status": "active",
    "startDate": "2016-06-12T00:00:00+00:00",
    "endDate": "2016-07-01T00:00:00+00:00",
    "targetPhints": [
        {
            "operator": "eq",
            "value": "Chevy",
            "id": 883,
            "key": "Make"
        }
    ],
    "maxLoadTime": 5000,
    "tags": [
        {
            "id": 1575,
            "name": "Sample tag"
        }
    ],
    "targetUser": {
        "id": 24,
        "name": "Target ABCD"
    },
    "periodDays": 30,
    "labels": [
        "label3"
    ],
    "sites": [
        {
            "id": 2206,
            "name": "Buyer site"
        }
    ],
    "priority": 1,
    "frequency": 5,
    "updatedAt": "2016-06-29T00:42:59+00:00",
    "insideIframe": true,
    "partner": {
        "id": 486,
        "name": "Buyer"
    },
    "maxAvgTagExecTime": 500,
    "id": 3840,
    "createdAt": "2016-06-29T00:42:57+00:00",
    "name": "test-123456789"
}

一括更新

複数のスケジュールを更新するには、PUT https://services.bluekai.com/rest/schedulesをコールして、スケジュール・オブジェクトの配列を含むリクエスト本文を指定します。

[
    {
        "status": "active",
        "startDate": "2016-06-17T00:00:00+00:00",
        "endDate": "2016-07-01T00:00:00+00:00",
        "targetPhints": [
            {
                "operator": "eq",
                "key": "make",
                "id": 552,
                "value": "Chevy"
            }
        ],
        "maxLoadTime": 5000,
        "tags": [
            {
                "id": 1575,
                "name": "Sample tag"
            }
        ],
        "periodDays": 30,
        "labels": [
            "label1",
            "label2"
        ],
        "sites": [
            {
                "id": 2206,
                "name": "Buyer site"
            }
        ],
        "priority": 1,
        "frequency": 5,
        "updatedAt": "2016-06-15T06:20:50+00:00",
        "insideIframe": true,
        "partner": {
            "id": 486,
            "name": "Buyer"
        },
        "isAlwaysOn": true,
        "maxAvgTagExecTime": 500,
        "id": 2568,
        "createdAt": "2016-06-15T06:20:50+00:00",
        "name": "test-123456789-updated"
    },
    {
        "status": "active",
        "startDate": "2016-06-17T00:00:00+00:00",
        "endDate": "2016-07-01T00:00:00+00:00",
        "targetPhints": [
            {
                "operator": "eq",
                "key": "Make",
                "id": 552,
                "value": "Chevy"
            }
        ],
        "maxLoadTime": 5000,
        "tags": [
            {
                "id": 1575,
                "name": "Sample tag"
            }
        ],
        "periodDays": 30,
        "labels": [
            "label1",
            "label2"
        ],
        "sites": [
            {
                "id": 2206,
                "name": "Buyer site"
            }
        ],
        "priority": 1,
        "frequency": 5,
        "updatedAt": "2016-06-15T06:22:00+00:00",
        "insideIframe": true,
        "partner": {
            "id": 486,
            "name": "Buyer"
        },
        "isAlwaysOn": true,
        "maxAvgTagExecTime": 500,
        "id": 12345,
        "createdAt": "2016-06-15T06:20:50+00:00",
        "name": "test-987654321-updated"
    }
]
{
    "items": [
        {
            "item": {
                "status": "active",
                "startDate": "2016-06-15T00:00:00+00:00",
                "endDate": "2016-07-01T00:00:00+00:00",
                "targetPhints": [
                    {
                        "operator": "eq",
                        "value": "Chevy",
                        "id": 552,
                        "key": "Make"
                    }
                ],
                "maxLoadTime": 5000,
                "tags": [
                    {
                        "id": 1575,
                        "name": "Sample tag"
                    }
                ],
                "targetUser": {
                    "id": 24,
                    "name": "Target ABCD"
                },
                "periodDays": 30,
                "labels": [
                    "label1",
                    "label2"
                ],
                "sites": [
                    {
                        "id": 2206,
                        "name": "Buyer site"
                    }
                ],
                "priority": 1,
                "frequency": 5,
                "updatedAt": "2016-06-15T06:23:24+00:00",
                "insideIframe": true,
                "partner": {
                    "id": 486,
                    "name": "Buyer"
                },
                "isAlwaysOn": true,
                "maxAvgTagExecTime": 500,
                "id": 2568,
                "createdAt": "2016-06-15T06:20:50+00:00",
                "name": "test-123456789"
            },
            "httpStatusCode": 200
        },
        {
            "item": {
                "status": 404,
                "o:errorCode": "BK-38001",
                "title": "Schedule was not found",
                "detail": "Schedule with ID '12345' was not found",
                "instance": "https://services.bluekai.com/rest/schedules",
                "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5"
            },
            "httpStatusCode": 404
        }
    ],
    "size": 2
}

レスポンスのエラー

エラー・メッセージの最新のリストについては、https://services.bluekai.com/rest/schedules.errors?bkuid=bkUserID&bksig=SignedStringをコールしてください

キャンペーン・リクエストに問題がある場合、レスポンスでは次のいずれかのエラー・メッセージが使用されます。

コード エラー・メッセージ
BK-10001 Could not find resource for the specified path
BK-10002 Bad query parameters
BK-10003 Invalid JSON input
BK-10004 Input JSON does not pass schema validation
BK-10005 Input JSON contains bad property
BK-10006 Input JSON has missing properties
BK-10007 Input JSON has bad property that does not match min length requirement
BK-10008 Input JSON has bad property that does not match max length requirement
BK-10009 Not enough privileges to access requested resource
BK-10010 The request could not be completed by the service due to malformed data or syntax
BK-10011 Incorrect sorting parameter
BK-10012 Additional properties detected.Schema does not allow extra properties to be present
BK-10013 Incorrect expand parameter
BK-10014 Incorrect q query parameter syntax
BK-10015 Property has unacceptable/bad format
BK-10016 Property value does not appear on the list of acceptable values
BK-10017 Array must not contain duplicate entries
BK-38001 Schedule was not found
BK-38002 Schedule status is invalid
BK-38003 Tag was not found
BK-38004 Site was not found
BK-38005 Target was not found

関連するAPIコール

次に、通常、スケジュールAPIを使用する前に実行するAPIコールを示します。

スケジュールAPIの前 ユースケース
コンテナAPI Oracle Data Cloudプラットフォームでサイトを作成および管理します。コンテナでは、デスクトップおよびモバイル・サイトのサードパーティ・タグを管理し、DMPにプッシュされるユーザー・データを収集します。

さらに学ぶ

日付書式

タグのスケジュール