type YieldGroup (v202408)
Stay organized with collections
Save and categorize content based on your preferences.
Service
YieldGroupService
- Namespace
-
https://www.google.com/apis/ads/publisher/v202408
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 YieldGroups, which are used to manage ad sources and targeting for yield management.\u003c/p\u003e\n"],["\u003cp\u003eYieldGroups have key properties such as a unique ID, name, exchange status (e.g., active, inactive), ad format (e.g., banner, video), and environment type (e.g., mobile, web).\u003c/p\u003e\n"],["\u003cp\u003eTargeting criteria and specific ad sources can be associated with a YieldGroup to control ad delivery.\u003c/p\u003e\n"],["\u003cp\u003eYieldGroup entities have various states like \u003ccode\u003eACTIVE\u003c/code\u003e, \u003ccode\u003eINACTIVE\u003c/code\u003e, \u003ccode\u003eEXPERIMENTING\u003c/code\u003e, reflecting their operational status within the system.\u003c/p\u003e\n"],["\u003cp\u003eThe service operates within the \u003ccode\u003ehttps://www.google.com/apis/ads/publisher/v202408\u003c/code\u003e namespace, indicating its context within the Ad Manager API.\u003c/p\u003e\n"]]],["The `YieldGroupService` allows for the management of yield groups, specifically through `createYieldGroups()` and `updateYieldGroups()`. Key fields for a `YieldGroup` include `yieldGroupId`, `yieldGroupName`, `exchangeStatus` (with possible values like `ACTIVE` or `DELETED`), `format` (e.g., `BANNER`, `VIDEO_VAST`), `environmentType`(e.g., `MOBILE`, `WEB`), `targeting`, and `adSources`. These fields define the yield group's properties, status, and scope. `YieldGroupPage` is a dependency.\n"],null,["# type YieldGroup (v202408)\n\n**Service** \n**YieldGroupService** **Dependencies** \n[YieldGroupPage](/ad-manager/api/reference/v202408/YieldGroupService.YieldGroupPage) [createYieldGroups()](/ad-manager/api/reference/v202408/YieldGroupService#createYieldGroups) [updateYieldGroups()](/ad-manager/api/reference/v202408/YieldGroupService#updateYieldGroups) \n▼\n**YieldGroup**\n\n*** ** * ** ***\n\nNamespace\n:\n `https://www.google.com/apis/ads/publisher/v202408`\n\n| Field ----- ||\n|-----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ### `yieldGroupId` | ` `xsd:`long` \u003cbr /\u003e |\n| ### `yieldGroupName` | ` `xsd:`string` \u003cbr /\u003e |\n| ### `exchangeStatus` | ` `[YieldEntityStatus](/ad-manager/api/reference/v202408/YieldGroupService.YieldEntityStatus)` ` *** ** * ** *** **Enumerations** `UNKNOWN` : `EXPERIMENTING` : `ACTIVE` : `INACTIVE` : `DELETED` : \u003cbr /\u003e |\n| ### `format` | ` `[YieldFormat](/ad-manager/api/reference/v202408/YieldGroupService.YieldFormat)` ` *** ** * ** *** **Enumerations** `UNKNOWN` : `BANNER` : `INTERSTITIAL` : `NATIVE` : `VIDEO_VAST` : `REWARDED` : `REWARDED_INTERSTITIAL` : `APP_OPEN` : \u003cbr /\u003e |\n| ### `environmentType` | ` `[YieldEnvironmentType](/ad-manager/api/reference/v202408/YieldGroupService.YieldEnvironmentType)` ` *** ** * ** *** **Enumerations** `UNKNOWN` : `MOBILE` : `VIDEO_VAST` : `WEB` : \u003cbr /\u003e |\n| ### `targeting` | ` `[Targeting](/ad-manager/api/reference/v202408/YieldGroupService.Targeting)` ` \u003cbr /\u003e |\n| ### `adSources` | ` `[YieldAdSource](/ad-manager/api/reference/v202408/YieldGroupService.YieldAdSource)`[]` \u003cbr /\u003e |"]]
