排程端點

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

主題：

建立對象：

undefined

排程是一種工具，可用於每天自動執行一次批次分段工作。您可以使用/config/schedules端點來擷取排程清單、建立新排程、擷取特定排程的詳細資料、更新特定排程或刪除特定排程。

快速入門

本指南中使用的端點是Adobe Experience Platform Segmentation Service API的一部分。繼續之前，請檢閱快速入門手冊以取得您成功呼叫API所需瞭解的重要資訊，包括必要的標頭以及如何讀取範例API呼叫。

擷取排程清單 retrieve-list

您可以向/config/schedules端點發出GET要求，以擷取貴組織的所有排程清單。

API格式

/config/schedules端點支援數個查詢引數，以協助篩選結果。雖然這些引數是選用的，但強烈建議使用這些引數來協助減少昂貴的額外負荷。在不使用引數的情況下呼叫此端點將會擷取您的組織可用的所有排程。可以包含多個引數，以&符號(&)分隔。

GET /config/schedules
GET /config/schedules?start={START}
GET /config/schedules?limit={LIMIT}

參數

說明

{START}

指定位移將從哪一頁開始。預設情況下，此值將為0。

{LIMIT}

指定傳回的排程數目。預設值為100。

要求

下列請求將擷取您組織內張貼的最後10個排程。

curl -X GET https://platform.adobe.io/data/core/ups/config/schedules?limit=10 \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

回應

成功的回應會傳回HTTP狀態200，其中包含指定組織的排程清單，格式為JSON。

NOTE

下列回應已因空間而截斷，且只顯示傳回的第一個排程。

{
    "_page": {
        "totalCount": 10,
        "pageSize": 1
    },
    "children": [
        {
            "id": "4e538382-dbd8-449e-988a-4ac639ebe72b",
            "imsOrgId": "{ORG_ID}",
            "sandbox": {
                "sandboxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
                "sandboxName": "prod",
                "type": "production",
                "default": true
            },
            "name": "Batch Segmentation",
            "state": "active",
            "type": "batch_segmentation",
            "schedule": "0 0 1 * * ?",
            "properties": {
                "segments": []
            },
            "createEpoch": 1573158851,
            "updateEpoch": 1574365202
        }
    ],
    "_links": {
        "next": {}
    }
}

屬性

說明

_page.totalCount

傳回的排程總數。

_page.pageSize

排程的頁面大小。

children.name

字串形式的排程名稱。

children.type

字串形式的作業型別。兩種支援的型別為「batch_segmentation」和「export」。

children.properties

包含與排程相關之其他屬性的物件。

children.properties.segments

使用["*"]可確保包含所有區段。

children.schedule

包含工作排程的字串。工作只能排程在一天執行一次，這表示您不能將工作排程在24小時的期間內執行超過一次。如需cron排程的詳細資訊，請閱讀cron運算式格式的附錄。在此範例中，「0 0 1 * *」表示此排程每天凌晨1:00執行。

children.state

包含排程狀態的字串。兩種支援的狀態為「作用中」和「非作用中」。依預設，狀態會設為「非使用中」。

建立新排程 create

您可以對/config/schedules端點發出POST要求，以建立新的排程。

API格式

POST /config/schedules

要求

curl -X POST https://platform.adobe.io/data/core/ups/config/schedules \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'
 -d '
{
    "name":"profile-default",
    "type":"batch_segmentation",
    "properties":{
        "segments":[
            "*"
        ]
    },
    "schedule":"0 0 1 * * ?",
    "state":"inactive"
}'

屬性

說明

name

必要。 排程的名稱（字串）。

type

必要。 作為字串的工作型別。兩種支援的型別為「batch_segmentation」和「export」。

properties

必要。 包含與排程相關之其他屬性的物件。

properties.segments

當type等於「batch_segmentation」時為必要。 使用["*"]可確保包含所有區段。

schedule

選擇性。 包含工作排程的字串。工作只能排程在一天執行一次，這表示您不能將工作排程在24小時的期間內執行超過一次。如需cron排程的詳細資訊，請閱讀cron運算式格式的附錄。在此範例中，「0 0 1 * *」表示此排程每天凌晨1:00執行。

如果未提供此字串，將自動產生系統產生的排程。

state

選擇性。 包含排程狀態的字串。兩種支援的狀態為「作用中」和「非作用中」。依預設，狀態會設為「非使用中」。

回應

成功的回應會傳回HTTP狀態200以及您新建立排程的詳細資料。

{
    "id": "4e538382-dbd8-449e-988a-4ac639ebe72b",
    "imsOrgId": "{ORG_ID}",
    "sandbox": {
        "sandboxId": "e7e17720-c5bb-11e9-aafb-87c71c35cac8",
        "sandboxName": "prod",
        "type": "production",
        "default": true
    },
    "name": "{SCHEDULE_NAME}",
    "state": "inactive",
    "type": "batch_segmentation",
    "schedule": "0 0 1 * * ?",
    "properties": {
        "segments": [
            "*"
        ]
    },
    "createEpoch": 1568267948,
    "updateEpoch": 1568267948
}

擷取特定排程 get

您可以向/config/schedules端點發出GET要求，並在要求路徑中提供您想要擷取之排程的ID，以擷取特定排程的詳細資訊。

API格式

GET /config/schedules/{SCHEDULE_ID}

參數

說明

{SCHEDULE_ID}

您要擷取之排程的id值。

要求

curl -X GET https://platform.adobe.io/data/core/ups/config/schedules/4e538382-dbd8-449e-988a-4ac639ebe72b
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

回應

成功的回應會傳回HTTP狀態200，其中包含指定排程的詳細資訊。

{
    "id": "4e538382-dbd8-449e-988a-4ac639ebe72b",
    "imsOrgId": "{ORG_ID}",
    "sandbox": {
        "sandboxId": "e7e17720-c5bb-11e9-aafb-87c71c35cac8",
        "sandboxName": "prod",
        "type": "production",
        "default": true
    },
    "name": "{SCHEDULE_NAME}",
    "state": "inactive",
    "type": "batch_segmentation",
    "schedule": "0 0 1 * * ?",
    "properties": {
        "segments": [
            "*"
        ]
    },
    "createEpoch": 1568267948,
    "updateEpoch": 1568267948
}

屬性

說明

name

字串形式的排程名稱。

type

字串形式的作業型別。兩個支援的型別為batch_segmentation和export。

properties

包含與排程相關之其他屬性的物件。

properties.segments

使用["*"]可確保包含所有區段。

schedule

包含工作排程的字串。工作只能排程在一天執行一次，這表示您不能將工作排程在24小時內執行超過一次。如需cron排程的詳細資訊，請閱讀cron運算式格式的附錄。在此範例中，「0 0 1 * *」表示此排程每天凌晨1:00執行。

state

包含排程狀態的字串。兩個支援的狀態是active和inactive。依預設，狀態設定為inactive。

更新特定排程的詳細資料 update

您可以向/config/schedules端點發出PATCH要求，並在要求路徑中提供您嘗試更新的排程識別碼，以更新特定排程。

PATCH要求可讓您更新個別排程的狀態或cron排程。

更新排程狀態 update-state

您可以使用JSON修補程式操作來更新排程的狀態。若要更新狀態，請宣告path屬性為/state並將value設定為active或inactive。如需JSON修補程式的詳細資訊，請參閱JSON修補程式檔案。

API格式

PATCH /config/schedules/{SCHEDULE_ID}

參數

說明

{SCHEDULE_ID}

您要更新之排程的id值。

要求

curl -X PATCH https://platform.adobe.io/data/core/ups/config/schedules/4e538382-dbd8-449e-988a-4ac639ebe72b \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'
 -d '
[
    {
        "op": "add",
        "path": "/state",
        "value": "active"
    }
]'

屬性

說明

path

您要修補的值的路徑。在此情況下，由於您正在更新排程的狀態，因此您必須將path的值設為"/state"。

value

排程狀態的更新值。此值可以設為「作用中」或「非作用中」，以啟用或停用排程。請注意，如果組織已啟用串流功能，則您無法停用排程。

回應

成功的回應會傳回HTTP狀態204 （無內容）。

更新cron排程 update-schedule

您可以使用JSON修補程式操作來更新cron排程。若要更新排程，請宣告path屬性為/schedule並將value設定為有效的cron排程。如需JSON修補程式的詳細資訊，請參閱JSON修補程式檔案。如需cron排程的詳細資訊，請閱讀cron運算式格式的附錄。

API格式

PATCH /config/schedules/{SCHEDULE_ID}

參數

說明

{SCHEDULE_ID}

您要更新之排程的id值。

要求

curl -X PATCH https://platform.adobe.io/data/core/ups/config/schedules/4e538382-dbd8-449e-988a-4ac639ebe72b \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'
 -d '
[
    {
        "op":"add",
        "path":"/schedule",
        "value":"0 0 2 * * ?"
    }
]'

屬性

說明

path

您要更新值的路徑。在此情況下，由於您正在更新cron排程，因此您需要將path的值設定為/schedule。

value

cron排程的更新值。此值必須採用cron排程的形式。在此範例中，排程會在每月的第二日執行。

回應

成功的回應會傳回HTTP狀態204 （無內容）。

刪除特定排程

您可以向/config/schedules端點發出DELETE要求，並在要求路徑中提供您要刪除之排程的ID，以要求刪除特定排程。

API格式

DELETE /config/schedules/{SCHEDULE_ID}

參數

說明

{SCHEDULE_ID}

您要刪除之排程的id值。

要求

curl -X DELETE https://platform.adobe.io/data/core/ups/config/schedules/4e538382-dbd8-449e-988a-4ac639ebe72b \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

回應

成功的回應會傳回HTTP狀態204 （無內容）。

後續步驟

閱讀本指南後，您現在已更瞭解排程的運作方式。

附錄 appendix

下列附錄說明排程中使用的cron運算式格式。

格式

cron運算式是包含6或7個欄位的字串。運算式看起來類似下列內容：

0 0 12 * * ?

在cron運算式字串中，第一個欄位代表秒，第二個欄位代表分鐘，第三個欄位代表小時，第四個欄位代表月份的日期，第五個欄位代表月份，第六個欄位代表星期幾。您也可以選擇加入第七個欄位，代表年份。

欄位名稱

必要

可能的值

允許的特殊字元

秒

是

0-59

, - * /

分鐘

是

0-59

, - * /

小時

是

0-23

, - * /

當月日期

是

1-31

, - * ? / L W

月

是

1-12， JAN-DEC

, - * /

星期幾

是

1-7，星期六

, - * ? / L #

年

無

空白，1970-2099

, - * /

NOTE

月份名稱和一星期的日期名稱是 不區分。因此，SUN相當於使用sun。

允許的特殊字元代表下列含義：

特殊字元

說明

*

此值用於選取欄位中的所有值。例如，將*放入hours欄位表示每小時。

?

此值表示不需要特定值。這通常用於在一個允許字元的欄位中指定某些專案，但不會在另一個欄位中指定。例如，如果您想要每個月的第3天觸發事件，但不要在乎星期幾，您可能會將3放在月日欄位中，並將?放在星期欄位中。

-

此值用於指定欄位的包含範圍。例如，如果您將9-15放在時數欄位，這表示時數會包括9、10、11、12、13、14和15。

,

此值用於指定其他值。例如，如果您將MON, FRI, SAT放在一週中的某天欄位中，這表示一週中的某天會包含星期一、星期五和星期六。

/

此值用於指定增量。置於/之前的值會決定其增量的來源，而置於/之後的值則會決定其增量的程度。例如，如果您將1/7放在分鐘欄位，這表示分鐘會包含1、8、15、22、29、36、43、50和57。

L

此值用於指定Last，根據其使用的欄位具有不同的含義。若與月份的日期欄位搭配使用，表示月份的最後一天。如果單獨搭配一週中的某天欄位使用，則代表一週中的最後一天，亦即星期六(SAT)。若與「星期」欄位搭配使用，並搭配其他值，則代表該月該型別的最後一天。例如，如果您將5L放在一週中的某天欄位中，則僅包含該月的最後一個星期五。

W

此值可用來指定最接近指定日的工作日。例如，如果您將18W放在月份欄位中，而該月的18日是星期六，則會在17日的星期五觸發，這是最接近的工作日。若該月18日是星期日，則會在19日星期一觸發，亦即最接近的工作日。請注意，如果您將1W放在當月欄位中，而最近的工作日是上個月，則事件仍會在目前月最近的工作日觸發。

此外，您可以合併L與W以產生LW，這會指定該月的最後一個工作日。

#

此值用於指定一月內一週的第n天。置於#之前的值代表一週中的某天，而置於#之後的值代表當月中的哪個事件。例如，如果您放入1#3，則事件會在當月的第三個星期日觸發。請注意，如果您放入X#5，而該月沒有該周的第5個發生次數，則事件將不會觸發。例如，如果您放入1#5，而該月沒有第五個星期日，則事件將不會觸發。

範例

下表顯示cron運算式字串範例，並說明其意義。

運算式

說明

0 0 13 * * ?

事件將於每天下午1點引發。

0 30 9 * * ? 2022

該活動將在2022年的每日上午9:30引發。

0 * 18 * * ?

此事件會每分鐘引發一次，從下午6點開始，到每天下午6:59結束。

0 0/10 17 * * ?

事件會每10分鐘引發一次，從下午5點開始，一直到下午6點結束。

0 13,38 5 ? 6 WED

事件將於每週三6月凌晨5:13及5:38引發。

0 30 12 ? * 4#3

事件將於每月第三個星期三中午12:30引發。

0 30 12 ? * 6L

事件將於每月最後一個星期五中午12:30引發。

0 45 11 ? * MON-THU

事件將於每個星期一、星期二、星期三和星期四上午11:45引發。

recommendation-more-help

770bc05d-534a-48a7-9f07-017ec1e14871