Looking for a REST API? The Ad Manager API (Beta) is now available.

YieldGroupService (v202411)

AI-generated Key Takeaways

The YieldGroupService provides operations for managing yield groups and retrieving yield partners.
You can create, retrieve, and update yield groups using this service.
The service defines various errors that can occur during operations, covering aspects like authentication, targeting, and internal issues.
The namespace for this service is https://www.google.com/apis/ads/publisher/v202411.

Production WSDL


                  https://ads.google.com/apis/ads/publisher/v202411/YieldGroupService?wsdl

Namespace

https://www.google.com/apis/ads/publisher/v202411

Operations

createYieldGroups
getYieldGroupsByStatement
getYieldPartners
updateYieldGroups

Errors

ApiVersionError
AuthenticationError
CollectionSizeError
CommonError
CustomTargetingError
DateTimeRangeTargetingError
DayPartTargetingError
DistinctError
EntityChildrenLimitReachedError
EntityLimitReachedError
FeatureError
GenericTargetingError
GeoTargetingError
IdError
InternalApiError
InvalidUrlError
InventoryTargetingError
MobileApplicationTargetingError
NotNullError
ParseError
PermissionError
PublisherQueryLanguageContextError
PublisherQueryLanguageSyntaxError
QuotaError
RequestPlatformTargetingError
RequiredCollectionError
RequiredError
RequiredNumberError
ServerError
StatementError
StringFormatError
StringLengthError
TechnologyTargetingError
UniqueError
UserDomainTargetingError
VideoPositionTargetingError
YieldError

createYieldGroups

Creates yield groups in bulk.

Parameters

Field	Type	Description
`yieldGroups`	`YieldGroup[]`

Response

Field	Type	Description
`rval`	`YieldGroup[]`

getYieldGroupsByStatement

Gets a page of yield groups, with child tags, filtered by the given statement.

Parameters

Field	Type	Description
`statement`	`Statement`

Response

Field	Type	Description
`rval`	`YieldGroupPage`

getYieldPartners

Returns the available partners for yield groups, each one of them is backed by a company.

Parameters

Field	Type	Description

Response

Field	Type	Description
`rval`	`YieldPartner[]`

updateYieldGroups

Updates a list of yield groups.

Parameters

Field	Type	Description
`yieldGroups`	`YieldGroup[]`

Response

Field	Type	Description
`rval`	`YieldGroup[]`

Errors

Error	Reasons
`ApiVersionError`	Enumerations `UPDATE_TO_NEWER_VERSION` `UNKNOWN`
`AuthenticationError`	Enumerations `AMBIGUOUS_SOAP_REQUEST_HEADER` `INVALID_EMAIL` `AUTHENTICATION_FAILED` `INVALID_OAUTH_SIGNATURE` `INVALID_SERVICE` `MISSING_SOAP_REQUEST_HEADER` `MISSING_AUTHENTICATION_HTTP_HEADER` `MISSING_AUTHENTICATION` `NETWORK_API_ACCESS_DISABLED` `NO_NETWORKS_TO_ACCESS` `NETWORK_NOT_FOUND` `NETWORK_CODE_REQUIRED` `CONNECTION_ERROR` `GOOGLE_ACCOUNT_ALREADY_ASSOCIATED_WITH_NETWORK` `UNDER_INVESTIGATION` `UNKNOWN`
`CollectionSizeError`	Enumerations `TOO_LARGE` `UNKNOWN`
`CommonError`	Enumerations `NOT_FOUND` `ALREADY_EXISTS` `NOT_APPLICABLE` `DUPLICATE_OBJECT` `CANNOT_UPDATE` `UNSUPPORTED_OPERATION` `CONCURRENT_MODIFICATION` `UNKNOWN`
`CustomTargetingError`	Enumerations `KEY_NOT_FOUND` `KEY_COUNT_TOO_LARGE` `KEY_NAME_DUPLICATE` `KEY_NAME_EMPTY` `KEY_NAME_INVALID_LENGTH` `KEY_NAME_INVALID_CHARS` `KEY_NAME_RESERVED` `KEY_DISPLAY_NAME_INVALID_LENGTH` `KEY_STATUS_NOT_ACTIVE` `VALUE_NOT_FOUND` `GET_VALUES_BY_STATEMENT_MUST_CONTAIN_KEY_ID` `VALUE_COUNT_FOR_KEY_TOO_LARGE` `VALUE_NAME_DUPLICATE` `VALUE_NAME_EMPTY` `VALUE_NAME_INVALID_LENGTH` `VALUE_NAME_INVALID_CHARS` `VALUE_DISPLAY_NAME_INVALID_LENGTH` `VALUE_MATCH_TYPE_NOT_ALLOWED` `VALUE_MATCH_TYPE_NOT_EXACT_FOR_PREDEFINED_KEY` `SUFFIX_MATCH_TYPE_NOT_ALLOWED` `CONTAINS_MATCH_TYPE_NOT_ALLOWED` `VALUE_STATUS_NOT_ACTIVE` `KEY_WITH_MISSING_VALUES` `INVALID_VALUE_FOR_KEY` `CANNOT_OR_DIFFERENT_KEYS` `INVALID_TARGETING_EXPRESSION` `DELETED_KEY_CANNOT_BE_USED_FOR_TARGETING` `DELETED_VALUE_CANNOT_BE_USED_FOR_TARGETING` `VIDEO_BROWSE_BY_KEY_CANNOT_BE_USED_FOR_CUSTOM_TARGETING` `CANNOT_DELETE_CUSTOM_KEY_USED_IN_PARTNER_ASSIGNMENT_TARGETING` `CANNOT_DELETE_CUSTOM_VALUE_USED_IN_PARTNER_ASSIGNMENT_TARGETING` `CANNOT_TARGET_AUDIENCE_SEGMENT` `CANNOT_TARGET_THIRD_PARTY_AUDIENCE_SEGMENT` `CANNOT_TARGET_INACTIVE_AUDIENCE_SEGMENT` `INVALID_AUDIENCE_SEGMENTS` `CANNOT_TARGET_MAPPED_METADATA` `ONLY_APPROVED_AUDIENCE_SEGMENTS_CAN_BE_TARGETED` `UNKNOWN`
`DateTimeRangeTargetingError`	Enumerations `EMPTY_RANGES` `NOT_SPONSORSHIP_LINEITEM` `NOT_SPONSORSHIP_OR_STANDARD_LINEITEM` `UNSUPPORTED_LINEITEM_RESERVATION_TYPE` `PAST_RANGES_CHANGED` `RANGES_OVERLAP` `FIRST_DATE_TIME_DOES_NOT_MATCH_START_TIME` `LAST_DATE_TIME_DOES_NOT_MATCH_END_TIME` `RANGES_OUT_OF_LINEITEM_ACTIVE_PERIOD` `START_TIME_IS_NOT_START_OF_DAY` `END_TIME_IS_NOT_END_OF_DAY` `START_DATE_TIME_IS_IN_PAST` `MODIFY_START_DATE_TIME_TO_PAST` `RANGE_END_TIME_BEFORE_START_TIME` `END_DATE_TIME_IS_TOO_LATE` `LIMITED_RANGES_IN_UNLIMITED_LINEITEM` `UNKNOWN`
`DayPartTargetingError`	Enumerations `INVALID_HOUR` `INVALID_MINUTE` `END_TIME_NOT_AFTER_START_TIME` `TIME_PERIODS_OVERLAP` `UNKNOWN`
`DistinctError`	Enumerations `DUPLICATE_ELEMENT` `DUPLICATE_TYPE`
`EntityChildrenLimitReachedError`	Enumerations `LINE_ITEM_LIMIT_FOR_ORDER_REACHED` `CREATIVE_ASSOCIATION_LIMIT_FOR_LINE_ITEM_REACHED` `AD_UNIT_LIMIT_FOR_PLACEMENT_REACHED` `TARGETING_EXPRESSION_LIMIT_FOR_LINE_ITEM_REACHED` `TARGETING_EXPRESSION_SIZE_LIMIT_REACHED` `CUSTOM_TARGETING_VALUES_FOR_KEY_LIMIT_REACHED` `TARGETING_EXPRESSION_LIMIT_FOR_CREATIVES_ON_LINE_ITEM_REACHED` `ATTACHMENT_LIMIT_FOR_PROPOSAL_REACHED` `PROPOSAL_LINE_ITEM_LIMIT_FOR_PROPOSAL_REACHED` `PRODUCT_LIMIT_FOR_PRODUCT_PACKAGE_REACHED` `PRODUCT_TEMPLATE_AND_PRODUCT_BASE_RATE_LIMIT_FOR_RATE_CARD_REACHED` `PRODUCT_PACKAGE_ITEM_BASE_RATE_LIMIT_FOR_RATE_CARD_REACHED` `PREMIUM_LIMIT_FOR_RATE_CARD_REACHED` `AD_UNIT_LIMIT_FOR_AD_EXCLUSION_RULE_TARGETING_REACHED` `NATIVE_STYLE_LIMIT_FOR_NATIVE_AD_FORMAT_REACHED` `TARGETING_EXPRESSION_LIMIT_FOR_PRESENTATION_ASSIGNMENT_REACHED` `UNKNOWN`
`EntityLimitReachedError`	Enumerations `CUSTOM_TARGETING_VALUES_LIMIT_REACHED` `AD_EXCLUSION_RULES_LIMIT_REACHED` `FIRST_PARTY_AUDIENCE_SEGMENTS_LIMIT_REACHED` `PLACEMENTS_LIMIT_REACHED` `LINE_ITEMS_LIMIT_REACHED` `ACTIVE_LINE_ITEMS_LIMIT_REACHED` `DAI_ENCODING_PROFILES_LIMIT_REACHED` `TRAFFIC_FORECAST_SEGMENTS_LIMIT_REACHED` `FORECAST_ADJUSTMENTS_LIMIT_REACHED` `ACTIVE_EXPERIMENTS_LIMIT_REACHED` `SITES_LIMIT_REACHED` `USER_TEAMS_LIMIT_REACHED` `UNKNOWN`
`FeatureError`	Enumerations `MISSING_FEATURE` `UNKNOWN`
`GenericTargetingError`	Enumerations `CONFLICTING_INCLUSION_OR_EXCLUSION_OF_SIBLINGS` `INCLUDING_DESCENDANTS_OF_EXCLUDED_CRITERIA` `UNKNOWN`
`GeoTargetingError`	Enumerations `TARGETED_LOCATIONS_NOT_EXCLUDABLE` `EXCLUDED_LOCATIONS_CANNOT_HAVE_CHILDREN_TARGETED` `POSTAL_CODES_CANNOT_BE_EXCLUDED` `UNTARGETABLE_LOCATION` `UNKNOWN`
`IdError`	Enumerations `NOT_FOUND`
`InternalApiError`	Enumerations `UNEXPECTED_INTERNAL_API_ERROR` `TRANSIENT_ERROR` `UNKNOWN` `DOWNTIME` `ERROR_GENERATING_RESPONSE`
`InvalidUrlError`	Enumerations `ILLEGAL_CHARACTERS` `INVALID_FORMAT` `INSECURE_SCHEME` `NO_SCHEME` `UNKNOWN`
`InventoryTargetingError`	Enumerations `AT_LEAST_ONE_PLACEMENT_OR_INVENTORY_UNIT_REQUIRED` `INVENTORY_CANNOT_BE_TARGETED_AND_EXCLUDED` `INVENTORY_UNIT_CANNOT_BE_TARGETED_IF_ANCESTOR_IS_TARGETED` `INVENTORY_UNIT_CANNOT_BE_TARGETED_IF_ANCESTOR_IS_EXCLUDED` `INVENTORY_UNIT_CANNOT_BE_EXCLUDED_IF_ANCESTOR_IS_EXCLUDED` `EXPLICITLY_TARGETED_INVENTORY_UNIT_CANNOT_BE_TARGETED` `EXPLICITLY_TARGETED_INVENTORY_UNIT_CANNOT_BE_EXCLUDED` `SELF_ONLY_INVENTORY_UNIT_NOT_ALLOWED` `SELF_ONLY_INVENTORY_UNIT_WITHOUT_DESCENDANTS` `YOUTUBE_AUDIENCE_SEGMENTS_CAN_ONLY_BE_TARGETED_WITH_YOUTUBE_SHARED_INVENTORY` `UNKNOWN`
`MobileApplicationTargetingError`	Enumerations `CANNOT_TARGET_UNLINKED_APPLICATION` `UNKNOWN`
`NotNullError`	Enumerations `ARG1_NULL` `ARG2_NULL` `ARG3_NULL` `NULL` `UNKNOWN`
`ParseError`	Enumerations `UNPARSABLE` `UNKNOWN`
`PermissionError`	Enumerations `PERMISSION_DENIED` `UNKNOWN`
`PublisherQueryLanguageContextError`	Enumerations `UNEXECUTABLE` `UNKNOWN`
`PublisherQueryLanguageSyntaxError`	Enumerations `UNPARSABLE` `UNKNOWN`
`QuotaError`	Enumerations `EXCEEDED_QUOTA` `UNKNOWN` `REPORT_JOB_LIMIT` `SEGMENT_POPULATION_LIMIT`
`RequestPlatformTargetingError`	Enumerations `REQUEST_PLATFORM_TYPE_NOT_SUPPORTED_BY_LINE_ITEM_TYPE` `REQUEST_PLATFORM_TYPE_NOT_SUPPORTED_BY_ENVIRONMENT_TYPE` `UNKNOWN`
`RequiredCollectionError`	Enumerations `REQUIRED` `TOO_LARGE` `TOO_SMALL` `UNKNOWN`
`RequiredError`	Enumerations `REQUIRED`
`RequiredNumberError`	Enumerations `REQUIRED` `TOO_LARGE` `TOO_SMALL` `TOO_LARGE_WITH_DETAILS` `TOO_SMALL_WITH_DETAILS` `UNKNOWN`
`ServerError`	Enumerations `SERVER_ERROR` `SERVER_BUSY` `UNKNOWN`
`StatementError`	Enumerations `VARIABLE_NOT_BOUND_TO_VALUE` `UNKNOWN`
`StringFormatError`	Enumerations `UNKNOWN` `ILLEGAL_CHARS` `INVALID_FORMAT`
`StringLengthError`	Enumerations `TOO_LONG` `TOO_SHORT` `UNKNOWN`
`TechnologyTargetingError`	Enumerations `MOBILE_LINE_ITEM_CONTAINS_WEB_TECH_CRITERIA` `WEB_LINE_ITEM_CONTAINS_MOBILE_TECH_CRITERIA` `MOBILE_CARRIER_TARGETING_FEATURE_NOT_ENABLED` `DEVICE_CAPABILITY_TARGETING_FEATURE_NOT_ENABLED` `UNKNOWN`
`UniqueError`
`UserDomainTargetingError`	Enumerations `INVALID_DOMAIN_NAMES` `UNKNOWN`
`VideoPositionTargetingError`	Enumerations `CANNOT_MIX_BUMPER_AND_NON_BUMPER_TARGETING` `INVALID_BUMPER_TARGETING` `CAN_ONLY_TARGET_CUSTOM_AD_SPOTS` `UNKNOWN`
`YieldError`	Enumerations `INVALID_BACKEND_DATA` `INVALID_REQUEST_DATA` `AD_SOURCE_COMPANY_CHANGE` `UNSUPPORTED_COMPANY_INTEGRATION_TYPE` `UNSUPPORTED_BUYER_SETTINGS` `DEPRECATED_AD_NETWORK_ADAPTER` `TOO_MANY_UPDATES` `DUPLICATE_YIELD_PARTNER` `DUPLICATE_HEADER_BIDDER` `INTERNAL_ERROR` `INVALID_EXCHANGE_STATUS` `INVALID_AD_SOURCE_STATUS` `INVALID_SDK_ADAPTER_KEY_NAME` `INVENTORY_UNIT_MAPPING_NOT_FOUND` `NO_COMPANIES_PERMISSION` `INVENTORY_UNIT_MAPPING_INVALID_PARAMETER` `UNSUPPORTED_FORMAT_AND_ENVIRONMENT` `UNKNOWN`

YieldGroupService (v202411) Stay organized with collections Save and categorize content based on your preferences.

AI-generated Key Takeaways

createYieldGroups

Parameters

Response

getYieldGroupsByStatement

Parameters

Response

getYieldPartners

Parameters

Response

updateYieldGroups

Parameters

Response

Errors

YieldGroupService (v202411)