REST Resource: purchases.subscriptionsv2

Ресурс: SubscriptionPurchaseV2

Указывает статус покупки подписки пользователем.

JSON-представление
{
  "kind": string,
  "regionCode": string,
  "lineItems": [
    {
      object (SubscriptionPurchaseLineItem)
    }
  ],
  "startTime": string,
  "subscriptionState": enum (SubscriptionState),
  "linkedPurchaseToken": string,
  "pausedStateContext": {
    object (PausedStateContext)
  },
  "canceledStateContext": {
    object (CanceledStateContext)
  },
  "testPurchase": {
    object (TestPurchase)
  },
  "acknowledgementState": enum (AcknowledgementState),
  "externalAccountIdentifiers": {
    object (ExternalAccountIdentifiers)
  },
  "subscribeWithGoogleInfo": {
    object (SubscribeWithGoogleInfo)
  },
  "etag": string,
  "outOfAppPurchaseContext": {
    object (OutOfAppPurchaseContext)
  },
  "onHoldStateContext": {
    object (OnHoldStateContext)
  },
  "inGracePeriodStateContext": {
    object (InGracePeriodStateContext)
  }
}
Поля
kind

string

Этот тип представляет объект SubscriptionPurchaseV2 в сервисе androidpublisher.

regionCode

string

Код страны или региона нахождения платежного адреса пользователя в формате ISO 3166-1 alpha-2 на момент предоставления подписки.

lineItems[]

object (SubscriptionPurchaseLineItem)

Информация о покупке подписки на уровне товара. Все товары в одной покупке должны быть либо с AutoRenewingPlan, либо с PrepaidPlan.

startTime

string (Timestamp format)

Время, когда подписка была предоставлена. Не задано для ожидающих подписок (подписка создана, но ожидает оплаты при регистрации).

Используется формат RFC 3339. Результат всегда будет Z-нормализованным, и в нем будут использоваться цифры дробных частей 0, 3, 6 или 9. Допустимы и другие типы нормализации. Примеры: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30".

subscriptionState

enum (SubscriptionState)

Текущий статус подписки.

linkedPurchaseToken

string

Токен покупки старой подписки, если текущая подписка: * оформлена повторно после отмены, но до истечения срока действия; * оформлена в результате перехода на другой тарифный план. * Переход с предоплаченного плана на подписку с автоматическим продлением. * Переход с подписки с автоматическим продлением на предоплаченный план. * Пополнить баланс предоплаченной подписки.

pausedStateContext

object (PausedStateContext)

Дополнительная информация о приостановленных подписках. Присутствует, только если подписка в настоящее время имеет статус SUBSCRIPTION_STATE_PAUSED.

canceledStateContext

object (CanceledStateContext)

Дополнительная информация об отмененных подписках. Указывается, только если подписка имеет статус SUBSCRIPTION_STATE_CANCELED или SUBSCRIPTION_STATE_EXPIRED.

testPurchase

object (TestPurchase)

Присутствует, только если покупка подписки является тестовой.

acknowledgementState

enum (AcknowledgementState)

Статус подтверждения подписки.

externalAccountIdentifiers

object (ExternalAccountIdentifiers)

Идентификатор аккаунта пользователя в стороннем сервисе.

subscribeWithGoogleInfo

object (SubscribeWithGoogleInfo)

Профиль пользователя, связанный с покупками, совершенными через сервис "Подписка через Google".

etag

string

Тег объекта, представляющий текущее состояние подписки. Разработчик будет предоставлять этот тег etag для действий с подписками. Этот тег всегда присутствует для подписок с автоматическим продлением и предоплатой.

outOfAppPurchaseContext

object (OutOfAppPurchaseContext)

Дополнительная информация о покупках вне приложения. Эта информация доступна только для покупок, совершенных через центр подписок Google Play после окончания срока действия предыдущей подписки на тот же продукт. Это поле будет удалено после подтверждения подписки.

onHoldStateContext

object (OnHoldStateContext)

Необязательное поле. Дополнительная информация о подписках в статусе ON_HOLD. Указывается, только если подписка имеет статус subscriptionState SUBSCRIPTION_STATE_ON_HOLD.

inGracePeriodStateContext

object (InGracePeriodStateContext)

Необязательное поле. Дополнительная информация о подписках в статусе IN_GRACE_PERIOD. Указывается, только если у подписки в настоящее время есть subscriptionState SUBSCRIPTION_STATE_IN_GRACE_PERIOD.

SubscriptionState

Возможные статусы подписки, например "активна" или "отменена". В рамках одной покупки можно приобрести только планы с автоматическим продлением или только планы с предоплатой.

Перечисления
SUBSCRIPTION_STATE_UNSPECIFIED Статус подписки не указан.
SUBSCRIPTION_STATE_PENDING Подписка создана, но ожидает оплаты во время регистрации. В этом состоянии все товары ожидают оплаты.
SUBSCRIPTION_STATE_ACTIVE Подписка активна. 1. Если подписка оформлена по тарифному плану с автоматическим продлением, хотя бы для одного элемента должно быть задано значение autoRenewEnabled и не должен истечь срок действия. - 2) Если подписка оформлена по предоплате, срок действия хотя бы одного элемента не истек.
SUBSCRIPTION_STATE_PAUSED Подписка приостановлена. Это состояние доступно только для тарифных планов с автоматическим продлением. В этом состоянии все элементы приостановлены.
SUBSCRIPTION_STATE_IN_GRACE_PERIOD Для подписки действует льготный период. Это состояние доступно только для тарифных планов с автоматическим продлением. В этом состоянии все элементы находятся в льготном периоде.
SUBSCRIPTION_STATE_ON_HOLD Подписка заблокирована. Это состояние доступно только для тарифных планов с автоматическим продлением. В этом состоянии все объекты находятся на хранении.
SUBSCRIPTION_STATE_CANCELED Подписка отменена, но срок ее действия ещё не истек. Это состояние доступно только для тарифных планов с автоматическим продлением. Для всех элементов параметр autoRenewEnabled имеет значение false.
SUBSCRIPTION_STATE_EXPIRED Срок действия подписки истек. У всех товаров значение expiryTime в прошлом.
SUBSCRIPTION_STATE_PENDING_PURCHASE_CANCELED Транзакция в обработке для подписки отменена. Если эта незавершенная покупка была для существующей подписки, используйте linkedPurchaseToken, чтобы узнать текущее состояние этой подписки.

PausedStateContext

Информация о приостановленной подписке.

JSON-представление
{
  "autoResumeTime": string
}
Поля
autoResumeTime

string (Timestamp format)

Время, когда подписка будет автоматически возобновлена.

Используется формат RFC 3339. Результат всегда будет Z-нормализованным, и в нем будут использоваться цифры дробных частей 0, 3, 6 или 9. Допустимы и другие типы нормализации. Примеры: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30".

CanceledStateContext

Информация о подписке со статусом SUBSCRIPTION_STATE_CANCELED или SUBSCRIPTION_STATE_EXPIRED.

JSON-представление
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "userInitiatedCancellation": {
    object (UserInitiatedCancellation)
  },
  "systemInitiatedCancellation": {
    object (SystemInitiatedCancellation)
  },
  "developerInitiatedCancellation": {
    object (DeveloperInitiatedCancellation)
  },
  "replacementCancellation": {
    object (ReplacementCancellation)
  }
  // End of mutually exclusive fields.
}
Поля
Причина отмены подписки. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
userInitiatedCancellation

object (UserInitiatedCancellation)

Подписка отменена пользователем.

systemInitiatedCancellation

object (SystemInitiatedCancellation)

Подписка была отменена системой, например из-за проблем с оплатой.

developerInitiatedCancellation

object (DeveloperInitiatedCancellation)

Подписка отменена разработчиком.

replacementCancellation

object (ReplacementCancellation)

Подписка была заменена новой.

Конец взаимоисключающих полей.

UserInitiatedCancellation

Информация об отменах, инициированных пользователями.

JSON-представление
{
  "cancelSurveyResult": {
    object (CancelSurveyResult)
  },
  "cancelTime": string
}
Поля
cancelSurveyResult

object (CancelSurveyResult)

Информация, предоставленная пользователем при отмене подписки (опрос о причине отмены).

cancelTime

string (Timestamp format)

Время, когда пользователь отменил подписку. Пользователь может сохранить доступ к подписке после этого времени. Чтобы определить, есть ли у пользователя доступ, используйте lineItems.expiry_time.

Используется формат RFC 3339. Результат всегда будет Z-нормализованным, и в нем будут использоваться цифры дробных частей 0, 3, 6 или 9. Допустимы и другие типы нормализации. Примеры: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30".

CancelSurveyResult

Результаты опроса, который пользователь прошел при отмене подписки.

JSON-представление
{
  "reason": enum (CancelSurveyReason),
  "reasonUserInput": string
}
Поля
reason

enum (CancelSurveyReason)

Причина, которую пользователь выбрал в опросе при отмене.

reasonUserInput

string

Задается только для CANCEL_SURVEY_REASON_OTHERS. Это ответ пользователя на опрос в свободной форме.

CancelSurveyReason

Причина, которую пользователь выбрал в опросе при отмене.

Перечисления
CANCEL_SURVEY_REASON_UNSPECIFIED Неизвестная причина отмены опроса.
CANCEL_SURVEY_REASON_NOT_ENOUGH_USAGE Подписка используется недостаточно.
CANCEL_SURVEY_REASON_TECHNICAL_ISSUES Технические проблемы при использовании приложения.
CANCEL_SURVEY_REASON_FOUND_BETTER_APP Пользователь нашел более подходящее приложение.
CANCEL_SURVEY_REASON_OTHERS Другие причины.

SystemInitiatedCancellation

У этого типа нет полей.

Информация об отмене, инициированной системой Google.

DeveloperInitiatedCancellation

У этого типа нет полей.

Информация об отменах, инициированных разработчиками.

ReplacementCancellation

У этого типа нет полей.

Информация об отменах, вызванных заменой подписки.

TestPurchase

У этого типа нет полей.

Является ли покупка подписки тестовой.

AcknowledgementState

Возможные статусы подтверждения подписки.

Перечисления
ACKNOWLEDGEMENT_STATE_UNSPECIFIED Статус подтверждения не указан.
ACKNOWLEDGEMENT_STATE_PENDING Подписка ещё не подтверждена.
ACKNOWLEDGEMENT_STATE_ACKNOWLEDGED Подписка подтверждена.

ExternalAccountIdentifiers

Идентификатор аккаунта пользователя в стороннем сервисе.

JSON-представление
{
  "externalAccountId": string,
  "obfuscatedExternalAccountId": string,
  "obfuscatedExternalProfileId": string
}
Поля
externalAccountId

string

Идентификатор аккаунта пользователя в стороннем сервисе. Присутствует, только если связывание аккаунтов произошло в рамках процесса покупки подписки.

obfuscatedExternalAccountId

string

Замаскированная версия идентификатора, уникально связанного с аккаунтом пользователя в вашем приложении. Присутствует для следующих покупок: * Если связывание аккаунтов произошло в рамках процесса покупки подписки. * Он был указан с помощью https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedaccountid при совершении покупки.

obfuscatedExternalProfileId

string

Замаскированная версия идентификатора, который уникальным образом связан с профилем пользователя в вашем приложении. Присутствует, только если при совершении покупки был указан параметр https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedprofileid.

SubscribeWithGoogleInfo

Информация о покупках, совершенных с помощью сервиса "Подписка через Google".

JSON-представление
{
  "profileId": string,
  "profileName": string,
  "emailAddress": string,
  "givenName": string,
  "familyName": string
}
Поля
profileId

string

Идентификатор профиля Google пользователя, который приобрел подписку.

profileName

string

Имя профиля пользователя на момент покупки подписки.

emailAddress

string

Адрес электронной почты пользователя, который был указан при покупке подписки.

givenName

string

Имя пользователя, указанное при покупке подписки.

familyName

string

Фамилия пользователя на момент покупки подписки.

SubscriptionPurchaseLineItem

Информация о покупке подписки на уровне товара.

JSON-представление
{
  "productId": string,
  "expiryTime": string,
  "developerTargetedOffers": [
    {
      object (DeveloperTargetedOffer)
    }
  ],
  "latestSuccessfulOrderId": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "autoRenewingPlan": {
    object (AutoRenewingPlan)
  },
  "prepaidPlan": {
    object (PrepaidPlan)
  }
  // End of mutually exclusive fields.
  "offerDetails": {
    object (OfferDetails)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "deferredItemReplacement": {
    object (DeferredItemReplacement)
  },
  "deferredItemRemoval": {
    object (DeferredItemRemoval)
  }
  // End of mutually exclusive fields.
  "signupPromotion": {
    object (SignupPromotion)
  },
  "itemReplacement": {
    object (ItemReplacement)
  },
  "offerPhase": {
    object (OfferPhase)
  }
}
Поля
productId

string

Идентификатор купленного товара, например monthly001.

expiryTime

string (Timestamp format)

Время, когда срок действия подписки истек или истечет, если доступ не будет продлен (например, при продлении подписки).

Используется формат RFC 3339. Результат всегда будет Z-нормализованным, и в нем будут использоваться цифры дробных частей 0, 3, 6 или 9. Допустимы и другие типы нормализации. Примеры: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30".

developerTargetedOffers[]

object (DeveloperTargetedOffer)

Необязательное поле. Сведения о предложениях для разработчиков, зарегистрированных для этой позиции.

latestSuccessfulOrderId

string

Идентификатор последнего успешного заказа, связанного с этим товаром. Не указывается, если пользователь ещё не владеет объектом (например, если объект заменяется отложенным).

Тип подписки. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
autoRenewingPlan

object (AutoRenewingPlan)

Объект продлевается автоматически.

prepaidPlan

object (PrepaidPlan)

Товар оплачен заранее.

Конец взаимоисключающих полей.
offerDetails

object (OfferDetails)

Сведения о предложении для этого товара.

Это поле присутствует, если у объекта есть отложенное изменение. Его можно удалить или заменить. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
deferredItemReplacement

object (DeferredItemReplacement)

Информация об отложенной замене товара.

deferredItemRemoval

object (DeferredItemRemoval)

Информация об отложенном удалении объекта.

Конец взаимоисключающих полей.
signupPromotion

object (SignupPromotion)

Информация о промоакции для этого товара. Задается, только если при регистрации была применена промоакция.

itemReplacement

object (ItemReplacement)

Сведения о заменяемом объекте. Это поле заполняется, только если объект заменил другой объект в предыдущей подписке, и доступно только в течение 60 дней после покупки.

offerPhase

object (OfferPhase)

Сведения о текущем периоде специального предложения для этого объекта.

AutoRenewingPlan

Информация о тарифном плане с автоматическим продлением.

JSON-представление
{
  "autoRenewEnabled": boolean,
  "recurringPrice": {
    object (Money)
  },
  "priceChangeDetails": {
    object (SubscriptionItemPriceChangeDetails)
  },
  "installmentDetails": {
    object (InstallmentPlan)
  },
  "planTransitionDetails": {
    object (PlanTransitionDetails)
  },
  "priceStepUpConsentDetails": {
    object (PriceStepUpConsentDetails)
  }
}
Поля
autoRenewEnabled

boolean

Если для подписки настроено автоматическое продление, например пользователь не отменил ее.

recurringPrice

object (Money)

Текущая регулярная цена тарифного плана с автоматическим продлением. Обратите внимание, что цена не учитывает скидки и налоги. Если вам нужны сведения о транзакциях, используйте orders.get API.

priceChangeDetails

object (SubscriptionItemPriceChangeDetails)

Информация о последнем изменении цены на товар с момента оформления подписки.

installmentDetails

object (InstallmentPlan)

Информация об обязательствах и статусе тарифного плана с автоматическим продлением в рассрочку.

planTransitionDetails

object (PlanTransitionDetails)

Информация о связанном переходе на другой тарифный план. Будет присутствовать, только если с этим планом связан план перехода, и будет включать только последние сведения о переходе, связанные с элементом.

SubscriptionItemPriceChangeDetails

Информация об изменении цены на подписку.

JSON-представление
{
  "newPrice": {
    object (Money)
  },
  "priceChangeMode": enum (PriceChangeMode),
  "priceChangeState": enum (PriceChangeState),
  "expectedNewPriceChargeTime": string
}
Поля
newPrice

object (Money)

Новая цена за регулярный платеж по подписке.

priceChangeMode

enum (PriceChangeMode)

Режим изменения цены определяет, как меняется цена на объект подписки.

priceChangeState

enum (PriceChangeState)

Укажите, на каком этапе находится изменение цены.

expectedNewPriceChargeTime

string (Timestamp format)

Время продления, когда изменение цены вступит в силу для пользователя. Время продления может быть перенесено на более поздний срок, например если подписка была приостановлена. Это поле заполняется, только если изменение цены ещё не вступило в силу.

Используется формат RFC 3339. Результат всегда будет Z-нормализованным, и в нем будут использоваться цифры дробных частей 0, 3, 6 или 9. Допустимы и другие типы нормализации. Примеры: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30".

PriceChangeMode

Способ изменения цены.

Перечисления
PRICE_CHANGE_MODE_UNSPECIFIED Режим изменения цены не указан. Это значение не должно быть задано.
PRICE_DECREASE Если цена подписки снижается.
PRICE_INCREASE Если цена подписки повышается и пользователю нужно принять ее.
OPT_OUT_PRICE_INCREASE Если цена подписки повышается без запроса согласия.

PriceChangeState

Статус изменения цены.

Перечисления
PRICE_CHANGE_STATE_UNSPECIFIED Статус изменения цены не указан. Это значение не должно использоваться.
OUTSTANDING Ожидание согласия пользователя на изменение цены.
CONFIRMED Пользователь подтвердил изменение цены.
APPLIED Изменение цены вступило в силу, то есть с пользователя начала списываться новая цена.
CANCELED Изменение цены отменено.

InstallmentPlan

Информация о рассрочке.

JSON-представление
{
  "initialCommittedPaymentsCount": integer,
  "subsequentCommittedPaymentsCount": integer,
  "remainingCommittedPaymentsCount": integer,
  "pendingCancellation": {
    object (PendingCancellation)
  }
}
Поля
initialCommittedPaymentsCount

integer

Общее количество платежей, которые пользователь должен совершить.

subsequentCommittedPaymentsCount

integer

Общее количество платежей, которые пользователь должен будет совершить после каждого минимального срока подписки. Если оставить поле пустым, то после первоначального обязательного периода рассрочка будет заменена на обычную подписку с автоматическим продлением.

remainingCommittedPaymentsCount

integer

Общее количество обязательных платежей, которые осталось внести в текущем цикле продления.

pendingCancellation

object (PendingCancellation)

Если этот параметр указан, значит рассрочка будет отменена. Отмена произойдет только после того, как пользователь внесет все обязательные платежи.

PendingCancellation

У этого типа нет полей.

Указывает, есть ли ожидающая отмена виртуального плана рассрочки. Отмена произойдет только после того, как пользователь внесет все обязательные платежи.

PlanTransitionDetails

Информация о переходе на другой тарифный план.

JSON-представление
{
  "productId": string,
  "basePlanId": string,
  "offerId": string,
  "transitionInfo": {
    object (TransitionInfo)
  }
}
Поля
productId

string

[Обязательно] Идентификатор товара, на который будет осуществлен переход (например, monthly001).

basePlanId

string

[Обязательно] Идентификатор основного плана, на который будет выполнен переход.

offerId

string

Идентификатор предложения. Указывается только для специальных предложений. Это значение задается, только если целевой план не является основным.

transitionInfo

object (TransitionInfo)

Дополнительная информация о запланированном переходе на другой тарифный план. Будет присутствовать, только если запланирован переход на другой план.

TransitionInfo

Информация о запланированном переходе на другой тарифный план.

JSON-представление
{
  "transitionState": enum (TransitionState),
  "price": {
    object (Money)
  },
  "expectedTransitionTime": string
}
Поля
transitionState

enum (TransitionState)

Только для вывода. [Обязательный параметр] Текущий статус перехода.

price

object (Money)

Цена основного плана по умолчанию, на который будет выполнен переход.

expectedTransitionTime

string (Timestamp format)

Текущее ожидаемое время, когда может быть осуществлен переход на план. Это время может измениться, если подписка была приостановлена или аккаунт был временно заблокирован.

Используется формат RFC 3339. Результат всегда будет Z-нормализованным, и в нем будут использоваться цифры дробных частей 0, 3, 6 или 9. Допустимы и другие типы нормализации. Примеры: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30".

TransitionState

Возможные состояния перехода.

Перечисления
TRANSITION_STATE_UNSPECIFIED Неуказанное состояние перехода.
SCHEDULED Переход запланирован на будущее.
IN_PROGRESS Процесс перехода запущен, и пользователю отправлено первое уведомление о переходе.
COMPLETED Переход завершен.
CANCELED Переход был отменен.

PriceStepUpConsentDetails

Информация о повышении цены, требующем согласия пользователя.

JSON-представление
{
  "state": enum (ConsentState),
  "consentDeadlineTime": string,
  "newPrice": {
    object (Money)
  }
}
Поля
state

enum (ConsentState)

Только для вывода. Статус согласия на повышение цены.

consentDeadlineTime

string (Timestamp format)

Крайний срок, до которого пользователь должен дать согласие. Если вы не дадите согласие до этого времени, подписка будет отменена.

Используется формат RFC 3339. Результат всегда будет Z-нормализованным, и в нем будут использоваться цифры дробных частей 0, 3, 6 или 9. Допустимы и другие типы нормализации. Примеры: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30".

newPrice

object (Money)

Новая цена, которая требует согласия пользователя.

ConsentState

Статус согласия на повышение цены.

Перечисления
CONSENT_STATE_UNSPECIFIED Статус согласия не указан.
PENDING Пользователь ещё не дал согласие.
CONFIRMED Пользователь дал согласие, и новая цена скоро вступит в силу.
COMPLETED Пользователь дал согласие, и новая цена вступила в силу.

PrepaidPlan

Информация о тарифном плане с предоплатой.

JSON-представление
{
  "allowExtendAfterTime": string
}
Поля
allowExtendAfterTime

string (Timestamp format)

Если это поле заполнено, то в нем указано время, после которого можно пополнять баланс предоплаченного плана. Недоступно для тарифных планов с предоплатой, срок действия которых истек.

Используется формат RFC 3339. Результат всегда будет Z-нормализованным, и в нем будут использоваться цифры дробных частей 0, 3, 6 или 9. Допустимы и другие типы нормализации. Примеры: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30".

OfferDetails

Информация о предложении, связанная с позицией покупки.

JSON-представление
{
  "offerTags": [
    string
  ],
  "basePlanId": string,
  "offerId": string
}
Поля
offerTags[]

string

Последние теги, связанные со специальным предложением. Включает теги, унаследованные от основного плана.

basePlanId

string

Идентификатор основного плана. Указывается для всех основных планов и специальных предложений.

offerId

string

Идентификатор предложения. Указывается только для специальных предложений.

DeferredItemReplacement

Информация об отложенной замене товара.

JSON-представление
{
  "productId": string
}
Поля
productId

string

Идентификатор товара, который заменит существующий.

DeferredItemRemoval

У этого типа нет полей.

Информация об отложенной замене товара.

SignupPromotion

Промоакция, примененная к этому товару при покупке.

JSON-представление
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "oneTimeCode": {
    object (OneTimeCode)
  },
  "vanityCode": {
    object (VanityCode)
  }
  // End of mutually exclusive fields.
}
Поля
Тип промоакции, примененной к товару. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
oneTimeCode

object (OneTimeCode)

Применен одноразовый код.

vanityCode

object (VanityCode)

Применен код Vanity.

Конец взаимоисключающих полей.

OneTimeCode

У этого типа нет полей.

Одноразовый промокод.

VanityCode

Многоразовый промокод, заданный заранее.

JSON-представление
{
  "promotionCode": string
}
Поля
promotionCode

string

Промокод.

ItemReplacement

Сведения о заменяемой позиции подписки.

JSON-представление
{
  "productId": string,
  "replacementMode": enum (ReplacementMode),
  "basePlanId": string,
  "offerId": string
}
Поля
productId

string

Идентификатор товара заменяемой позиции подписки.

replacementMode

enum (ReplacementMode)

Режим замены, примененный во время покупки.

basePlanId

string

Идентификатор основного плана заменяемой позиции подписки.

offerId

string

Идентификатор предложения, относящегося к заменяемой строке подписки (если применимо).

ReplacementMode

Режим замены подписки.

Перечисления
REPLACEMENT_MODE_UNSPECIFIED Режим замены не указан.
WITH_TIME_PRORATION Стоимость нового тарифного плана будет рассчитана пропорционально и зачислена со старого тарифного плана.
CHARGE_PRORATED_PRICE С пользователя будет списана сумма, пропорциональная остатку текущего платежного цикла.
WITHOUT_PRORATION Новый тарифный план заменит старый без пропорционального пересчета времени.
CHARGE_FULL_PRICE С пользователя будет списана полная стоимость нового плана.
DEFERRED Старый тарифный план будет отменен, а новый начнет действовать после окончания срока действия старого.
KEEP_EXISTING При такой замене тарифный план останется прежним.

OfferPhase

Сведения о периоде специального предложения.

JSON-представление
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "prorationPeriod": {
    object (ProrationPeriodOfferPhase)
  },
  "freeTrial": {
    object (FreeTrialOfferPhase)
  },
  "introductoryPrice": {
    object (IntroductoryPriceOfferPhase)
  },
  "basePrice": {
    object (BasePriceOfferPhase)
  }
  // End of mutually exclusive fields.
}
Поля
Сведения о периоде специального предложения. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
prorationPeriod

object (ProrationPeriodOfferPhase)

Устанавливается, когда этап специального предложения является периодом пропорциональной оплаты.

freeTrial

object (FreeTrialOfferPhase)

Указывается, если этап предложения – бесплатный пробный период.

introductoryPrice

object (IntroductoryPriceOfferPhase)

Указывается, если этап предложения является этапом предложения с начальной ценой.

basePrice

object (BasePriceOfferPhase)

Укажите, когда этап специального предложения является этапом цены основного плана.

Конец взаимоисключающих полей.

ProrationPeriodOfferPhase

Подробная информация о периоде пропорциональной оплаты.

JSON-представление
{
  "originalOfferPhaseType": enum (OriginalOfferPhaseType)
}
Поля
originalOfferPhaseType

enum (OriginalOfferPhaseType)

Тип исходного этапа специального предложения до периода пропорционального распределения. Устанавливается, только когда период пропорционального распределения обновляется из существующего этапа специального предложения.

OriginalOfferPhaseType

Этап исходного предложения, к которому относится платеж, если платеж пропорциональный.

Перечисления
ORIGINAL_OFFER_PHASE_TYPE_UNSPECIFIED Тип этапа исходного специального предложения не указан.
BASE Подписка находится на этапе базовой цены (например, полной цены).
INTRODUCTORY Подписка находится в периоде начальной цены.
FREE_TRIAL Подписка находится в бесплатном пробном периоде.

FreeTrialOfferPhase

У этого типа нет полей.

Сведения о бесплатном пробном периоде.

IntroductoryPriceOfferPhase

У этого типа нет полей.

Подробная информация о этапе специальной цены.

BasePriceOfferPhase

У этого типа нет полей.

Подробная информация об этапе специального предложения с базовой ценой.

DeveloperTargetedOffer

Информация о специальном предложении для разработчиков, связанном со строкой подписки.

JSON-представление
{
  "offerId": string,
  "activateTime": string
}
Поля
offerId

string

Необязательное поле. Идентификатор предложения, созданного разработчиком для подписки.

activateTime

string (Timestamp format)

Необязательное поле. Время, когда был активирован таргетинг предложения.

Используется формат RFC 3339. Результат всегда будет Z-нормализованным, и в нем будут использоваться цифры дробных частей 0, 3, 6 или 9. Допустимы и другие типы нормализации. Примеры: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30".

OutOfAppPurchaseContext

Информация о покупке вне приложения.

JSON-представление
{
  "expiredExternalAccountIdentifiers": {
    object (ExternalAccountIdentifiers)
  },
  "expiredPurchaseToken": string
}
Поля
expiredExternalAccountIdentifiers

object (ExternalAccountIdentifiers)

Идентификатор аккаунта пользователя из последней истекшей подписки для этого SKU.

expiredPurchaseToken

string

Токен покупки последней подписки с истекшим сроком действия. Этот токен можно использовать для идентификации пользователя, только если связь между purchaseToken и пользователем хранится в вашей базе данных. Если с момента окончания срока действия прошло более 60 дней, то вызывать Google Developer API нельзя.

OnHoldStateContext

Дополнительная информация о подписках в статусе ON_HOLD.

JSON-представление
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "renewalDeclined": {
    object (RenewalDeclinedContext)
  }
  // End of mutually exclusive fields.
}
Поля
Причина, по которой подписка находится в состоянии ON_HOLD. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
renewalDeclined

object (RenewalDeclinedContext)

Необязательное поле. Платеж за продление был отклонен.

Конец взаимоисключающих полей.

RenewalDeclinedContext

Контекст, связанный со сценарием отклонения продления.

JSON-представление
{
  "pendingOrderId": string
}
Поля
pendingOrderId

string

Обязательно. Идентификатор заказа, который находится в состоянии ожидания или не был выполнен.

InGracePeriodStateContext

Дополнительная информация о подписках в статусе IN_GRACE_PERIOD.

JSON-представление
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "renewalDeclined": {
    object (RenewalDeclinedContext)
  }
  // End of mutually exclusive fields.
}
Поля
Причина, по которой подписка находится в состоянии IN_GRACE_PERIOD. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
renewalDeclined

object (RenewalDeclinedContext)

Необязательное поле. Платеж за продление был отклонен.

Конец взаимоисключающих полей.

Методы

activateoffertargeting

Активирует таргетинг для определенного предложения.

cancel

Отменить подписку пользователя.

cancelplantransition

Отмена перехода на другой тарифный план для подписки.

deactivateoffertargeting

Отключает таргетинг для определенного предложения.

defer

Откладывает продление подписки.

get

Получение метаданных о подписке

revoke

Отменить покупку подписки для пользователя.

scheduleplantransition

Запланируйте переход на другой тарифный план.

Коды ошибок

Операции этого ресурса возвращают следующие коды ошибок HTTP:

Код ошибки Причина Описание Разрешение
400 / 410 subscriptionExpired Срок действия подписки истек, и запрошенную операцию выполнить нельзя. Проверьте срок действия подписки. Это действие нельзя выполнить для подписок с истекшим сроком действия.
400 subscriptionInvalidArgument В запросе на подписку указан недопустимый аргумент. Изучите документацию по API и убедитесь, что все обязательные поля заполнены и правильно отформатированы.
400 invalidPurchaseState Покупка не находится в состоянии, позволяющем выполнить запрошенную операцию. Например, вы пытаетесь подтвердить уже использованную покупку или отменить неактивную подписку. Прежде чем выполнять операцию, проверьте текущее состояние ресурса с помощью соответствующего API Get. Убедитесь, что ресурс находится в состоянии, подходящем для этого действия.
400 invalidValue В запросе указано недопустимое значение. Обычно это происходит, если токен покупки недействителен или неправильно оформлен. Исправьте недопустимое значение поля в теле запроса или параметрах, следуя инструкциям в документации по API.
400 prepaidSubscriptionNotSupported Запрошенная операция не поддерживается для подписок с предоплатой. Убедитесь, что операция применима к типу подписки. Эта ошибка связана с такими методами, как Cancel.
400 productNotOwnedByUser Указанный токен покупки действителен, но пользователь в настоящее время не владеет продуктом. Это может произойти, если до подтверждения покупки средства за нее были возвращены, она была аннулирована или срок ее действия истек. Прежде чем выполнять операцию, проверьте текущее состояние ресурса с помощью соответствующего API Get. Убедитесь, что ресурс находится в состоянии, подходящем для этого действия.
400 purchaseTokenMismatch Указанный токен покупки не соответствует покупке, названию пакета, идентификатору подписки или идентификатору товара. Убедитесь, что все данные в запросе верны и соответствуют друг другу.
400 required В запросе отсутствует обязательное поле или параметр. Чтобы убедиться, что вы указали все обязательные поля и параметры, изучите документацию API.
400 unsupportedIabType Операция не поддерживается для указанного типа оплаты контента. Убедитесь, что метод API совместим с типом объекта, которым вы управляете.
403 userInsufficientPermission У пользователя недостаточно разрешений для выполнения запрошенной операции. Убедитесь, что у аутентифицированного пользователя есть необходимые разрешения в Google Play Console. Подробнее об использовании сервисного аккаунта…
404 notFound Запрошенный ресурс не найден. Проверьте, правильно ли указаны идентификаторы, например токен покупки, название пакета, идентификатор товара или подписки.
409 concurrentUpdate Попытка обновить объект, который уже обновляется. Повторите запрос с экспоненциальной выдержкой. Не изменяйте один и тот же ресурс одновременно.
410 purchaseTokenNoLongerValid Токен покупки недействителен, поскольку связанный с ним аккаунт пользователя удален или запись о покупке больше не существует. Прекратите использовать этот токен покупки.
410 subscriptionNoLongerAvailable Запрос на покупку подписки больше недоступен, так как срок его действия истек слишком давно. Эта ошибка означает, что срок действия подписки истек более 60 дней назад. Не запрашивайте эти подписки.
5xx Generic error Общая ошибка на сервере Google Play. Повторите запрос.

Если проблема не исчезнет, обратитесь к менеджеру аккаунта Google Play или отправьте запрос в службу поддержки. Проверьте, нет ли известных сбоев, на панели мониторинга доступности Google Play.