# アンインストール

ショップからアプリを削除する処理を「アンインストール」といいます。

# アンインストールによって行われる処理

アプリをアンインストールしたとき、以下の処理をカラーミーショップが行います。

  • カラーミーショップAPIのアクセストークンの無効化
  • 登録したスクリプトタグの削除
  • 契約の自動更新の無効化

# アンインストールが発生する操作・条件

以下のいずれかの操作・条件によってアンインストールが行われます。

# アンインストールフック

アンインストール直後に、アンインストールが行われた旨をデベロッパーに通知します。 通知内容を確認いただき、アプリ側で必要なアンインストールに伴う処理（アプリ側でのアカウント処理など）を行ってください。

アンインストールAPIをご利用の場合

アンインストールAPI (opens new window)の利用によるアンインストール時は、アンインストールフックは通知されません。 以下のアンインストールフックのリクエスト仕様と同様の形式で、APIのレスポンスボディに含めます。アンインストールAPI (opens new window)の項も合わせて確認ください。

# フックのリクエスト・レスポンス仕様とパラメータ

アンインストール直後に POST メソッドで、以下の情報を application/json 形式で通知します。 受け取りに成功した場合はHTTPステータスコード 200 のレスポンスを返却してください。

パラメータ 機能 形式
account_id アンインストールしたショップオーナーのアカウントID PA+8桁の整数
application_charge_source_id プラン課金ID 数字と大文字アルファベットで構成される文字列(6桁以上)
uninstalled_at アンインストール日時 整数値(UNIXタイムスタンプ)
reason アンインストール理由（reasonパラメータの項を参照してください） by_shop_owner (ショップオーナーによる), by_unpaid (未払いによる)
recurring_application_charge_id （月額課金の場合）課金契約ID 数字と大文字アルファベットで構成される文字列(6桁以上)
usage_charge （従量課金の場合）従量課金アンインストール情報（課金形式「従量による課金」を含むプラン課金の請求の項を参照してください） JSONオブジェクト

# フックの署名検証

インストールフックの署名検証と同様に、アンインストールフックについても署名検証を強く推奨します。

# アンインストールフック例

アンインストールフックの例を以下に示します。

例) 前払い・買い切りの場合

{
  "account_id": "PA00000001",
  "application_charge_source_id": "Q21GPC",
  "uninstalled_at": 1552022739,
  "reason": "by_shop_owner"
}

例) 前払い・月額固定費を含む場合

{
  "account_id": "PA00000001",
  "application_charge_source_id": "EW3V21",
  "recurring_application_charge_id": "F3RN9A",
  "uninstalled_at": 1552022740,
  "reason": "by_shop_owner"
}

例) 後払いの場合

{
  "account_id": "PA00000001",
  "application_charge_source_id": "WA37CA",
  "recurring_application_charge_id": "F3WQ1S",
  "uninstalled_at": 1552022740,
  "reason": "by_shop_owner",
  "usage_charge": {
    "api_token": "token",
    "closing_on": 1552533465
  }
}

# 通知先の設定

通知先のURLはカラーミーショップ デベロッパー (opens new window)にログインし、各アプリのアプリ設定から登録を行ってください。

# reasonパラメータ

アンインストールの理由を reason パラメータで確認できます。

reasonパラメータの値 アンインストール理由
by_shop_owner ショップオーナーによるアンインストール操作
by_unpaid ポイント不足による利用料回収の失敗による強制アンインストール

# 課金形式「従量による課金」を含むプラン課金の請求

課金形式に「従量による課金」を含むプラン課金をご利用の場合、アンインストール後に従量課金データを作成するために必要な以下の情報を usage_charge パラメータとして送信します。

パラメータ 機能 形式
api_token アンインストール後に従量課金APIを利用するために必要な情報 文字列
closing_on ポイント締め日 整数値(UNIXタイムスタンプ)

アンインストールAPIによるアンインストール処理

アンインストールAPI (opens new window)のご利用によるアンインストール時は、APIのレスポンスボディに上記パラメータを含めます。 アンインストールAPI (opens new window)の項もご覧ください。

アンインストール後はカラーミーショップAPIのアクセストークンが無効化されているため、アクセストークンを利用して従量課金APIを呼び出すことができません。 アンインストール後はアクセストークンの代わりに api_token をリクエストヘッダーに含め、従量課金APIを呼び出してください。 詳しくは、従量課金データの作成 (opens new window)を参照してください。

無料お試し期間中のアンインストールについて

無料お試し期間中にアプリがアンインストールされた場合は、api_token は発行されません。

api_token を利用した従量課金APIの呼び出しは、ポイント締め日 closing_on までですので、ご注意ください。 通常、 closing_on は、アンインストール直前まで利用されていた契約の期間の月末となります。以下に例を示します。

アンインストール日 直前まで利用されていた契約の期間 closing_on の示す日時
2021/01/09 2021/12/10〜2021/01/09 2021/01/31
2021/01/10 2021/01/10〜2021/02/09 2021/02/28

# アンインストールフックのリトライ

HTTPステータスコード 200 のレスポンスをカラーミーショップが受け取れない場合は、HTTPステータスコード 200 をカラーミーショップが受け取るまで、以下の条件で再度アンインストールフックを送信します。

なお、カラーミーショップによるアンインストール処理は、アンインストールフックの送信結果の成否によらず、アンインストールが実行されたときに完了します。

  • 2時間30分ごとにアンインストールフックの仕様に基づき再送します
  • 最大で合計19回再送します
  • すべての再送でHTTPステータスコード 200 をカラーミーショップが受け取れない場合は、カラーミーショップ デベロッパーページ (opens new window)にてアカウント作成時にご登録いただいたメールアドレス宛にメールを送信します

# 強制アンインストール

以下の条件のいずれかを満たすとき、カラーミーショップが強制的にアプリをアンインストールします。

  • 課金タイミングが「前払い」かつ月額固定費を含むプラン課金をご利用の際のポイント不足
    • 月額固定費を含むプラン課金の契約更新時に、ポイントが不足しているとき
    • 無料お試し期間が適用されていた際に、無料お試し期間終了日の翌日（=支払日）にポイントが不足しているとき
  • 課金タイミングが「後払い」のプラン課金をご利用の際のポイント不足
    • 月額固定費、または従量による課金の支払期限までにポイントが支払われなかったとき

← アプリの最低技術要件 →