ログイン

サポートセンター

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

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

Criteo API を使用してレポート作成情報をコールするには?

Crieto API を用いてレポートを出力するには、下記のクエリーを使用します: 
  1. clientLogin
  2. scheduleReportJob
  3. getJobStatus
  4. getReportDownloadUrl

 

API コール & 応答リスト

 
1. clientLogin
次の出力で使用するための authToken を戻します。

パラメーター:
フィールド タイプ 説明
username xsd:string ユーザー名
password xsd:string 広告主のパスワード
source xsd:string ロギングを目的として使用アプリケーションを特定するための短い文字列。この文字列は、"companyName-applicationName-versionID" という形式をとります。

回答:
フィールド タイプ 説明
clientLoginResult xsd:string clientLoginResult は、その他すべてのコールで使用されるための認証用トークン (authToken) です。このトークンは48 時間有効です。
 
2. getAccount
基本的なアカウント情報を戻します。

パラメーター:
N/A

回答:
フィールド タイプ 説明
advertiserName xsd:string このアカウントの名前
email xsd:string 広告主の主要担当者の Email
currency xsd:string 通貨一覧
timezone xsd:string このアカウントのタイムゾーン。一覧
country xsd:string アカウントの国。一覧
 
3. getBudgets
セレクター基準に適合する予算のリストを戻します。

パラメーター:
フィールド タイプ 説明
budgetSelector BudgetIDs[] 取得する予算 ID のリスト。空の場合は、すべての予算が取得されます。

回答:
フィールド タイプ 説明
getBudgetsResult Budget[] 対象予算のリスト
 
4. getCampaigns
セレクター基準に適合するキャンペーンのリストを戻します。

パラメーター:
フィールド タイプ 説明
campaignSelector CampaignSelector BudgetID、CampaignID、CampaignStatus、および BiddingStartegy を使用してキャンペーンを取得できます。

回答:
フィールド タイプ 説明
getCampaignsResult Campaign[] キャンペーン オブジェクトのリスト
 
5. getCategories
選択基準に適合するカテゴリーのリストを戻します。

パラメーター:
フィールド タイプ 説明
categorySelector CategorySelector CategoryID および Selected を使用してカテゴリーを取得できます。

回答:
フィールド タイプ 説明
getCategoriesResult Category[] カテゴリー オブジェクトのリスト
 
6. mutateCategories
カテゴリーを更新します。

パラメーター:
フィールド タイプ 説明
mutateCategories CategoryMutates[] mutate オペレーションのリスト。SET オペレーションのみがサポートされています。

回答:
フィールド タイプ 説明
jobResponse categoryMutateJobResponse[] categoryJobResponseObjects のリスト。各オペレーションは、独自の jobID を持ち、getJobStatus で確認できます。
 
7. mutateCampaigns
キャンペーンを更新します。

パラメーター:
フィールド タイプ 説明
mutateCampaigns CampaignMutates[] mutate オペレーションのリスト。SET オペレーションのみがサポートされています。


レスポンス:
フィールド タイプ 説明
jobResponse campaignMutateJobResponse[] campaignJobResponseObjects のリスト。 各オペレーションは、独自の jobID を持ちます。getJobStatus で確認できます。


8. scheduleReportJob
レポート作業の実行をスケジューリングします。

パラメーター:
フィールド タイプ 説明
reportJob ReportJob リクエストされたレポートを説明する reportJob オブジェクトが渡されます。

回答:
フィールド タイプ 説明
jobID xsd:int リクエストされたジョブの ID.getJobStatus および getReportDownloadURL で使用できます。
jobStatus xsd:string リクエストのステータス。reportJob が許可されると、Pending が戻されます。
reportJob ReportJob 初期の reportJob リクエスト


9. getJobStatus
ID に基づいてジョブ ステータスを戻します。

パラメーター:
フィールド タイプ 説明
jobID xsd:int ステータスが取得された jobID。

回答:
フィールド タイプ 説明
getJobStatusResult xsd:String リクエストされたジョブのステータス。一覧


10. getReportDownloadUrl
URL を差し戻します。そこから、指定したジョブ ID を使用するレポートをダウンロードできます。このメソッドを呼び出したあと、呼び出し元は、戻された URL 上で通常の HTTP GET を実行し、レポートを取得します。レポートは XML 形式です。

パラメーター:
フィールド タイプ 説明
jobID xsd:int ダウンロード URL を取得する jobID 。

回答:
フィールド タイプ 説明
jobURL xsd:String レポートをダウンロードできるFull URL。


11. getStatisticsLastUpdate
StatUpdate オブジェクトのリストを戻し、関連する指標の “books closed” を示します (現在は、Click、Impression、Sales)。

パラメーター:
なし。

応答:
フィールド タイプ 説明
getStatisticsLastUpdateResult StatUpdate[] StatUpdateObjects のリスト。StatUpdate には種類および日付が含まれます。

 

オブジェクトの説明

 
Type Campaign
フィールド タイプ 説明
campaignID xsd:int キャンペーンID
campaignName xsd:string キャンペーン名
campaignBid BidInformation キャンペーンの入札情報
budgetID xsd:decimal キャンペーンで使用している予算ID。
remainingDays xsd:int 既存の予算でこのキャンペーンを実行できる日数。この値は、現在のスペンドペースに基づいて見積もられます。
status xsd:string キャンペーンステータス:
  • RUNNING : キャンペーンは現在アクティブである
  • NOT_RUNNING : キャンペーンはアクティブではない
  • DEAD : キャンペーンはアーカイブされている (読み取り専用)
categoryBids CategoryBid[] カテゴリーに添付されているBidInformationのリスト。


カテゴリータイプ
フィールド タイプ 説明
categoryID xsd:int カテゴリーID
categoryName xsd:string カテゴリーの名前 (フィードから取得)
avgPrice xsd:double このカテゴリー内商品の平均価格。
numberOfProducts xsd:int このカテゴリーにタグ付けされた商品の数。
selected xsd:boolean カテゴリーを選択済みの場合は True (選択済みとは、入札およびレポート作成が利用できることを意味します)。


Type Budget
フィールド タイプ 説明
budgetID xsd:int 予算の ID。
budgetName xsd:string 予算の名前。
totalAmount xsd:int この予算に追加された合計金額。
remainingBudget xsd:decimal 残予算額。
remainingBudgetUpdated xsd:dateTime remainingBudget が計算された時間。


Type BidInformation
フィールド タイプ 説明
biddingStrategy xsd:string 入札の戦略:
  • Cpc : クリック単価
  • Cpa : 一回のコンバージョン当たりのコスト
  • Cpm: 1000 インプレッション当たりの平均コスト
注: Cpc のみがサポートされています。
cpcBid xsd:double CPC の単価。
cpaBid CPABid CPABid には postClick、postView、commission、および percent が含まれます。(現在まだサポートされていません)。


Type CategoryBid
フィールド タイプ 説明
campaignCategoryUID xsd:int 特定のキャンペーンのカテゴリーを特定するグローバル UID。
campaignID xsd:int カテゴリー入札が行われるキャンペーンID。
categoryID xsd:int この入札が実行されるカテゴリーの ID。
selected xsd:boolean カテゴリーを選択済みの場合は True (選択済みとは、入札およびレポート作成が利用できることを意味します)。
bidInformation BidInformation カテゴリー入札の入札情報。


Type ReportJob
フィールド タイプ 説明
reportSelector CategoryIDs
CampaignIDs
レポートでデータを取得するカテゴリーまたはキャンペーン ID のリスト。
reportType xsd:string 実行するレポートの種類:
  • キャンペーン
  • カテゴリー
aggregationType xsd:string レポートの集計の種類:
  • 時間単位
  • 日単位
startDate xsd:string レポートの startDate (YYYY-MM-DD)。
endDate xsd:string レポートの終了日 (YYYY-MM-DD)。
selectedColumns ReportColumn[] レポートでリクエストされたカラムのリスト:
  • clicks
  • impressions
  • ctr
  • revcpc
  • ecpm
  • cost
  • sales
  • convRate
  • orderValue
  • salesPostView
  • convRatePostView
  • orderValuePostView
  • costOfSale
  • impressionWin
  • costPerOrder
isResultGzipped xsd:boolean True の場合は、レポートの Zip 圧縮が必要。

 

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