type YieldGroup (v202411)
Stay organized with collections
Save and categorize content based on your preferences.
Service
YieldGroupService
- Namespace
-
https://www.google.com/apis/ads/publisher/v202411
Field
|
yieldGroupId
|
xsd:long
|
yieldGroupName
|
xsd:string
|
exchangeStatus
|
YieldEntityStatus
Enumerations
-
UNKNOWN
-
EXPERIMENTING
-
ACTIVE
-
INACTIVE
-
DELETED
|
|
|
YieldFormat
Enumerations
-
UNKNOWN
-
BANNER
-
INTERSTITIAL
-
NATIVE
-
VIDEO_VAST
-
REWARDED
-
REWARDED_INTERSTITIAL
-
APP_OPEN
|
environmentType
|
YieldEnvironmentType
Enumerations
-
UNKNOWN
-
MOBILE
-
VIDEO_VAST
-
WEB
|
targeting
|
Targeting
|
adSources
|
YieldAdSource[]
|
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-06 UTC.
[null,null,["Last updated 2025-08-06 UTC."],[[["\u003cp\u003eThe YieldGroupService allows for the creation and updating of yield groups, which are used to manage and optimize ad inventory.\u003c/p\u003e\n"],["\u003cp\u003eYield groups have several key properties, including a unique ID, name, exchange status, ad format, environment type, targeting criteria, and associated ad sources.\u003c/p\u003e\n"],["\u003cp\u003eThe exchange status of a yield group indicates its operational state, such as active, inactive, or experimenting.\u003c/p\u003e\n"],["\u003cp\u003eTargeting parameters can be defined for yield groups to control which ad requests they are eligible for.\u003c/p\u003e\n"],["\u003cp\u003eAd sources can be linked to yield groups, enabling the integration of various ad networks and platforms for monetization.\u003c/p\u003e\n"]]],["The `YieldGroupService` allows for the management of yield groups, which have dependencies like `YieldGroupPage`. Key actions include `createYieldGroups()` and `updateYieldGroups()`. A yield group has attributes like `yieldGroupId`, `yieldGroupName`, `exchangeStatus`, `format`, `environmentType`, `targeting`, and `adSources`. These attributes utilize enumerations such as `YieldEntityStatus` (e.g., `ACTIVE`, `INACTIVE`), `YieldFormat`(e.g., `BANNER`, `VIDEO_VAST`) and `YieldEnvironmentType`(e.g., `MOBILE`, `WEB`).\n"],null,["# type YieldGroup (v202411)\n\n**Service** \n**YieldGroupService** **Dependencies** \n[YieldGroupPage](/ad-manager/api/reference/v202411/YieldGroupService.YieldGroupPage) [createYieldGroups()](/ad-manager/api/reference/v202411/YieldGroupService#createYieldGroups) [updateYieldGroups()](/ad-manager/api/reference/v202411/YieldGroupService#updateYieldGroups) \n▼\n**YieldGroup**\n\n*** ** * ** ***\n\nNamespace\n:\n `https://www.google.com/apis/ads/publisher/v202411`\n\n| Field ----- ||\n|-----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ### `yieldGroupId` | ` `xsd:`long` \u003cbr /\u003e |\n| ### `yieldGroupName` | ` `xsd:`string` \u003cbr /\u003e |\n| ### `exchangeStatus` | ` `[YieldEntityStatus](/ad-manager/api/reference/v202411/YieldGroupService.YieldEntityStatus)` ` *** ** * ** *** **Enumerations** `UNKNOWN` : `EXPERIMENTING` : `ACTIVE` : `INACTIVE` : `DELETED` : \u003cbr /\u003e |\n| ### `format` | ` `[YieldFormat](/ad-manager/api/reference/v202411/YieldGroupService.YieldFormat)` ` *** ** * ** *** **Enumerations** `UNKNOWN` : `BANNER` : `INTERSTITIAL` : `NATIVE` : `VIDEO_VAST` : `REWARDED` : `REWARDED_INTERSTITIAL` : `APP_OPEN` : \u003cbr /\u003e |\n| ### `environmentType` | ` `[YieldEnvironmentType](/ad-manager/api/reference/v202411/YieldGroupService.YieldEnvironmentType)` ` *** ** * ** *** **Enumerations** `UNKNOWN` : `MOBILE` : `VIDEO_VAST` : `WEB` : \u003cbr /\u003e |\n| ### `targeting` | ` `[Targeting](/ad-manager/api/reference/v202411/YieldGroupService.Targeting)` ` \u003cbr /\u003e |\n| ### `adSources` | ` `[YieldAdSource](/ad-manager/api/reference/v202411/YieldGroupService.YieldAdSource)`[]` \u003cbr /\u003e |"]]
