メインコンテンツへスキップ
POST
/
marketing
/
v3
/
campaigns
/
batch
/
read
キャンペーンをバッチ読み取り
curl --request POST \
  --url https://api.hubapi.com/marketing/v3/campaigns/batch/read \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "inputs": [
    {
      "id": "<string>"
    }
  ]
}
'
{
  "completedAt": "2023-11-07T05:31:56Z",
  "results": [
    {
      "assets": {},
      "businessUnits": [
        {
          "id": 123
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "properties": {},
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "startedAt": "2023-11-07T05:31:56Z",
  "links": {},
  "requestedAt": "2023-11-07T05:31:56Z"
}

Supported products

承認

Authorization
string
header
必須

The access token received from the authorization server in the OAuth 2.0 flow.

クエリパラメータ

endDate
string

アセット測定指標を取得する終了日で、形式はYYYY-MM-DDとなります。この日付は指定された期間のアセットに関連付けられている測定指標の取得に使用されます。指定しない場合、アセット測定指標は取得されません。 例:2024-01-27

properties
string[]

レスポンスで返されるプロパティーのカンマ区切りリスト。指定されたプロパティーのいずれかに要求されたオブジェクトの空の値が含まれる場合は無視され、レスポンスで返されません。このパラメーターが空の場合、レスポンスには空のプロパティーマップが含まれます。 例:hs_name, hs_campaign_status, hs_notes

startDate
string

アセット測定指標を取得する開始日で、形式はYYYY-MM-DDとなります。この日付は指定された期間のアセットに関連付けられている測定指標の取得に使用されます。指定されない場合、アセット測定指標は取得されません。 例:2023-01-20

ボディ

application/json
inputs
object[]
必須

PublicCampaignReadInputオブジェクトの配列。各オブジェクトには、読み取るキャンペーンのIDが含まれます。このプロパティーは必須です。

レスポンス

successful operation

completedAt
string<date-time>
必須

バッチ要求処理が完了した時点のタイムスタンプ。

results
object[]
必須

バッチ操作の結果の配列。各結果は、アセットを含む公開キャンペーンを表します。

startedAt
string<date-time>
必須

バッチ要求の処理が開始された時点のタイムスタンプ。

status
enum<string>
必須

次の値を取り得る、バッチ処理の現在の処理ステータス:CANCELED、COMPLETE、PENDING、PROCESSING。

利用可能なオプション:
CANCELED,
COMPLETE,
PENDING,
PROCESSING

関連するリソースやドキュメントにリンクしているURLのコレクション。

requestedAt
string<date-time>

バッチ要求が最初に行われた時点のタイムスタンプ。

Last modified on April 13, 2026