Method: subscriptions.delete

定期購入を解約、一時停止、または直接に移行する。

HTTP リクエスト

DELETE https://reseller.googleapis.com/apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
customerId

string

顧客のプライマリ ドメイン名または顧客の一意の識別子のいずれかです。顧客のドメイン名が変更された場合、古いドメイン名を使用して顧客にアクセスすることはできませんが、API によって返される顧客の一意の識別子は常に使用できます。可能な場合は、一意の識別子をシステムに保存することをおすすめします。
subscriptionId

string

これは必須プロパティです。subscriptionId は定期購入 ID で、顧客ごとに一意です。subscriptionId はサブスクリプションが更新されると変更されるため、この ID を永続データのキーとして使用しないことをおすすめします。subscriptionId は、retrieve all reseller subscription メソッドを使用して確認できます。

クエリ パラメータ

パラメータ
deletionType

enum (DeletionType)

deletionType クエリ文字列は、サブスクリプションの解約、ダウングレード、停止を有効にします。

リクエスト本文

リクエストの本文は空にする必要があります。

レスポンスの本文

任意の HTTP 本文を表すメッセージ。RAW バイナリや HTML ページなど、JSON として表現できないペイロード形式にのみ使用する必要があります。

このメッセージは、リクエストとレスポンスのストリーミングと非ストリーミング両方の API メソッドで使用できます。

最上位レベルのリクエスト フィールドとして使用でき、URL または HTTP テンプレートからリクエスト フィールドにパラメータを抽出する場合や、RAW HTTP 本文にアクセスする場合にも便利です。

例:

message GetResourceRequest {
  // A unique request id.
  string requestId = 1;

  // The raw HTTP body is bound to this field.
  google.api.HttpBody http_body = 2;

}

service ResourceService {
  rpc GetResource(GetResourceRequest)
    returns (google.api.HttpBody);
  rpc UpdateResource(google.api.HttpBody)
    returns (google.protobuf.Empty);

}

ストリーミング メソッドの例:

service CaldavService {
  rpc GetCalendar(stream google.api.HttpBody)
    returns (stream google.api.HttpBody);
  rpc UpdateCalendar(stream google.api.HttpBody)
    returns (stream google.api.HttpBody);

}

このタイプを使用すると、リクエストとレスポンスの本文の処理方法のみ変更され、他のすべての機能は未変更のまま動作を継続します。

成功した場合、レスポンスはメソッドによって定義された形式の汎用 HTTP レスポンスになります。

JSON 表現 
{
  "contentType": string,
  "data": string,
  "extensions": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
フィールド
contentType

string

本文のコンテンツ タイプを指定する HTTP Content-Type ヘッダー値。
data

string (bytes format)

未加工のバイナリとしての HTTP リクエスト / レスポンスの本文。

base64 でエンコードされた文字列。
extensions[]

object

アプリケーション固有のレスポンス メタデータ。ストリーミング API の最初のレスポンスで設定する必要があります。

任意のデータ型のフィールドを含むオブジェクト。型を識別する URI を含むフィールド "@type" を追加できます。例: { "id": 1234, "@type": "types.example.com/standard/id" }

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/apps.order

詳細については、承認ガイドをご覧ください。

DeletionType

列挙型
deletion_type_undefined
cancel サブスクリプションを直ちに解約します。これは G Suite サブスクリプションには適用されません。
transfer_to_direct

定期購入を Google に直接移行します。 顧客は直ちに Google との直接請求契約に移行し、短期間だけサービスが中断されることはありません。お客様は、クレジット カードを使用して Google に直接お支払い情報を設定するか、別の販売パートナーに移行するかを選択できます。