Method: monetization.onetimeproducts.purchaseOptions.offers.list
コレクションでコンテンツを整理
必要に応じて、コンテンツの保存と分類を行います。
特定のアプリ、アイテム、または購入オプションの全特典のリストを作成します。
HTTP リクエスト
GET https://androidpublisher.googleapis.com/androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions/{purchaseOptionId}/offers
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ |
packageName |
string
必須。特典を読み取る対象の親アプリ(パッケージ名)。
|
productId |
string
必須。特典を読み取る対象の 1 回限りの親アイテム(ID)。アプリのすべての特典を読み取る場合は「-」を指定できます。
|
purchaseOptionId |
string
必須。特典を読み取る対象の親購入オプション(ID)。1 回限りのアイテムまたはアプリのすべての特典を読み取る場合は「-」を指定できます。productId に「-」が指定されている場合は「-」を指定しなければなりません。
|
クエリ パラメータ
パラメータ |
pageSize |
integer
省略可。返す特典の最大数。サービスが返す値はこれよりも少ないことがあります。指定されていない場合は、最大で 50 件の特典が返されます。最大値は 1,000 です。1,000 を超える値は 1,000 に強制変換されます。
|
pageToken |
string
省略可。前回の ListOneTimeProductsOffers 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。 ページネーションを行う場合、ListOneTimeProductsOffersRequest に指定する productId、packageName、purchaseOptionId は、ページトークンを受け取った呼び出しと一致している必要があります。
|
リクエストの本文
リクエストの本文は空にする必要があります。
レスポンスの本文
offers.list のレスポンス メッセージ。
成功した場合、レスポンスの本文には次の構造のデータが含まれます。
JSON 表現 |
{
"oneTimeProductOffers": [
{
object (OneTimeProductOffer )
}
],
"nextPageToken": string
} |
フィールド |
oneTimeProductOffers[] |
object (OneTimeProductOffer )
指定されたリクエストの oneTimeProduct 特典。
|
nextPageToken |
string
次のページを取得するために pageToken として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。
|
認可スコープ
次の OAuth スコープが必要です。
https://www.googleapis.com/auth/androidpublisher
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。コードサンプルは Apache 2.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2025-07-26 UTC。
[null,null,["最終更新日 2025-07-26 UTC。"],[],[],null,["# Method: monetization.onetimeproducts.purchaseOptions.offers.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListOneTimeProductOffersResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists all offers under a given app, product, or purchase option.\n\n### HTTP request\n\n`GET https://androidpublisher.googleapis.com/androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions/{purchaseOptionId}/offers`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `packageName` | `string` Required. The parent app (package name) for which the offers should be read. |\n| `productId` | `string` Required. The parent one-time product (ID) for which the offers should be read. May be specified as '-' to read all offers under an app. |\n| `purchaseOptionId` | `string` Required. The parent purchase option (ID) for which the offers should be read. May be specified as '-' to read all offers under a one-time product or an app. Must be specified as '-' if productId is specified as '-'. |\n\n### Query parameters\n\n| Parameters ||\n|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` Optional. The maximum number of offers to return. The service may return fewer than this value. If unspecified, at most 50 offers will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |\n| `pageToken` | `string` Optional. A page token, received from a previous `ListOneTimeProductsOffers` call. Provide this to retrieve the subsequent page. When paginating, productId, packageName and purchaseOptionId provided to `ListOneTimeProductsOffersRequest` must match the call that provided the page token. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message for offers.list.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"oneTimeProductOffers\": [ { object (/android-publisher/api-ref/rest/v3/monetization.onetimeproducts.purchaseOptions.offers#OneTimeProductOffer) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|--------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `oneTimeProductOffers[]` | `object (`[OneTimeProductOffer](/android-publisher/api-ref/rest/v3/monetization.onetimeproducts.purchaseOptions.offers#OneTimeProductOffer)`)` The oneTimeProduct offers from the specified request. |\n| `nextPageToken` | `string` A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted, there are no subsequent pages. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/androidpublisher`"]]