__________________________________________________________________________________________________________________
本項の目的:
- Partnerize APIを使用した承認 / 非承認作業の自動化手順をご案内いたします。
__________________________________________________________________________________________________________________
目次
概要
Partnerizeで計測されたコンバージョンは、請求書の発行やパートナーへの報酬支払いを行う前に必ず、承認 / 非承認へステータス変更される必要があります。トラッキングされた全てのコンバージョンに対しての承認作業は広告主様自身で実施して頂く必要がございます。 承認作業を行う方法は数多くありますが、PartnerizeではAPIを利用しての自動承認作業を推奨しています。
自動化には以下のようなメリットがあります。
- 手作業で行われていた承認・非承認作業に関する時間を短縮できます。
- 広告主様システムとPartnerizeが、適切に同期されていることを、承認ステータスを通じて確認できます。
- 承認タイミングを広告主様の希望のタイミングで実施できます。
実装手順
Partnerizeのコンバージョンデータは作成時(計測時)、ステータスが保留(pending)で登録されます。コンバージョン送信時のconversionrefパラメータには、広告主様が承認作業を行う際に利用する値であり、広告主様システム側の注文IDを設定することを推奨いたします。それにより、広告主様側の注文状態と紐づけて承認作業を行うことが可能となります。
広告主様側では、Partnerize APIから保留(pending)状態のコンバージョンレポートを取得し、conversionrefパラメータの値を自社システムの注文IDと照合し、各コンバージョンの承認／非承認を決定する処理を実装してください。
保留(pending)のコンバージョンをを抽出するためのAPIの例
■コンバージョン（バスケット）レベルを取得する場合
https://{app_api_key}:{user_api_key}@api.partnerize.com/reporting/report_advertiser/campaign/{campaign_id}/conversion.{format}?start_date={YYYY-MM-DD hh:mm:ss}& end_date={YYYY-MM-DD hh:mm:ss}&statuses%5B%5D=pending.
■アイテムレベル のコンバージョンを取得する場合
https://{app_api_key}:{user_api_key}@api.partnerize.com/reporting/export/conversion_item.{format}?start_date={YYYY-MM-DD hh:mm:ss}& end_date={YYYY-MM-DD hh:mm:ss}& campaign_id={campaign_id}&statuses%5B%5D=pending
__________________________________________________________________________________________________________________
❗NOTE
- 認証キー : 「{app_api_key}」と「{user_api_key}」は、Partnerizeの管理画面から確認することができます。以下の手順で確認してください。
- アプリケーションAPIキー（ロゴ＞アカウント設定＞ユーザーアプリケーションキー）
- ユーザーAPIキー（ロゴ＞アカウント設定＞ユーザーAPIキー）
- データフォーマット : csv、jsonまたはxmlをお選びいただけます。
- 対象日時の指定方法 : 「start_date」や「end_date」の代わりに「text_date」パラメータの利用も可能です。
例）text_date=last+7+days
__________________________________________________________________________________________________________________
コンバージョンの承認／非承認プロセス
上記のAPIを利用し、承認 / 非承認への変更を行う必要のあるコンバージョンデータを取得後、下記APIを利用して各コンバージョンのステータスを更新してください。必要に応じて、非承認とするコンバージョンにオプションの拒否理由(reject_reason)の設定も可能です。承認 / 非承認へ変更を行うコンバージョンの指定には、以下3つの異なるIDを使用できます。
- conversionref
- 一般に、広告主様側システムの注文IDを設定します。
- conversion_id:
- Partnerizeが発行するコンバージョン毎の固有IDとなります。
- conversion_item_id
- Partnerizeが発行するコンバージョンアイテム毎の固有IDとなります。
__________________________________________________________________________________________________________________
❗NOTE
- コンバージョンアイテム毎の承認 / 非承認を行う際にはconversion_item_idを必ず指定する必要があります。
__________________________________________________________________________________________________________________
承認／非承認に使用するAPI
https://{app_api_key}:{user_api_key}@api.partnerize.com/v3/brand/campaigns/{campaignID}/conversions/bulk
承認に使用するAPIのPOSTデータ例（conversion_referenceで指定）。
{ "conversion_references":
{ "AUTO-5de90e8ccdc106.23934624":
{ "status":"approved
" }, "AUTO-0de90e8adec106.23934947":
{ "status": "approved":
"approved", }.
}
}
承認に使用するAPIのPOSTデータ例（conversion_idで指定）。
{ "conversions":
{ "111111l1":
{ "status":"approved
" }, "111111l2":
{ "status": "approved":
"approved", } 。
}
}
承認に使用するAPIのPOSTデータ例（conversion_item_idで指定）。
{ "conversion_items":
{ "111111l3":
{ "status":"approved
" }, "111111l4":{ "
status": "approved":
"approved", }.
}
}
非承認に使用するAPIのPOSTデータ例（conversion_referenceで指定）
{ "conversion_references":
{ "AUTO-5de90e8ccdc106.23934624":
{ "status":"rejected
" }, "AUTO-0de90e8adec106.23934947":
{ "status":"rejected
", "reason":"cancelled order" }
}
}
非承認に使用するAPIのPOSTデータ例（conversion_idで指定）
{ "conversions":
{ "111111l1":
{ "status":"rejected
" }, "111111l2":
{ "status": "rejected
"rejected
", "reason":"cancelled order" }
}
}
複数承認／非承認に使用するAPIのPOSTデータ例 （conversion_item_idで指定）
{ "conversion_items":
{ "111111l3":
{
"status":"approved"
},
"111111l4":
{
"status":"rejected",
"reason":"cancelled order" }
}
}
APIの詳細については以下のマニュアルをご参照ください。
https://api-docs.partnerize.com/brand/#tag/Campaign-Conversions
ご質問
実装に関するその他技術的なご質問に関しましては、integrations.support@partnerize.com までお問い合わせ下さい。