- HTTP request
- Path parameters
- Request body
- Response body
- Authorization Scopes
- Preferences
- ReachPlanAdLength
- ProductAllocation
Generates a product mix ideas given a set of preferences. This method helps the advertiser to obtain a good mix of ad formats and budget allocations based on its preferences.
List of thrown errors: AuthenticationError AuthorizationError HeaderError InternalError QuotaError ReachPlanError RequestError
HTTP request
POST https://googleads.googleapis.com/v8/customers/{customerId}:generateProductMixIdeas
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
customerId |
Required. The ID of the customer. |
Request body
The request body contains data with the following structure:
JSON representation | |
---|---|
{
"plannableLocationId": string,
"currencyCode": string,
"budgetMicros": string,
"preferences": {
object ( |
Fields | |
---|---|
plannableLocationId |
Required. The ID of the location, this is one of the ids returned by |
currencyCode |
Required. Currency code. Three-character ISO 4217 currency code. |
budgetMicros |
Required. Total budget. Amount in micros. One million is equivalent to one unit. |
preferences |
The preferences of the suggested product mix. An unset preference is interpreted as all possible values are allowed, unless explicitly specified. |
Response body
If successful, the response body contains data with the following structure:
The suggested product mix.
JSON representation | |
---|---|
{
"productAllocation": [
{
object ( |
Fields | |
---|---|
productAllocation[] |
A list of products (ad formats) and the associated budget allocation idea. |
Authorization Scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/adwords
For more information, see the OAuth 2.0 Overview.
Preferences
Set of preferences about the planned mix.
JSON representation | |
---|---|
{
"adLength": enum ( |
Fields | |
---|---|
adLength |
The length of the ad. If not set, default is any value. |
isSkippable |
True if ad skippable. If not set, default is any value. |
startsWithSound |
True if ad start with sound. If not set, default is any value. |
topContentOnly |
True if ad will only show on the top content. If not set, default is false. |
hasGuaranteedPrice |
True if the price guaranteed. The cost of serving the ad is agreed upfront and not subject to an auction. If not set, default is any value. |
ReachPlanAdLength
Possible ad length values.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
The value is unknown in this version. |
SIX_SECONDS |
6 seconds long ad. |
FIFTEEN_OR_TWENTY_SECONDS |
15 or 20 seconds long ad. |
TWENTY_SECONDS_OR_MORE |
More than 20 seconds long ad. |
ProductAllocation
An allocation of a part of the budget on a given product.
JSON representation | |
---|---|
{ "plannableProductCode": string, "budgetMicros": string } |
Fields | |
---|---|
plannableProductCode |
Selected product for planning. The product codes returned are within the set of the ones returned by v4.listPlannableProducts when using the same location ID. |
budgetMicros |
The value to be allocated for the suggested product in requested currency. Amount in micros. One million is equivalent to one unit. |