ログイン

サポートセンター

実装と運用のサポートコンテンツをご利用いただけます。

サポートセンター. 実装と運用のサポートコンテンツをご利用いただけます。

Marketing APIの詳細

Criteo APIには、https://api.criteo.com/marketingからアクセスできます。

エンドポイント

認証

タイプ

エンドポイント

目的

パラメータ

補足

POST

/oauth2/token

APIにリクエストをポストするためのトークンを取得します

  • client_id(必須)
  • client_secret(必須)
  • grant_type(必須)

トークンは300秒間有効です

 

広告主管理

タイプ

エンドポイント

目的

パラメータ

GET

/portfolio

advertiser_Id(s)の取得

なし

GET

/advertiser/{advertiser_Id}/campaigns

指定した広告主のキャンペーンとカテゴリーの取得

advertiser_Id(必須):文字列

GET

/advertiser/{advertiser_Id}/categories

指定した広告主のキャンペーンとカテゴリーの取得

カテゴリーステータス別のフィルタリング

advertiser_Id(必須):int

enabledOnly: Bool

GET

/advertiser/{advertiser_Id}/categories/{categoryHashCode}

指定した広告主の特定のカテゴリーの取得

advertiser_Id(必須)

categoryHashCode(必須)

 


キャンペーン管理

タイプ

エンドポイント

目的

パラメータ

GET

/campaigns/

ポートフォリオ用のキャンペーンの取得

advertiser_Ids: string

campaignIds: string

campaignstatus: string

bidtype: string

GET

/campaigns/{campaignId}

特定のキャンペーン用のキャンペーンとカテゴリーの取得

campaignId(必須): int

GET

/campaigns/{campaignId}/categories

特定のキャンペーン用のキャンペーンとカテゴリーの取得

カテゴリーステータス別のフィルタリング

campaignId(必須): int

enabledOnly: string

GET

/campaigns/{campaignId}/categories/{categoryHashCode}

ポートフォリオ用の特定のキャンペーンカテゴリーの取得

campaignId(必須): int

categoryHashCodes(必須): int

GET

/campaigns/bids

ポートフォリオ用の入札を取得

advertiser_Ids: string

campaignIds: string

categoryHashCodes: string

bidType: string

campaignStatus: string

pendingChanges: bool

PUT

/campaigns/bids

キャンペーンまたはキャンペーンのカテゴリーに新しい入札価格を設定

bidChanges(必須): int

 

キャンペーンのレポーティング

タイプ

エンドポイント

目的

パラメータ

補足

POST

/statistics

広告パフォーマンスレポートの取得

statsQuery(必須)

このエンドポイントに関する詳細は、専用の資料の該当するセクションをご確認ください。

 

予算管理

タイプ

エンドポイント

目的

パラメータ

GET

/budgets

ポートフォリオ用の予算の取得

advertiser_Ids: string

budgetIds: string

onlyActiveCampaigns: bool

 

カテゴリー管理

タイプ

エンドポイント

目的

パラメータ

GET

/categories

ポートフォリオ用のカテゴリーの取得

campaign_Ids: : string

advertiser_Ids: string

categoryHashCodes: string

enabledOnly: bool

PUT

/categories

カテゴリーの有効化または無効化

categoriesPerCatalog(必須)

 

オーディエンス管理

タイプ

エンドポイント

目的

パラメータ

補足

GET

/audiences

オーディエンスリストの取得

advertiser_Id : int

広告主IDの指定がない場合には、ユーザのポートフォリオが返されます

POST

 /audiences/userlist/ 

オーディエンスの作成

advertiser_Id : int

name: string

説明:string

オーディエンスIDは、次のIDになります(オーディエンスを作成するたびに増加)

PUT

/audiences/{audienceId} 

オーディエンスメタデータの変更

name: string

description: string

 

PATCH

/audiences/userlist/{audienceId}

オーディエンスのユーザの追加/削除

operation: string(ADD/REMOVE) 

schema: string(email/madid)

identifiers: list of string

1回のリクエストで指定可能なIDの最大数は5万です

識別子:

Eメール:プレーンテキスト、MD5またはMD5のSHA256

MADID:IDFAまたはAAID

注意 :APIがDMPからcookie IDを受け取ることはありません

DELETE 

/audiences/userlist/{audienceId}/users

オーディエンスからすべてのユーザを削除

   

DELETE 

/audiences/{audienceId}

オーディエンスの削除

   

 

パラメータ

パラメータ

使用目的

詳細

client_id

トークンの取得

Eメールアドレス(Criteoマネージメントセンターのログインに使用するものと同じ)

client_secret

トークンの取得

パスワード(Criteoマネージメントセンターのログインに使用するものと同じ)

grant_type

トークンの取得

常にclient_credentialsと同じ

advertiser_Id

特定の広告主データの取得

/portfolioエンドポイントから取得

/advertisersエンドポイントから取得

/audienceエンドポイントから取得

/audiences/userlist/から取得 

advertiser_Ids

特定の広告主データの取得

/budgetエンドポイントから取得

/campaignsエンドポイントから取得

/campaigns/bidsエンドポイントから取得

/categoriesエンドポイントから取得

/statisticsエンドポイントから取得

カンマで区切って指定することで(例えば1,2,3)複数のadvertiser_Idsをリクエストすることが可能

enabledOnly

カテゴリーのフィルターリスト

/categoriesエンドポイントから取得

/advertiser/{advertiser_id}/categoriesエンドポイントから取得

/campaigns/{campaignid}/categoriesエンドポイントから取得

enabled

カテゴリーステータスの更新

/categoriesエンドポイントから取得

categoryHashCode

特定のカテゴリーデータの取得

特定のカテゴリーステータスの更新

/advertiser/{advertiser_id}/categories/{categoriesHashCode}エンドポイントから取得

categoryHashCodes

特定のカテゴリーデータの取得

特定のキャンペーンカテゴリーの入札価格を更新

/categoriesエンドポイントから取得

/campaigns/bidsエンドポイントから取得

/campaigns/{campaignid}//categories/{categoriesHashCode}エンドポイントから取得

カンマで区切って指定することで(例えば1,2,3)複数のcategoryhashcodeをリクエストすることが可能

budgetIds

特定の予算データの取得

/budgetsエンドポイントから取得

onlyactiveCampaigns

ステータス毎にキャンペーンをフィルタリング

/budgetsエンドポイントから取得

campaignID

特定のキャンペーンデータの取得

特定のキャンペーンの入札価格の更新

/campaigns/{campaignid}エンドポイントから取得

/campaigns/{campaignid}/categoriesエンドポイントから取得

/campaigns/{campaignid}/categories/{categoriesHashCode}エンドポイントから取得

/campaigns/bidsエンドポイントから取得

campaignIds

特定のキャンペーンデータの取得

/campaignsエンドポイントから取得

/campaigns/bidsエンドポイントから取得

/categoriesエンドポイントから取得

カンマで区切って指定することで(例えば1,2,3)複数のcampaignidをリクエストすることが可能

bidType

ビットタイプ毎にフィルタリング

/campaignsエンドポイントから取得

/campaigns/bidsエンドポイントから取得

bidValue

特定のキャンペーンカテゴリーの入札価格を更新

/campaigns/bidsエンドポイントから取得

campaignStatus

キャンペーンステータス毎にフィルタリング

/campaignsエンドポイントから取得

/campaigns/bidsエンドポイントから取得

pendingChanges

変更保留中または完了済みのキャンペーンのフィルタリング

/campaigns/bidsエンドポイントから取得

catalogId

カテゴリーステータスの更新

/categoriesエンドポイントから取得

audienceId

特定のオーディエンスを更新

/audiences/から取得 

name

オーディエンス名の更新

/audiences/userlist/エンドポイントから取得

/audiences/{audience_id}エンドポイントから取得

description

オーディエンスの説明の更新

/audiences/userlist/エンドポイントから取得

/audiences/{audience_id}エンドポイントから取得

operation

オーディエンスに対する処理

/audiences/userlist/{audience_id}エンドポイントから取得

値は以下のいずれかとします:ADD / REMOVE

schema

オーディエンスデータのタイプ

/audiences/userlist/{audience_id}エンドポイントから取得

Identifiers

ユーザIDのリスト

/audiences/{audience_id}エンドポイントから取得

reportType

統計レポートのエクスポート

/statisticsから取得

値は以下のいずれかとします:Campaign performance / Facebook DPA Report / Transaction ID Report

ignoreXDevice

統計レポートのエクスポート

/statisticsから取得

startDate

統計レポートのエクスポート

/statisticsから取得

endDate

統計レポートのエクスポート

/statisticsから取得

ディメンション

統計レポートのエクスポート

/statisticsから取得

最大3ディメンション

指標

統計レポートのエクスポート

/statisticsから取得

マネージメントセンターのUI内の指標を選択

フォーマット

統計レポートのエクスポート

/statisticsから取得

値は以下のいずれかとします:XML、JSON、CSV、EXCEL、HTML

currency

統計レポートのエクスポート

/statisticsから取得

値はISO通貨コードで指定します

timezone

統計レポートのエクスポート

/statisticsから取得

値は以下のいずれかとします:GMT / PST / JST 


レスポンスコード

レスポンスコード

理由

200

成功

400

不正なリクエスト、シンタックスエラー

401

認証失敗

403

アクセス禁止

429

レート制限に抵触。1クライアントあたり1分間のリクエスト数は200未満である必要があります

500

不明なエラー

この記事は役に立ちましたか?
0人中0人がこの記事が役に立ったと言っています
Powered by Zendesk