Method: accounts.generatedImages.generateProductImageBackground
Stay organized with collections
Save and categorize content based on your preferences.
generatedImages.generateProductImageBackground generates a new image where the background of the original image is replaced by an AI generated scene based on provided product information and a text prompt.
HTTP request
POST https://merchantapi.googleapis.com/productstudio/v1alpha/{name=accounts/*}/generatedImages:generateProductImageBackground
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
Required. The account for which to generate an image. This acts as a container for the request and does not affect the generation itself. Format: accounts/{account}
|
Request body
The request body contains data with the following structure:
| Fields |
outputConfig |
object (OutputImageConfig)
Optional. Configuration for how the output image should be returned.
|
inputImage |
object (InputImage)
Required. The input image.
|
config |
object (GenerateImageBackgroundConfig)
Required. Configuration parameters for the generation of the background.
|
Response body
Response message for the generatedImages.generateProductImageBackground method.
If successful, the response body contains data with the following structure:
| Fields |
generatedImage |
object (GeneratedImage)
The generated output image.
|
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/content
For more information, see the OAuth 2.0 Overview.
GenerateImageBackgroundConfig
Client provided input configuration for generating the background.
| JSON representation |
{
"productDescription": string,
"backgroundDescription": string
} |
| Fields |
productDescription |
string
Required. Example: "Hat on a baseball field" "Hat" = product description Description of product.
|
backgroundDescription |
string
Required. Example: "Hat on a baseball field" "on a baseball field" = background description Description of wanted background.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-08 UTC.
[null,null,["Last updated 2025-07-08 UTC."],[],[],null,["# Method: accounts.generatedImages.generateProductImageBackground\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n - [JSON representation](#body.GenerateProductImageBackgroundResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [GenerateImageBackgroundConfig](#GenerateImageBackgroundConfig)\n - [JSON representation](#GenerateImageBackgroundConfig.SCHEMA_REPRESENTATION)\n- [Try it!](#try-it)\n\ngeneratedImages.generateProductImageBackground generates a new image where the background of the original image is replaced by an AI generated scene based on provided product information and a text prompt.\n\n### HTTP request\n\n`POST https://merchantapi.googleapis.com/productstudio/v1alpha/{name=accounts/*}/generatedImages:generateProductImageBackground`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Required. The account for which to generate an image. This acts as a container for the request and does not affect the generation itself. Format: accounts/{account} |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"outputConfig\": { object (/merchant/api/reference/rest/productstudio_v1alpha/OutputImageConfig) }, \"inputImage\": { object (/merchant/api/reference/rest/productstudio_v1alpha/accounts.videos#InputImage) }, \"config\": { object (/merchant/api/reference/rest/productstudio_v1alpha/accounts.generatedImages/generateProductImageBackground#GenerateImageBackgroundConfig) } } ``` |\n\n| Fields ||\n|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `outputConfig` | `object (`[OutputImageConfig](/merchant/api/reference/rest/productstudio_v1alpha/OutputImageConfig)`)` Optional. Configuration for how the output image should be returned. |\n| `inputImage` | `object (`[InputImage](/merchant/api/reference/rest/productstudio_v1alpha/accounts.videos#InputImage)`)` Required. The input image. |\n| `config` | `object (`[GenerateImageBackgroundConfig](/merchant/api/reference/rest/productstudio_v1alpha/accounts.generatedImages/generateProductImageBackground#GenerateImageBackgroundConfig)`)` Required. Configuration parameters for the generation of the background. |\n\n### Response body\n\nResponse message for the generatedImages.generateProductImageBackground method.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------|\n| ``` { \"generatedImage\": { object (/merchant/api/reference/rest/productstudio_v1alpha/GeneratedImage) } } ``` |\n\n| Fields ||\n|------------------|------------------------------------------------------------------------------------------------------------------------------|\n| `generatedImage` | `object (`[GeneratedImage](/merchant/api/reference/rest/productstudio_v1alpha/GeneratedImage)`)` The generated output image. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/content`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2).\n\nGenerateImageBackgroundConfig\n-----------------------------\n\nClient provided input configuration for generating the background.\n\n| JSON representation |\n|---------------------------------------------------------------------------|\n| ``` { \"productDescription\": string, \"backgroundDescription\": string } ``` |\n\n| Fields ||\n|-------------------------|----------------------------------------------------------------------------------------------------------------------------------------|\n| `productDescription` | `string` Required. Example: \"Hat on a baseball field\" \"Hat\" = product description Description of product. |\n| `backgroundDescription` | `string` Required. Example: \"Hat on a baseball field\" \"on a baseball field\" = background description Description of wanted background. |"]]
