type YieldGroup (v202508)
Stay organized with collections
Save and categorize content based on your preferences.
Service
YieldGroupService
A Yield Group represents a segment of inventory and a set of networks to which the inventory is
made available for yield.
- Namespace
-
https://www.google.com/apis/ads/publisher/v202508
Field
|
yieldGroupId
|
xsd:long
The unique ID of the YieldGroup. This attribute is read-only and is assigned by Google.
|
yieldGroupName
|
xsd:string
The display name of the yield group.
|
exchangeStatus
|
YieldEntityStatus
Status of the Ad Exchange on for this yield group. This can be used to create a yield group
with only the Ad Exchange enabled. If there are any active adSources, this must be
ACTIVE.
Enumerations
-
UNKNOWN
-
EXPERIMENTING
-
ACTIVE
-
INACTIVE
-
DELETED
|
|
|
YieldFormat
The format for the group.
Enumerations
-
UNKNOWN
-
BANNER
-
INTERSTITIAL
-
NATIVE
-
VIDEO_VAST
-
REWARDED
-
REWARDED_INTERSTITIAL
-
APP_OPEN
|
environmentType
|
YieldEnvironmentType
The environment type of the group.
Enumerations
-
UNKNOWN
-
MOBILE
-
VIDEO_VAST
-
WEB
|
targeting
|
Targeting
This yield's group targeting. Only the following targeting types are available: TODO: List them
|
adSources
|
YieldAdSource[]
The ad sources belonging to this yield group.
|
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-08-13 UTC.
[null,null,["Last updated 2025-08-13 UTC."],[],[],null,["# type YieldGroup (v202508)\n\n**Service** \n**YieldGroupService** **Dependencies** \n[YieldGroupPage](/ad-manager/api/reference/v202508/YieldGroupService.YieldGroupPage) [createYieldGroups()](/ad-manager/api/reference/v202508/YieldGroupService#createYieldGroups) [updateYieldGroups()](/ad-manager/api/reference/v202508/YieldGroupService#updateYieldGroups) \n▼\n**YieldGroup**\n\nA Yield Group represents a segment of inventory and a set of networks to which the inventory is\nmade available for yield.\n\n*** ** * ** ***\n\nNamespace\n:\n `https://www.google.com/apis/ads/publisher/v202508`\n\n| Field ----- ||\n|-----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ### `yieldGroupId` | ` `xsd:`long` The unique ID of the `YieldGroup`. This attribute is read-only and is assigned by Google. |\n| ### `yieldGroupName` | ` `xsd:`string` The display name of the yield group. |\n| ### `exchangeStatus` | ` `[YieldEntityStatus](/ad-manager/api/reference/v202508/YieldGroupService.YieldEntityStatus)` ` Status of the Ad Exchange on for this yield group. This can be used to create a yield group with only the Ad Exchange enabled. If there are any active `adSources`, this must be `ACTIVE`. *** ** * ** *** **Enumerations** `UNKNOWN` : `EXPERIMENTING` : `ACTIVE` : `INACTIVE` : `DELETED` : \u003cbr /\u003e |\n| ### `format` | ` `[YieldFormat](/ad-manager/api/reference/v202508/YieldGroupService.YieldFormat)` ` The format for the group. *** ** * ** *** **Enumerations** `UNKNOWN` : `BANNER` : `INTERSTITIAL` : `NATIVE` : `VIDEO_VAST` : `REWARDED` : `REWARDED_INTERSTITIAL` : `APP_OPEN` : \u003cbr /\u003e |\n| ### `environmentType` | ` `[YieldEnvironmentType](/ad-manager/api/reference/v202508/YieldGroupService.YieldEnvironmentType)` ` The environment type of the group. *** ** * ** *** **Enumerations** `UNKNOWN` : `MOBILE` : `VIDEO_VAST` : `WEB` : \u003cbr /\u003e |\n| ### `targeting` | ` `[Targeting](/ad-manager/api/reference/v202508/YieldGroupService.Targeting)` ` This yield's group targeting. Only the following targeting types are available: TODO: List them |\n| ### `adSources` | ` `[YieldAdSource](/ad-manager/api/reference/v202508/YieldGroupService.YieldAdSource)`[]` The ad sources belonging to this yield group. |"]]
