|
Ads API .NET library
|
|
Ads API .NET library
|
Namespaces | |
| package | Wrappers |
Classes | |
| class | ApiException |
| Exception class for holding a list of service errors. More... | |
| class | ApiError |
| The API error base class that provides details about an error that occurred while processing a service request. More... | |
| class | FieldPathElement |
| A segment of a field path. Each dot in a field path defines a new segment. More... | |
| class | ApplicationException |
| Base class for exceptions. More... | |
| class | ActivityGroup |
| Activities are organized within activity groups, which are sets of activities that share the same configuration. You create and manage activities from within activity groups. More... | |
| class | UniqueError |
| An error for a field which must satisfy a uniqueness constraint More... | |
| class | StringLengthError |
| Errors for Strings which do not meet given length constraints. More... | |
| class | StringFormatError |
| A list of error code for reporting invalid content of input strings. More... | |
| class | StatementError |
| An error that occurs while parsing Statement objects. More... | |
| class | ServerError |
| Errors related to the server. More... | |
| class | RequiredNumberError |
| A list of all errors to be used in conjunction with required number validators. More... | |
| class | RequiredError |
| Errors due to missing required field. More... | |
| class | RequiredCollectionError |
| A list of all errors to be used for validating sizes of collections. More... | |
| class | RangeError |
| A list of all errors associated with the Range constraint. More... | |
| class | QuotaError |
| Describes a client-side error on which a user is attempting to perform an action to which they have no quota remaining. More... | |
| class | PublisherQueryLanguageSyntaxError |
| An error that occurs while parsing a PQL query contained in a Statement object. More... | |
| class | PublisherQueryLanguageContextError |
| An error that occurs while executing a PQL query contained in a Statement object. More... | |
| class | PermissionError |
| Errors related to incorrect permission. More... | |
| class | ParseError |
| Lists errors related to parsing. More... | |
| class | NotNullError |
| Caused by supplying a null value for an attribute that cannot be null. More... | |
| class | InternalApiError |
| Indicates that a server-side error has occured. More... | |
| class | FeatureError |
| Errors related to feature management. If you attempt using a feature that is not available to the current network you'll receive a FeatureError with the missing feature as the trigger. More... | |
| class | CommonError |
| A place for common errors that can be used across services. More... | |
| class | CollectionSizeError |
| Error for the size of the collection being too large More... | |
| class | AuthenticationError |
| An error for an exception that occurred when authenticating. More... | |
| class | ApiVersionError |
| Errors related to the usage of API versions. More... | |
| class | ActivityError |
| Errors relating to Activity and Activity Group services. More... | |
| class | Statement |
| Captures the More... | |
| class | String_ValueMapEntry |
| This represents an entry in a map with a key of type String and value of type Value. More... | |
| class | Value |
| class | TextValue |
| Contains a string value. More... | |
| class | SetValue |
| Contains a set of Values. May not contain duplicates. More... | |
| class | NumberValue |
| Contains a numeric value. More... | |
| class | DateValue |
| Contains a date value. More... | |
| class | Date |
| Represents a date. More... | |
| class | DateTimeValue |
| Contains a date-time value. More... | |
| class | DateTime |
| Represents a date combined with the time of day. More... | |
| class | BooleanValue |
| Contains a boolean value. More... | |
| class | ObjectValue |
| Contains an object value. More... | |
| class | ActivityGroupPage |
| Captures a page of ActivityGroup objects. More... | |
| interface | ActivityGroupServiceInterfaceChannel |
| interface | ActivityGroupServiceInterface |
| class | ActivityGroupService |
| Provides methods for creating, updating and retrieving ActivityGroup objects. More... | |
| class | BaseCreativeTemplateVariableValue |
| A base class for storing values of the CreativeTemplateVariable. More... | |
| class | UrlCreativeTemplateVariableValue |
| Stores values of CreativeTemplateVariable of VariableType::URL. More... | |
| class | StringCreativeTemplateVariableValue |
| Stores values of CreativeTemplateVariable of VariableType::STRING and VariableType::LIST. More... | |
| class | LongCreativeTemplateVariableValue |
| Stores values of CreativeTemplateVariable of VariableType::LONG. More... | |
| class | AssetCreativeTemplateVariableValue |
| Stores values of CreativeTemplateVariable of VariableType::ASSET. More... | |
| class | CreativeAsset |
| A More... | |
| class | Size |
| Represents the dimensions of an AdUnit, LineItem or Creative. More... | |
| class | ClickTag |
| Click tags define click-through URLs for each exit on an HTML5 creative. An exit is any area that can be clicked that directs the browser to a landing page. Each click tag defines the click-through URL for a different exit. In Ad Manager, tracking pixels are attached to the click tags if URLs are valid. More... | |
| class | CustomCreativeAsset |
| A More... | |
| class | VideoMetadata |
| Metadata for a video asset. More... | |
| class | Asset |
| Base asset properties. More... | |
| class | RedirectAsset |
| An externally hosted asset. More... | |
| class | VideoRedirectAsset |
| An externally-hosted video asset. More... | |
| class | ConversionEvent_TrackingUrlsMapEntry |
| This represents an entry in a map with a key of type ConversionEvent and value of type TrackingUrls. More... | |
| class | RichMediaStudioChildAssetProperty |
| Represents a child asset in More... | |
| class | ThirdPartyDataDeclaration |
| Represents a set of declarations about what (if any) third party companies are associated with a given creative. More... | |
| class | BaseCustomFieldValue |
| The value of a CustomField for a particular entity. More... | |
| class | DropDownCustomFieldValue |
| A CustomFieldValue for a CustomField that has a CustomField::dataType of CustomFieldDataType::DROP_DOWN More... | |
| class | CustomFieldValue |
| The value of a CustomField that does not have a CustomField::dataType of CustomFieldDataType::DROP_DOWN. More... | |
| class | AppliedLabel |
| Represents a Label that can be applied to an entity. To negate an inherited label, create an More... | |
| class | Creative |
| A More... | |
| class | VastRedirectCreative |
| A More... | |
| class | UnsupportedCreative |
| A More... | |
| class | ThirdPartyCreative |
| A More... | |
| class | TemplateCreative |
| A More... | |
| class | ProgrammaticCreative |
| A More... | |
| class | LegacyDfpCreative |
| A More... | |
| class | InternalRedirectCreative |
| A More... | |
| class | Html5Creative |
| A More... | |
| class | HasDestinationUrlCreative |
| A More... | |
| class | CustomCreative |
| A More... | |
| class | BaseVideoCreative |
| A base type for video creatives. More... | |
| class | VideoRedirectCreative |
| A More... | |
| class | VideoCreative |
| A More... | |
| class | SetTopBoxCreative |
| A More... | |
| class | BaseImageRedirectCreative |
| The base type for creatives that load an image asset from a specified URL. More... | |
| class | ImageRedirectOverlayCreative |
| An overlay More... | |
| class | ImageRedirectCreative |
| A More... | |
| class | BaseImageCreative |
| The base type for creatives that display an image. More... | |
| class | ImageOverlayCreative |
| An overlay More... | |
| class | ImageCreative |
| A More... | |
| class | BaseAudioCreative |
| A base type for audio creatives. More... | |
| class | AudioRedirectCreative |
| A More... | |
| class | AudioCreative |
| A More... | |
| class | AspectRatioImageCreative |
| A More... | |
| class | ClickTrackingCreative |
| A creative that is used for tracking clicks on ads that are served directly from the customers' web servers or media servers. NOTE: The size attribute is not used for click tracking creative and it will not be persisted upon save. More... | |
| class | BaseRichMediaStudioCreative |
| A More... | |
| class | RichMediaStudioCreative |
| A More... | |
| class | BaseDynamicAllocationCreative |
| A base class for dynamic allocation creatives. More... | |
| class | HasHtmlSnippetDynamicAllocationCreative |
| Dynamic allocation creative with a backfill code snippet. More... | |
| class | AdSenseCreative |
| An AdSense dynamic allocation creative. More... | |
| class | AdExchangeCreative |
| An Ad Exchange dynamic allocation creative. More... | |
| class | TypeError |
| An error for a field which is an invalid type. More... | |
| class | TranscodingError |
| Errors associated with the video and audio transcoding flow. More... | |
| class | TemplateInstantiatedCreativeError |
| Lists all errors associated with template instantiated creatives. More... | |
| class | SwiffyConversionError |
| Error for converting flash to swiffy asset. More... | |
| class | SetTopBoxCreativeError |
| Errors associated with set-top box creatives. More... | |
| class | RichMediaStudioCreativeError |
| Lists all errors associated with Studio creatives. More... | |
| class | RequiredSizeError |
| A list of all errors to be used for validating Size. More... | |
| class | NullError |
| Caused by supplying a non-null value for an attribute that should be null. More... | |
| class | LineItemCreativeAssociationError |
| Lists all errors associated with line item-to-creative association dates. More... | |
| class | LabelEntityAssociationError |
| Errors specific to creating label entity associations. More... | |
| class | InvalidUrlError |
| Lists all errors associated with URLs. More... | |
| class | InvalidPhoneNumberError |
| Lists all errors associated with phone numbers. More... | |
| class | ImageError |
| Lists all errors associated with images. More... | |
| class | HtmlBundleProcessorError |
| Lists all errors associated with html5 file processing. More... | |
| class | FileError |
| A list of all errors to be used for problems related to files. More... | |
| class | EntityLimitReachedError |
| An error that occurs when creating an entity if the limit on the number of allowed entities for a network has already been reached. More... | |
| class | CustomFieldValueError |
| Errors specific to editing custom field values More... | |
| class | CustomCreativeError |
| Lists all errors associated with custom creatives. More... | |
| class | CreativeTemplateOperationError |
| An error that can occur while performing an operation on a creative template. More... | |
| class | CreativeTemplateError |
| A catch-all error that lists all generic errors associated with CreativeTemplate. More... | |
| class | CreativeSetError |
| Errors relating to creative sets & subclasses. More... | |
| class | CreativeError |
| Lists all errors associated with creatives. More... | |
| class | CreativeAssetMacroError |
| Lists all errors associated with creative asset macros. More... | |
| class | AssetError |
| Lists all errors associated with assets. More... | |
| interface | CreativeServiceInterface |
| class | CreativePage |
| Captures a page of Creative objects. More... | |
| class | CreativeAction |
| Represents the actions that can be performed on Creative objects. More... | |
| class | DeactivateCreatives |
| The action used for deactivating Creative objects. More... | |
| class | ActivateCreatives |
| The action used for activating Creative objects. More... | |
| class | UpdateResult |
| Represents the result of performing an action on objects. More... | |
| interface | CreativeServiceInterfaceChannel |
| class | CreativeService |
| Provides methods for adding, updating and retrieving Creative objects. More... | |
| class | CreativeSet |
| A creative set is comprised of a master creative and its companion creatives. More... | |
| interface | CreativeSetServiceInterface |
| class | CreativeSetPage |
| Captures a page of CreativeSet objects. More... | |
| interface | CreativeSetServiceInterfaceChannel |
| class | CreativeSetService |
| Provides methods for adding, updating and retrieving CreativeSet objects. More... | |
| class | ListStringCreativeTemplateVariableVariableChoice |
| Stores variable choices that users can select from More... | |
| class | CreativeTemplateVariable |
| Represents a variable defined in a creative template. More... | |
| class | UrlCreativeTemplateVariable |
| Represents a url variable defined in a creative template. More... | |
| class | StringCreativeTemplateVariable |
| Represents a string variable defined in a creative template. More... | |
| class | ListStringCreativeTemplateVariable |
| Represents a list variable defined in a creative template. This is similar to StringCreativeTemplateVariable, except that there are possible choices to choose from. More... | |
| class | LongCreativeTemplateVariable |
| Represents a long variable defined in a creative template. More... | |
| class | AssetCreativeTemplateVariable |
| Represents a file asset variable defined in a creative template. More... | |
| class | CreativeTemplate |
| A template upon which a creative can be created. More... | |
| class | CreativeTemplatePage |
| Captures a page of CreativeTemplate objects. More... | |
| interface | CreativeTemplateServiceInterface |
| interface | CreativeTemplateServiceInterfaceChannel |
| class | CreativeTemplateService |
| Provides methods for retrieving CreativeTemplate objects. More... | |
| class | CreativeWrapper |
| A More... | |
| class | LabelError |
| Errors specific to labels. More... | |
| class | CreativeWrapperError |
| Errors specific to creative wrappers. More... | |
| interface | CreativeWrapperServiceInterface |
| class | CreativeWrapperPage |
| Captures a page of CreativeWrapper objects. More... | |
| class | CreativeWrapperAction |
| Represents the actions that can be performed on CreativeWrapper objects. More... | |
| class | DeactivateCreativeWrappers |
| The action used for deactivating CreativeWrapper objects. More... | |
| class | ActivateCreativeWrappers |
| The action used for activating CreativeWrapper objects. More... | |
| interface | CreativeWrapperServiceInterfaceChannel |
| class | CreativeWrapperService |
| Provides methods for the creation and management of creative wrappers. CreativeWrappers allow HTML snippets to be served along with creatives. More... | |
| class | CustomTargetingKey |
| class | EntityChildrenLimitReachedError |
| Lists errors relating to having too many children on an entity. More... | |
| class | CustomTargetingError |
| Lists all errors related to CustomTargetingKey and CustomTargetingValue objects. More... | |
| interface | CustomTargetingServiceInterface |
| class | CustomTargetingValue |
| class | CustomTargetingKeyPage |
| Captures a page of CustomTargetingKey objects. More... | |
| class | CustomTargetingValuePage |
| Captures a page of CustomTargetingValue objects. More... | |
| class | CustomTargetingKeyAction |
| Represents the actions that can be performed on CustomTargetingKey objects. More... | |
| class | DeleteCustomTargetingKeys |
| Represents the delete action that can be performed on CustomTargetingKey objects. Deleting a key will not delete the CustomTargetingValue objects associated with it. Also, if a custom targeting key that has been deleted is recreated, any previous custom targeting values associated with it that were not deleted will continue to exist. More... | |
| class | ActivateCustomTargetingKeys |
| The action used for activating inactive (i.e. deleted) CustomTargetingKey objects. More... | |
| class | CustomTargetingValueAction |
| Represents the actions that can be performed on CustomTargetingValue objects. More... | |
| class | DeleteCustomTargetingValues |
| Represents the delete action that can be performed on CustomTargetingValue objects. More... | |
| class | ActivateCustomTargetingValues |
| The action used for activating inactive (i.e. deleted) CustomTargetingValue objects. More... | |
| interface | CustomTargetingServiceInterfaceChannel |
| class | CustomTargetingService |
| Provides operations for creating, updating and retrieving CustomTargetingKey and CustomTargetingValue objects. More... | |
| class | CustomFieldOption |
| An option represents a permitted value for a custom field that has a CustomField::dataType of CustomFieldDataType::DROP_DOWN. More... | |
| class | CustomFieldError |
| Errors specific to editing custom fields More... | |
| interface | CustomFieldServiceInterface |
| class | CustomField |
| An additional, user-created field on an entity. More... | |
| class | DropDownCustomField |
| A custom field that has the drop-down data type. More... | |
| class | CustomFieldPage |
| Captures a page of CustomField objects. More... | |
| class | CustomFieldAction |
| Represents the actions that can be performed on CustomField objects. More... | |
| class | DeactivateCustomFields |
| The action used for deactivating CustomField objects. More... | |
| class | ActivateCustomFields |
| The action used for activating CustomField objects. More... | |
| interface | CustomFieldServiceInterfaceChannel |
| class | CustomFieldService |
| Provides methods for the creation and management of CustomField objects. More... | |
| class | AlternativeUnitTypeForecast |
| A view of the forecast in terms of an alternative unit type. More... | |
| class | ContendingLineItem |
| Describes contending line items for a Forecast. More... | |
| class | TargetingCriteriaBreakdown |
| A single targeting criteria breakdown result. More... | |
| class | BreakdownForecast |
| Represents a single delivery data point, with both available and forecast number. More... | |
| class | ForecastBreakdownEntry |
| A single forecast breakdown entry. More... | |
| class | ForecastBreakdown |
| Represents the breakdown entries for a list of targetings and/or creatives. More... | |
| class | AvailabilityForecast |
| Describes predicted inventory availability for a ProspectiveLineItem. More... | |
| class | ForecastBreakdownTarget |
| Specifies inventory targeted by a breakdown entry. More... | |
| class | Targeting |
| Contains targeting criteria for LineItem objects. See LineItem::targeting. More... | |
| class | GeoTargeting |
| Provides line items the ability to target geographical locations. By default, line items target all countries and their subdivisions. With geographical targeting, you can target line items to specific countries, regions, metro areas, and cities. You can also exclude the same. More... | |
| class | Location |
| A Location represents a geographical entity that can be targeted. If a location type is not available because of the API version you are using, the location will be represented as just the base class, otherwise it will be sub-classed correctly. More... | |
| class | InventoryTargeting |
| A collection of targeted and excluded ad units and placements. More... | |
| class | AdUnitTargeting |
| Represents targeted or excluded ad units. More... | |
| class | DayPartTargeting |
| Modify the delivery times of line items for particular days of the week. By default, line items are served at all days and times. More... | |
| class | DayPart |
| class | TimeOfDay |
| Represents a specific time in a day. More... | |
| class | DateTimeRange |
| Represents a range of dates (combined with time of day) that has an upper and/or lower bound. More... | |
| class | TechnologyTargeting |
| Provides LineItem objects the ability to target or exclude technologies. More... | |
| class | BandwidthGroupTargeting |
| Represents bandwidth groups that are being targeted or excluded by the LineItem. More... | |
| class | Technology |
| Represents a technology entity that can be targeted. More... | |
| class | OperatingSystemVersion |
| Represents a specific version of an operating system. More... | |
| class | OperatingSystem |
| Represents an Operating System, such as Linux, Mac OS or Windows. More... | |
| class | MobileDeviceSubmodel |
| Represents a mobile device submodel. More... | |
| class | MobileDevice |
| Represents a Mobile Device. More... | |
| class | MobileCarrier |
| Represents a mobile carrier. Carrier targeting is only available to Ad Manager mobile publishers. For a list of current mobile carriers, you can use PublisherQueryLanguageService::mobile_carrier. More... | |
| class | DeviceManufacturer |
| Represents a mobile device's manufacturer. More... | |
| class | DeviceCategory |
| Represents the category of a device. More... | |
| class | DeviceCapability |
| Represents a capability of a physical device. More... | |
| class | BrowserLanguage |
| Represents a Browser's language. More... | |
| class | Browser |
| Represents an internet browser. More... | |
| class | BandwidthGroup |
| Represents a group of bandwidths that are logically organized by some well known generic names such as 'Cable' or 'DSL'. More... | |
| class | BrowserTargeting |
| Represents browsers that are being targeted or excluded by the LineItem. More... | |
| class | BrowserLanguageTargeting |
| Represents browser languages that are being targeted or excluded by the LineItem. More... | |
| class | DeviceCapabilityTargeting |
| Represents device capabilities that are being targeted or excluded by the LineItem. More... | |
| class | DeviceCategoryTargeting |
| Represents device categories that are being targeted or excluded by the LineItem. More... | |
| class | DeviceManufacturerTargeting |
| Represents device manufacturer that are being targeted or excluded by the LineItem. More... | |
| class | MobileCarrierTargeting |
| Represents mobile carriers that are being targeted or excluded by the LineItem. More... | |
| class | MobileDeviceTargeting |
| Represents mobile devices that are being targeted or excluded by the LineItem. More... | |
| class | MobileDeviceSubmodelTargeting |
| Represents mobile devices that are being targeted or excluded by the LineItem. More... | |
| class | OperatingSystemTargeting |
| Represents operating systems that are being targeted or excluded by the LineItem. More... | |
| class | OperatingSystemVersionTargeting |
| Represents operating system versions that are being targeted or excluded by the LineItem. More... | |
| class | CustomCriteriaSet |
| A CustomCriteriaSet comprises of a set of CustomCriteriaNode objects combined by the CustomCriteriaSet.LogicalOperator::logicalOperator. The custom criteria targeting tree is subject to the rules defined on Targeting::customTargeting. More... | |
| class | CustomCriteriaNode |
| A CustomCriteriaNode is a node in the custom targeting tree. A custom criteria node can either be a CustomCriteriaSet (a non-leaf node) or a CustomCriteria (a leaf node). The custom criteria targeting tree is subject to the rules defined on Targeting::customTargeting. More... | |
| class | CustomCriteriaLeaf |
| A CustomCriteriaLeaf object represents a generic leaf of CustomCriteria tree structure. More... | |
| class | AudienceSegmentCriteria |
| An AudienceSegmentCriteria object is used to target AudienceSegment objects. More... | |
| class | CmsMetadataCriteria |
| A More... | |
| class | CustomCriteria |
| A CustomCriteria object is used to perform custom criteria targeting on custom targeting keys of type CustomTargetingKey.Type::PREDEFINED or CustomTargetingKey.Type::FREEFORM. More... | |
| class | UserDomainTargeting |
| Provides line items the ability to target or exclude users visiting their websites from a list of domains or subdomains. More... | |
| class | ContentTargeting |
| Used to target LineItems to specific videos on a publisher's site. More... | |
| class | VideoPositionTargeting |
| Represents positions within and around a video where ads can be targeted to. More... | |
| class | VideoPositionTarget |
| Represents the options for targetable positions within a video. More... | |
| class | VideoPosition |
| Represents a targetable position within a video. A video ad can be targeted to a position (pre-roll, all mid-rolls, or post-roll), or to a specific mid-roll index. More... | |
| class | VideoPositionWithinPod |
| Represents a targetable position within a pod within a video stream. A video ad can be targeted to any position in the pod (first, second, third ... last). If there is only 1 ad in a pod, either first or last will target that position. More... | |
| class | MobileApplicationTargeting |
| Provides line items the ability to target or exclude users' mobile applications. More... | |
| class | BuyerUserListTargeting |
| The More... | |
| class | InventoryUrlTargeting |
| A collection of targeted inventory urls. More... | |
| class | InventoryUrl |
| The representation of an inventory Url that is used in targeting. More... | |
| class | RequestPlatformTargeting |
| Provides line items the ability to target the platform that requests and renders the ad. More... | |
| class | InventorySizeTargeting |
| Represents a collection of targeted and excluded inventory sizes. This is currently only available on YieldGroup and TrafficDataRequest. More... | |
| class | TargetedSize |
| A size that is targeted on a request. More... | |
| class | CreativePlaceholder |
| A More... | |
| class | ForecastBreakdownOptions |
| Configuration of forecast breakdown. More... | |
| class | AvailabilityForecastOptions |
| Forecasting options for line item availability forecasts. More... | |
| class | ProposalLineItemMakegoodInfo |
| Makegood info for a ProposalLineItemDto. More... | |
| class | ProposalLineItem |
| A More... | |
| class | Goal |
| Defines the criteria a LineItem needs to satisfy to meet its delivery goal. More... | |
| class | FrequencyCap |
| Represents a limit on the number of times a single viewer can be exposed to the same LineItem in a specified time period. More... | |
| class | Money |
| Represents a money amount. More... | |
| class | DeliveryIndicator |
| Indicates the delivery performance of the LineItem. More... | |
| class | GrpSettings |
| class | ThirdPartyMeasurementSettings |
| Contains third party auto-pixeling settings for cross-sell Partners. More... | |
| class | CreativeTargeting |
| Represents the creative targeting criteria for a LineItem. More... | |
| class | LineItemDealInfoDto |
| Data transfer object for the exchange deal info of a line item. More... | |
| class | Stats |
| class | LineItemActivityAssociation |
| A More... | |
| class | CustomPacingGoal |
| An interval of a CustomPacingCurve. A custom pacing goal contains a start time and an amount. The goal will apply until either the next custom pacing goal's More... | |
| class | CustomPacingCurve |
| A curve consisting of CustomPacingGoal objects that is used to pace line item delivery. More... | |
| class | LineItemSummary |
| The More... | |
| class | LineItem |
| LineItem is an advertiser's commitment to purchase a specific number of ad impressions, clicks, or time. More... | |
| class | ProspectiveLineItem |
| Represents a prospective line item to be forecasted. More... | |
| class | VideoPositionTargetingError |
| Lists all errors related to VideoPositionTargeting. More... | |
| class | UserDomainTargetingError |
| Lists all errors related to user domain targeting for a line item. More... | |
| class | TimeZoneError |
| Errors related to timezones. More... | |
| class | TechnologyTargetingError |
| Technology targeting validation errors. More... | |
| class | TeamError |
| Errors related to a Team. More... | |
| class | SetTopBoxLineItemError |
| Errors associated with set-top box line items. More... | |
| class | AudienceSegmentError |
| Errors that could occur on audience segment related requests. More... | |
| class | ReservationDetailsError |
| Lists all errors associated with LineItem's reservation details. More... | |
| class | RequestPlatformTargetingError |
| Errors related to request platform targeting. More... | |
| class | RegExError |
| Caused by supplying a value for an object attribute that does not conform to a documented valid regular expression. More... | |
| class | ProgrammaticError |
| Errors associated with programmatic line items. More... | |
| class | OrderError |
| Lists all errors associated with orders. More... | |
| class | OrderActionError |
| Lists all errors associated with performing actions on Order objects. More... | |
| class | MobileApplicationTargetingError |
| Lists all errors related to mobile application targeting for a line item. More... | |
| class | LineItemOperationError |
| Lists all errors for executing operations on line items More... | |
| class | LineItemFlightDateError |
| Lists all errors associated with LineItem start and end dates. More... | |
| class | LineItemError |
| A catch-all error that lists all generic errors associated with LineItem. More... | |
| class | LineItemActivityAssociationError |
| Errors specific to associating activities to line items. More... | |
| class | InventoryUnitError |
| Lists the generic errors associated with AdUnit objects. More... | |
| class | InventoryTargetingError |
| Lists all inventory errors caused by associating a line item with a targeting expression. More... | |
| class | GrpSettingsError |
| Errors associated with line items with GRP settings. More... | |
| class | GeoTargetingError |
| Lists all errors associated with geographical targeting for a LineItem. More... | |
| class | GenericTargetingError |
| Targeting validation errors that can be used by different targeting types. More... | |
| class | FrequencyCapError |
| Lists all errors associated with frequency caps. More... | |
| class | ForecastError |
| Errors that can result from a forecast request. More... | |
| class | DayPartTargetingError |
| Lists all errors associated with day-part targeting for a line item. More... | |
| class | DateTimeRangeTargetingError |
| Lists all date time range errors caused by associating a line item with a targeting expression. More... | |
| class | DateError |
| A list of all errors associated with the dates. More... | |
| class | CurrencyCodeError |
| Errors related to currency codes. More... | |
| class | CrossSellError |
| Lists all errors associated with cross selling. More... | |
| class | CompanyCreditStatusError |
| Lists all errors due to Company::creditStatus. More... | |
| class | ClickTrackingLineItemError |
| Click tracking is a special line item type with a number of unique errors as described below. More... | |
| class | AudienceExtensionError |
| Errors associated with audience extension enabled line items More... | |
| class | AdUnitCodeError |
| Lists the generic errors associated with AdUnit::adUnitCode. More... | |
| interface | ForecastServiceInterface |
| class | DeliveryForecastOptions |
| Forecasting options for line item delivery forecasts. More... | |
| class | DeliveryForecast |
| The forecast of delivery for a list of ProspectiveLineItem objects to be reserved at the same time. More... | |
| class | LineItemDeliveryForecast |
| The forecasted delivery of a ProspectiveLineItem. More... | |
| class | TrafficDataRequest |
| Defines a segment of traffic for which traffic data should be returned. More... | |
| class | DateRange |
| Represents a range of dates that has an upper and a lower bound. More... | |
| class | TrafficDataResponse |
| Contains forecasted and historical traffic volume data describing a segment of traffic. More... | |
| class | TimeSeries |
| Represents a chronological sequence of daily values. More... | |
| interface | ForecastServiceInterfaceChannel |
| class | ForecastService |
| Provides methods for estimating traffic (clicks/impressions) for line items. Forecasts can be provided for LineItem objects that exist in the system or which have not had an ID set yet. More... | |
| class | LabelFrequencyCap |
| A More... | |
| class | AdSenseSettings |
| Contains the AdSense configuration for an AdUnit. More... | |
| class | AdUnitSize |
| An More... | |
| class | AdUnitParent |
| The summary of a parent AdUnit. More... | |
| class | AdUnit |
| An More... | |
| class | InventoryUnitSizesError |
| An error specifically for InventoryUnitSizes. More... | |
| class | InventoryUnitRefreshRateError |
| Lists errors relating to AdUnit::refreshRate. More... | |
| class | InvalidColorError |
| A list of all errors associated with a color attribute. More... | |
| class | CompanyError |
| A list of all errors associated with companies. More... | |
| class | AdUnitHierarchyError |
| Caused by creating an AdUnit object with an invalid hierarchy. More... | |
| class | AdSenseAccountError |
| Error for AdSense related API calls. More... | |
| interface | InventoryServiceInterface |
| class | AdUnitPage |
| Captures a page of AdUnit objects. More... | |
| class | AdUnitAction |
| Represents the actions that can be performed on AdUnit objects. More... | |
| class | DeactivateAdUnits |
| The action used for deactivating AdUnit objects. More... | |
| class | ArchiveAdUnits |
| The action used for archiving AdUnit objects. More... | |
| class | ActivateAdUnits |
| The action used for activating AdUnit objects. More... | |
| interface | InventoryServiceInterfaceChannel |
| class | InventoryService |
| Provides operations for creating, updating and retrieving AdUnit objects. More... | |
| class | AdCategoryDto |
| A canonical ad category. More... | |
| class | Label |
| A More... | |
| interface | LabelServiceInterface |
| class | LabelPage |
| Captures a page of Label objects. More... | |
| class | LabelAction |
| Represents the actions that can be performed on Label objects. More... | |
| class | DeactivateLabels |
| The action used for deactivating Label objects. More... | |
| class | ActivateLabels |
| The action used for activating Label objects. More... | |
| interface | LabelServiceInterfaceChannel |
| class | LabelService |
| Provides methods for the creation and management of Labels. More... | |
| class | Long_StatsMapEntry |
| This represents an entry in a map with a key of type Long and value of type Stats. More... | |
| class | LineItemCreativeAssociationStats |
| Contains statistics such as impressions, clicks delivered and cost for LineItemCreativeAssociation objects. More... | |
| class | LineItemCreativeAssociation |
| A More... | |
| class | LineItemCreativeAssociationOperationError |
| Lists all errors for executing operations on line item-to-creative associations More... | |
| class | CreativePreviewError |
| Errors associated with generation of creative preview URIs. More... | |
| interface | LineItemCreativeAssociationServiceInterface |
| class | LineItemCreativeAssociationPage |
| Captures a page of LineItemCreativeAssociation objects. More... | |
| class | CreativeNativeStylePreview |
| Represents the NativeStyle of a Creative and its corresponding preview URL. More... | |
| class | LineItemCreativeAssociationAction |
| Represents the actions that can be performed on LineItemCreativeAssociation objects. More... | |
| class | DeleteLineItemCreativeAssociations |
| The action used for deleting LineItemCreativeAssociation objects. More... | |
| class | DeactivateLineItemCreativeAssociations |
| The action used for deactivating LineItemCreativeAssociation objects. More... | |
| class | ActivateLineItemCreativeAssociations |
| The action used for activating LineItemCreativeAssociation objects. More... | |
| class | CreativePushOptions |
| Data needed to push a creative to a mobile device. More... | |
| interface | LineItemCreativeAssociationServiceInterfaceChannel |
| class | LineItemCreativeAssociationService |
| Provides operations for creating, updating and retrieving LineItemCreativeAssociation objects. More... | |
| class | Activity |
| An activity is a specific user action that an advertiser wants to track, such as the completion of a purchase or a visit to a webpage. You create and manage activities in Ad Manager. When a user performs the action after seeing an advertiser's ad, that's a conversion. More... | |
| interface | ActivityServiceInterface |
| class | ActivityPage |
| Captures a page of Activity objects. More... | |
| interface | ActivityServiceInterfaceChannel |
| class | ActivityService |
| Provides methods for creating, updating and retrieving Activity objects. More... | |
| interface | LineItemServiceInterface |
| class | LineItemPage |
| Captures a page of LineItem objects. More... | |
| class | LineItemAction |
| Represents the actions that can be performed on LineItem objects. More... | |
| class | UnarchiveLineItems |
| The action used for unarchiving LineItem objects. More... | |
| class | ResumeLineItems |
| The action used for resuming LineItem objects. More... | |
| class | ResumeAndOverbookLineItems |
| The action used for resuming and overbooking LineItem objects. More... | |
| class | ReserveLineItems |
| The action used for reserving LineItem objects. More... | |
| class | ReserveAndOverbookLineItems |
| The action used for reserving and overbooking LineItem objects. More... | |
| class | ReleaseLineItems |
| The action used for releasing LineItem objects. More... | |
| class | PauseLineItems |
| The action used for pausing LineItem objects. More... | |
| class | DeleteLineItems |
| The action used for deleting LineItem objects. A line item can be deleted if it has never been eligible to serve. Note: deleted line items will still count against your network limits. For more information, see the Help Center. More... | |
| class | ArchiveLineItems |
| The action used for archiving LineItem objects. More... | |
| class | ActivateLineItems |
| The action used for activating LineItem objects. More... | |
| interface | LineItemServiceInterfaceChannel |
| class | LineItemService |
| Provides methods for creating, updating and retrieving LineItem objects. More... | |
| class | LineItemTemplate |
| Represents the template that populates the fields of a new line item being created. More... | |
| class | LineItemTemplatePage |
| Captures a page of LineItemTemplate objects. More... | |
| interface | LineItemTemplateServiceInterface |
| interface | LineItemTemplateServiceInterfaceChannel |
| class | LineItemTemplateService |
| Provides methods for creating, updating and retrieving LineItemTemplate objects. More... | |
| class | DashBridge |
| A More... | |
| class | LiveStreamConditioning |
| Settings to specify all types of conditioning to apply to the associated LiveStreamEvent. More... | |
| class | PrefetchSettings |
| The information needed to prefetch ad requests for an ad break. More... | |
| class | MasterPlaylistSettings |
| Settings for the HLS (HTTP Live Streaming) master playlist. More... | |
| class | HlsSettings |
| LiveStream settings that are specific to the HTTP live streaming (HLS) protocol. More... | |
| class | PrerollSettings |
| Settings for ad breaks on LiveStreamEvent that are specific to preroll. More... | |
| class | LiveStreamEvent |
| A More... | |
| class | VideoAdTagError |
| Lists all errors associated with live stream event ad tags. More... | |
| class | LiveStreamEventSlateError |
| Lists all errors associated with LiveStreamEvent slate creative id. More... | |
| class | LiveStreamEventPrerollSettingsError |
| Lists all errors associated with preroll settings applied to a LiveStreamEvent. More... | |
| class | LiveStreamEventDvrWindowError |
| Lists the errors associated with setting the LiveStreamEvent DVR window duration. More... | |
| class | LiveStreamEventDateTimeError |
| Lists all errors associated with live stream event start and end date times. More... | |
| class | LiveStreamEventCustomAssetKeyError |
| Lists all errors associated with live stream event custom asset keys. More... | |
| class | LiveStreamEventConditioningError |
| Lists all errors associated with conditioning applied to a LiveStreamEvent. More... | |
| class | LiveStreamEventCdnSettingsError |
| Lists all errors associated with LiveStreamEvent CDN configurations. More... | |
| class | LiveStreamEventActionError |
| Lists all errors associated with live stream event action. More... | |
| class | AdBreakMarkupError |
| An error for publisher provided ad break markups in a LiveStreamEvent which are invalid for the given StreamingFormat. More... | |
| interface | LiveStreamEventServiceInterface |
| class | Slate |
| A More... | |
| class | LiveStreamEventPage |
| Captures a page of LiveStreamEvent objects. More... | |
| class | SlatePage |
| Captures a page of Slate objects. More... | |
| class | LiveStreamEventAction |
| Represents the actions that can be performed on LiveStreamEvent objects. More... | |
| class | RefreshLiveStreamEventMasterPlaylists |
| The action used for refreshing the master playlists of LiveStreamEvent objects. More... | |
| class | PauseLiveStreamEvents |
| The action used for pausing LiveStreamEvent objects. More... | |
| class | PauseLiveStreamEventAds |
| The action used for pausing ads for LiveStreamEvent objects. More... | |
| class | ArchiveLiveStreamEvents |
| The action used for archiving LiveStreamEvent objects. More... | |
| class | ActivateLiveStreamEvents |
| The action used for activating LiveStreamEvent objects. More... | |
| class | SlateAction |
| Represents the actions that can be performed on slates. More... | |
| class | UnarchiveSlates |
| The action used for unarchiving slates. More... | |
| class | ArchiveSlates |
| The action used for archiving slates. More... | |
| interface | LiveStreamEventServiceInterfaceChannel |
| class | LiveStreamEventService |
| Provides methods for creating, updating and retrieving LiveStreamEvent objects. More... | |
| class | MobileApplication |
| A mobile application that has been added to or "claimed" by the network to be used for targeting purposes. These mobile apps can come from various app stores. More... | |
| class | MobileApplicationError |
| Lists all errors associated with MobileApplication objects. More... | |
| class | MobileApplicationActionError |
| Lists all error reasons associated with performing actions on MobileApplication objects. More... | |
| interface | MobileApplicationServiceInterface |
| class | MobileApplicationPage |
| Captures a page of mobile applications. More... | |
| class | MobileApplicationAction |
| Represents the actions that can be performed on mobile applications. More... | |
| class | ArchiveMobileApplications |
| The action used to deactivate MobileApplication objects. More... | |
| class | UnarchiveMobileApplications |
| The action used to activate MobileApplication objects. More... | |
| interface | MobileApplicationServiceInterfaceChannel |
| class | MobileApplicationService |
| Provides methods for retrieving MobileApplication objects. More... | |
| class | ChildPublisher |
| A More... | |
| class | Network |
| class | UrlError |
| Common errors for URLs. More... | |
| class | RequestError |
| Encapsulates the generic errors thrown when there's an error with user request. More... | |
| class | PrecisionError |
| List all errors associated with number precisions. More... | |
| class | NetworkError |
| An error for a network. More... | |
| class | InventoryClientApiError |
| ApiError for common exceptions thrown when accessing AdSense InventoryClient. More... | |
| class | InvalidEmailError |
| Caused by supplying a value for an email attribute that is not a valid email address. More... | |
| class | ExchangeSignupApiError |
| ApiError for exceptions thrown by ExchangeSignupService. More... | |
| interface | NetworkServiceInterface |
| interface | NetworkServiceInterfaceChannel |
| class | NetworkService |
| Provides operations for retrieving information related to the publisher's networks. This service can be used to obtain the list of all networks that the current login has access to, or to obtain information about a specific network. More... | |
| class | Order |
| An More... | |
| interface | OrderServiceInterface |
| class | OrderPage |
| Captures a page of Order objects. More... | |
| class | OrderAction |
| Represents the actions that can be performed on Order objects. More... | |
| class | UnarchiveOrders |
| The action used for unarchiving Order objects. More... | |
| class | SubmitOrdersForApprovalWithoutReservationChanges |
| The action used for submitting Order objects for approval. This action does not make any changes to the LineItem::reservationStatus of the line items within the order. More... | |
| class | SubmitOrdersForApproval |
| The action used for submitting Order objects for approval. More... | |
| class | SubmitOrdersForApprovalAndOverbook |
| The action used for submitting and overbooking Order objects for approval. More... | |
| class | RetractOrdersWithoutReservationChanges |
| The action used for retracting Order objects. This action does not make any changes to the LineItem::reservationStatus of the line items within the order. More... | |
| class | RetractOrders |
| The action used for retracting Order objects. More... | |
| class | ResumeOrders |
| The action used for resuming Order objects. LineItem objects within the order that are eligble to resume will resume as well. More... | |
| class | ResumeAndOverbookOrders |
| The action used for resuming and overbooking Order objects. All LineItem objects within the order will resume as well. More... | |
| class | PauseOrders |
| The action used for pausing all LineItem objects within an order. More... | |
| class | DisapproveOrdersWithoutReservationChanges |
| The action used for disapproving Order objects. All LineItem objects within the order will be disapproved as well. This action does not make any changes to the LineItem::reservationStatus of the line items within the order. More... | |
| class | DisapproveOrders |
| The action used for disapproving Order objects. All LineItem objects within the order will be disapproved as well. More... | |
| class | DeleteOrders |
| The action used for deleting Order objects. All line items within that order are also deleted. Orders can only be deleted if none of its line items have been eligible to serve. This action can be used to delete proposed orders and line items if they are no longer valid. More... | |
| class | ArchiveOrders |
| The action used for archiving Order objects. More... | |
| class | ApproveOrdersWithoutReservationChanges |
| The action used for approving Order objects. All LineItem objects within the order will be approved as well. This action does not make any changes to the LineItem::reservationStatus of the line items within the order. If there are reservable line items that have not been reserved the operation will not succeed. More... | |
| class | ApproveOrders |
| The action used for approving Order objects. All LineItem objects within the order will be approved as well. For more information on what happens to an order and its line items when it is approved, see the Ad Manager Help Center. More... | |
| class | ApproveAndOverbookOrders |
| The action used for approving and overbooking Order objects. All LineItem objects within the order will be approved as well. For more information on what happens to an order and its line items when it is approved and overbooked, see the Ad Manager Help Center. More... | |
| interface | OrderServiceInterfaceChannel |
| class | OrderService |
| Provides methods for creating, updating and retrieving Order objects. More... | |
| class | SiteTargetingInfo |
| Deprecated container for information required for AdWords advertisers to place their ads. More... | |
| class | Placement |
| A More... | |
| class | PlacementError |
| Class defining all validation errors for a placement. More... | |
| interface | PlacementServiceInterface |
| class | PlacementPage |
| Captures a page of Placement objects. More... | |
| class | PlacementAction |
| Represents the actions that can be performed on Placement objects. More... | |
| class | DeactivatePlacements |
| The action used for deactivating Placement objects. More... | |
| class | ArchivePlacements |
| The action used for archiving Placement objects. More... | |
| class | ActivatePlacements |
| The action used for activating Placement objects. More... | |
| interface | PlacementServiceInterfaceChannel |
| class | PlacementService |
| Provides methods for creating, updating and retrieving Placement objects. More... | |
| class | BuyerRfp |
| Represents the buyer RFP information associated with a Proposal describing the requirements from the buyer. More... | |
| class | ProposalMarketplaceInfo |
| Marketplace info for a proposal with a corresponding order in Marketplace. More... | |
| class | SalespersonSplit |
| A More... | |
| class | ProposalCompanyAssociation |
| A More... | |
| class | Proposal |
| A More... | |
| class | ProposalLineItemProgrammaticError |
| Errors associated with programmatic proposal line items. More... | |
| class | ProposalLineItemError |
| Lists all errors associated with proposal line items. More... | |
| class | ProposalError |
| Lists all errors associated with proposals. More... | |
| class | ProposalActionError |
| Lists all errors associated with performing actions on Proposal objects. More... | |
| class | ExchangeRateError |
| Lists all errors associated with ExchangeRate objects. More... | |
| class | DealError |
| Errors associated with creating or updating programmatic proposals. More... | |
| class | BillingError |
| Lists all errors associated with the billing settings of a proposal or proposal line item. More... | |
| interface | ProposalServiceInterface |
| class | MarketplaceCommentPage |
| Captures a page of MarketplaceComment objects. More... | |
| class | MarketplaceComment |
| A comment associated with a programmatic Proposal that has been sent to Marketplace. More... | |
| class | ProposalPage |
| Captures a page of Proposal objects. More... | |
| class | ProposalAction |
| Represents the actions that can be performed on Proposal objects. More... | |
| class | UpdateOrderWithSellerData |
| The action to update a finalized Marketplace Order with the seller's data. More... | |
| class | UnarchiveProposals |
| The action used for unarchiving Proposal objects. More... | |
| class | TerminateNegotiations |
| The action for marking all negotiations on the Proposal as terminated in Marketplace. More... | |
| class | ResumeProposals |
| The action used for resuming programmatic Proposal objects. More... | |
| class | ReserveProposals |
| The action to reserve inventory for Proposal objects. It does not allow overbooking unless #allowOverbook is set to More... | |
| class | RequestBuyerReview |
| The action used to request buyer review for the Proposal. More... | |
| class | RequestBuyerAcceptance |
| The action used to request acceptance from the buyer for the Proposal through Marketplace. This action does check forecasting unless #allowOverbook is set to More... | |
| class | PauseProposals |
| The action used for pausing programmatic Proposal objects. More... | |
| class | EditProposalsForNegotiation |
| Opens the fields of a Proposal for edit. More... | |
| class | DiscardLocalVersionEdits |
| The action for reverting the local Proposal modifications to reflect the latest terms and private data in Marketplace. More... | |
| class | ArchiveProposals |
| The action used for archiving Proposal objects. More... | |
| interface | ProposalServiceInterfaceChannel |
| class | ProposalService |
| Provides methods for adding, updating and retrieving Proposal objects. More... | |
| class | ProposalLineItemMakegoodError |
| Lists all errors for makegood proposal line items. More... | |
| class | ProposalLineItemActionError |
| Lists all errors for executing operations on proposal line items. More... | |
| class | PreferredDealError |
| Errors associated with preferred deal proposal line items. More... | |
| interface | ProposalLineItemServiceInterface |
| class | ProposalLineItemPage |
| Captures a page of ProposalLineItem objects. More... | |
| class | ProposalLineItemAction |
| Represents the actions that can be performed on ProposalLineItem objects. More... | |
| class | UnarchiveProposalLineItems |
| The action used for unarchiving ProposalLineItem objects. More... | |
| class | ResumeProposalLineItems |
| The action used for resuming ProposalLineItem objects. More... | |
| class | ReserveProposalLineItems |
| The action to reserve inventory for ProposalLineItem objects. It does not overbook inventory unless #allowOverbook is set to More... | |
| class | ReleaseProposalLineItems |
| The action used for releasing inventory for ProposalLineItem objects. More... | |
| class | PauseProposalLineItems |
| The action used for pausing ProposalLineItem objects. More... | |
| class | ArchiveProposalLineItems |
| The action used for archiving ProposalLineItem objects. More... | |
| interface | ProposalLineItemServiceInterfaceChannel |
| class | ProposalLineItemService |
| Provides methods for creating, updating and retrieving ProposalLineItem objects. More... | |
| class | Row |
| Each Row object represents data about one entity in a ResultSet. More... | |
| class | TargetingValue |
| Contains a Targeting value. More... | |
| class | ChangeHistoryValue |
| class | ColumnType |
| Contains information about a column in a ResultSet. More... | |
| class | ResultSet |
| The More... | |
| interface | PublisherQueryLanguageServiceInterface |
| interface | PublisherQueryLanguageServiceInterfaceChannel |
| class | PublisherQueryLanguageService |
| Provides methods for executing a PQL Statement to retrieve information from the system. In order to support the selection of columns of interest from various tables, Statement objects support a "select" clause. More... | |
| class | BaseAdRuleSlot |
| Simple object representing an ad slot within an AdRule. Ad rule slots contain information about the types/number of ads to display, as well as additional information on how the ad server will generate playlists. More... | |
| class | UnknownAdRuleSlot |
| The BaseAdRuleSlot subtype returned if the actual type is not exposed by the requested API version. More... | |
| class | StandardPoddingAdRuleSlot |
| An ad rule slot with standard podding. A standard pod is a series of video ads played back to back. Standard pods are defined by a BaseAdRuleSlot::maxAdsInPod and a BaseAdRuleSlot::maxVideoAdDuration. More... | |
| class | OptimizedPoddingAdRuleSlot |
| Ad rule slot with optimized podding. Optimized pods are defined by a BaseAdRuleSlot::maxPodDuration and a BaseAdRuleSlot::maxAdsInPod, and the ad server chooses the best ads for the alloted duration. More... | |
| class | NoPoddingAdRuleSlot |
| An ad rule slot with no podding. It is defined by a BaseAdRuleSlot::maxVideoAdDuration. More... | |
| class | AdRule |
| An AdRule contains data that the ad server will use to generate a playlist of video ads. More... | |
| class | PoddingError |
| Errors related to podding fields in ad rule slots. More... | |
| class | AdRuleTargetingError |
| Lists all errors associated with ad rule targeting. More... | |
| class | AdRuleSlotError |
| Errors related to ad rule slots. More... | |
| class | AdRulePriorityError |
| Errors associated with ad rule priorities. More... | |
| class | AdRuleFrequencyCapError |
| Errors related to ad rule frequency caps More... | |
| class | AdRuleError |
| Errors ad rule break template objects. More... | |
| class | AdRuleDateError |
| Lists all errors associated with ad rule start and end dates. More... | |
| interface | AdRuleServiceInterface |
| class | AdSpot |
| A AdSpot is a targetable entity used in the creation of AdRule objects. More... | |
| class | BreakTemplate |
| A BreakTemplate defines what kinds of ads show at which positions within a pod. More... | |
| class | BreakTemplateBreakTemplateMember |
| A building block of a pod template. More... | |
| class | AdRulePage |
| Captures a page of AdRule objects. More... | |
| class | AdSpotPage |
| Captures a page of AdSpot objects. More... | |
| class | BreakTemplatePage |
| Captures a page of BreakTemplate objects. More... | |
| class | AdRuleAction |
| Represents the actions that can be performed on AdRule objects. More... | |
| class | DeleteAdRules |
| The action used for deleting AdRule objects. More... | |
| class | DeactivateAdRules |
| The action used for pausing AdRule objects. More... | |
| class | ActivateAdRules |
| The action used for resuming AdRule objects. More... | |
| interface | AdRuleServiceInterfaceChannel |
| class | AdRuleService |
| Provides methods for creating, updating and retrieving AdRule objects. More... | |
| class | ReportError |
| An error for an exception that occurred while running the report. More... | |
| interface | ReportServiceInterface |
| class | ReportDownloadOptions |
| Represents the options for an API report download request. See ReportService::getReportDownloadUrlWithOptions. More... | |
| class | SavedQueryPage |
| A page of SavedQuery objects. More... | |
| class | SavedQuery |
| A saved ReportQuery representing the selection criteria for running a report. More... | |
| class | ReportQuery |
| A More... | |
| class | ReportJob |
| Represents a report job that will be run to retrieve performance and statistics information about ad campaigns, networks, inventory and sales. More... | |
| interface | ReportServiceInterfaceChannel |
| class | ReportService |
| Provides methods for executing a ReportJob and retrieving performance and statistics about ad campaigns, networks, inventory and sales. More... | |
| class | SuggestedAdUnit |
| A More... | |
| class | SuggestedAdUnitPage |
| Contains a page of SuggestedAdUnit objects. More... | |
| interface | SuggestedAdUnitServiceInterface |
| class | SuggestedAdUnitAction |
| Represents the actions that can be performed on SuggestedAdUnit objects. More... | |
| class | ApproveSuggestedAdUnits |
| Action to approve SuggestedAdUnit objects. More... | |
| class | SuggestedAdUnitUpdateResult |
| Represents the result of performing an action on SuggestedAdUnit objects. More... | |
| interface | SuggestedAdUnitServiceInterfaceChannel |
| class | SuggestedAdUnitService |
| This service provides operations for retrieving and approving SuggestedAdUnit objects. More... | |
| class | Team |
| A More... | |
| interface | TeamServiceInterface |
| class | TeamPage |
| Captures a page of Team objects. More... | |
| class | TeamAction |
| Represents the actions that can be performed on Team objects. More... | |
| class | DeactivateTeams |
| The action used for deactivating Team objects. More... | |
| class | ActivateTeams |
| The action used for activating Team objects. More... | |
| interface | TeamServiceInterfaceChannel |
| class | TeamService |
| Provides methods for creating, updating, and retrieving Team objects. More... | |
| class | UserRecord |
| The More... | |
| class | User |
| Represents a user of the system. More... | |
| class | TokenError |
| An error for an exception that occurred when using a token. More... | |
| interface | UserServiceInterface |
| class | Role |
| Each More... | |
| class | UserPage |
| Captures a page of User objects More... | |
| class | UserAction |
| Represents the actions that can be performed on User objects. More... | |
| class | DeactivateUsers |
| The action used for deactivating User objects. More... | |
| class | ActivateUsers |
| The action used for activating User objects. More... | |
| interface | UserServiceInterfaceChannel |
| class | UserService |
| Provides operations for creating, updating and retrieving User objects. More... | |
| class | UserRecordTeamAssociation |
| class | UserTeamAssociation |
| interface | UserTeamAssociationServiceInterface |
| class | UserTeamAssociationPage |
| Captures a page of UserTeamAssociation objects. More... | |
| class | UserTeamAssociationAction |
| Represents the actions that can be performed on UserTeamAssociation objects. More... | |
| class | DeleteUserTeamAssociations |
| Action to delete the association between a User and a Team. More... | |
| interface | UserTeamAssociationServiceInterfaceChannel |
| class | UserTeamAssociationService |
| Provides methods for creating, updating, and retrieving UserTeamAssociation objects. More... | |
| class | NativeStyle |
| Used to define the look and feel of native ads, for both web and apps. Native styles determine how native creatives look for a segment of inventory. More... | |
| class | NativeStyleError |
| Errors for native styles. More... | |
| interface | NativeStyleServiceInterface |
| class | NativeStylePage |
| Captures a page of NativeStyle objects. More... | |
| class | NativeStyleAction |
| Represents an action that can be performed on native styles. More... | |
| class | DeactivateNativeStyles |
| Action to deactivate native styles. More... | |
| class | ArchiveNativeStyles |
| Action to archive native styles. More... | |
| class | ActivateNativeStyles |
| Action to activate native styles. More... | |
| interface | NativeStyleServiceInterfaceChannel |
| class | NativeStyleService |
| Provides methods for creating and retrieving NativeStyle objects. More... | |
| class | HistoricalBasisVolumeSettings |
| Settings to specify the volume of ad opportunities per day over the ForecastAdjustment date range based on the traffic volume of a historical reference period. More... | |
| class | TotalVolumeSettings |
| Settings to specify a single total traffic volume that will be used as the expected total future volume for a forecast adjustment. More... | |
| class | ForecastAdjustment |
| Provides information about the expected volume and composition of traffic over a date range for a traffic forecast segment. More... | |
| class | TrafficForecastSegmentError |
| Lists all errors associated with traffic forecast segments. More... | |
| class | ForecastAdjustmentError |
| Lists all errors associated with forecast adjustments. More... | |
| interface | AdjustmentServiceInterface |
| class | TrafficForecastSegment |
| An entity that defines a segment of traffic that will be adjusted or explored. More... | |
| class | ForecastAdjustmentPage |
| A page of ForecastAdjustmentDto objects. More... | |
| class | TrafficForecastSegmentPage |
| A page of TrafficForecastSegmentDto objects. More... | |
| class | ForecastAdjustmentAction |
| Represents the actions that can be performed on com.google.ads.publisher.api.service.adjustment.ForecastAdjustment objects. More... | |
| class | DeactivateForecastAdjustments |
| The action used for deactivating ForecastAdjustment objects. More... | |
| class | ActivateForecastAdjustments |
| The action used for activating ForecastAdjustment objects. More... | |
| interface | AdjustmentServiceInterfaceChannel |
| class | AdjustmentService |
| Provides methods for creating, updating, and retrieving ForecastAdjustments and TrafficForecastSegments. More... | |
| class | CmsMetadataKey |
| Key associated with a piece of content from a publisher's CMS. More... | |
| class | CmsMetadataKeyPage |
| Captures a page of CMS metadata key objects. More... | |
| class | MetadataMergeSpecError |
| Errors associated with metadata merge specs. More... | |
| interface | CmsMetadataServiceInterface |
| class | CmsMetadataValuePage |
| Captures a page of CMS metadata value objects. More... | |
| class | CmsMetadataValue |
| Key value pair associated with a piece of content from a publisher's CMS. More... | |
| class | CmsMetadataKeyAction |
| Represents the actions that can be performed on CmsMetadataKey objects. More... | |
| class | DeactivateCmsMetadataKeys |
| The action used for deactivating CmsMetadataKey objects. More... | |
| class | ActivateCmsMetadataKeys |
| The action used for activating CmsMetadataKey objects. More... | |
| class | CmsMetadataValueAction |
| Represents the actions that can be performed on CmsMetadataValue objects. More... | |
| class | DeactivateCmsMetadataValues |
| The action used for deactivating CmsMetadataValue objects. More... | |
| class | ActivateCmsMetadataValues |
| The action used for activating CmsMetadataValue objects. More... | |
| interface | CmsMetadataServiceInterfaceChannel |
| class | CmsMetadataService |
| Provides methods for querying CMS metadata keys and values. More... | |
| class | TargetingPreset |
| User-defined preset targeting criteria. More... | |
| class | TargetingPresetPage |
| Captures a paged query of TargetingPresetDto objects. More... | |
| interface | TargetingPresetServiceInterface |
| interface | TargetingPresetServiceInterfaceChannel |
| class | TargetingPresetService |
| Service for interacting with Targeting Presets. More... | |
| class | CreativeReview |
| class | CreativeReviewPage |
| interface | CreativeReviewServiceInterface |
| class | CreativeReviewAction |
| class | DisapproveCreativeReviews |
| class | ArchiveCreativeReviews |
| class | ApproveCreativeReviews |
| interface | CreativeReviewServiceInterfaceChannel |
| class | CreativeReviewService |
| class | BaseContact |
| Base class for a Contact. More... | |
| class | Contact |
| A More... | |
| class | ContactError |
| Errors associated with More... | |
| interface | ContactServiceInterface |
| class | ContactPage |
| Captures a page of Contact objects. More... | |
| interface | ContactServiceInterfaceChannel |
| class | ContactService |
| Provides methods for creating, updating and retrieving Contact objects. More... | |
| class | TrackingEventPing |
| class | CreativeTranscode |
| class | AdDecisionCreative |
| class | SamError |
| class | AdResponse |
| class | AdBreak |
| class | StreamCreateRequest |
| class | VodStreamCreateRequest |
| class | LinearStreamCreateRequest |
| class | SamSession |
| class | SamSessionError |
| interface | StreamActivityMonitorServiceInterface |
| interface | StreamActivityMonitorServiceInterfaceChannel |
| class | StreamActivityMonitorService |
| class | AudioSettings |
| Information about the audio settings of an encoding profile. More... | |
| class | VideoSettings |
| Information about the video settings of an encoding profile. More... | |
| class | DaiEncodingProfile |
| A DaiEncodingProfile contains data about a publisher's encoding profiles. Ad Manager Dynamic Ad Insertion (DAI) uses the profile information about the content to select an appropriate ad transcode to play for the particular video. More... | |
| class | DaiEncodingProfileVariantSettingsError |
| Lists all errors associated with encoding profile variant settings. More... | |
| class | DaiEncodingProfileUpdateError |
| Lists all errors associated with encoding profile updates. More... | |
| class | DaiEncodingProfileNameError |
| Lists all errors associated with encoding profile names. More... | |
| class | DaiEncodingProfileContainerSettingsError |
| Lists all errors associated with encoding profile container settings. More... | |
| class | DaiEncodingProfileAdMatchingError |
| Lists all warnings associated with validating encoding profiles. More... | |
| interface | DaiEncodingProfileServiceInterface |
| class | DaiEncodingProfilePage |
| Captures a page of DaiEncodingProfile objects. More... | |
| class | DaiEncodingProfileAction |
| Represents the actions that can be performed on DaiEncodingProfile objects. More... | |
| class | ArchiveDaiEncodingProfiles |
| The action used for archiving DaiEncodingProfile objects. More... | |
| class | ActivateDaiEncodingProfiles |
| The action used for activating DaiEncodingProfile objects. More... | |
| interface | DaiEncodingProfileServiceInterfaceChannel |
| class | DaiEncodingProfileService |
| Provides methods for creating, updating and retrieving DaiEncodingProfile objects. More... | |
| class | DisapprovalReason |
| class | Site |
| class | SiteError |
| Errors associated with the More... | |
| interface | SiteServiceInterface |
| class | SitePage |
| class | SiteAction |
| class | SubmitSiteForApproval |
| class | DeactivateSite |
| interface | SiteServiceInterfaceChannel |
| class | SiteService |
| class | YieldParameter |
| class | YieldParameter_StringMapEntry |
| This represents an entry in a map with a key of type YieldParameter and value of type String. More... | |
| class | AbstractDisplaySettings |
| class | SdkMediationSettings |
| class | OpenBiddingSetting |
| class | YieldAdSource |
| class | YieldGroup |
| class | YieldError |
| class | IdError |
| class | DistinctError |
| interface | YieldGroupServiceInterface |
| class | YieldGroupPage |
| class | YieldPartner |
| class | YieldPartnerSettings |
| interface | YieldGroupServiceInterfaceChannel |
| class | YieldGroupService |
| class | SegmentPopulationResults |
| class | SegmentPopulationError |
| interface | SegmentPopulationServiceInterface |
| class | SegmentPopulationAction |
| class | ProcessAction |
| class | SegmentPopulationRequest |
| class | SegmentPopulationResponse |
| interface | SegmentPopulationServiceInterfaceChannel |
| class | SegmentPopulationService |
| class | DaiAuthenticationKey |
| A More... | |
| class | DaiAuthenticationKeyActionError |
| Lists all errors associated with DAI authentication key actions. More... | |
| interface | DaiAuthenticationKeyServiceInterface |
| class | DaiAuthenticationKeyPage |
| Captures a page of DaiAuthenticationKey objects. More... | |
| class | DaiAuthenticationKeyAction |
| Represents the actions that can be performed on DaiAuthenticationKey objects. More... | |
| class | DeactivateDaiAuthenticationKeys |
| The action used for deactivating DaiAuthenticationKey objects. More... | |
| class | ActivateDaiAuthenticationKeys |
| The action used for activating DaiAuthenticationKey objects. More... | |
| interface | DaiAuthenticationKeyServiceInterfaceChannel |
| class | DaiAuthenticationKeyService |
| Provides methods for creating, updating and retrieving DaiAuthenticationKey objects. More... | |
| class | FirstPartyAudienceSegmentRule |
| Rule of a FirstPartyAudienceSegment that defines user's eligibility criteria to be part of a segment. More... | |
| class | AudienceSegmentDataProvider |
| Data provider that owns this segment. For a FirstPartyAudienceSegment, it would be the publisher network. For a SharedAudienceSegment or a ThirdPartyAudienceSegment, it would be the entity that provides that AudienceSegment. More... | |
| class | AudienceSegment |
| An AudienceSegment represents audience segment object. More... | |
| class | SharedAudienceSegment |
| A SharedAudienceSegment is an AudienceSegment owned by another entity and shared with the publisher network. More... | |
| class | ThirdPartyAudienceSegment |
| A ThirdPartyAudienceSegment is an AudienceSegment owned by a data provider and licensed to the Ad Manager publisher. More... | |
| class | FirstPartyAudienceSegment |
| A FirstPartyAudienceSegment is an AudienceSegment owned by the publisher network. More... | |
| class | RuleBasedFirstPartyAudienceSegmentSummary |
| A RuleBasedFirstPartyAudienceSegmentSummary is a FirstPartyAudienceSegment owned by the publisher network. More... | |
| class | RuleBasedFirstPartyAudienceSegment |
| A RuleBasedFirstPartyAudienceSegment is a FirstPartyAudienceSegment owned by the publisher network. It contains a rule. More... | |
| class | NonRuleBasedFirstPartyAudienceSegment |
| A NonRuleBasedFirstPartyAudienceSegment is a FirstPartyAudienceSegment owned by the publisher network. It doesn't contain a rule. Cookies are usually added to this segment via cookie upload. More... | |
| interface | AudienceSegmentServiceInterface |
| class | AudienceSegmentPage |
| Represents a page of AudienceSegment objects. More... | |
| class | AudienceSegmentAction |
| Action that can be performed on AudienceSegment objects. More... | |
| class | RejectAudienceSegments |
| Action that can be performed on ThirdPartyAudienceSegment objects to reject them. More... | |
| class | PopulateAudienceSegments |
| Action that can be performed on FirstPartyAudienceSegment objects to populate them based on last 30 days of traffic. More... | |
| class | DeactivateAudienceSegments |
| Action that can be performed on FirstPartyAudienceSegment objects to deactivate them. More... | |
| class | ApproveAudienceSegments |
| Action that can be performed on ThirdPartyAudienceSegment objects to approve them. More... | |
| class | ActivateAudienceSegments |
| Action that can be performed on FirstPartyAudienceSegment objects to activate them. More... | |
| interface | AudienceSegmentServiceInterfaceChannel |
| class | AudienceSegmentService |
| Provides operations for creating, updating and retrieving AudienceSegment objects. More... | |
| class | SecurityPolicySettings |
| A set of security requirements to authenticate against in order to access video content. Different locations (e.g. different CDNs) can have different security policies. More... | |
| class | MediaLocationSettings |
| Configuration that associates a media location with a security policy and the authentication credentials needed to access the content. More... | |
| class | SourceContentConfiguration |
| Parameters about this CDN configuration as a source of content. This facilitates fetching the original content for conditioning and delivering the original content as part of a modified stream. More... | |
| class | CdnConfiguration |
| A CdnConfiguration encapsulates information about where and how to ingest and deliver content enabled for DAI (Dynamic Ad Insertion). More... | |
| class | CdnConfigurationError |
| Errors associated with CdnConfigurations. More... | |
| interface | CdnConfigurationServiceInterface |
| class | CdnConfigurationPage |
| Captures a page of CdnConfiguration objects. More... | |
| class | CdnConfigurationAction |
| Represents the actions that can be performed on CdnConfiguration objects. More... | |
| class | ArchiveCdnConfigurations |
| The action used for archiving CdnConfiguration objects. More... | |
| class | ActivateCdnConfigurations |
| The action used for activating CdnConfiguration objects. More... | |
| interface | CdnConfigurationServiceInterfaceChannel |
| class | CdnConfigurationService |
| Provides methods for creating, updating and retrieving CdnConfiguration objects. More... | |
| class | ViewabilityProvider |
| Information required for Company of Type VIEWABILITY_PROVIDER. It contains all of the data needed to capture viewability metrics. More... | |
| class | CompanySettings |
| Settings for a Company. More... | |
| class | Company |
| A More... | |
| interface | CompanyServiceInterface |
| class | CompanyPage |
| Captures a page of Company objects. More... | |
| class | CompanyAction |
| Represents the actions that can be performed on More... | |
| class | ResendInvitationAction |
| The action used by the parent network to resend an invitation email with the same proposal to an expired child publisher. More... | |
| class | EndAgreementAction |
| The action used by the parent network to withdraw from being the MCM parent for a child. More... | |
| class | ReInviteAction |
| The action used by the parent network to send a new invitation with a potentially updated proposal to a rejected or withdrawn child publisher. More... | |
| interface | CompanyServiceInterfaceChannel |
| class | CompanyService |
| Provides operations for creating, updating and retrieving Company objects. More... | |
| class | ContentBundle |
| A More... | |
| class | ContentFilterError |
| Errors associated with the incorrect creation of a Condition. More... | |
| interface | ContentBundleServiceInterface |
| class | ContentBundlePage |
| Captures a page of ContentBundle objects. More... | |
| class | ContentBundleAction |
| Represents the actions that can be performed on ContentBundle objects. More... | |
| class | DeactivateContentBundles |
| The action used for deactivating ContentBundle objects. More... | |
| class | ActivateContentBundles |
| The action used for activating ContentBundle objects. More... | |
| interface | ContentBundleServiceInterfaceChannel |
| class | ContentBundleService |
| Provides methods for creating, updating and retrieving ContentBundle objects. More... | |
| class | CmsContent |
| Contains information about Content from the CMS it was ingested from. More... | |
| class | DaiIngestError |
| Represents an error associated with a DAI content's status. More... | |
| class | Content |
| A More... | |
| class | ContentPage |
| Captures a page of More... | |
| interface | ContentServiceInterface |
| interface | ContentServiceInterfaceChannel |
| class | ContentService |
| Service for retrieving Content. More... | |
| interface | IActivityGroupService |
| Provides methods for creating, updating and retrieving ActivityGroup objects. More... | |
| interface | ICreativeService |
| Provides methods for adding, updating and retrieving Creative objects. More... | |
| interface | ICreativeSetService |
| Provides methods for adding, updating and retrieving CreativeSet objects. More... | |
| interface | ICreativeTemplateService |
| Provides methods for retrieving CreativeTemplate objects. More... | |
| interface | ICreativeWrapperService |
| Provides methods for the creation and management of creative wrappers. CreativeWrappers allow HTML snippets to be served along with creatives. More... | |
| interface | ICustomTargetingService |
| Provides operations for creating, updating and retrieving CustomTargetingKey and CustomTargetingValue objects. More... | |
| interface | ICustomFieldService |
| Provides methods for the creation and management of CustomField objects. More... | |
| interface | IForecastService |
| Provides methods for estimating traffic (clicks/impressions) for line items. Forecasts can be provided for LineItem objects that exist in the system or which have not had an ID set yet. More... | |
| interface | IInventoryService |
| interface | ILabelService |
| Provides methods for the creation and management of Labels. More... | |
| interface | ILineItemCreativeAssociationService |
| Provides operations for creating, updating and retrieving LineItemCreativeAssociation objects. More... | |
| interface | IActivityService |
| Provides methods for creating, updating and retrieving Activity objects. More... | |
| interface | ILineItemService |
| Provides methods for creating, updating and retrieving LineItem objects. More... | |
| interface | ILineItemTemplateService |
| Provides methods for creating, updating and retrieving LineItemTemplate objects. More... | |
| interface | ILiveStreamEventService |
| Provides methods for creating, updating and retrieving LiveStreamEvent objects. More... | |
| interface | IMobileApplicationService |
| Provides methods for retrieving MobileApplication objects. More... | |
| interface | INetworkService |
| Provides operations for retrieving information related to the publisher's networks. This service can be used to obtain the list of all networks that the current login has access to, or to obtain information about a specific network. More... | |
| interface | IOrderService |
| Provides methods for creating, updating and retrieving Order objects. More... | |
| interface | IPlacementService |
| Provides methods for creating, updating and retrieving Placement objects. More... | |
| interface | IProposalService |
| Provides methods for adding, updating and retrieving Proposal objects. More... | |
| interface | IProposalLineItemService |
| Provides methods for creating, updating and retrieving ProposalLineItem objects. More... | |
| interface | IPublisherQueryLanguageService |
| Provides methods for executing a PQL Statement to retrieve information from the system. In order to support the selection of columns of interest from various tables, Statement objects support a "select" clause. More... | |
| interface | IAdRuleService |
| Provides methods for creating, updating and retrieving AdRule objects. More... | |
| interface | IReportService |
| Provides methods for executing a ReportJob and retrieving performance and statistics about ad campaigns, networks, inventory and sales. More... | |
| interface | ISuggestedAdUnitService |
| This service provides operations for retrieving and approving SuggestedAdUnit objects. More... | |
| interface | ITeamService |
| Provides methods for creating, updating, and retrieving Team objects. More... | |
| interface | IUserService |
| Provides operations for creating, updating and retrieving User objects. More... | |
| interface | IUserTeamAssociationService |
| Provides methods for creating, updating, and retrieving UserTeamAssociation objects. More... | |
| interface | INativeStyleService |
| Provides methods for creating and retrieving NativeStyle objects. More... | |
| interface | IAdjustmentService |
| Provides methods for creating, updating, and retrieving ForecastAdjustments and TrafficForecastSegments. More... | |
| interface | ICmsMetadataService |
| Provides methods for querying CMS metadata keys and values. More... | |
| interface | ITargetingPresetService |
| Service for interacting with Targeting Presets. More... | |
| interface | ICreativeReviewService |
| interface | IContactService |
| Provides methods for creating, updating and retrieving Contact objects. More... | |
| interface | IStreamActivityMonitorService |
| interface | IDaiEncodingProfileService |
| Provides methods for creating, updating and retrieving DaiEncodingProfile objects. More... | |
| interface | ISiteService |
| interface | IYieldGroupService |
| interface | ISegmentPopulationService |
| interface | IDaiAuthenticationKeyService |
| Provides methods for creating, updating and retrieving DaiAuthenticationKey objects. More... | |
| interface | IAudienceSegmentService |
| Provides operations for creating, updating and retrieving AudienceSegment objects. More... | |
| interface | ICdnConfigurationService |
| Provides methods for creating, updating and retrieving CdnConfiguration objects. More... | |
| interface | ICompanyService |
| Provides operations for creating, updating and retrieving Company objects. More... | |
| interface | IContentBundleService |
| Provides methods for creating, updating and retrieving ContentBundle objects. More... | |
| interface | IContentService |
| Service for retrieving Content. More... | |
Status of the MCM child publisher's Ad Manager account with respect to delegated serving. In order for the child network to be served ads for MCM, it must have accepted the invite from the parent network, and must have passed Google's policy compliance verifications.
| Enumerator | |
|---|---|
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
| INVITED |
The child publisher has not acted on the invite from the parent. |
| DECLINED |
The child publisher has declined the invite. |
| PENDING_GOOGLE_APPROVAL |
The child publisher has accepted the invite, and is awaiting Google's policy compliance verifications. |
| APPROVED |
The child publisher accepted the invite, and Google found it to be compliant with its policies, i.e. no policy violations were found, and the child publisher can be served ads. |
| CLOSED_POLICY_VIOLATION |
The child publisher accepted the invite, but was disapproved by Google for violating its policies. |
| CLOSED_INVALID_ACTIVITY |
The child publisher accepted the invite, but was disapproved by Google for invalid activity. |
| CLOSED_BY_PUBLISHER |
The child publisher has closed their own account. |
| DISAPPROVED_INELIGIBLE |
The child publisher accepted the invite, but was disapproved as ineligible by Google. |
| DISAPPROVED_DUPLICATE_ACCOUNT |
The child publisher accepted the invite, but was disapproved by Google for being a duplicate of another account. |
| EXPIRED |
The invite was sent to the child publisher more than 90 days ago, due to which it has been deactivated. |
| INACTIVE |
Either the child publisher disconnected from the parent network, or the parent network withdrew the invite. |
| DEACTIVATED_BY_AD_MANAGER |
The association between the parent and child publishers was deactivated by Google Ad Manager. |
The reasons for the target error.
| Enumerator | |
|---|---|
| ACTIVITIES_FEATURE_REQUIRED |
The 'activities' feature is required but not enabled. |
| UNSUPPORTED_COMPANY_TYPE |
Activity group cannot be associated with the company types. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
The activity type.
Describes the SCTE ad break markups for a LiveStreamEvent.
| Enumerator | |
|---|---|
| AD_BREAK_MARKUP_HLS_EXT_CUE |
The CUE-OUT/CUE-IN ad break marker type. This mark up type is only applicable for HLS live streams. |
| AD_BREAK_MARKUP_HLS_PRIMETIME_SPLICE |
The CUE (Adobe/Azure Prime Time) ad break marker type. This mark up type is only applicable for HLS live streams. |
| AD_BREAK_MARKUP_HLS_DATERANGE_SPLICE |
The DATERANGE (Anvato) ad break marker type. This mark up type is only applicable for HLS live streams. |
| AD_BREAK_MARKUP_SCTE35_XML_SPLICE_INSERT |
The SCTE35 XML Splice In/Out ad break marker type. This markup type is only applicable for DASH live streams. |
| AD_BREAK_MARKUP_SCTE35_BINARY_SPLICE_INSERT |
The SCTE35 Binary Splice Insert ad break marker type. This mark up type is only applicable for HLS and DASH live streams. |
| AD_BREAK_MARKUP_SCTE35_BINARY_PROVIDER_AD_START_END |
The SCTE35 Binary Time Signal: Provider Ad Start/End ad break marker type. This mark up type is only applicable for HLS and DASH live streams. |
| AD_BREAK_MARKUP_SCTE35_BINARY_PROVIDER_PLACEMENT_OP_START_END |
The SCTE35 Binary Time Signal: Provider Placement Opportunity Start/End ad break marker type. This mark up type is only applicable for HLS and DASH live streams. |
| AD_BREAK_MARKUP_SCTE35_BINARY_BREAK_START_END |
The SCTE35 Binary Time Signal: Break Start/End ad break marker type. This mark up type is only applicable for HLS and DASH live streams. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
Identifies the format of inventory or "channel" in which ads serve.
| Enumerator | |
|---|---|
| DISPLAY |
Ads serve in a browser. |
| VIDEO |
In-stream video ads serve in a video. |
| GAMES |
In-stream video ads serve in a game. |
| MOBILE |
Ads serve in a mobile app. |
| MOBILE_OUTSTREAM_VIDEO |
Out-stream video ads serve in a mobile app. Examples include mobile app interstitials and mobile app rewarded ads. |
| DISPLAY_OUTSTREAM_VIDEO |
Out-stream video ads serve in a browser. Examples include in-feed and in-banner video ads. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
The registry that an ad ID belongs to.
Describes reasons for
| Enumerator | |
|---|---|
| START_DATE_TIME_IS_IN_PAST |
Cannot create a new ad rule with a start date in the past. |
| END_DATE_TIME_IS_IN_PAST |
Cannot update an existing ad rule that has already completely passed with a new end date that is still in the past. |
| END_DATE_TIME_NOT_AFTER_START_TIME |
End date must be after the start date. |
| END_DATE_TIME_TOO_LATE |
|
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
Describes reason for
Describes reason for
The types of behaviors for ads within a ad rule slot.
Types of bumper ads on an ad rule slot.
Describes reason for
Describes reasons for
AdRuleTargetingError ad rule targeting errors.
Specifies the type of ads that can be served through this AdUnit.
| Enumerator | |
|---|---|
| TEXT |
Allows text-only ads. |
| IMAGE |
Allows image-only ads. |
| TEXT_AND_IMAGE |
Allows both text and image ads. |
Describes the border of the HTML elements used to surround an ad displayed by the AdUnit.
The different options for how ad spots are filled. Only some allocations of ads to subpods produce a valid final pod.
Defines the targeting behavior of an ad spot.
| Enumerator | |
|---|---|
| NOT_REQUIRED |
Line items not targeting this ad spot explicitly may serve in it. |
| EXPLICITLY_TARGETED |
Only line items targeting this ad spots explicitly may serve in it |
| EXPLICITLY_TARGETED_EXCEPT_HOUSE |
If house ads are an allowed reservation type, they may serve in the ad spot regardless of whether they explicitly target it. Ads of other reservation types (whose type is allowed in the ad spot), may serve in the ad spot only if explicitly targeted. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
| Enumerator | |
|---|---|
| INVALID_CHARACTERS |
For AdUnit::adUnitCode, only alpha-numeric characters, underscores, hyphens, periods, asterisks, double quotes, back slashes, forward slashes, exclamations, left angle brackets, colons and parentheses are allowed. |
| INVALID_CHARACTERS_WHEN_UTF_CHARACTERS_ARE_ALLOWED |
For AdUnit::adUnitCode, only letters, numbers, underscores, hyphens, periods, asterisks, double quotes, back slashes, forward slashes, exclamations, left angle brackets, colons and parentheses are allowed. |
| INVALID_CHARACTERS_FOR_LEGACY_AD_EXCHANGE_TAG |
For AdUnit::adUnitCode representing slot codes, only alphanumeric characters, underscores, hyphens, periods and colons are allowed. |
| LEADING_FORWARD_SLASH |
For AdUnit::adUnitCode, forward slashes are not allowed as the first character. |
| RESERVED_CODE |
Specific codes matching ca-*pub-*-tag are reserved for "Web Property IUs" generated as part of the SlotCode migration. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
| Enumerator | |
|---|---|
| INVALID_DEPTH |
The depth of the AdUnit in the inventory hierarchy is greater than is allowed. The maximum allowed depth is two below the effective root ad unit for Ad Manager 360 accounts and is one level below the effective root ad unit for Ad Manager accounts. |
| INVALID_PARENT |
The only valid AdUnit::parentId for an Ad Manager account is the Network::effectiveRootAdUnitId, Ad Manager 360 accounts can specify an ad unit hierarchy with more than two levels. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
The formats that a publisher allows on their programmatic LineItem or ProposalLineItem.
| Enumerator | |
|---|---|
| AUDIO |
Audio format. This is only relevant for programmatic video line items. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
The reasons for the target error.
Specific audience extension error reasons.
| Enumerator | |
|---|---|
| FREQUENCY_CAPS_NOT_SUPPORTED |
Frequency caps are not supported by audience extension line items |
| INVALID_TARGETING |
Audience extension line items can only target geography |
| INVENTORY_UNIT_TARGETING_INVALID |
Audience extension line items can only target audience extension inventory units |
| INVALID_CREATIVE_ROTATION |
Audience extension line items do not support CreativeRotationType::SEQUENTIAL. |
| INVALID_EXTERNAL_ENTITY_ID |
The given ID of the external entity is not valid |
| INVALID_LINE_ITEM_TYPE |
Audience extension line items only support LineItemType::STANDARD. |
| INVALID_MAX_BID |
Audience extension max bid is invalid when it is greater then the max budget. |
| AUDIENCE_EXTENSION_BULK_UPDATE_NOT_ALLOWED |
Bulk update for audience extension line items is not allowed. |
| UNEXPECTED_AUDIENCE_EXTENSION_ERROR |
An unexpected error occurred. |
| MAX_DAILY_BUDGET_AMOUNT_EXCEEDED |
The value entered for the maximum daily budget on an audience extension line item exceeds the maximum allowed. |
| EXTERNAL_CAMPAIGN_ALREADY_EXISTS |
Creating a campaign for a line item that already has an associated campaign is not allowed. |
| AUDIENCE_EXTENSION_WITHOUT_FEATURE |
Audience extension was specified on a line item but the feature was not enabled. |
| AUDIENCE_EXTENSION_WITHOUT_LINKED_ACCOUNT |
Audience extension was specified on a line item but no audience extension account has been linked. |
| CANNOT_OVERRIDE_CREATIVE_SIZE_WITH_AUDIENCE_EXTENSION |
Assocation creative size overrides are not allowed with audience extension. |
| CANNOT_OVERRIDE_FIELD_WITH_AUDIENCE_EXTENSION |
Some association overrides are not allowed with audience extension. |
| ONLY_ONE_CREATIVE_PLACEHOLDER_ALLOWED |
Only one creative placeholder is allowed for an audience extension line item. |
| MULTIPLE_AUDIENCE_EXTENSION_LINE_ITEMS_ON_ORDER |
Only one audience extension line item can be associated with a given order. |
| CANNOT_COPY_AUDIENCE_EXTENSION_LINE_ITEMS_AND_CREATIVES_TOGETHER |
Audience extension line items must be copied separately from their associated creatives. |
| FEATURE_DEPRECATED |
Audience extension is no longer supported and cannot be used. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
Approval status values for ThirdPartyAudienceSegment objects.
Reason of the given AudienceSegmentError.
| Enumerator | |
|---|---|
| FIRST_PARTY_AUDIENCE_SEGMENT_NOT_SUPPORTED |
First party audience segment is not supported. |
| ONLY_RULE_BASED_FIRST_PARTY_AUDIENCE_SEGMENTS_CAN_BE_CREATED |
Only rule-based first-party audience segments can be created. |
| AUDIENCE_SEGMENT_ID_NOT_FOUND |
Audience segment for the given id is not found. |
| INVALID_AUDIENCE_SEGMENT_RULE |
Audience segment rule is invalid. |
| AUDIENCE_SEGMENT_RULE_TOO_LONG |
Audience segment rule contains too many ad units and/or custom criteria. |
| INVALID_AUDIENCE_SEGMENT_NAME |
Audience segment name is invalid. |
| DUPLICATE_AUDIENCE_SEGMENT_NAME |
Audience segment with this name already exists. |
| INVALID_AUDIENCE_SEGMENT_DESCRIPTION |
Audience segment description is invalid. |
| INVALID_AUDIENCE_SEGMENT_PAGEVIEWS |
Audience segment pageviews value is invalid. It must be between 1 and 12. |
| INVALID_AUDIENCE_SEGMENT_RECENCY |
Audience segment recency value is invalid. It must be between 1 and 90 if pageviews > 1. |
| INVALID_AUDIENCE_SEGMENT_MEMBERSHIP_EXPIRATION |
Audience segment membership expiration value is invalid. It must be between 1 and 180. |
| INVALID_AUDIENCE_SEGMENT_CUSTOM_KEY_NAME |
The given custom key cannot be part of audience segment rule due to unsupported characters. |
| INVALID_AUDIENCE_SEGMENT_CUSTOM_VALUE_NAME |
The given custom value cannot be part of audience segment rule due to unsupported characters. |
| INVALID_AUDIENCE_SEGMENT_CUSTOM_VALUE_MATCH_TYPE |
Broad-match custom value cannot be part of audience segment rule. |
| INVALID_NESTED_FIRST_PARTY_AUDIENCE_SEGMENT |
Audience segment rule cannot contain itself. |
| SHARED_SELLING_PARTNER_ROOT_CANNOT_BE_INCLUDED |
Audience segment rule cannot contain shared selling inventory unit. |
| INVALID_NESTED_THIRD_PARTY_AUDIENCE_SEGMENT |
Audience segment rule cannot contain a nested third-party segment. |
| INACTIVE_NESTED_AUDIENCE_SEGMENT |
Audience segment rule cannot contain a nested inactive segment. |
| AUDIENCE_SEGMENT_GLOBAL_LICENSE_ERROR |
An error occurred when purchasing global licenses. |
| SEGMENT_VIOLATED_POLICY |
Segment cannot be activated as it violates Google's Platform Policy. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
Specifies the statuses for AudienceSegment objects.
| Enumerator | |
|---|---|
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
| ACTIVE |
Active status means this audience segment is available for targeting. |
| INACTIVE |
Inactive status means this audience segment is not available for targeting. |
| UNUSED |
Unused status means this audience segment was deactivated by Google because it is unused. |
Specifies types for AudienceSegment objects.
| Enumerator | |
|---|---|
| AMBIGUOUS_SOAP_REQUEST_HEADER |
The SOAP message contains a request header with an ambiguous definition of the authentication header fields. This means either the
|
| INVALID_EMAIL |
The login provided is invalid. |
| AUTHENTICATION_FAILED |
Tried to authenticate with provided information, but failed. |
| INVALID_OAUTH_SIGNATURE |
The OAuth provided is invalid. |
| INVALID_SERVICE |
The specified service to use was not recognized. |
| MISSING_SOAP_REQUEST_HEADER |
The SOAP message is missing a request header with an
|
| MISSING_AUTHENTICATION_HTTP_HEADER |
The HTTP request is missing a request header with an
|
| MISSING_AUTHENTICATION |
The request is missing an
|
| NETWORK_API_ACCESS_DISABLED |
The network does not have API access enabled. |
| NO_NETWORKS_TO_ACCESS |
The user is not associated with any network. |
| NETWORK_NOT_FOUND |
No network for the given
|
| NETWORK_CODE_REQUIRED |
The user has access to more than one network, but did not provide a
|
| CONNECTION_ERROR |
An error happened on the server side during connection to authentication service. |
| GOOGLE_ACCOUNT_ALREADY_ASSOCIATED_WITH_NETWORK |
The user tried to create a test network using an account that already is associated with a network. |
| UNDER_INVESTIGATION |
The account is blocked and under investigation by the collections team. Please contact Google for more information. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
The reasons for the target error.
The reasons for the CdnConfigurationError.
Indicates the status of the CdnConfiguration.
| Enumerator | |
|---|---|
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
| ACTIVE |
The CDN configuration is in use. |
| ARCHIVED |
The CDN configuration is no longer used. |
Indicates the type of CDN configuration for CdnConfiguration.
| Enumerator | |
|---|---|
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
| LIVE_STREAM_SOURCE_CONTENT |
A configuration that specifies where and how LiveStreamEvent content should be ingested and delivered. |
The type of entity a change occurred on.
Child content eligibility designation.
This field is optional and defaults to ChildContentEligibility::DISALLOWED. This field has no effect on serving enforcement unless you opt to "Child content enforcement" in the network's Child Content settings.
| Enumerator | |
|---|---|
| UNKNOWN | |
| DISALLOWED |
This line item is not eligible to serve on any requests that are child-directed. |
| ALLOWED |
This line item is eligible to serve on requests that are child-directed. |
The reasons for the target error.
| Enumerator | |
|---|---|
| TYPE_IMMUTABLE |
The line item type cannot be changed once created. |
| INVALID_TARGETING_TYPE |
Click tracking line items can only be targeted at ad unit inventory, all other types are invalid, as well as placements. |
| INVALID_ROADBLOCKING_TYPE |
Click tracking line items do not allow us to control creative delivery so are by nature one or more as entered by the third party. |
| INVALID_CREATIVEROTATION_TYPE |
Click tracking line items do not support the CreativeRotationType::OPTIMIZED creative rotation type. |
| INVALID_DELIVERY_RATE_TYPE |
Click tracking line items do not allow us to control line item delivery so we can not control the rate at which they are served. |
| UNSUPPORTED_FIELD |
Not all fields are supported by the click tracking line items. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
Status for
CmsMetadataKey objects.
| Enumerator | |
|---|---|
| ACTIVE | |
| INACTIVE | |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
Status for
CmsMetadataValue objects.
| Enumerator | |
|---|---|
| ACTIVE | |
| INACTIVE | |
| ARCHIVED | |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
Column provides all the trafficking statistics and revenue information available for the chosen Dimension objects.
Columns with INVENTORY_LEVEL should not be used with dimensions relating to line items, orders, companies and creatives, such as Dimension::LINE_ITEM_NAME. Columns with LINE_ITEM_LEVEL can only be used if you have line item-level dynamic allocation enabled on your network.
| Enumerator | |
|---|---|
| AD_SERVER_IMPRESSIONS |
The number of impressions delivered by the ad server. Corresponds to "Ad server impressions" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AD_SERVER_BEGIN_TO_RENDER_IMPRESSIONS |
The number of begin-to-render impressions delivered by the ad server. Corresponds to "Ad server begin to render impressions" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AD_SERVER_TARGETED_IMPRESSIONS |
The number of impressions delivered by the ad server by explicit custom criteria targeting. Corresponds to "Ad server targeted impressions" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AD_SERVER_CLICKS |
The number of clicks delivered by the ad server. Corresponds to "Ad server clicks" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AD_SERVER_TARGETED_CLICKS |
The number of clicks delivered by the ad server by explicit custom criteria targeting. Corresponds to "Ad server targeted clicks" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AD_SERVER_CTR |
The CTR for an ad delivered by the ad server. Corresponds to "Ad server CTR" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AD_SERVER_CPM_AND_CPC_REVENUE |
The CPM and CPC revenue earned, calculated in publisher currency, for the ads delivered by the ad server. Corresponds to "Ad server CPM and CPC revenue" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AD_SERVER_CPD_REVENUE |
The CPD revenue earned, calculated in publisher currency, for the ads delivered by the ad server. Corresponds to "Ad server CPD revenue" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AD_SERVER_CPA_REVENUE |
The CPA revenue earned, calculated in publisher currency, for the ads delivered by the ad server. Corresponds to "CPA revenue" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AD_SERVER_ALL_REVENUE |
The CPM, CPC and CPD revenue earned, calculated in publisher currency, for the ads delivered by the ad server. Corresponds to "Ad server CPM, CPC, CPD, and vCPM revenue" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AD_SERVER_WITHOUT_CPD_AVERAGE_ECPM |
The average estimated cost-per-thousand-impressions earned from the CPM and CPC ads delivered by the ad server. Corresponds to "Ad server average eCPM" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AD_SERVER_WITH_CPD_AVERAGE_ECPM |
The average estimated cost-per-thousand-impressions earned from the CPM, CPC and CPD ads delivered by the ad server. |
| AD_SERVER_LINE_ITEM_LEVEL_PERCENT_IMPRESSIONS |
The ratio of the number of impressions delivered to the total impressions delivered by the ad server for line item-level dynamic allocation. Represented as a percentage. Corresponds to "Ad server impressions (%)" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AD_SERVER_LINE_ITEM_LEVEL_PERCENT_CLICKS |
The ratio of the number of clicks delivered to the total clicks delivered by the ad server for line item-level dynamic allocation. Represented as a percentage. Corresponds to "Ad server clicks (%)" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AD_SERVER_LINE_ITEM_LEVEL_WITHOUT_CPD_PERCENT_REVENUE |
The ratio of revenue generated by ad server to the total CPM and CPC revenue earned by the ads delivered for line item-level dynamic allocation. Represented as a percentage. Corresponds to "Ad server revenue (%)" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AD_SERVER_LINE_ITEM_LEVEL_WITH_CPD_PERCENT_REVENUE |
The ratio of revenue generated by ad server to the total CPM, CPC and CPD revenue earned by the ads delivered for line item-level dynamic allocation. Represented as a percentage. |
| AD_SERVER_UNFILTERED_IMPRESSIONS |
The number of downloaded impressions delivered by the ad server including impressions recognized as spam. Corresponds to "Ad server unfiltered downloaded impressions" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AD_SERVER_UNFILTERED_BEGIN_TO_RENDER_IMPRESSIONS |
The number of begin to render impressions delivered by the ad server including impressions recognized as spam. Corresponds to "Ad server unfiltered begin to render impressions" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AD_SERVER_UNFILTERED_CLICKS |
The number of clicks delivered by the ad server including clicks recognized as spam. Corresponds to "Ad server unfiltered clicks" in the Ad Manager UI. Compatible with the "Historical" report type. |
| ADSENSE_LINE_ITEM_LEVEL_IMPRESSIONS |
The number of impressions an AdSense ad delivered for line item-level dynamic allocation. Corresponds to "AdSense impressions" in the Ad Manager UI. Compatible with the "Historical" report type. |
| ADSENSE_LINE_ITEM_LEVEL_TARGETED_IMPRESSIONS |
The number of impressions an AdSense ad delivered for line item-level dynamic allocation by explicit custom criteria targeting. Corresponds to "AdSense targeted impressions" in the Ad Manager UI. Compatible with the "Historical" report type. |
| ADSENSE_LINE_ITEM_LEVEL_CLICKS |
The number of clicks an AdSense ad delivered for line item-level dynamic allocation. Corresponds to "AdSense clicks" in the Ad Manager UI. Compatible with the "Historical" report type. |
| ADSENSE_LINE_ITEM_LEVEL_TARGETED_CLICKS |
The number of clicks an AdSense ad delivered for line item-level dynamic allocation by explicit custom criteria targeting. Corresponds to "AdSense targeted clicks" in the Ad Manager UI. Compatible with the "Historical" report type. |
| ADSENSE_LINE_ITEM_LEVEL_CTR |
The ratio of clicks an AdSense reservation ad delivered to the number of impressions it delivered, including line item-level dynamic allocation. Corresponds to "AdSense CTR" in the Ad Manager UI. Compatible with the "Historical" report type. |
| ADSENSE_LINE_ITEM_LEVEL_REVENUE |
Revenue generated from AdSense ads delivered for line item-level dynamic allocation. Corresponds to "AdSense revenue" in the Ad Manager UI. Compatible with the "Historical" report type. |
| ADSENSE_LINE_ITEM_LEVEL_AVERAGE_ECPM |
The average estimated cost-per-thousand-impressions earned from the ads delivered by AdSense for line item-level dynamic allocation. Corresponds to "AdSense average eCPM" in the Ad Manager UI. Compatible with the "Historical" report type. |
| ADSENSE_LINE_ITEM_LEVEL_PERCENT_IMPRESSIONS |
The ratio of the number of impressions delivered by AdSense reservation ads to the total impressions delivered for line item-level dynamic allocation. Represented as a percentage. Corresponds to "AdSense impressions (%)" in the Ad Manager UI. Compatible with the "Historical" report type. |
| ADSENSE_LINE_ITEM_LEVEL_PERCENT_CLICKS |
The ratio of the number of clicks delivered by AdSense reservation ads to the total clicks delivered for line item-level dynamic allocation. Represented as a percentage. Corresponds to "AdSense clicks (%)" in the Ad Manager UI. Compatible with the "Historical" report type. |
| ADSENSE_LINE_ITEM_LEVEL_WITHOUT_CPD_PERCENT_REVENUE |
The ratio of revenue to the total revenue earned from the CPM and CPC ads delivered by AdSense for line item-level dynamic allocation. Represented as a percentage. Corresponds to "AdSense revenue (%)" in the Ad Manager UI. Compatible with the "Historical" report type. |
| ADSENSE_LINE_ITEM_LEVEL_WITH_CPD_PERCENT_REVENUE |
The ratio of revenue to the total revenue earned from the CPM, CPC and CPD ads delivered by AdSense for line item-level dynamic allocation. Represented as a percentage. |
| AD_EXCHANGE_LINE_ITEM_LEVEL_IMPRESSIONS |
The number of impressions an Ad Exchange ad delivered for line item-level dynamic allocation. Corresponds to "Ad Exchange impressions" in the Ad Manager UI. Compatible with the "Historical" report type. |
| BID_COUNT |
The number of bids associated with the selected dimensions. Corresponds to "Bids" in the Ad Manager UI. Compatible with the "Historical" report type. |
| BID_AVERAGE_CPM |
The average CPM associated with these bids. Corresponds to "Average bid CPM" in the Ad Manager UI. Compatible with the "Historical" report type. |
| YIELD_GROUP_CALLOUTS |
Number of times a yield partner is asked to return bid to fill a yield group request. Only applies to Open Bidding; not Mediation. This data is available for 45 days after the event. Corresponds to "Yield group callouts" in the Ad Manager UI. Compatible with the "Historical" report type. |
| YIELD_GROUP_SUCCESSFUL_RESPONSES |
Number of times a yield group buyer successfully returned a bid in response to a yield group callout, even if that response is "no bids." Only applies to Open Bidding; not Mediation. This data is available for 45 days after the event. Corresponds to "Yield group successful responses" in the Ad Manager UI. Compatible with the "Historical" report type. |
| YIELD_GROUP_BIDS |
Number of bids received from Open Bidding buyers, regardless of whether the returned bid competes in an auction. This number might be greater than Yield group callouts because a buyer can return multiple bids. Only applies to Open Bidding; not Mediation. This data is available for 45 days after the event. Corresponds to "Yield group bids" in the Ad Manager UI. Compatible with the "Historical" report type. |
| YIELD_GROUP_BIDS_IN_AUCTION |
Number of bids received from Open Bidding buyers that competed in the auction. Some bids may be filtered out before the auction runs if the bidder's response omits required fields or contains a creative that violates Google's policies. Learn more about policies and enforcement. Only applies to Open Bidding; not Mediation. This data is available for 45 days after the event. Corresponds to "Yield group bids in auction" in the Ad Manager UI. Compatible with the "Historical" report type. |
| YIELD_GROUP_AUCTIONS_WON |
Number of winning bids received from Open Bidding buyers, even when the winning bid is placed at the end of a mediation for mobile apps chain. Only applies to Open Bidding; not Mediation. This data is available for 45 days after the event. Corresponds to "Yield group auctions won" in the Ad Manager UI. Compatible with the "Historical" report type. |
| DEALS_BID_REQUESTS |
Number of bid requests sent for each deal. Must be broken down by Not tracked for Programmatic Guaranteed deals (will show zero on those rows). Corresponds to "Deals bid requests" in the Ad Manager UI. Compatible with the "Historical" report type. |
| DEALS_BIDS |
Number of bids placed on each deal. Not tracked for Programmatic Guaranteed deals (will show zero on those rows). Corresponds to "Deals bids" in the Ad Manager UI. Compatible with the "Historical" report type. |
| DEALS_BID_RATE |
Bid rate for each deal. Must be broken down by Not tracked for Programmatic Guaranteed deals (will show N/A on those rows). Corresponds to "Deals bid rate" in the Ad Manager UI. Compatible with the "Historical" report type. |
| DEALS_WINNING_BIDS |
Number of winning bids for each deal. Not tracked for Programmatic Guaranteed deals (will show zero on those rows). Corresponds to "Deals winning bids" in the Ad Manager UI. Compatible with the "Historical" report type. |
| DEALS_WIN_RATE |
Win rate for each deal. Not tracked for Programmatic Guaranteed deals (will show N/A on those rows). Corresponds to "Deals win rate" in the Ad Manager UI. Compatible with the "Historical" report type. |
| YIELD_GROUP_IMPRESSIONS |
Number of matched yield group requests where a yield partner delivered their ad to publisher inventory. Corresponds to "Yield group impressions" in the Ad Manager UI. Compatible with the "Historical" report type. |
| YIELD_GROUP_ESTIMATED_REVENUE |
Total net revenue earned by a yield group, based upon the yield group estimated CPM and yield group impressions recorded. This revenue already excludes Google revenue share. Corresponds to "Yield group estimated revenue" in the Ad Manager UI. Compatible with the "Historical" report type. |
| YIELD_GROUP_ESTIMATED_CPM |
The estimated net rate for yield groups or individual yield group partners. Corresponds to "Yield group estimated CPM" in the Ad Manager UI. Compatible with the "Historical" report type. |
| YIELD_GROUP_MEDIATION_FILL_RATE |
Yield group Mediation fill rate indicating how often a network fills an ad request. Corresponds to "Mediation fill rate" in the Ad Manager UI. Compatible with the "Historical" report type. |
| YIELD_GROUP_MEDIATION_PASSBACKS |
Passbacks are counted when an ad network is given a chance to serve but does not deliver an impression, and Ad Manager Mediation moves on to the next ad network in the mediation chain. Passbacks are not currently counted for the "Ad server" demand channel. Corresponds to "Mediation passbacks" in the Ad Manager UI. Compatible with the "Historical" report type. |
| YIELD_GROUP_MEDIATION_THIRD_PARTY_ECPM |
Revenue per thousand impressions based on data collected by Ad Manager from third-party ad network reports. Displays zero if data collection is not enabled. Corresponds to "Mediation third-party eCPM" in the Ad Manager UI. Compatible with the "Historical" report type. |
| YIELD_GROUP_MEDIATION_CHAINS_SERVED |
Total requests where a Mediation chain was served, even if none of the ad networks delivered an impression. Corresponds to "Mediation chains served" in the Ad Manager UI. Compatible with the "Historical" report type. |
| MEDIATION_THIRD_PARTY_ECPM |
Mediation third-party average cost-per-thousand-impressions. Compatible with the "Historical" report type. |
| AD_EXCHANGE_LINE_ITEM_LEVEL_TARGETED_IMPRESSIONS |
The number of impressions an Ad Exchange ad delivered for line item-level dynamic allocation by explicit custom criteria targeting. Corresponds to "Ad Exchange targeted impressions" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AD_EXCHANGE_LINE_ITEM_LEVEL_CLICKS |
The number of clicks an Ad Exchange ad delivered for line item-level dynamic allocation. Corresponds to "Ad Exchange clicks" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AD_EXCHANGE_LINE_ITEM_LEVEL_TARGETED_CLICKS |
The number of clicks an Ad Exchange ad delivered for line item-level dynamic allocation by explicit custom criteria targeting. Corresponds to "Ad Exchange targeted clicks" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AD_EXCHANGE_LINE_ITEM_LEVEL_CTR |
The ratio of clicks an Ad Exchange ad delivered to the number of impressions it delivered for line item-level dynamic allocation. Corresponds to "Ad Exchange CTR" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AD_EXCHANGE_LINE_ITEM_LEVEL_PERCENT_IMPRESSIONS |
The ratio of the number of impressions delivered to the total impressions delivered by Ad Exchange for line item-level dynamic allocation. Represented as a percentage. Corresponds to "Ad Exchange impressions (%)" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AD_EXCHANGE_LINE_ITEM_LEVEL_PERCENT_CLICKS |
The ratio of the number of clicks delivered to the total clicks delivered by Ad Exchange for line item-level dynamic allocation. Represented as a percentage. Corresponds to "Ad Exchange clicks (%)" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AD_EXCHANGE_LINE_ITEM_LEVEL_REVENUE |
Revenue generated from Ad Exchange ads delivered for line item-level dynamic allocation. Represented in publisher currency and time zone. Corresponds to "Ad Exchange revenue" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AD_EXCHANGE_LINE_ITEM_LEVEL_WITHOUT_CPD_PERCENT_REVENUE |
The ratio of revenue generated by Ad Exchange to the total revenue earned by CPM and CPC ads delivered for line item-level dynamic allocation. Represented as a percentage. Corresponds to "Ad Exchange revenue (%)" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AD_EXCHANGE_LINE_ITEM_LEVEL_WITH_CPD_PERCENT_REVENUE |
The ratio of revenue generated by Ad Exchange to the total revenue earned by CPM, CPC and CPD ads delivered for line item-level dynamic allocation. Represented as a percentage. |
| AD_EXCHANGE_LINE_ITEM_LEVEL_AVERAGE_ECPM |
The average estimated cost-per-thousand-impressions earned from the delivery of Ad Exchange ads for line item-level dynamic allocation. Corresponds to "Ad Exchange average eCPM" in the Ad Manager UI. Compatible with the "Historical" report type. |
| TOTAL_LINE_ITEM_LEVEL_IMPRESSIONS |
The total number of impressions delivered including line item-level dynamic allocation. Corresponds to "Total impressions" in the Ad Manager UI. Compatible with the "Historical" report type. |
| TOTAL_LINE_ITEM_LEVEL_TARGETED_IMPRESSIONS |
The total number of impressions delivered including line item-level dynamic allocation by explicit custom criteria targeting. Corresponds to "Total targeted impressions" in the Ad Manager UI. Compatible with the "Historical" report type. |
| TOTAL_LINE_ITEM_LEVEL_CLICKS |
The total number of clicks delivered including line item-level dynamic allocation. Corresponds to "Total clicks" in the Ad Manager UI. Compatible with the "Historical" report type. |
| TOTAL_LINE_ITEM_LEVEL_TARGETED_CLICKS |
The total number of clicks delivered including line item-level dynamic allocation by explicit custom criteria targeting Corresponds to "Total targeted clicks" in the Ad Manager UI. Compatible with the "Historical" report type. |
| TOTAL_LINE_ITEM_LEVEL_CTR |
The ratio of total clicks on ads delivered by the ad servers to the total number of impressions delivered for an ad including line item-level dynamic allocation. Corresponds to "Total CTR" in the Ad Manager UI. Compatible with the "Historical" report type. |
| TOTAL_LINE_ITEM_LEVEL_CPM_AND_CPC_REVENUE |
The total CPM and CPC revenue generated by the ad servers including line item-level dynamic allocation. Corresponds to "Total CPM and CPC revenue" in the Ad Manager UI. Compatible with the "Historical" report type. |
| TOTAL_LINE_ITEM_LEVEL_ALL_REVENUE |
The total CPM, CPC and CPD revenue generated by the ad servers including line item-level dynamic allocation. Corresponds to "Total CPM, CPC, CPD, and vCPM revenue" in the Ad Manager UI. Compatible with the "Historical" report type. |
| TOTAL_LINE_ITEM_LEVEL_WITHOUT_CPD_AVERAGE_ECPM |
Estimated cost-per-thousand-impressions (eCPM) of CPM and CPC ads delivered by the ad servers including line item-level dynamic allocation. Corresponds to "Total average eCPM" in the Ad Manager UI. Compatible with the "Historical" report type. |
| TOTAL_LINE_ITEM_LEVEL_WITH_CPD_AVERAGE_ECPM |
Estimated cost-per-thousand-impressions (eCPM) of CPM, CPC and CPD ads delivered by the ad servers including line item-level dynamic allocation. |
| TOTAL_CODE_SERVED_COUNT |
The total number of times that the code for an ad is served by the ad server including inventory-level dynamic allocation. Corresponds to "Total code served count" in the Ad Manager UI. Compatible with the "Historical" report type. |
| TOTAL_AD_REQUESTS |
The total number of times that an ad request is sent to the ad server including dynamic allocation. Corresponds to "Total ad requests" in the Ad Manager UI. Compatible with the "Historical" report type. |
| TOTAL_RESPONSES_SERVED |
The total number of times that an ad is served by the ad server including dynamic allocation. Corresponds to "Total responses served" in the Ad Manager UI. Compatible with the "Historical" report type. |
| TOTAL_UNMATCHED_AD_REQUESTS |
The total number of times that an ad is not returned by the ad server. Corresponds to "Total unmatched ad requests" in the Ad Manager UI. Compatible with the "Historical" report type. |
| TOTAL_FILL_RATE |
The fill rate indicating how often an ad request is filled by the ad server including dynamic allocation. Corresponds to "Total fill rate" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AD_SERVER_RESPONSES_SERVED |
The total number of times that an ad is served by the ad server. Corresponds to "Ad server responses served" in the Ad Manager UI. Compatible with the "Historical" report type. |
| ADSENSE_RESPONSES_SERVED |
The total number of times that an AdSense ad is delivered. Corresponds to "AdSense responses served" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AD_EXCHANGE_RESPONSES_SERVED |
The total number of times that an Ad Exchange ad is delivered. Corresponds to "Ad Exchange responses served" in the Ad Manager UI. Compatible with the "Historical" report type. |
| PROGRAMMATIC_RESPONSES_SERVED |
Total number of ad responses served from programmatic demand sources. Includes Ad Exchange, Open Bidding, and Preferred Deals. Differs from Ad Exchange responses served, which doesn't include Open Bidding matched ad requests. Corresponds to "Programmatic responses served" in the Ad Manager UI. Compatible with the "Historical" report type. |
| PROGRAMMATIC_MATCH_RATE |
The number of programmatic responses served divided by the number of requests eligible for programmatic. Includes Ad Exchange, Open Bidding, and Preferred Deals. Corresponds to "Programmatic match rate" in the Ad Manager UI. Compatible with the "Historical" report type. |
| TOTAL_PROGRAMMATIC_ELIGIBLE_AD_REQUESTS |
The total number of ad requests eligible for programmatic inventory, including Programmatic Guaranteed, Preferred Deals, backfill, and open auction. For optimized pods, this metric will count a single opportunity when the pod doesn't fill with programmatic demand. When it does fill, it will count each matched query. Corresponds to "Programmatic eligible ad requests" in the Ad Manager UI. Compatible with the "Historical" report type. |
| TOTAL_VIDEO_OPPORTUNITIES |
The total number of video opportunities. Corresponds to "True opportunities" in the Ad Manager UI. Compatible with the "Historical" report type. |
| TOTAL_VIDEO_CAPPED_OPPORTUNITIES |
The total number of video capped opportunities. Corresponds to "Capped opportunities" in the Ad Manager UI. Compatible with the "Historical" report type. |
| TOTAL_VIDEO_MATCHED_OPPORTUNITIES |
The total number of video matched opportunities. Corresponds to "Matched opportunities" in the Ad Manager UI. Compatible with the "Historical" report type. |
| TOTAL_VIDEO_MATCHED_DURATION |
The total filled duration in ad breaks. Corresponds to "Matched duration (seconds)" in the Ad Manager UI. Compatible with the "Historical" report type. |
| TOTAL_VIDEO_DURATION |
The total duration in ad breaks. Corresponds to "Total duration (seconds)" in the Ad Manager UI. Compatible with the "Historical" report type. |
| TOTAL_VIDEO_BREAK_START |
The total number of break starts. Corresponds to "Break start" in the Ad Manager UI. Compatible with the "Historical" report type. |
| TOTAL_VIDEO_BREAK_END |
The total number of break ends. Corresponds to "Break end" in the Ad Manager UI. Compatible with the "Historical" report type. |
| TOTAL_INVENTORY_LEVEL_UNFILLED_IMPRESSIONS |
The total number of missed impressions due to the ad servers' inability to find ads to serve, including inventory-level dynamic allocation. Corresponds to "Unfilled impressions" in the Ad Manager UI. Compatible with the "Historical" report type. |
| UNIQUE_REACH_FREQUENCY |
Corresponds to "Average impressions/unique visitor" in the Ad Manager UI. Compatible with the "Reach" report type. |
| UNIQUE_REACH_IMPRESSIONS |
Corresponds to "Total reach impressions" in the Ad Manager UI. Compatible with the "Reach" report type. |
| UNIQUE_REACH |
Corresponds to "Total unique visitors" in the Ad Manager UI. Compatible with the "Reach" report type. |
| SDK_MEDIATION_CREATIVE_IMPRESSIONS |
The number of impressions for a particular SDK mediation creative. Corresponds to "SDK mediation creative impressions" in the Ad Manager UI. Compatible with the "Historical" report type. |
| SDK_MEDIATION_CREATIVE_CLICKS |
The number of clicks for a particular SDK mediation creative. Corresponds to "SDK mediation creative clicks" in the Ad Manager UI. Compatible with the "Historical" report type. |
| SELL_THROUGH_FORECASTED_IMPRESSIONS |
The number of forecasted impressions for future sell-through reports. This metric is available for the next 90 days with a daily break down and for the next 12 months with a monthly break down. Corresponds to "Forecasted impressions" in the Ad Manager UI. Compatible with the "Future sell-through" report type. |
| PARTNER_SALES_PARTNER_IMPRESSIONS |
The number of partner-sold impressions served to the YouTube partner ad inventory. Corresponds to "Partner-sold impressions" in the Ad Manager UI. Compatible with the "YouTube consolidated" report type. |
| PARTNER_SALES_PARTNER_CODE_SERVED |
The number of times the ad server responded to a request for the YouTube partner ad inventory. Corresponds to "Partner-sold code served count" in the Ad Manager UI. Compatible with the "YouTube consolidated" report type. |
| PARTNER_SALES_GOOGLE_IMPRESSIONS |
The number of Google-sold impressions served to the YouTube partner ad inventory. Corresponds to "Google-sold impressions" in the Ad Manager UI. Compatible with the "YouTube consolidated" report type. |
| PARTNER_SALES_GOOGLE_RESERVATION_IMPRESSIONS |
The number of Google-sold reservation impressions served to the YouTube partner ad inventory. Corresponds to "Google-sold reservation impressions" in the Ad Manager UI. Compatible with the "YouTube consolidated" report type. |
| PARTNER_SALES_GOOGLE_AUCTION_IMPRESSIONS |
The number of Google-sold auction impressions served to the YouTube partner ad inventory. Corresponds to "Google-sold auction impressions" in the Ad Manager UI. Compatible with the "YouTube consolidated" report type. |
| PARTNER_SALES_QUERIES |
The total number of ad requests that were eligible to serve to the YouTube partner ad inventory. Corresponds to "Total ad requests" in the Ad Manager UI. Compatible with the "YouTube consolidated" report type. |
| PARTNER_SALES_FILLED_QUERIES |
The number of ad requests for the YouTube partner ad inventory that were filled with at least 1 ad. This includes both partner-sold and Google-sold requests. Google-sold can fill at most 2 ads, while partner-sold can fill at most 1 ad. Corresponds to "Filled ad requests" in the Ad Manager UI. Compatible with the "YouTube consolidated" report type. |
| PARTNER_SALES_SELL_THROUGH_RATE |
The fill rate percentage of filled requests to total ad requests. Corresponds to "Fill rate" in the Ad Manager UI. Compatible with the "YouTube consolidated" report type. |
| SELL_THROUGH_AVAILABLE_IMPRESSIONS |
The number of available impressions for future sell-through reports. This metric is available for the next 90 days with a daily break down and for the next 12 months with a monthly break down. Corresponds to "Available impressions" in the Ad Manager UI. Compatible with the "Future sell-through" report type. |
| SELL_THROUGH_RESERVED_IMPRESSIONS |
The number of reserved impressions for future sell-through reports. This metric is available for the next 90 days with a daily break down and for the next 12 months with a monthly break down. Corresponds to "Reserved impressions" in the Ad Manager UI. Compatible with the "Future sell-through" report type. |
| SELL_THROUGH_SELL_THROUGH_RATE |
The sell-through rate for impressions for future sell-through reports. This metric is available for the next 90 days with a daily break down and for the next 12 months with a monthly break down. Corresponds to "Sell-through rate" in the Ad Manager UI. Compatible with the "Future sell-through" report type. |
| RICH_MEDIA_BACKUP_IMAGES |
The total number of times a backup image is served in place of a rich media ad. Corresponds to "Backup image impressions" in the Ad Manager UI. Compatible with the "Historical" report type. |
| RICH_MEDIA_DISPLAY_TIME |
The amount of time(seconds) that each rich media ad is displayed to users. Corresponds to "Total display time" in the Ad Manager UI. Compatible with the "Historical" report type. |
| RICH_MEDIA_AVERAGE_DISPLAY_TIME |
The average amount of time(seconds) that each rich media ad is displayed to users. Corresponds to "Average display time" in the Ad Manager UI. Compatible with the "Historical" report type. |
| RICH_MEDIA_EXPANSIONS |
The number of times an expanding ad was expanded. Corresponds to "Total expansions" in the Ad Manager UI. Compatible with the "Historical" report type. |
| RICH_MEDIA_EXPANDING_TIME |
The average amount of time(seconds) that an expanding ad is viewed in an expanded state. Corresponds to "Average expanding time" in the Ad Manager UI. Compatible with the "Historical" report type. |
| RICH_MEDIA_INTERACTION_TIME |
The average amount of time(seconds) that a user interacts with a rich media ad. Corresponds to "Interaction time" in the Ad Manager UI. Compatible with the "Historical" report type. |
| RICH_MEDIA_INTERACTION_COUNT |
The number of times that a user interacts with a rich media ad. Corresponds to "Total interactions" in the Ad Manager UI. Compatible with the "Historical" report type. |
| RICH_MEDIA_INTERACTION_RATE |
The ratio of rich media ad interactions to the number of times the ad was displayed. Represented as a percentage. Corresponds to "Interaction rate" in the Ad Manager UI. Compatible with the "Historical" report type. |
| RICH_MEDIA_AVERAGE_INTERACTION_TIME |
The average amount of time(seconds) that a user interacts with a rich media ad. Corresponds to "Average interaction time" in the Ad Manager UI. Compatible with the "Historical" report type. |
| RICH_MEDIA_INTERACTION_IMPRESSIONS |
The number of impressions where a user interacted with a rich media ad. Corresponds to "Interactive impressions" in the Ad Manager UI. Compatible with the "Historical" report type. |
| RICH_MEDIA_MANUAL_CLOSES |
The number of times that a user manually closes a floating, expanding, in-page with overlay, or in-page with floating ad. Corresponds to "Manual closes" in the Ad Manager UI. Compatible with the "Historical" report type. |
| RICH_MEDIA_FULL_SCREEN_IMPRESSIONS |
A metric that measures an impression only once when a user opens an ad in full screen mode. Corresponds to "Full-screen impressions" in the Ad Manager UI. Compatible with the "Historical" report type. |
| RICH_MEDIA_VIDEO_INTERACTIONS |
The number of times a user clicked on the graphical controls of a video player. Corresponds to "Total video interactions" in the Ad Manager UI. Compatible with the "Historical" report type. |
| RICH_MEDIA_VIDEO_INTERACTION_RATE |
The ratio of video interactions to video plays. Represented as a percentage. Corresponds to "Video interaction rate" in the Ad Manager UI. Compatible with the "Historical" report type. |
| RICH_MEDIA_VIDEO_MUTES |
The number of times a rich media video was muted. Corresponds to "Mute" in the Ad Manager UI. Compatible with the "Historical" report type. |
| RICH_MEDIA_VIDEO_PAUSES |
The number of times a rich media video was paused. Corresponds to "Pause" in the Ad Manager UI. Compatible with the "Historical" report type. |
| RICH_MEDIA_VIDEO_PLAYES |
The number of times a rich media video was played. Corresponds to "Plays" in the Ad Manager UI. Compatible with the "Historical" report type. |
| RICH_MEDIA_VIDEO_MIDPOINTS |
The number of times a rich media video was played up to midpoint. Corresponds to "Midpoint" in the Ad Manager UI. Compatible with the "Historical" report type. |
| RICH_MEDIA_VIDEO_COMPLETES |
The number of times a rich media video was fully played. Corresponds to "Complete" in the Ad Manager UI. Compatible with the "Historical" report type. |
| RICH_MEDIA_VIDEO_REPLAYS |
The number of times a rich media video was restarted. Corresponds to "Replays" in the Ad Manager UI. Compatible with the "Historical" report type. |
| RICH_MEDIA_VIDEO_STOPS |
The number of times a rich media video was stopped. Corresponds to "Stops" in the Ad Manager UI. Compatible with the "Historical" report type. |
| RICH_MEDIA_VIDEO_UNMUTES |
The number of times a rich media video was unmuted. Corresponds to "Unmute" in the Ad Manager UI. Compatible with the "Historical" report type. |
| RICH_MEDIA_VIDEO_VIEW_TIME |
The average amount of time(seconds) that a rich media video was viewed per view. Corresponds to "Average view time" in the Ad Manager UI. Compatible with the "Historical" report type. |
| RICH_MEDIA_VIDEO_VIEW_RATE |
The percentage of a video watched by a user. Corresponds to "View rate" in the Ad Manager UI. Compatible with the "Historical" report type. |
| RICH_MEDIA_CUSTOM_EVENT_TIME |
The amount of time (seconds) that a user interacts with a rich media ad. Corresponds to "Custom event - time" in the Ad Manager UI. Compatible with the "Historical" report type. |
| RICH_MEDIA_CUSTOM_EVENT_COUNT |
The number of times a user views and interacts with a specified part of a rich media ad. Corresponds to "Custom event - count" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_VIEWERSHIP_START |
The number of impressions where the video was played. Corresponds to "Start" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_VIEWERSHIP_FIRST_QUARTILE |
The number of times the video played to 25% of its length. Corresponds to "First quartile" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_VIEWERSHIP_MIDPOINT |
The number of times the video reached its midpoint during play. Corresponds to "Midpoint" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_VIEWERSHIP_THIRD_QUARTILE |
The number of times the video played to 75% of its length. Corresponds to "Third quartile" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_VIEWERSHIP_COMPLETE |
The number of times the video played to completion. Corresponds to "Complete" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_VIEWERSHIP_AVERAGE_VIEW_RATE |
Average percentage of the video watched by users. Corresponds to "Average view rate" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_VIEWERSHIP_AVERAGE_VIEW_TIME |
Average time(seconds) users watched the video. Corresponds to "Average view time" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_VIEWERSHIP_COMPLETION_RATE |
Percentage of times the video played to the end. Corresponds to "Completion rate" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_VIEWERSHIP_TOTAL_ERROR_COUNT |
The number of times an error occurred, such as a VAST redirect error, a video playback error, or an invalid response error. Corresponds to "Total error count" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_VIEWERSHIP_VIDEO_LENGTH |
Duration of the video creative. Corresponds to "Video length" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_VIEWERSHIP_SKIP_BUTTON_SHOWN |
The number of times a skip button is shown in video. Corresponds to "Skip button shown" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_VIEWERSHIP_ENGAGED_VIEW |
The number of engaged views i.e. ad is viewed to completion or for 30s, whichever comes first. Corresponds to "Engaged view" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_VIEWERSHIP_VIEW_THROUGH_RATE |
View-through rate represented as a percentage. Corresponds to "View-through rate" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_VIEWERSHIP_AUTO_PLAYS |
Number of times that the publisher specified a video ad played automatically. Corresponds to "Auto-plays" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_VIEWERSHIP_CLICK_TO_PLAYS |
Number of times that the publisher specified a video ad was clicked to play. Corresponds to "Click-to-plays" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_VIEWERSHIP_TOTAL_ERROR_RATE |
Error rate is the percentage of video error count from (error count + total impressions). Corresponds to "Total error rate" in the Ad Manager UI. Compatible with the "Historical" report type. |
| DROPOFF_RATE |
The drop-off rate. Corresponds to "Drop-off rate" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_TRUEVIEW_VIEWS |
Number of times a video ad has been viewed to completion or watched to 30 seconds, whichever happens first. Corresponds to "TrueView views" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_TRUEVIEW_SKIP_RATE |
Percentage of times a user clicked Skip. Corresponds to "TrueView skip rate" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_TRUEVIEW_VTR |
TrueView views divided by TrueView impressions. Corresponds to "TrueView VTR" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_ERRORS_VAST_ERROR_100_COUNT |
Number of VAST video errors of type 100. Corresponds to "VAST error 100 count" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_ERRORS_VAST_ERROR_101_COUNT |
Number of VAST video errors of type 101. Corresponds to "VAST error 101 count" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_ERRORS_VAST_ERROR_102_COUNT |
Number of VAST video errors of type 102. Corresponds to "VAST error 102 count" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_ERRORS_VAST_ERROR_200_COUNT |
Number of VAST video errors of type 200. Corresponds to "VAST error 200 count" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_ERRORS_VAST_ERROR_201_COUNT |
Number of VAST video errors of type 201. Corresponds to "VAST error 201 count" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_ERRORS_VAST_ERROR_202_COUNT |
Number of VAST video errors of type 202. Corresponds to "VAST error 202 count" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_ERRORS_VAST_ERROR_203_COUNT |
Number of VAST video errors of type 203. Corresponds to "VAST error 203 count" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_ERRORS_VAST_ERROR_300_COUNT |
Number of VAST video errors of type 300. Corresponds to "VAST error 300 count" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_ERRORS_VAST_ERROR_301_COUNT |
Number of VAST video errors of type 301. Corresponds to "VAST error 301 count" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_ERRORS_VAST_ERROR_302_COUNT |
Number of VAST video errors of type 302. Corresponds to "VAST error 302 count" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_ERRORS_VAST_ERROR_303_COUNT |
Number of VAST video errors of type 303. Corresponds to "VAST error 303 count" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_ERRORS_VAST_ERROR_400_COUNT |
Number of VAST video errors of type 400. Corresponds to "VAST error 400 count" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_ERRORS_VAST_ERROR_401_COUNT |
Number of VAST video errors of type 401. Corresponds to "VAST error 401 count" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_ERRORS_VAST_ERROR_402_COUNT |
Number of VAST video errors of type 402. Corresponds to "VAST error 402 count" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_ERRORS_VAST_ERROR_403_COUNT |
Number of VAST video errors of type 403. Corresponds to "VAST error 403 count" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_ERRORS_VAST_ERROR_405_COUNT |
Number of VAST video errors of type 405. Corresponds to "VAST error 405 count" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_ERRORS_VAST_ERROR_500_COUNT |
Number of VAST video errors of type 500. Corresponds to "VAST error 500 count" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_ERRORS_VAST_ERROR_501_COUNT |
Number of VAST video errors of type 501. Corresponds to "VAST error 501 count" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_ERRORS_VAST_ERROR_502_COUNT |
Number of VAST video errors of type 502. Corresponds to "VAST error 502 count" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_ERRORS_VAST_ERROR_503_COUNT |
Number of VAST video errors of type 503. Corresponds to "VAST error 503 count" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_ERRORS_VAST_ERROR_600_COUNT |
Number of VAST video errors of type 600. Corresponds to "VAST error 600 count" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_ERRORS_VAST_ERROR_601_COUNT |
Number of VAST video errors of type 601. Corresponds to "VAST error 601 count" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_ERRORS_VAST_ERROR_602_COUNT |
Number of VAST video errors of type 602. Corresponds to "VAST error 602 count" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_ERRORS_VAST_ERROR_603_COUNT |
Number of VAST video errors of type 603. Corresponds to "VAST error 603 count" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_ERRORS_VAST_ERROR_604_COUNT |
Number of VAST video errors of type 604. Corresponds to "VAST error 604 count" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_ERRORS_VAST_ERROR_900_COUNT |
Number of VAST video errors of type 900. Corresponds to "VAST error 900 count" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_ERRORS_VAST_ERROR_901_COUNT |
Number of VAST video errors of type 901. Corresponds to "VAST error 901 count" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_INTERACTION_PAUSE |
Video interaction event: The number of times user paused ad clip. Corresponds to "Pause" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_INTERACTION_RESUME |
Video interaction event: The number of times the user unpaused the video. Corresponds to "Resume" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_INTERACTION_REWIND |
Video interaction event: The number of times a user rewinds the video. Corresponds to "Rewind" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_INTERACTION_MUTE |
Video interaction event: The number of times video player was in mute state during play of ad clip. Corresponds to "Mute" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_INTERACTION_UNMUTE |
Video interaction event: The number of times a user unmutes the video. Corresponds to "Unmute" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_INTERACTION_COLLAPSE |
Video interaction event: The number of times a user collapses a video, either to its original size or to a different size. Corresponds to "Collapse" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_INTERACTION_EXPAND |
Video interaction event: The number of times a user expands a video. Corresponds to "Expand" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_INTERACTION_FULL_SCREEN |
Video interaction event: The number of times ad clip played in full screen mode. Corresponds to "Full screen" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_INTERACTION_AVERAGE_INTERACTION_RATE |
Video interaction event: The number of user interactions with a video, on average, such as pause, full screen, mute, etc. Corresponds to "Average interaction rate" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_INTERACTION_VIDEO_SKIPS |
Video interaction event: The number of times a skippable video is skipped. Corresponds to "Video skipped" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_OPTIMIZATION_CONTROL_STARTS |
The number of control starts. Corresponds to "Control starts" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_OPTIMIZATION_OPTIMIZED_STARTS |
The number of optimized starts. Corresponds to "Optimized starts" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_OPTIMIZATION_CONTROL_COMPLETES |
The number of control completes. Corresponds to "Control completes" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_OPTIMIZATION_OPTIMIZED_COMPLETES |
The number of optimized completes. Corresponds to "Optimized completes" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_OPTIMIZATION_CONTROL_COMPLETION_RATE |
The rate of control completions. Corresponds to "Control completion rate" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_OPTIMIZATION_OPTIMIZED_COMPLETION_RATE |
The rate of optimized completions. Corresponds to "Optimized completion rate" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_OPTIMIZATION_COMPLETION_RATE_LIFT |
The percentage by which optimized completion rate is greater than the unoptimized completion rate. This is calculated as (( Column::VIDEO_OPTIMIZATION_OPTIMIZED_COMPLETION_RATE/ Column::VIDEO_OPTIMIZATION_CONTROL_COMPLETION_RATE)
Corresponds to "Completion rate lift" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_OPTIMIZATION_CONTROL_SKIP_BUTTON_SHOWN |
The number of control skip buttons shown. Corresponds to "Control skip button shown" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_OPTIMIZATION_OPTIMIZED_SKIP_BUTTON_SHOWN |
The number of optimized skip buttons shown. Corresponds to "Optimized skip button shown" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_OPTIMIZATION_CONTROL_ENGAGED_VIEW |
The number of control engaged views. Corresponds to "Control engaged view" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_OPTIMIZATION_OPTIMIZED_ENGAGED_VIEW |
The number of optimized engaged views. Corresponds to "Optimized engaged view" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_OPTIMIZATION_CONTROL_VIEW_THROUGH_RATE |
The control view-through rate. Corresponds to "Control view-through rate" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_OPTIMIZATION_OPTIMIZED_VIEW_THROUGH_RATE |
The optimized view-through rate. Corresponds to "Optimized view-through rate" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_OPTIMIZATION_VIEW_THROUGH_RATE_LIFT |
The percentage by which optimized view-through rate is greater than the unoptimized view-through rate. This is calculated as (( Column::VIDEO_OPTIMIZATION_OPTIMIZED_VIEW_THROUGH_RATE/ Column::VIDEO_OPTIMIZATION_CONTROL_VIEW_THROUGH_RATE) - 1) * 100 for an ad for which the optimization feature has been enabled. Corresponds to "View-through rate lift" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_IMPRESSIONS_REAL_TIME |
The number of impressions for video realtime reporting. Corresponds to "Total impressions" in the Ad Manager UI. |
| VIDEO_MATCHED_QUERIES_REAL_TIME |
The number of matched queries for video realtime reporting. Corresponds to "Total responses served" in the Ad Manager UI. |
| VIDEO_UNMATCHED_QUERIES_REAL_TIME |
The number of unmatched queries for video realtime reporting. Corresponds to "Total unmatched ad requests" in the Ad Manager UI. |
| VIDEO_TOTAL_QUERIES_REAL_TIME |
The number of total queries for video realtime reporting. Corresponds to "Total ad requests" in the Ad Manager UI. |
| VIDEO_CREATIVE_SERVE_REAL_TIME |
The number of queries on creative level for video realtime reporting. Corresponds to "Total creative serves" in the Ad Manager UI. |
| VIDEO_VAST3_ERROR_100_COUNT_REAL_TIME |
Number of VAST video errors of type 100 for video realtime reporting. Corresponds to "VAST error 100 count" in the Ad Manager UI. |
| VIDEO_VAST3_ERROR_101_COUNT_REAL_TIME |
Number of VAST video errors of type 101 for video realtime reporting. Corresponds to "VAST error 101 count" in the Ad Manager UI. |
| VIDEO_VAST3_ERROR_102_COUNT_REAL_TIME |
Number of VAST video errors of type 102 for video realtime reporting. Corresponds to "VAST error 102 count" in the Ad Manager UI. |
| VIDEO_VAST3_ERROR_200_COUNT_REAL_TIME |
Number of VAST video errors of type 200 for video realtime reporting. Corresponds to "VAST error 200 count" in the Ad Manager UI. |
| VIDEO_VAST3_ERROR_201_COUNT_REAL_TIME |
Number of VAST video errors of type 201 for video realtime reporting. Corresponds to "VAST error 201 count" in the Ad Manager UI. |
| VIDEO_VAST3_ERROR_202_COUNT_REAL_TIME |
Number of VAST video errors of type 202 for video realtime reporting. Corresponds to "VAST error 202 count" in the Ad Manager UI. |
| VIDEO_VAST3_ERROR_203_COUNT_REAL_TIME |
Number of VAST video errors of type 203 for video realtime reporting. Corresponds to "VAST error 203 count" in the Ad Manager UI. |
| VIDEO_VAST3_ERROR_300_COUNT_REAL_TIME |
Number of VAST video errors of type 300 for video realtime reporting. Corresponds to "VAST error 300 count" in the Ad Manager UI. |
| VIDEO_VAST3_ERROR_301_COUNT_REAL_TIME |
Number of VAST video errors of type 301 for video realtime reporting. Corresponds to "VAST error 301 count" in the Ad Manager UI. |
| VIDEO_VAST3_ERROR_302_COUNT_REAL_TIME |
Number of VAST video errors of type 302 for video realtime reporting. Corresponds to "VAST error 302 count" in the Ad Manager UI. |
| VIDEO_VAST3_ERROR_303_COUNT_REAL_TIME |
Number of VAST video errors of type 303 for video realtime reporting. Corresponds to "VAST error 303 count" in the Ad Manager UI. |
| VIDEO_VAST3_ERROR_400_COUNT_REAL_TIME |
Number of VAST video errors of type 400 for video realtime reporting. Corresponds to "VAST error 400 count" in the Ad Manager UI. |
| VIDEO_VAST3_ERROR_401_COUNT_REAL_TIME |
Number of VAST video errors of type 401 for video realtime reporting. Corresponds to "VAST error 401 count" in the Ad Manager UI. |
| VIDEO_VAST3_ERROR_402_COUNT_REAL_TIME |
Number of VAST video errors of type 402 for video realtime reporting. Corresponds to "VAST error 402 count" in the Ad Manager UI. |
| VIDEO_VAST3_ERROR_403_COUNT_REAL_TIME |
Number of VAST video errors of type 403 for video realtime reporting. Corresponds to "VAST error 403 count" in the Ad Manager UI. |
| VIDEO_VAST3_ERROR_405_COUNT_REAL_TIME |
Number of VAST video errors of type 405 for video realtime reporting. Corresponds to "VAST error 405 count" in the Ad Manager UI. |
| VIDEO_VAST3_ERROR_500_COUNT_REAL_TIME |
Number of VAST video errors of type 500 for video realtime reporting. Corresponds to "VAST error 500 count" in the Ad Manager UI. |
| VIDEO_VAST3_ERROR_501_COUNT_REAL_TIME |
Number of VAST video errors of type 501 for video realtime reporting. Corresponds to "VAST error 501 count" in the Ad Manager UI. |
| VIDEO_VAST3_ERROR_502_COUNT_REAL_TIME |
Number of VAST video errors of type 502 for video realtime reporting. Corresponds to "VAST error 502 count" in the Ad Manager UI. |
| VIDEO_VAST3_ERROR_503_COUNT_REAL_TIME |
Number of VAST video errors of type 503 for video realtime reporting. Corresponds to "VAST error 503 count" in the Ad Manager UI. |
| VIDEO_VAST3_ERROR_600_COUNT_REAL_TIME |
Number of VAST video errors of type 600 for video realtime reporting. Corresponds to "VAST error 600 count" in the Ad Manager UI. |
| VIDEO_VAST3_ERROR_601_COUNT_REAL_TIME |
Number of VAST video errors of type 601 for video realtime reporting. Corresponds to "VAST error 601 count" in the Ad Manager UI. |
| VIDEO_VAST3_ERROR_602_COUNT_REAL_TIME |
Number of VAST video errors of type 602 for video realtime reporting. Corresponds to "VAST error 602 count" in the Ad Manager UI. |
| VIDEO_VAST3_ERROR_603_COUNT_REAL_TIME |
Number of VAST video errors of type 603 for video realtime reporting. Corresponds to "VAST error 603 count" in the Ad Manager UI. |
| VIDEO_VAST3_ERROR_604_COUNT_REAL_TIME |
Number of VAST video errors of type 604 for video realtime reporting. Corresponds to "VAST error 604 count" in the Ad Manager UI. |
| VIDEO_VAST3_ERROR_900_COUNT_REAL_TIME |
Number of VAST video errors of type 900 for video realtime reporting. Corresponds to "VAST error 900 count" in the Ad Manager UI. |
| VIDEO_VAST3_ERROR_901_COUNT_REAL_TIME |
Number of VAST video errors of type 901 for video realtime reporting. Corresponds to "VAST error 901 count" in the Ad Manager UI. |
| VIDEO_VAST4_ERROR_406_COUNT_REAL_TIME |
Number of VAST video errors of type 406 for video realtime reporting. Corresponds to "VAST error 406 count" in the Ad Manager UI. |
| VIDEO_VAST4_ERROR_407_COUNT_REAL_TIME |
Number of VAST video errors of type 407 for video realtime reporting. Corresponds to "VAST error 407 count" in the Ad Manager UI. |
| VIDEO_VAST4_ERROR_408_COUNT_REAL_TIME |
Number of VAST video errors of type 408 for video realtime reporting. Corresponds to "VAST error 408 count" in the Ad Manager UI. |
| VIDEO_VAST4_ERROR_409_COUNT_REAL_TIME |
Number of VAST video errors of type 409 for video realtime reporting. Corresponds to "VAST error 409 count" in the Ad Manager UI. |
| VIDEO_VAST4_ERROR_410_COUNT_REAL_TIME |
Number of VAST video errors of type 410 for video realtime reporting. Corresponds to "VAST error 410 count" in the Ad Manager UI. |
| VIDEO_VAST_TOTAL_ERROR_COUNT_REAL_TIME |
Number of total VAST video errors for video realtime reporting. Corresponds to "Total error count" in the Ad Manager UI. |
| TOTAL_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS |
The total number of impressions viewed on the user's screen. Corresponds to "Total Active View viewable impressions" in the Ad Manager UI. Compatible with the "Historical" report type. |
| TOTAL_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS |
The total number of impressions that were sampled and measured by active view. Corresponds to "Total Active View measurable impressions" in the Ad Manager UI. Compatible with the "Historical" report type. |
| TOTAL_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS_RATE |
The percentage of total impressions viewed on the user's screen (out of the total impressions measurable by active view). |
| TOTAL_ACTIVE_VIEW_ELIGIBLE_IMPRESSIONS |
Total number of impressions that were eligible to measure viewability. Corresponds to "Total Active View eligible impressions" in the Ad Manager UI. Compatible with the "Historical" report type. |
| TOTAL_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS_RATE |
The percentage of total impressions that were measurable by active view (out of all the total impressions sampled for active view). Corresponds to "Total Active View % measurable impressions" in the Ad Manager UI. Compatible with the "Historical" report type. |
| TOTAL_ACTIVE_VIEW_AVERAGE_VIEWABLE_TIME |
Active View total average time in seconds that specific impressions are reported as being viewable. Corresponds to "Total Active View average viewable time (seconds)" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AD_SERVER_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS |
The number of impressions delivered by the ad server viewed on the user's screen. Corresponds to "Ad server Active View viewable impressions" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AD_SERVER_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS |
The number of impressions delivered by the ad server that were sampled, and measurable by active view. Corresponds to "Ad server Active View measurable impressions" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AD_SERVER_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS_RATE |
The percentage of impressions delivered by the ad server viewed on the user's screen (out of the ad server impressions measurable by active view). Corresponds to "Ad server Active View % viewable impressions" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AD_SERVER_ACTIVE_VIEW_ELIGIBLE_IMPRESSIONS |
Total number of impressions delivered by the ad server that were eligible to measure viewability. Corresponds to "Ad server Active View eligible impressions" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AD_SERVER_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS_RATE |
The percentage of impressions delivered by the ad server that were measurable by active view ( out of all the ad server impressions sampled for active view). Corresponds to "Ad server Active View % measurable impressions" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AD_SERVER_ACTIVE_VIEW_REVENUE |
Active View ad server revenue. Corresponds to "Ad server Active View revenue" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AD_SERVER_ACTIVE_VIEW_AVERAGE_VIEWABLE_TIME |
Active View ad server average time in seconds that specific impressions are reported as being viewable. Corresponds to "Ad server Active View average viewable time (seconds)" in the Ad Manager UI. Compatible with the "Historical" report type. |
| ADSENSE_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS |
The number of impressions delivered by AdSense viewed on the user's screen, Corresponds to "AdSense Active View viewable impressions" in the Ad Manager UI. Compatible with the "Historical" report type. |
| ADSENSE_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS |
The number of impressions delivered by AdSense that were sampled, and measurable by active view. Corresponds to "AdSense Active View measurable impressions" in the Ad Manager UI. Compatible with the "Historical" report type. |
| ADSENSE_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS_RATE |
The percentage of impressions delivered by AdSense viewed on the user's screen (out of AdSense impressions measurable by active view). Corresponds to "AdSense Active View % viewable impressions" in the Ad Manager UI. Compatible with the "Historical" report type. |
| ADSENSE_ACTIVE_VIEW_ELIGIBLE_IMPRESSIONS |
Total number of impressions delivered by AdSense that were eligible to measure viewability. Corresponds to "AdSense Active View eligible impressions" in the Ad Manager UI. Compatible with the "Historical" report type. |
| ADSENSE_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS_RATE |
The percentage of impressions delivered by AdSense that were measurable by active view ( out of all AdSense impressions sampled for active view). Corresponds to "AdSense Active View % measurable impressions" in the Ad Manager UI. Compatible with the "Historical" report type. |
| ADSENSE_ACTIVE_VIEW_REVENUE |
Active View AdSense revenue. Corresponds to "AdSense Active View revenue" in the Ad Manager UI. Compatible with the "Historical" report type. |
| ADSENSE_ACTIVE_VIEW_AVERAGE_VIEWABLE_TIME |
Active View AdSense average time in seconds that specific impressions are reported as being viewable. Corresponds to "AdSense Active View average viewable time (seconds)" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AD_EXCHANGE_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS |
The number of impressions delivered by Ad Exchange viewed on the user's screen, Corresponds to "Ad Exchange Active View viewable impressions" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AD_EXCHANGE_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS |
The number of impressions delivered by Ad Exchange that were sampled, and measurable by active view. Corresponds to "Ad Exchange Active View measurable impressions" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AD_EXCHANGE_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS_RATE |
The percentage of impressions delivered by Ad Exchange viewed on the user's screen (out of Ad Exchange impressions measurable by active view). Corresponds to "Ad Exchange Active View % viewable impressions" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AD_EXCHANGE_ACTIVE_VIEW_ELIGIBLE_IMPRESSIONS |
Total number of impressions delivered by Ad Exchange that were eligible to measure viewability. Corresponds to "Ad Exchange Active View eligible impressions" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AD_EXCHANGE_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS_RATE |
The percentage of impressions delivered by Ad Exchange that were measurable by active view ( out of all Ad Exchange impressions sampled for active view). Corresponds to "Ad Exchange Active View % measurable impressions" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AD_EXCHANGE_ACTIVE_VIEW_REVENUE |
Active View AdExchange revenue. Corresponds to "Ad Exchange Active View revenue" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AD_EXCHANGE_ACTIVE_VIEW_AVERAGE_VIEWABLE_TIME |
Active View AdExchange average time in seconds that specific impressions are reported as being viewable. Corresponds to "Ad Exchange Active View average viewable time (seconds)" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AD_EXCHANGE_TOTAL_REQUESTS |
The total number of queries sent to Ad Exchange. Corresponds to "Ad Exchange ad requests" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AD_EXCHANGE_MATCH_RATE |
The fraction of Ad Exchange queries that result in a matched query. Also known as "Coverage". Corresponds to "Ad Exchange match rate" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AD_EXCHANGE_COST_PER_CLICK |
The amount earned per click on Ad Exchange. Corresponds to "Ad Exchange CPC" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AD_EXCHANGE_TOTAL_REQUEST_CTR |
The fraction of Ad Exchange requests that result in a click. Corresponds to "Ad Exchange ad request CTR" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AD_EXCHANGE_MATCHED_REQUEST_CTR |
The fraction of Ad Exchange matched requests that result in a click. Corresponds to "Ad Exchange matched request CTR" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AD_EXCHANGE_TOTAL_REQUEST_ECPM |
The amount earned per thousand Ad Exchange requests. Corresponds to "Ad Exchange ad request eCPM" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AD_EXCHANGE_MATCHED_REQUEST_ECPM |
The amount earned per thousand Ad Exchange matched requests. Corresponds to "Ad Exchange matched request eCPM" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AD_EXCHANGE_LIFT_EARNINGS |
The increase in Ad Exchange revenue gained for won impressions over the applicable minimum CPM or the best price specified during dynamic allocation. Corresponds to "Ad Exchange lift" in the Ad Manager UI. Compatible with the "Historical" report type. |
| TOTAL_ACTIVE_VIEW_REVENUE |
Active View total revenue. Corresponds to "Total Active View revenue" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIEW_THROUGH_CONVERSIONS |
Number of view-through conversions. |
| CONVERSIONS_PER_THOUSAND_IMPRESSIONS |
Number of view-through conversions per thousand impressions. Corresponds to "Conversions per thousand impressions" in the Ad Manager UI. Compatible with the "Historical" report type. |
| CLICK_THROUGH_CONVERSIONS |
Number of click-through conversions. Corresponds to "Click-through conversions" in the Ad Manager UI. Compatible with the "Historical" report type. |
| CONVERSIONS_PER_CLICK |
Number of click-through conversions per click. Corresponds to "Conversions per click" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIEW_THROUGH_REVENUE |
Revenue for view-through conversions. Corresponds to "Advertiser view-through sales" in the Ad Manager UI. Compatible with the "Historical" report type. |
| CLICK_THROUGH_REVENUE |
Revenue for click-through conversions. Corresponds to "Advertiser click-through sales" in the Ad Manager UI. Compatible with the "Historical" report type. |
| TOTAL_CONVERSIONS |
Total number of conversions. Corresponds to "Total conversions" in the Ad Manager UI. Compatible with the "Historical" report type. |
| TOTAL_CONVERSION_REVENUE |
Total revenue for conversions. Corresponds to "Total advertiser sales" in the Ad Manager UI. Compatible with the "Historical" report type. |
| DYNAMIC_ALLOCATION_OPPORTUNITY_IMPRESSIONS_COMPETING_TOTAL |
The number of impressions sent to Ad Exchange / AdSense, regardless of whether they won or lost (total number of dynamic allocation impressions). Corresponds to "Impressions competing" in the Ad Manager UI. Compatible with the "Historical" report type. |
| DYNAMIC_ALLOCATION_OPPORTUNITY_UNFILLED_IMPRESSIONS_COMPETING |
The number of unfilled queries that attempted dynamic allocation by Ad Exchange / AdSense. Corresponds to "Unfilled competing impressions" in the Ad Manager UI. Compatible with the "Historical" report type. |
| DYNAMIC_ALLOCATION_OPPORTUNITY_ELIGIBLE_IMPRESSIONS_TOTAL |
The number of Ad Exchange / AdSense and Ad Manager impressions. Corresponds to "Eligible impressions" in the Ad Manager UI. Compatible with the "Historical" report type. |
| DYNAMIC_ALLOCATION_OPPORTUNITY_IMPRESSIONS_NOT_COMPETING_TOTAL |
The difference between eligible impressions and competing impressions in dynamic allocation. |
| DYNAMIC_ALLOCATION_OPPORTUNITY_IMPRESSIONS_NOT_COMPETING_PERCENT_TOTAL |
The percentage of eligible impressions that are not competing in dynamic allocation. Corresponds to "Impressions not competing (%)" in the Ad Manager UI. Compatible with the "Historical" report type. |
| DYNAMIC_ALLOCATION_OPPORTUNITY_SATURATION_RATE_TOTAL |
The percent of eligible impressions participating in dynamic allocation. |
| DYNAMIC_ALLOCATION_OPPORTUNITY_MATCH_RATE_TOTAL |
The percent of total dynamic allocation queries that won. Corresponds to "Dynamic allocation match rate" in the Ad Manager UI. Compatible with the "Historical" report type. |
| INVOICED_IMPRESSIONS |
The number of invoiced impressions. Corresponds to "Invoiced impressions" in the Ad Manager UI. Compatible with the "Historical" report type. |
| INVOICED_UNFILLED_IMPRESSIONS |
The number of invoiced unfilled impressions. Corresponds to "Invoiced unfilled impressions" in the Ad Manager UI. Compatible with the "Historical" report type. |
| NIELSEN_IMPRESSIONS |
The total number of impressions tracked for Nielsen Digital Ad Ratings measurement. Corresponds to "Impressions" in the Ad Manager UI. Compatible with the "Reach" report type. |
| NIELSEN_IN_TARGET_IMPRESSIONS |
The total number of impressions for in-target demographic tracked for Nielsen Digital Ad Ratings measurement. Corresponds to "In-target impressions" in the Ad Manager UI. Compatible with the "Reach" report type. |
| NIELSEN_POPULATION_BASE |
The population in the demographic. Corresponds to "Population base" in the Ad Manager UI. Compatible with the "Reach" report type. |
| NIELSEN_IN_TARGET_POPULATION_BASE |
The total population for all in-target demographics. Compatible with the "Reach" report type. |
| NIELSEN_UNIQUE_AUDIENCE |
The total number of different people within the selected demographic who were reached. Corresponds to "Unique audience" in the Ad Manager UI. Compatible with the "Reach" report type. |
| NIELSEN_IN_TARGET_UNIQUE_AUDIENCE |
The total number of different people within all in-target demographics who were reached. Compatible with the "Reach" report type. |
| NIELSEN_PERCENT_AUDIENCE_REACH |
The unique audience reached as a percentage of the population base. Corresponds to "% audience reach" in the Ad Manager UI. Compatible with the "Reach" report type. |
| NIELSEN_IN_TARGET_PERCENT_AUDIENCE_REACH |
The unique audience reached as a percentage of the population base for all in-target demographics. Compatible with the "Reach" report type. |
| NIELSEN_AVERAGE_FREQUENCY |
The average number of times that a person within the target audience sees an advertisement. Corresponds to "Average frequency" in the Ad Manager UI. Compatible with the "Reach" report type. |
| NIELSEN_IN_TARGET_AVERAGE_FREQUENCY |
The average number of times that a person within the target audience sees an advertisement for all in-target demographics. Compatible with the "Reach" report type. |
| NIELSEN_GROSS_RATING_POINTS |
The unit of audience volume, which is based on the percentage of the reached target audience population multiplied by the average frequency. Corresponds to "Gross rating points" in the Ad Manager UI. Compatible with the "Reach" report type. |
| NIELSEN_IN_TARGET_GROSS_RATING_POINTS |
The unit of audience volume, which is based on the percentage of the reached target audience population multiplied by the average frequency, for all in-target demographics. Compatible with the "Reach" report type. |
| NIELSEN_PERCENT_IMPRESSIONS_SHARE |
The share of impressions that reached the target demographic. Corresponds to "% impression share" in the Ad Manager UI. Compatible with the "Reach" report type. |
| NIELSEN_IN_TARGET_PERCENT_IMPRESSIONS_SHARE |
The share of impressions that reached all in-target demographics. Corresponds to "In-target % impression share" in the Ad Manager UI. Compatible with the "Reach" report type. |
| NIELSEN_PERCENT_POPULATION_SHARE |
The share of the total population represented by the population base. Corresponds to "% population share" in the Ad Manager UI. Compatible with the "Reach" report type. |
| NIELSEN_IN_TARGET_PERCENT_POPULATION_SHARE |
The share of the total population for all in-target demographics represented by the population base. Compatible with the "Reach" report type. |
| NIELSEN_PERCENT_AUDIENCE_SHARE |
The share of the unique audience in the demographic. Corresponds to "% audience share" in the Ad Manager UI. Compatible with the "Reach" report type. |
| NIELSEN_IN_TARGET_PERCENT_AUDIENCE_SHARE |
The share of the unique audience for all in-target demographics. Compatible with the "Reach" report type. |
| NIELSEN_AUDIENCE_INDEX |
The relative unique audience in the demographic compared with its share of the overall population. Corresponds to "Audience index" in the Ad Manager UI. Compatible with the "Reach" report type. |
| NIELSEN_IN_TARGET_AUDIENCE_INDEX |
The relative unique audience for all in-target demographics compared with its share of the overall population. Compatible with the "Reach" report type. |
| NIELSEN_IMPRESSIONS_INDEX |
The relative impressions per person in the demographic compared with the impressions per person for the overall population. Corresponds to "Impressions index" in the Ad Manager UI. Compatible with the "Reach" report type. |
| NIELSEN_IN_TARGET_IMPRESSIONS_INDEX |
The relative impressions per person for all in-target demographics compared with the impressions per person for the overall population. Compatible with the "Reach" report type. |
| NIELSEN_IN_TARGET_RATIO |
The adjusted in-target impression share used for pacing and billing, based on the GRP pacing preferences indicated in your line item settings. Corresponds to "Processed Nielsen in-target rate" in the Ad Manager UI. Compatible with the "Reach" report type. |
| DP_IMPRESSIONS |
Number of impressions delivered. Corresponds to "Impressions" in the Ad Manager UI. Compatible with the "Ad Connector" report type. |
| DP_CLICKS |
Number of clicks delivered Corresponds to "Clicks" in the Ad Manager UI. Compatible with the "Ad Connector" report type. |
| DP_QUERIES |
Number of requests. Corresponds to "Queries" in the Ad Manager UI. Compatible with the "Ad Connector" report type. |
| DP_MATCHED_QUERIES |
Number of requests where a buyer was matched with the Ad request. Corresponds to "Matched queries" in the Ad Manager UI. Compatible with the "Ad Connector" report type. |
| DP_COST |
The revenue earned, calculated in publisher currency, for the ads delivered. Corresponds to "Cost" in the Ad Manager UI. Compatible with the "Ad Connector" report type. |
| DP_ECPM |
The average estimated cost-per-thousand-impressions earned from ads delivered. Corresponds to "Total Average eCPM" in the Ad Manager UI. Compatible with the "Ad Connector" report type. |
| DP_ACTIVE_VIEW_ELIGIBLE_IMPRESSIONS |
Total number of impressions delivered by the ad server that were eligible to measure viewability. Corresponds to "Total Active View eligible impressions" in the Ad Manager UI. Compatible with the "Ad Connector" report type. |
| DP_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS |
The number of impressions delivered that were sampled and measurable by active view. Corresponds to "Total Active View measurable impressions" in the Ad Manager UI. Compatible with the "Ad Connector" report type. |
| DP_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS |
The number of impressions delivered that were viewed on the user's screen. Corresponds to "Total Active View viewable impressions" in the Ad Manager UI. Compatible with the "Ad Connector" report type. |
| DP_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS_RATE |
The percentage of impressions delivered that were measurable by active view (out of all the impressions sampled for active view). Corresponds to "Total Active View % measurable impressions" in the Ad Manager UI. Compatible with the "Ad Connector" report type. |
| DP_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS_RATE |
The percentage of impressions delivered thar were viewed on the user's screen (out of the impressions measurable by active view). Corresponds to "Total Active View % viewable impressions" in the Ad Manager UI. Compatible with the "Ad Connector" report type. |
| PARTNER_MANAGEMENT_HOST_IMPRESSIONS |
The host impressions in the partner management. Corresponds to "Host impressions" in the Ad Manager UI. Compatible with the "Historical" report type. |
| PARTNER_MANAGEMENT_HOST_CLICKS |
The host clicks in the partner management. Corresponds to "Host clicks" in the Ad Manager UI. Compatible with the "Historical" report type. |
| PARTNER_MANAGEMENT_HOST_CTR |
The host CTR in the partner management. Corresponds to "Host CTR" in the Ad Manager UI. Compatible with the "Historical" report type. |
| PARTNER_MANAGEMENT_UNFILLED_IMPRESSIONS |
The unfilled impressions in the partner management. Corresponds to "Unfilled impressions" in the Ad Manager UI. Compatible with any of the following report types: Historical, Partner finance. |
| PARTNER_MANAGEMENT_PARTNER_IMPRESSIONS |
The partner impressions in the partner management. Corresponds to "Partner impressions" in the Ad Manager UI. Compatible with the "Historical" report type. |
| PARTNER_MANAGEMENT_PARTNER_CLICKS |
The partner clicks in the partner management. Corresponds to "Partner clicks" in the Ad Manager UI. Compatible with the "Historical" report type. |
| PARTNER_MANAGEMENT_PARTNER_CTR |
The partner CTR in the partner management. Corresponds to "Partner CTR" in the Ad Manager UI. Compatible with the "Historical" report type. |
| PARTNER_MANAGEMENT_GROSS_REVENUE |
The gross revenue in the partner management. Corresponds to "Gross revenue" in the Ad Manager UI. Compatible with the "Historical" report type. |
| PARTNER_FINANCE_HOST_IMPRESSIONS |
Monthly host impressions for partner finance reports. Corresponds to "Host impressions" in the Ad Manager UI. Compatible with the "Partner finance" report type. |
| PARTNER_FINANCE_HOST_REVENUE |
Monthly host revenue for partner finance reports. Corresponds to "Host revenue" in the Ad Manager UI. Compatible with the "Partner finance" report type. |
| PARTNER_FINANCE_HOST_ECPM |
Monthly host eCPM for partner finance reports. Corresponds to "Host eCPM" in the Ad Manager UI. Compatible with the "Partner finance" report type. |
| PARTNER_FINANCE_PARTNER_REVENUE |
Monthly partner revenue for partner finance reports. Corresponds to "Partner revenue" in the Ad Manager UI. Compatible with the "Partner finance" report type. |
| PARTNER_FINANCE_PARTNER_ECPM |
Monthly partner eCPM for partner finance reports. Corresponds to "Partner eCPM" in the Ad Manager UI. Compatible with the "Partner finance" report type. |
| PARTNER_FINANCE_GROSS_REVENUE |
Monthly gross revenue for partner finance reports. Corresponds to "Gross revenue" in the Ad Manager UI. Compatible with the "Partner finance" report type. |
| CREATIVE_LOAD_TIME_0_500_MS_PERCENT |
The ratio of the number of impressions for which the creative load time is between 0 and 500 ms to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "Creative load time 0 - 500ms (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type. |
| CREATIVE_LOAD_TIME_500_1000_MS_PERCENT |
The ratio of the number of impressions for which the creative load time is between 500 milliseconds and 1 second to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "Creative load time 500ms - 1s (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type. |
| CREATIVE_LOAD_TIME_1_2_S_PERCENT |
The ratio of the number of impressions for which the creative load time is between 1 second and 2 seconds to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "Creative load time 1s - 2s (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type. |
| CREATIVE_LOAD_TIME_2_4_S_PERCENT |
The ratio of the number of impressions for which the creative load time is between 2 seconds and 4 seconds to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "Creative load time 2s - 4s (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type. |
| CREATIVE_LOAD_TIME_4_8_S_PERCENT |
The ratio of the number of impressions for which the creative load time is between 4 seconds and 8 seconds to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "Creative load time 4s - 8s (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type. |
| CREATIVE_LOAD_TIME_GREATER_THAN_8_S_PERCENT |
The ratio of the number of impressions for which the creative load time is greater than 8 seconds to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "Creative load time >8s (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type. |
| UNVIEWED_REASON_SLOT_NEVER_ENTERED_VIEWPORT_PERCENT |
The ratio of the number of impressions which are unviewed because the ad slot never entered the viewport to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "Slot never entered viewport (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type. |
| UNVIEWED_REASON_USER_SCROLLED_BEFORE_AD_FILLED_PERCENT |
The ratio of the number of impressions which are unviewed because the user scrolled before the ad filled to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "User scrolled before ad filled (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type. |
| UNVIEWED_REASON_USER_SCROLLED_BEFORE_AD_LOADED_PERCENT |
The ratio of the number of impressions which are unviewed because the user scrolled or navigated before the ad loaded to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "User scrolled/navigated before ad loaded (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type. |
| UNVIEWED_REASON_USER_SCROLLED_BEFORE_1_S_PERCENT |
The ratio of the number of impressions which are unviewed because the user scrolled or navigated before one second to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "User scrolled/navigated before 1 second (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type. |
| UNVIEWED_REASON_OTHER_PERCENT |
The ratio of the number of impressions which are unviewed because the of another non-viewable-impression reason to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "Other non-viewable impression reasons (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type. |
| PAGE_NAVIGATION_TO_TAG_LOADED_TIME_0_500_MS_PERCENT |
The ratio of the number of impressions for which the DOM load to tag log time is between 0 and 500 milliseconds to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "Page navigation to tag loaded time 0 - 500ms (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type. |
| PAGE_NAVIGATION_TO_TAG_LOADED_TIME_500_1000_MS_PERCENT |
The ratio of the number of impressions for which the DOM load to tag log time is between 500 milliseconds and 1 second to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "Page navigation to tag loaded time 500ms - 1s (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type. |
| PAGE_NAVIGATION_TO_TAG_LOADED_TIME_1_2_S_PERCENT |
The ratio of the number of impressions for which the DOM load to tag log time is between 1 second and 2 seconds to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "Page navigation to tag loaded time 1s - 2s (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type. |
| PAGE_NAVIGATION_TO_TAG_LOADED_TIME_2_4_S_PERCENT |
The ratio of the number of impressions for which the DOM load to tag log time is between 2 seconds and 4 seconds to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "Page navigation to tag loaded time 2s - 4s (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type. |
| PAGE_NAVIGATION_TO_TAG_LOADED_TIME_4_8_S_PERCENT |
The ratio of the number of impressions for which the DOM load to tag log time is between 4 seconds and 8 seconds to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "Page navigation to tag loaded time 4s - 8s (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type. |
| PAGE_NAVIGATION_TO_TAG_LOADED_TIME_GREATER_THAN_8_S_PERCENT |
The ratio of the number of impressions for which the DOM load to tag log time is greater than 8 seconds to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "Page navigation to tag loaded time >8s (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type. |
| PAGE_NAVIGATION_TO_FIRST_AD_REQUEST_TIME_0_500_MS_PERCENT |
The ratio of the number of impressions for which the DOM load to first ad request time is between 0 and 500 milliseconds to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "Page navigation to first ad request time 0 - 500ms (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type. |
| PAGE_NAVIGATION_TO_FIRST_AD_REQUEST_TIME_500_1000_MS_PERCENT |
The ratio of the number of impressions for which the DOM load to first ad request time is between 500 milliseconds and 1 second to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "Page navigation to first ad request time 500ms - 1s (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type. |
| PAGE_NAVIGATION_TO_FIRST_AD_REQUEST_TIME_1_2_S_PERCENT |
The ratio of the number of impressions for which the DOM load to first ad request time is between 1 second and 2 seconds to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "Page navigation to first ad request time 1s - 2s (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type. |
| PAGE_NAVIGATION_TO_FIRST_AD_REQUEST_TIME_2_4_S_PERCENT |
The ratio of the number of impressions for which the DOM load to first ad request time is between 2 seconds and 4 seconds to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "Page navigation to first ad request time 2s - 4s (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type. |
| PAGE_NAVIGATION_TO_FIRST_AD_REQUEST_TIME_4_8_S_PERCENT |
The ratio of the number of impressions for which the DOM load to first ad request time is between 4 seconds and 8 seconds to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "Page navigation to first ad request time 4s - 8s (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type. |
| PAGE_NAVIGATION_TO_FIRST_AD_REQUEST_TIME_GREATER_THAN_8_S_PERCENT |
The ratio of the number of impressions for which the DOM load to first ad request time is greater than 8 seconds to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "Page navigation to first ad request time >8s (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type. |
| TAG_LOAD_TO_FIRST_AD_REQUEST_TIME_0_500_MS_PERCENT |
The ratio of the number of impressions for which the tag load to first ad request time is between 0 and 500 milliseconds to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "Tag loaded to first ad request time 0 - 500ms (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type. |
| TAG_LOAD_TO_FIRST_AD_REQUEST_TIME_500_1000_MS_PERCENT |
The ratio of the number of impressions for which the tag load to first ad request time is between 500 milliseconds and 1 second to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "Tag loaded to first ad request time 500ms - 1s (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type. |
| TAG_LOAD_TO_FIRST_AD_REQUEST_TIME_1_2_S_PERCENT |
The ratio of the number of impressions for which the tag load to first ad request time is between 1 second and 2 seconds to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "Tag loaded to first ad request time 1s - 2s (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type. |
| TAG_LOAD_TO_FIRST_AD_REQUEST_TIME_2_4_S_PERCENT |
The ratio of the number of impressions for which the tag load to first ad request time is between 2 seconds and 4 seconds to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "Tag loaded to first ad request time 2s - 4s (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type. |
| TAG_LOAD_TO_FIRST_AD_REQUEST_TIME_4_8_S_PERCENT |
The ratio of the number of impressions for which the tag load to first ad request time is between 4 seconds and 8 seconds to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "Tag loaded to first ad request time 4s - 8s (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type. |
| TAG_LOAD_TO_FIRST_AD_REQUEST_TIME_GREATER_THAN_8_S_PERCENT |
The ratio of the number of impressions for which the tag load to first ad request time is greater than 8 seconds to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "Tag loaded to first ad request time >8s (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type. |
Describes reasons for common errors
The delivery option for companions. Used for line items whose environmentType is EnvironmentType::VIDEO_PLAYER.
Specifies the credit-worthiness of the company for which the publisher runs an order. By doing so, the publisher can control the running of campaigns for the company. A publisher can choose between Basic and Advanced Credit Status settings. This feature needs to be enabled in the Ad Manager web site. Also the kind of setting you need - Basic or Advanced must be configured. If Basic is enabled then, the values allowed are
ACTIVE and . If Advanced is chosen, then all values are allowed. Choosing an Advanced setting when only the Basic feature has been enabled, or using the Basic setting without turning the feature on will result in an error.
The reasons for the target error.
| Enumerator | |
|---|---|
| COMPANY_CREDIT_STATUS_CHANGE_NOT_ALLOWED |
The user's role does not have permission to change Company::creditStatus from the default value. The default value is Company.CreditStatus::ACTIVE for the Basic credit status setting and Company.CreditStatus::ON_HOLD for the Advanced credit status setting. |
| CANNOT_USE_CREDIT_STATUS_SETTING |
The network has not been enabled for editing credit status settings for companies. |
| CANNOT_USE_ADVANCED_CREDIT_STATUS_SETTING |
The network has not been enabled for the Advanced credit status settings for companies. Company::creditStatus must be either
|
| UNACCEPTABLE_COMPANY_CREDIT_STATUS_FOR_ORDER |
An order cannot be created or updated because the Order::advertiserId or the Order::agencyId it is associated with has Company::creditStatus that is not
|
| UNACCEPTABLE_COMPANY_CREDIT_STATUS_FOR_LINE_ITEM |
A line item cannot be created for the order because the Order::advertiserId or {Order::agencyId} it is associated with has Company::creditStatus that is not
|
| CANNOT_BLOCK_COMPANY_TOO_MANY_APPROVED_ORDERS |
The company cannot be blocked because there are more than 200 approved orders of the company. Archive some, so that there are less than 200 of them. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
Enumerates all possible company specific errors.
| Enumerator | |
|---|---|
| CANNOT_SET_THIRD_PARTY_COMPANY_DUE_TO_TYPE |
Indicates that an attempt was made to set a third party company for a company whose type is not the same as the third party company. |
| CANNOT_UPDATE_COMPANY_TYPE |
Indicates that an invalid attempt was made to change a company's type. |
| INVALID_COMPANY_TYPE |
Indicates that this type of company is not supported. |
| PRIMARY_CONTACT_DOES_NOT_BELONG_TO_THIS_COMPANY |
Indicates that an attempt was made to assign a primary contact who does not belong to the specified company. |
| THIRD_PARTY_STATS_PROVIDER_IS_WRONG_ROLE_TYPE |
Indicates that the user specified as the third party stats provider is of the wrong role type. The user must have the third party stats provider role. |
| INVALID_LABEL_ASSOCIATION |
Labels can only be applied to Company.Type::ADVERTISER, Company.Type::HOUSE_ADVERTISER, and Company.Type::AD_NETWORK company types. |
| INVALID_COMPANY_TYPE_FOR_DEFAULT_BILLING_SETTING |
Indicates that the Company.Type does not support default billing settings. |
| INVALID_DEFAULT_BILLING_SETTING |
Indicates that the format of the default billing setting is wrong. |
| COMPANY_HAS_ACTIVE_SHARE_ASSIGNMENTS |
Cannot remove the cross selling config from a company that has active share assignments. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
The type of the company. Once a company is created, it is not possible to change its type.
The scope to which the assignment of any competitive exclusion labels for a video line item is limited.
Describes the computed LineItem status that is derived from the current state of the line item.
| Enumerator | |
|---|---|
| DELIVERY_EXTENDED |
The LineItem has past its LineItem::endDateTime with an auto extension, but hasn't met its goal. |
| DELIVERING |
The LineItem has begun serving. |
| READY |
The LineItem has been activated and is ready to serve. |
| PAUSED |
The LineItem has been paused from serving. |
| INACTIVE |
The LineItem is inactive. It is either caused by missing creatives or the network disabling auto-activation. |
| PAUSED_INVENTORY_RELEASED |
The LineItem has been paused and its reserved inventory has been released. The
|
| PENDING_APPROVAL |
The LineItem has been submitted for approval. |
| COMPLETED |
The LineItem has completed its run. |
| DISAPPROVED |
The LineItem has been disapproved and is not eligible to serve. |
| DRAFT |
The LineItem is still being drafted. |
| CANCELED |
The LineItem has been canceled and is no longer eligible to serve. This is a legacy status imported from Google Ad Manager orders. |
Describes the contact statuses.
Describes the digital media container type of the underlying media.
Status for
ContentBundle objects.
The reasons for the ContentFilterError.
| Enumerator | |
|---|---|
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
| WRONG_NUMBER_OF_ARGUMENTS | |
| ANY_FILTER_NOT_SUPPORTED | |
Describes the status of a Content object.
| Enumerator | |
|---|---|
| ACTIVE |
Indicates the Content has been created and is eligible to have ads served against it. |
| INACTIVE |
Indicates the Content has been deactivated and cannot have ads served against it. |
| ARCHIVED |
Indicates the Content has been archived; user-visible. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
All possible tracking event types. Not all events are supported by every kind of creative.
Describes the LineItem actions that are billable.
| Enumerator | |
|---|---|
| CPA |
Cost per action. The LineItem::lineItemType must be one of: |
| CPC |
Cost per click. The LineItem::lineItemType must be one of: |
| CPD |
Cost per day. The LineItem::lineItemType must be one of: |
| CPM |
Cost per mille (cost per thousand impressions). The LineItem::lineItemType must be one of: |
| VCPM |
Cost per thousand Active View viewable impressions. The LineItem::lineItemType must be LineItemType::STANDARD. |
| CPM_IN_TARGET |
Cost per thousand in-target impressions. The LineItem::lineItemType must be LineItemType::STANDARD. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
The reasons for the target error.
The reasons for the target error.
| Enumerator | |
|---|---|
| FLASH_AND_FALLBACK_URL_ARE_SAME |
FlashRedirectCreative::flashUrl and FlashRedirectCreative::fallbackUrl are the same. The fallback URL is used when the flash URL does not work and must be different from it. |
| INVALID_INTERNAL_REDIRECT_URL |
The internal redirect URL was invalid. The URL must have the following syntax http://ad.doubleclick.net/ad/sitename/;sz=size. |
| DESTINATION_URL_REQUIRED |
HasDestinationUrlCreative::destinationUrl is required. |
| DESTINATION_URL_NOT_EMPTY |
HasDestinationUrlCreative::destinationUrl must be empty when its type is DestinationUrlType::NONE. |
| DESTINATION_URL_TYPE_NOT_SUPPORTED |
The provided DestinationUrlType is not supported for the creative type it is being used on. |
| CANNOT_CREATE_OR_UPDATE_LEGACY_DFP_CREATIVE |
Cannot create or update legacy DART For Publishers creative. |
| CANNOT_CREATE_OR_UPDATE_LEGACY_DFP_MOBILE_CREATIVE |
Cannot create or update legacy mobile creative. |
| MISSING_FEATURE |
The user is missing a necessary feature. |
| INVALID_COMPANY_TYPE |
Company type should be one of Advertisers, House Advertisers and Ad Networks. |
| INVALID_ADSENSE_CREATIVE_SIZE |
Invalid size for AdSense dynamic allocation creative. Only valid AFC sizes are allowed. |
| INVALID_AD_EXCHANGE_CREATIVE_SIZE |
Invalid size for Ad Exchange dynamic allocation creative. Only valid Ad Exchange sizes are allowed. |
| DUPLICATE_ASSET_IN_CREATIVE |
Assets associated with the same creative must be unique. |
| CREATIVE_ASSET_CANNOT_HAVE_ID_AND_BYTE_ARRAY |
A creative asset cannot contain an asset ID and a byte array. |
| CANNOT_CREATE_OR_UPDATE_UNSUPPORTED_CREATIVE |
Cannot create or update unsupported creative. |
| CANNOT_CREATE_PROGRAMMATIC_CREATIVES |
Cannot create programmatic creatives. |
| INVALID_SIZE_FOR_THIRD_PARTY_IMPRESSION_TRACKER |
A creative must have valid size to use the third-party impression tracker. |
| CANNOT_DEACTIVATE_CREATIVES_IN_CREATIVE_SETS |
Ineligible creatives can not be deactivated. |
| HOSTED_VIDEO_CREATIVE_REQUIRES_VIDEO_ASSET |
Ad Manager hosted video creatives must contain a video asset. |
| CANNOT_SET_MULTIPLE_IMPRESSION_TRACKING_URLS |
ImageCreative::thirdPartyImpressionTrackingUrls should not contain more than one url. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
Represents the different types of policy violations that may be detected on a given creative.
For more information about the various types of policy violations, see here.
| Enumerator | |
|---|---|
| MALWARE_IN_CREATIVE |
Malware was found in the creative. For more information see here. |
| MALWARE_IN_LANDING_PAGE |
Malware was found in the landing page. For more information see here. |
| LEGALLY_BLOCKED_REDIRECT_URL |
The redirect url contains legally objectionable content. |
| MISREPRESENTATION_OF_PRODUCT |
The creative misrepresents the product or service being advertised. For more information see here. |
| SELF_CLICKING_CREATIVE |
The creative has been determined to be self clicking. |
| GAMING_GOOGLE_NETWORK |
The creative has been determined as attempting to game the Google network. For more information see here. |
| DYNAMIC_DNS |
The landing page for the creative uses a dynamic DNS. For more information see here. |
| CIRCUMVENTING_SYSTEMS |
The creative has been determined as attempting to circumvent Google advertising systems. |
| PHISHING |
Phishing found in creative or landing page. For more information see here. |
| DOWNLOAD_PROMPT_IN_CREATIVE |
The creative prompts the user to download a file. For more information see here |
| UNAUTHORIZED_COOKIE_DETECTED |
The creative sets an unauthorized cookie on a Google domain. For more information see here |
| TEMPORARY_PAUSE_FOR_VENDOR_INVESTIGATION |
The creative has been temporarily paused while we investigate. |
| ABUSIVE_EXPERIENCE |
The landing page contains an abusive experience. For more information see here. |
| TRICK_TO_CLICK |
The creative is designed to mislead or trick the user into interacting with it. For more information see here. |
| USE_OF_NON_ALLOWLISTED_OMID_VERIFICATION_SCRIPT |
Non-allowlisted OMID verification script. For more information see here. |
| MISUSE_OF_OMID_API |
OMID sdk injected by creative. < p>For more information see here. |
| UNACCEPTABLE_HTML_AD |
Unacceptable HTML5 ad. For more information see here. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
| Enumerator | |
|---|---|
| CANNOT_GENERATE_PREVIEW_URL |
The creative cannot be previewed on this page. |
| CANNOT_GENERATE_PREVIEW_URL_FOR_NATIVE_CREATIVES |
Preview URLs for native creatives must be retrieved with LineItemCreativeAssociationService::getPreviewUrlsForNativeStyles. |
| HTML_SNIPPET_REQUIRED_FOR_THIRD_PARTY_CREATIVE |
Third party creatives must have an html snippet set in order to obtain a preview URL. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
The strategy to use for displaying multiple Creative objects that are associated with a LineItem.
| Enumerator | |
|---|---|
| EVEN |
Creatives are displayed roughly the same number of times over the duration of the line item. |
| OPTIMIZED |
Creatives are served roughly proportionally to their performance. |
| MANUAL |
Creatives are served roughly proportionally to their weights, set on the LineItemCreativeAssociation. |
| SEQUENTIAL |
Creatives are served exactly in sequential order, aka Storyboarding. Set on the LineItemCreativeAssociation. |
The reasons for the target error.
Descriptions of the types of sizes a creative can be. Not all creatives can be described by a height-width pair, this provides additional context.
| Enumerator | |
|---|---|
| PIXEL |
Dimension based size, an actual height and width. |
| ASPECT_RATIO |
Mobile size, that is expressed as a ratio of say 4 by 1, that could be met by a 100 x 25 sized image. |
| INTERSTITIAL |
Out-of-page size, that is not related to the slot it is served. But rather is a function of the snippet, and the values set. This must be used with 1x1 size. |
| IGNORED |
Size has no meaning 1. For Click Tracking entities, where size doesn't matter
|
| NATIVE |
Native size, which is a function of the how the client renders the creative. This must be used with 1x1 size. |
| AUDIO |
Audio size. Used with audio ads. This must be used with 1x1 size. |
The reasons for the target error.
The reasons for the target error.
Describes status of the creative template
| Enumerator | |
|---|---|
| ACTIVE |
The CreativeTemplate is active |
| INACTIVE |
The CreativeTemplate is inactive. Users cannot create new creatives from this template, but existing ones can be edited and continue to serve |
| DELETED |
The CreativeTemplate is deleted. Creatives created from this CreativeTemplate can no longer serve. |
The reasons for the creative wrapper error.
| Enumerator | |
|---|---|
| LABEL_ALREADY_ASSOCIATED_WITH_CREATIVE_WRAPPER |
The label is already associated with a CreativeWrapper. |
| INVALID_LABEL_TYPE |
The label type of a creative wrapper must be LabelType::CREATIVE_WRAPPER. |
| UNRECOGNIZED_MACRO |
A macro used inside the snippet is not recognized. |
| NEITHER_HEADER_NOR_FOOTER_SPECIFIED |
When creating a new creative wrapper, either header or footer should exist. |
| NEITHER_HEADER_NOR_FOOTER_NOR_VIDEO_TRACKING_URLS_SPECIFIED |
Creative wrapper must have either header and/or footer, or video tracking URLs. |
| CANNOT_USE_CREATIVE_WRAPPER_TYPE |
The network has not been enabled for creating labels of type LabelType::CREATIVE_WRAPPER. |
| CANNOT_UPDATE_LABEL_ID |
Cannot update CreativeWrapper::labelId. |
| CANNOT_APPLY_TO_AD_UNIT_WITH_VIDEO_SIZES |
Cannot apply LabelType::CREATIVE_WRAPPER labels to an ad unit if it has no descendants with AdUnit::adUnitSizes of |
| CANNOT_APPLY_TO_AD_UNIT_WITHOUT_VIDEO_SIZES |
Cannot apply LabelType::CREATIVE_WRAPPER labels with a CreativeWrapper::VIDEO_TRACKING_URL type to an ad unit if it has no descendants with AdUnit::adUnitSizes of
|
| CANNOT_APPLY_TO_MOBILE_AD_UNIT |
Cannot apply LabelType::CREATIVE_WRAPPER labels to an ad unit if AdUnit::targetPlatform is of type
|
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
Defines the order in which the header and footer HTML snippets will be wrapped around the served creative.
INNER snippets will be wrapped first, followed by NO_PREFERENCE and finally OUTER. If the creative needs to be wrapped with more than one snippet with the same CreativeWrapperOrdering, then the order is unspecified.
| Enumerator | |
|---|---|
| NO_PREFERENCE | |
| INNER |
Wrapping occurs as early as possible. |
| OUTER |
Wrapping occurs after both #NO_PREFERENCE and #INNER |
Indicates whether the
CreativeWrapper is active. HTML snippets are served to creatives only when the creative wrapper is active.
| Enumerator | |
|---|---|
| ACTIVE | |
| INACTIVE | |
The type of a creative wrapper which is specified on the CreativeWrapper.
The reason of the error.
| Enumerator | |
|---|---|
| COMPANY_IS_NOT_DISTRIBUTION_PARTNER |
A company for cross-sell partner must be of type Company.Type::PARTNER. |
| CHANGING_PARTNER_NETWORK_IS_NOT_SUPPORTED |
The network code of a cross-sell partner cannot be changed. |
| MISSING_DISTRIBUTOR_PARTNER_NAME |
A cross-sell partner must have a partner name. |
| DISTRIBUTOR_NETWORK_MISSING_PUBLISHER_FEATURE |
The cross-sell distributor publisher feature must be enabled. |
| CONTENT_PROVIDER_NETWORK_MISSING_PUBLISHER_FEATURE |
The cross-sell publisher features must be enabled on the partner's network. |
| INVALID_DISTRIBUTOR_PARTNER_NAME |
The cross-sell partner name conflicts with an ad unit name on the partner's network. |
| INVALID_CONTENT_PROVIDER_NETWORK |
The network code of a cross-sell partner is invalid. |
| CONTENT_PROVIDER_NETWORK_CANNOT_BE_ACTIVE_NETWORK |
The content provider network must be different than the distributor network. |
| CONTENT_PROVIDER_NETWORK_ALREADY_ENABLED_FOR_CROSS_SELLING |
The same network code was already enabled for cross-sell in a different company. |
| DISTRIBUTOR_RULE_VIOLATION_ERROR |
A rule defined by the cross selling distributor has been violated by a line item targeting a shared ad unit. Violating this rule is an error. |
| DISTRIBUTOR_RULE_VIOLATION_WARNING |
A rule defined by the cross selling distributor has been violated by a line item targeting a shared ad unit. Violating this rule is a warning. By setting LineItem::skipCrossSellingRuleWarningChecks, the content partner can suppress the warning (and create or save the line item). This flag is available beginning in V201411. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
The reasons for the target error.
The data types allowed for CustomField objects.
| Enumerator | |
|---|---|
| STRING |
A string field. The max length is 255 characters. |
| NUMBER |
A number field. |
| TOGGLE |
A boolean field. Values may be "true", "false", or empty. |
| DROP_DOWN |
A drop-down field. Values may only be the ids of CustomFieldOption objects. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
Entity types recognized by custom fields
| Enumerator | |
|---|---|
| LINE_ITEM |
Represents the LineItem type. |
| ORDER |
Represents the Order type. |
| CREATIVE |
Represents the Creative type. |
| PRODUCT_TEMPLATE |
Represents the ProductTemplate type. |
| PRODUCT |
Represents the Product type. |
| PROPOSAL |
Represents the Proposal type. |
| PROPOSAL_LINE_ITEM |
Represents the ProposalLineItem type. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
The reasons for the target error.
| Enumerator | |
|---|---|
| INVALID_CUSTOM_FIELD_FOR_OPTION |
An attempt was made to create a CustomFieldOption for a CustomField that does not have CustomFieldDataType::DROPDOWN. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
The reasons for the target error.
| Enumerator | |
|---|---|
| CUSTOM_FIELD_NOT_FOUND |
An attempt was made to modify or create a CustomFieldValue for a CustomField that does not exist. |
| CUSTOM_FIELD_INACTIVE |
An attempt was made to create a new value for a custom field that is inactive. |
| CUSTOM_FIELD_OPTION_NOT_FOUND |
An attempt was made to modify or create a CustomFieldValue corresponding to a CustomFieldOption that could not be found. |
| INVALID_ENTITY_TYPE |
An attempt was made to modify or create a CustomFieldValue with an association to an entity of the wrong type for its field. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
Options for the unit of the custom pacing goal amounts.
| Enumerator | |
|---|---|
| ABSOLUTE |
The custom pacing goal amounts represent absolute numbers corresponding to the line item's Goal::unitType. |
| MILLI_PERCENT |
The custom pacing goal amounts represent a millipercent. For example, 15000 millipercent equals 15%. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
The reasons for the target error.
| Enumerator | |
|---|---|
| KEY_NOT_FOUND |
Requested CustomTargetingKey is not found. |
| KEY_COUNT_TOO_LARGE |
Number of CustomTargetingKey objects created exceeds the limit allowed for the network. |
| KEY_NAME_DUPLICATE |
CustomTargetingKey with the same CustomTargetingKey::name already exists. |
| KEY_NAME_EMPTY |
CustomTargetingKey::name is empty. |
| KEY_NAME_INVALID_LENGTH |
CustomTargetingKey::name is too long. |
| KEY_NAME_INVALID_CHARS |
CustomTargetingKey::name contains unsupported or reserved characters. |
| KEY_NAME_RESERVED |
CustomTargetingKey::name matches one of the reserved custom targeting key names. |
| KEY_DISPLAY_NAME_INVALID_LENGTH |
CustomTargetingKey::displayName is too long. |
| KEY_STATUS_NOT_ACTIVE |
Key is not active. |
| VALUE_NOT_FOUND |
Requested CustomTargetingValue is not found. |
| GET_VALUES_BY_STATEMENT_MUST_CONTAIN_KEY_ID |
The
|
| VALUE_COUNT_FOR_KEY_TOO_LARGE |
The number of CustomTargetingValue objects associated with a CustomTargetingKey exceeds the network limit. This is only applicable for keys of type
|
| VALUE_NAME_DUPLICATE |
CustomTargetingValue with the same CustomTargetingValue::name already exists. |
| VALUE_NAME_EMPTY |
CustomTargetingValue::name is empty. |
| VALUE_NAME_INVALID_LENGTH |
CustomTargetingValue::name is too long. |
| VALUE_NAME_INVALID_CHARS |
CustomTargetingValue::name contains unsupported or reserved characters. |
| VALUE_DISPLAY_NAME_INVALID_LENGTH |
CustomTargetingValue::displayName is too long. |
| VALUE_MATCH_TYPE_NOT_ALLOWED |
Only Ad Manager 360 networks can have CustomTargetingValue::matchType other than CustomTargetingValue.MatchType::EXACT. |
| VALUE_MATCH_TYPE_NOT_EXACT_FOR_PREDEFINED_KEY |
You can only create CustomTargetingValue objects with match type CustomTargetingValue.MatchType::EXACT when associating with CustomTargetingKey objects of type CustomTargetingKey.Type::PREDEFINED |
| SUFFIX_MATCH_TYPE_NOT_ALLOWED |
CustomTargetingValue object cannot have match type of CustomTargetingValue.MatchType::SUFFIX when adding a CustomTargetingValue to a line item. |
| CONTAINS_MATCH_TYPE_NOT_ALLOWED |
CustomTargetingValue object cannot have match type of CustomTargetingValue.MatchType::CONTAINS when adding a CustomTargetingValue to targeting expression of a line item. |
| VALUE_STATUS_NOT_ACTIVE |
Value is not active. |
| KEY_WITH_MISSING_VALUES |
The CustomTargetingKey does not have any CustomTargetingValue associated with it. |
| INVALID_VALUE_FOR_KEY |
The CustomTargetingKey has a CustomTargetingValue specified for which the value is not a valid child. |
| CANNOT_OR_DIFFERENT_KEYS |
CustomCriteriaSet.LogicalOperator::OR operation cannot be applied to values with different keys. |
| INVALID_TARGETING_EXPRESSION |
Targeting expression is invalid. This can happen if the sequence of operators is wrong, or a node contains invalid number of children. |
| DELETED_KEY_CANNOT_BE_USED_FOR_TARGETING |
The key has been deleted. CustomCriteria cannot have deleted keys. |
| DELETED_VALUE_CANNOT_BE_USED_FOR_TARGETING |
The value has been deleted. CustomCriteria cannot have deleted values. |
| VIDEO_BROWSE_BY_KEY_CANNOT_BE_USED_FOR_CUSTOM_TARGETING |
The key is set as the video browse-by key, which cannot be used for custom targeting. |
| CANNOT_DELETE_CUSTOM_KEY_USED_IN_CONTENT_METADATA_MAPPING |
Only active custom-criteria keys are supported in content metadata mapping. |
| CANNOT_DELETE_CUSTOM_VALUE_USED_IN_CONTENT_METADATA_MAPPING |
Only active custom-criteria values are supported in content metadata mapping. |
| CANNOT_DELETE_CUSTOM_KEY_USED_IN_PARTNER_ASSIGNMENT_TARGETING |
Cannot delete a custom criteria key that is targeted by an active partner assignment. |
| CANNOT_DELETE_CUSTOM_VALUE_USED_IN_PARTNER_ASSIGNMENT_TARGETING |
Cannot delete a custom criteria value that is targeted by an active partner assignment. |
| CANNOT_TARGET_AUDIENCE_SEGMENT |
AudienceSegment object cannot be targeted. |
| CANNOT_TARGET_THIRD_PARTY_AUDIENCE_SEGMENT |
Third party AudienceSegment cannot be targeted. |
| CANNOT_TARGET_INACTIVE_AUDIENCE_SEGMENT |
Inactive AudienceSegment object cannot be targeted. |
| INVALID_AUDIENCE_SEGMENTS |
Targeted AudienceSegment object is not valid. |
| CANNOT_TARGET_MAPPED_METADATA |
Mapped metadata key-values are deprecated and cannot be targeted. |
| ONLY_APPROVED_AUDIENCE_SEGMENTS_CAN_BE_TARGETED |
Targeted AudienceSegment objects have not been approved. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
Describes the statuses for
CustomTargetingKey objects.
| Enumerator | |
|---|---|
| ACTIVE |
The object is active. |
| INACTIVE |
The object is no longer active. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
Specifies the types for
CustomTargetingKey objects.
| Enumerator | |
|---|---|
| PREDEFINED |
Target audiences by criteria values that are defined in advance. |
| FREEFORM |
Target audiences by adding criteria values when creating line items. |
Represents the ways in which CustomTargetingValue::name strings will be matched with ad requests.
Describes the statuses for
CustomTargetingValue objects.
| Enumerator | |
|---|---|
| ACTIVE |
The object is active. |
| INACTIVE |
The object is no longer active. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
Describes reasons for DaiAuthenticationKeyActionError.
Statuses associated with DaiAuthenticationKey objects.
Key types associated with DaiAuthenticationKey objects.
Describes reasons for
.
Describes the status of a DaiEncodingProfile object.
| Enumerator | |
|---|---|
| ACTIVE |
Indicates the DaiEncodingProfile has been created and is eligible for streaming. |
| ARCHIVED |
Indicates the DaiEncodingProfile has been archived. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
Describes reasons for
.
Describes what caused the DAI content to fail during the ingestion process.
The status of the DAI ingestion process. Only content with a status of #SUCCESS will be available for dynamic ad insertion.
Represents a period of time.
| Enumerator | |
|---|---|
| TODAY |
The current day. |
| YESTERDAY |
The previous day. |
| LAST_WEEK |
The last week, from monday to sunday. |
| LAST_MONTH |
The previous month. |
| LAST_3_MONTHS |
The last 3 full months. For example, if today is May 5, 2017, then LAST_3_MONTHS would go from February 1 to April 30. |
| REACH_LIFETIME |
This will report on the last 93 days for the following columns: Column::UNIQUE_REACH_IMPRESSIONS, Column::UNIQUE_REACH_FREQUENCY, and Column::UNIQUE_REACH. |
| CUSTOM_DATE |
Specifying this value will enable the user to specify ReportQuery::startDate and ReportQuery::endDate. |
| NEXT_DAY |
The next day. |
| NEXT_90_DAYS |
The next ninety days. |
| NEXT_WEEK |
The next week, from monday to sunday. |
| NEXT_MONTH |
The next month. |
| CURRENT_AND_NEXT_MONTH |
Beginning of the next day until the end of the next month. |
| NEXT_QUARTER |
The next quarter. |
| NEXT_3_MONTHS |
The next three months. |
| NEXT_12_MONTHS |
The next twelve months. |
ApiErrorReason enum for date time range targeting error.
Days of the week.
The reasons for the target error.
| Enumerator | |
|---|---|
| INVALID_HOUR |
Hour of day must be between 0 and 24, inclusive. |
| INVALID_MINUTE |
Minute of hour must be one of 0, 15,30, 45. |
| END_TIME_NOT_AFTER_START_TIME |
The DayPart::endTime cannot be after DayPart::startTime. |
| TIME_PERIODS_OVERLAP |
Cannot create day-parts that overlap. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
The reasons for the target error.
| Enumerator | |
|---|---|
| CANNOT_ADD_LINE_ITEM_WHEN_SOLD |
Cannot add new proposal line items to a Proposal when Proposal::isSold is
|
| CANNOT_ARCHIVE_LINE_ITEM_WHEN_SOLD |
Cannot archive proposal line items from a Proposal when Proposal::isSold is
|
| CANNOT_ARCHIVE_PROPOSAL_WHEN_SOLD |
Cannot archive a Proposal when Proposal::isSold is
|
| CANNOT_CHANGE_FIELD_REQUIRING_BUYER_APPROVAL |
Cannot change a field that requires buyer approval during the current operation. |
| CANNOT_GET_SELLER_ID |
Cannot find seller ID for the Proposal. |
| CAN_ONLY_EXECUTE_IF_LOCAL_EDITS |
Proposal must be marked as editable by EditProposalsForNegotiation before performing requested action. |
| MISSING_PROPOSAL_LINE_ITEMS |
Proposal contains no proposal line items. |
| MISSING_ENVIRONMENT |
No environment set for Proposal. |
| MISSING_AD_EXCHANGE_PROPERTY |
The Ad Exchange property is not associated with the current network. |
| CANNOT_FIND_PROPOSAL_IN_MARKETPLACE |
Cannot find Proposal in Marketplace. |
| CANNOT_GET_PRODUCT |
No Product exists for buyer-initiated programmatic proposals. |
| NEW_VERSION_FROM_BUYER |
A new version of the Proposal was sent from buyer, cannot execute the requested action before performing DiscardLocalVersionEdits. |
| PROPOSAL_OUT_OF_SYNC_WITH_MARKETPLACE |
A new version of the Proposal exists in Marketplace, cannot execute the requested action before the proposal is synced to newest revision. |
| NO_PROPOSAL_CHANGES_FOUND |
No Proposal changes were found. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
The declaration about third party data usage on the associated entity.
| Enumerator | |
|---|---|
| NONE |
There are no companies associated. Functionally the same as DECLARED, combined with an empty company list. |
| DECLARED |
There is a set of RichMediaAdsCompanys associated with this entity. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
Status of the association between networks. When a parent network requests access, it is marked as pending. Once the child network approves, it is marked as approved.
The type of delegation of the child network to the parent network in MCM.
Strategies for choosing forecasted traffic shapes to pace line items.
Possible delivery rates for a LineItem, which dictate the manner in which they are served.
| Enumerator | |
|---|---|
| EVENLY |
Line items are served as evenly as possible across the number of days specified in a line item's LineItem::duration. |
| FRONTLOADED |
Line items are served more aggressively in the beginning of the flight date. |
| AS_FAST_AS_POSSIBLE |
The booked impressions for a line item may be delivered well before the LineItem::endDateTime. Other lower-priority or lower-value line items will be stopped from delivering until this line item meets the number of impressions or clicks it is booked for. |
Represents the time zone to be used for DayPartTargeting.
| Enumerator | |
|---|---|
| PUBLISHER |
Use the time zone of the publisher. |
| BROWSER |
Use the time zone of the browser. |
The valid actions that a destination URL may perform if the user clicks on the ad.
Dimension provides the break-down and filterable types available for running a ReportJob. Aggregate and percentage columns will be calculated based on these groupings.
| Enumerator | |
|---|---|
| MONTH_AND_YEAR |
Breaks down reporting data by month and year in the network time zone. Can be used to filter on month using ISO 4601 format 'YYYY-MM'. Corresponds to "Month and year" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Partner finance, YouTube consolidated. |
| WEEK |
Breaks down reporting data by week of the year in the network time zone. Cannot be used for filtering. Corresponds to "Week" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, YouTube consolidated. |
| DATE |
Breaks down reporting data by date in the network time zone. Can be used to filter by date using ISO 8601's format 'YYYY-MM-DD'". <p>Corresponds to "Date" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed, YouTube consolidated. |
| DAY |
Breaks down reporting data by day of the week in the network time zone. Can be used to filter by day of the week using the index of the day (from 1 for Monday is 1 to 7 for Sunday). Corresponds to "Day of week" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, YouTube consolidated. |
| HOUR |
Breaks down reporting data by hour of the day in the network time zone. Can be used to filter by hour of the day (from 0 to 23). Corresponds to "Hour" in the Ad Manager UI. Compatible with the "Historical" report type. |
| DATE_PT |
Breaks down reporting data by date in the PT time zone. Can be used to filter by date using ISO 8601's format 'YYYY-MM-DD'". Can only be used when time zone type is PACIFIC. Compatible with the "Historical" report type. |
| WEEK_PT |
Breaks down reporting data by week of the year in the PT time zone. Cannot be used for filtering. Can only be used when time zone type is PACIFIC. Compatible with the "Historical" report type. |
| MONTH_YEAR_PT |
Breaks down reporting data by month and year in the PT time zone. Can be used to filter on month using ISO 4601 format 'YYYY-MM'. Can only be used when time zone type is PACIFIC. Compatible with the "Historical" report type. |
| DAY_OF_WEEK_PT |
Breaks down reporting data by day of the week in the PT time zone. Can be used to filter by day of the week using the index of the day (from 1 for Monday is 1 to 7 for Sunday). Can only be used when time zone type is PACIFIC. Compatible with the "Historical" report type. |
| LINE_ITEM_ID |
Breaks down reporting data by LineItem::id. Can be used to filter by LineItem::id. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed. |
| LINE_ITEM_NAME |
Breaks down reporting data by line item. LineItem::name and LineItem::id are automatically included as columns in the report. Can be used to filter by LineItem::name. Corresponds to "Line item" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed. |
| LINE_ITEM_TYPE |
Breaks down reporting data by LineItem::lineItemType. Can be used to filter by line item type using LineItemType enumeration names. Corresponds to "Line item type" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed. |
| ORDER_ID |
Breaks down reporting data by Order::id. Can be used to filter by Order::id. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed. |
| ORDER_NAME |
Breaks down reporting data by order. Order::name and Order::id are automatically included as columns in the report. Can be used to filter by Order::name. Corresponds to "Order" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed. |
| ORDER_DELIVERY_STATUS |
Delivery status of the order. Not available as a dimension to report on, but exists as a dimension in order to filter on it using PQL. Valid values are 'STARTED', 'NOT_STARTED' and 'COMPLETED'. Compatible with the "Historical" report type. |
| ADVERTISER_ID |
Breaks down reporting data by advertising company Company::id. Can be used to filter by Company::id. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed. |
| ADVERTISER_NAME |
Breaks down reporting data by advertising company. Company::name and Company::id are automatically included as columns in the report. Can be used to filter by Company::name. Corresponds to "Advertiser" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed. |
| AD_NETWORK_ID |
The network that provided the ad for SDK ad mediation. If selected for a report, that report will include only SDK mediation ads and will not contain non-SDK mediation ads. SDK mediation ads are ads for mobile devices. They have a list of ad networks which can provide ads to serve. Not every ad network will have an ad to serve so the device will try each network one-by-one until it finds an ad network with an ad to serve. The ad network that ends up serving the ad will appear here. Note that this id does not correlate to anything in the companies table and is not the same id as is served by #ADVERTISER_ID. Compatible with the "Historical" report type. |
| AD_NETWORK_NAME |
The name of the network defined in #AD_NETWORK_ID. Corresponds to "Ad network name" in the Ad Manager UI. Compatible with the "Historical" report type. |
| SALESPERSON_ID |
Breaks down reporting data by salesperson User::id. Can be used to filter by User::id. Compatible with any of the following report types: Historical, Future sell-through, Reach. |
| SALESPERSON_NAME |
Breaks down reporting data by salesperson. User::name and User::id of the salesperson are automatically included as columns in the report. Can be used to filter by User::name. Corresponds to "Salesperson" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach. |
| CREATIVE_ID |
Breaks down reporting data by Creative::id or creative set id (master's Creative::id) if the creative is part of a creative set. Can be used to filter by Creative::id. Compatible with any of the following report types: Historical, Ad speed. |
| CREATIVE_NAME |
Breaks down reporting data by creative. Creative::name and Creative::id are automatically included as columns in the report. Can be used to filter by Creative::name. Corresponds to "Creative" in the Ad Manager UI. Compatible with any of the following report types: Historical, Ad speed. |
| CREATIVE_TYPE |
Breaks down reporting data by creative type. Corresponds to "Creative type" in the Ad Manager UI. Compatible with any of the following report types: Historical, Ad speed. |
| CREATIVE_BILLING_TYPE |
Breaks down reporting data by creative billing type. Corresponds to "Creative billing type" in the Ad Manager UI. Compatible with the "Historical" report type. |
| CUSTOM_EVENT_ID |
Breaks down reporting data by custom event ID. Compatible with the "Historical" report type. |
| CUSTOM_EVENT_NAME |
Breaks down reporting data by custom event name. Corresponds to "Custom event" in the Ad Manager UI. Compatible with the "Historical" report type. |
| CUSTOM_EVENT_TYPE |
Breaks down reporting data by custom event type (timer/exit/counter). Corresponds to "Custom event type" in the Ad Manager UI. Compatible with the "Historical" report type. |
| CREATIVE_SIZE |
Breaks down reporting data by Creative::size. Cannot be used for filtering. Corresponds to "Creative size" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AD_UNIT_ID |
Breaks down reporting data by AdUnit::id. Can be used to filter by AdUnit::id. #AD_UNIT_NAME, i.e. AdUnit::name, is automatically included as a dimension in the report. Compatible with any of the following report types: Historical, Future sell-through, Ad speed. |
| AD_UNIT_NAME |
Breaks down reporting data by ad unit. AdUnit::name and AdUnit::id are automatically included as columns in the report. Can be used to filter by AdUnit::name. Corresponds to "Ad unit" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Ad speed. |
| PARENT_AD_UNIT_ID |
Used to filter on all the descendants of an ad unit by AdUnit::id. Not available as a dimension to report on. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed. |
| PARENT_AD_UNIT_NAME |
Used to filter on all the descendants of an ad unit by AdUnit::name. Not available as a dimension to report on. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed. |
| PLACEMENT_ID |
Breaks down reporting data by Placement::id. Can be used to filter by Placement::id. Compatible with any of the following report types: Historical, Future sell-through, Reach. |
| PLACEMENT_NAME |
Breaks down reporting data by placement. Placement::name and Placement::id are automatically included as columns in the report. Can be used to filter by Placement::name. Corresponds to "Placement" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach. |
| PLACEMENT_STATUS |
Status of the placement. Not available as a dimension to report on, but exists as a dimension in order to filter on it using PQL. Can be used to filter on Placement::status by using InventoryStatus enumeration names. Compatible with any of the following report types: Historical, Future sell-through. |
| TARGETING |
Breaks down reporting data by criteria predefined by Ad Manager like the operating system, browser etc. Cannot be used for filtering. Corresponds to "Targeting" in the Ad Manager UI. Compatible with the "Historical" report type. |
| BROWSER_NAME |
Breaks down reporting data by browser criteria predefined by Ad Manager. Corresponds to "Browser" in the Ad Manager UI. Compatible with the "Historical" report type. |
| DEVICE_CATEGORY_ID |
The ID of the device category to which an ad is being targeted. Can be used to filter by device category ID. Compatible with any of the following report types: Historical, Ad speed. |
| DEVICE_CATEGORY_NAME |
The category of device (smartphone, feature phone, tablet, or desktop) to which an ad is being targeted. Can be used to filter by device category name. Corresponds to "Device category" in the Ad Manager UI. Compatible with any of the following report types: Historical, Ad speed. |
| COUNTRY_CRITERIA_ID |
Breaks down reporting data by country criteria ID. Can be used to filter by country criteria ID. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed, YouTube consolidated. |
| COUNTRY_CODE |
Breaks down reporting data by country code. Compatible with the "Historical" report type. |
| COUNTRY_NAME |
Breaks down reporting data by country name. The country name and the country criteria ID are automatically included as columns in the report. Can be used to filter by country name using the US English name. Corresponds to "Country" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed, YouTube consolidated. |
| REGION_CRITERIA_ID |
Breaks down reporting data by region criteria ID. Can be used to filter by region criteria ID. Compatible with the "Historical" report type. |
| REGION_NAME |
Breaks down reporting data by region name. The region name and the region criteria ID are automatically included as columns in the report. Can be used to filter by region name using the US English name. Corresponds to "Region" in the Ad Manager UI. Compatible with the "Historical" report type. |
| CITY_CRITERIA_ID |
Breaks down reporting data by city criteria ID. Can be used to filter by city criteria ID. Compatible with the "Historical" report type. |
| CITY_NAME |
Breaks down reporting data by city name. The city name and the city criteria ID are automatically included as columns in the report. Can be used to filter by city name using the US English name. Corresponds to "City" in the Ad Manager UI. Compatible with the "Historical" report type. |
| METRO_CRITERIA_ID |
Breaks down reporting data by metro criteria ID. Can be used to filter by metro criteria ID. Compatible with the "Historical" report type. |
| METRO_NAME |
Breaks down reporting data by metro name. The metro name and the metro criteria ID are automatically included as columns in the report. Can be used to filter by metro name using the US English name. Corresponds to "Metro" in the Ad Manager UI. Compatible with the "Historical" report type. |
| POSTAL_CODE_CRITERIA_ID |
Breaks down reporting data by postal code criteria ID. Can be used to filter by postal code criteria ID. Compatible with the "Historical" report type. |
| POSTAL_CODE |
Breaks down reporting data by postal code. The postal code and the postal code criteria ID are automatically included as columns in the report. Can be used to filter by postal code. Corresponds to "Postal code" in the Ad Manager UI. Compatible with the "Historical" report type. |
| CUSTOM_TARGETING_VALUE_ID |
Breaks down reporting data by CustomTargetingValue::id. Can be used to filter by CustomTargetingValue::id. Compatible with the "Historical" report type. |
| CUSTOM_CRITERIA |
Breaks down reporting data by custom criteria. The CustomTargetingValue is displayed in the form:
#CUSTOM_TARGETING_VALUE_ID, i.e. CustomTargetingValue::id is automatically included as a column in the report. Cannot be used for filtering; use #CUSTOM_TARGETING_VALUE_ID instead. When using this Corresponds to "Key-values" in the Ad Manager UI. Compatible with the "Historical" report type. |
| ACTIVITY_ID |
Breaks down reporting data by activity ID. Can be used to filter by activity ID. Compatible with the "Historical" report type. |
| ACTIVITY_NAME |
Breaks down reporting data by activity. The activity name and the activity ID are automatically included as columns in the report. Can be used to filter by activity name. Corresponds to "Activity" in the Ad Manager UI. Compatible with the "Historical" report type. |
| ACTIVITY_GROUP_ID |
Breaks down reporting data by activity group ID. Can be used to filter by activity group ID. Compatible with the "Historical" report type. |
| ACTIVITY_GROUP_NAME |
Breaks down reporting data by activity group. The activity group name and the activity group ID are automatically included as columns in the report. Can be used to filter by activity group name. Corresponds to "Activity group" in the Ad Manager UI. Compatible with the "Historical" report type. |
| CONTENT_ID |
Breaks down reporting data by Content::id. Can be used to filter by Content::id. Compatible with any of the following report types: Historical, Future sell-through, YouTube consolidated. |
| CONTENT_NAME |
Breaks down reporting data by content. Content::name and Content::id are automatically included as columns in the report. Can be used to filter by Content::name. Corresponds to "Content" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, YouTube consolidated. |
| CONTENT_BUNDLE_ID |
Breaks down reporting data by ContentBundle::id. Can be used to filter by ContentBundle::id. Compatible with any of the following report types: Historical, Future sell-through, YouTube consolidated. |
| CONTENT_BUNDLE_NAME |
Breaks down reporting data by content bundle. ContentBundle::name and ContentBundle::id are automatically included as columns in the report. Can be used to filter by ContentBundle::name. Corresponds to "Content bundle" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, YouTube consolidated. |
| VIDEO_METADATA_KEY_ID |
Breaks down reporting data by CustomTargetingKey::id. Compatible with the "Historical" report type. |
| VIDEO_METADATA_KEY_NAME |
Breaks down reporting data by custom targeting key. CustomTargetingKey::name and CustomTargetingKey::id are automatically included as columns in the report. Corresponds to "Metadata key" in the Ad Manager UI. Compatible with the "Historical" report type. |
| CMS_METADATA |
Breaks down reporting data by CMS metadata. To use this dimension in API, a list of cms metadata key IDs must be specified in ReportQuery::cmsMetadataKeyIds. This dimension can be used as a filter in the Statement in PQL syntax: CMS_METADATA_KEY[keyId]_ID = CMS metadata value ID For example: WHERE CMS_METADATA_KEY[4242]_ID = 53423 |
| VIDEO_FALLBACK_POSITION |
Breaks down reporting data by the fallback position of the video ad, i.e.,
Corresponds to "Fallback position" in the Ad Manager UI. Compatible with the "Historical" report type. |
| POSITION_OF_POD |
Breaks down reporting data by the position of the video ad within the video stream, i.e.,
Corresponds to "Position of pod" in the Ad Manager UI. Compatible with the "Historical" report type. |
| POSITION_IN_POD |
Breaks down reporting data by the position of the video ad within the pod, i.e.,
Corresponds to "Position in pod" in the Ad Manager UI. Compatible with the "Historical" report type. |
| CUSTOM_SPOT_ID |
Breaks down reporting data by AdSpot::id. Can be used to filter by AdSpot::id. Compatible with the "Historical" report type. |
| CUSTOM_SPOT_NAME |
Breaks down reporting data by content. AdSpot::name and AdSpot::id are automatically included as columns in the report. Can be used to filter by AdSpot::name. Corresponds to "Custom spot" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_REDIRECT_THIRD_PARTY |
Breaks down reporting data by video redirect vendor. Corresponds to "Video redirect third party" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_BREAK_TYPE |
The filter to break down reporting data by video break type. Not available as a dimension to report on. Compatible with the "Historical" report type. |
| VIDEO_BREAK_TYPE_NAME |
The filter to break down reporting data by video break type. Can only be used with the following string values: "Unknown", "Single ad video request", "Optimized pod video request". Not available as a dimension to report on. Compatible with the "Historical" report type. |
| VIDEO_VAST_VERSION |
Breaks down reporting data by vast version type name. Corresponds to "VAST version" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_AD_REQUEST_DURATION_ID |
Breaks down reporting data by video request duration bucket. Compatible with the "Historical" report type. |
| VIDEO_AD_REQUEST_DURATION |
Breaks down reporting data by video request duration bucket name. Corresponds to "Video ad request duration" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_PLACEMENT_NAME |
Breaks down reporting data by video placement. Corresponds to "Video Placement" in the Ad Manager UI. Compatible with the "Historical" report type. |
| PARTNER_MANAGEMENT_PARTNER_ID |
Breaks down reporting data by partner Company::id. Compatible with any of the following report types: Historical, Partner finance. |
| PARTNER_MANAGEMENT_PARTNER_NAME |
Breaks down reporting data by partner Company::name and Company::id are automatically included as columns in the report. Corresponds to "Partner" in the Ad Manager UI. Compatible with any of the following report types: Historical, Partner finance. |
| PARTNER_MANAGEMENT_PARTNER_LABEL_ID |
Breaks down reporting data by partner label Label::id. Compatible with any of the following report types: Historical, Partner finance. |
| PARTNER_MANAGEMENT_PARTNER_LABEL_NAME |
Breaks down reporting data by partner label. Label::name and Label::id are automatically included as columns in the report. Corresponds to "Partner label" in the Ad Manager UI. Compatible with any of the following report types: Historical, Partner finance. |
| PARTNER_MANAGEMENT_ASSIGNMENT_ID |
Breaks down reporting data by partner assignment id. Compatible with any of the following report types: Historical, Partner finance. |
| PARTNER_MANAGEMENT_ASSIGNMENT_NAME |
Breaks down reporting data by partner assignment name. PartnerAssignment name and id are automatically included as columns in the report. Corresponds to "Assignment" in the Ad Manager UI. Compatible with any of the following report types: Historical, Partner finance. |
| INVENTORY_SHARE_ASSIGNMENT_ID |
Breaks down reporting data by inventory sharing assignment ID. Compatible with the "Historical" report type. |
| INVENTORY_SHARE_ASSIGNMENT_NAME |
Breaks down reporting data by inventory sharing assignment name. Corresponds to "Inventory share assignment" in the Ad Manager UI. Compatible with the "Historical" report type. |
| INVENTORY_SHARE_OUTCOME |
Breaks down reporting data by inventory sharing outcome. Corresponds to "Inventory share outcome" in the Ad Manager UI. Compatible with the "Historical" report type. |
| GRP_DEMOGRAPHICS |
Breaks down reporting data by gender and age group, i.e., MALE_13_TO_17, MALE_18_TO_24, MALE_25_TO_34, MALE_35_TO_44, MALE_45_TO_54, MALE_55_TO_64, MALE_65_PLUS, FEMALE_13_TO_17, FEMALE_18_TO_24, FEMALE_25_TO_34, FEMALE_35_TO_44, FEMALE_45_TO_54, FEMALE_55_TO_64, FEMALE_65_PLUS, UNKNOWN_0_TO_17 and UNKNOWN. Whenever this dimension is selected, #COUNTRY_NAME must be selected. This dimension is supported only for GRP columns. Can correspond to any of the following in the Ad Manager UI: Demographics, comScore vCE demographics. Compatible with the "Reach" report type. |
| AD_REQUEST_AD_UNIT_SIZES |
Breaks down reporting data by the ad unit sizes specified in ad requests. Formatted as comma separated values, e.g. "300x250,300x250v,300x60". This dimension is supported only for sell-through columns. Corresponds to "Ad request sizes" in the Ad Manager UI. Compatible with the "Future sell-through" report type. |
| AD_REQUEST_CUSTOM_CRITERIA |
Breaks down reporting data by the custom criteria specified in ad requests. Formatted as comma separated key-values, where a key-value is formatted as This dimension is supported only for sell-through columns. Corresponds to "Key-values" in the Ad Manager UI. Compatible with the "Future sell-through" report type. |
| IS_FIRST_LOOK_DEAL |
Break down the report by a boolean indicator. It's TRUE for Ad Exchange traffic fulfilled by First Look Deals. It can be used both as a dimension or dimension filter. As a filter, it can only be used with the string values "true" and "false". Corresponds to "Is First Look" in the Ad Manager UI. Compatible with the "Historical" report type. |
| IS_ADX_DIRECT |
Break down the report by a boolean indicator. It's TRUE for AdX Direct traffic. It can be used both as a dimension or dimension filter. As a filter, it can only be used with the string values "true" and "false". Corresponds to "Is AdX Direct" in the Ad Manager UI. Compatible with the "Historical" report type. |
| YIELD_GROUP_ID |
Breaks down reporting data by yield group ID. Compatible with the "Historical" report type. |
| YIELD_GROUP_NAME |
Breaks down reporting data by yield group name. Corresponds to "Yield group" in the Ad Manager UI. Compatible with the "Historical" report type. |
| YIELD_PARTNER |
Breaks down reporting data by yield partner. Corresponds to "Yield partner" in the Ad Manager UI. Compatible with the "Historical" report type. |
| YIELD_PARTNER_TAG |
Breaks down reporting data by the tag of a yield partner in a yield group. Corresponds to "Yield partner tag" in the Ad Manager UI. Compatible with the "Historical" report type. |
| EXCHANGE_BIDDING_DEAL_ID |
The ID of an exchange bidding deal. Corresponds to "Exchange bidding deal id" in the Ad Manager UI. Compatible with the "Historical" report type. |
| EXCHANGE_BIDDING_DEAL_TYPE |
The type of an exchange bidding deal. Corresponds to "Exchange bidding deal type" in the Ad Manager UI. Compatible with the "Historical" report type. |
| CLASSIFIED_ADVERTISER_ID |
The ID of a classified advertiser. Compatible with the "Ad speed" report type. |
| CLASSIFIED_ADVERTISER_NAME |
The name of a classified advertiser. Corresponds to "Advertiser (classified)" in the Ad Manager UI. Compatible with any of the following report types: Historical, Ad speed. |
| CLASSIFIED_BRAND_ID |
The ID of a classified brand. Compatible with the "Ad speed" report type. |
| CLASSIFIED_BRAND_NAME |
The name of a classified brand. Corresponds to "Brand (classified)" in the Ad Manager UI. Compatible with any of the following report types: Historical, Ad speed. |
| MEDIATION_TYPE |
Breaks down reporting data by mediation type. A mediation type can be web, mobile app or video. Corresponds to "Mediation type" in the Ad Manager UI. Compatible with the "Historical" report type. |
| NATIVE_TEMPLATE_ID |
Breaks down reporting data by native template (also known as creative template) ID. Compatible with the "Historical" report type. |
| NATIVE_TEMPLATE_NAME |
Breaks down reporting data by native template (also known as creative template) name. Corresponds to "Native ad format name" in the Ad Manager UI. Compatible with the "Historical" report type. |
| NATIVE_STYLE_ID |
Breaks down reporting data by native style ID. Compatible with the "Historical" report type. |
| NATIVE_STYLE_NAME |
Breaks down reporting data by native style name. Corresponds to "Native style name" in the Ad Manager UI. Compatible with the "Historical" report type. |
| CHILD_NETWORK_CODE |
Breaks down reporting data by child network code in MCM "Manage Inventory". This dimension only works for MCM "Manage Inventory" parent publishers. Corresponds to "Child network code" in the Ad Manager UI. Compatible with the "Historical" report type. |
| MOBILE_APP_RESOLVED_ID |
Breaks down reporting data by mobile app 'resolved' id - either the app store id or '(Not applicable)' if the app is not registered in the app store. Note: app ids are not guaranteed to be unique across different app stores. Can be used for filtering. Corresponds to "App ID" in the Ad Manager UI. Compatible with the "Historical" report type. |
| MOBILE_APP_NAME |
Breaks down reporting data by mobile app name. Can be used for filtering. Corresponds to "App names" in the Ad Manager UI. Compatible with the "Historical" report type. |
| MOBILE_DEVICE_NAME |
Breaks down reporting data by device name. Can be used for filtering. Corresponds to "Devices" in the Ad Manager UI. Compatible with the "Historical" report type. |
| MOBILE_INVENTORY_TYPE |
Breaks down reporting data by inventory type. Can be used for filtering. Corresponds to "Inventory types" in the Ad Manager UI. Compatible with any of the following report types: Historical, Ad speed. |
| OPERATING_SYSTEM_VERSION_ID |
Breaks down reporting data by OS version id. Compatible with the "Historical" report type. |
| OPERATING_SYSTEM_VERSION_NAME |
Breaks down reporting data by OS version name. Corresponds to "Operating system" in the Ad Manager UI. Compatible with the "Historical" report type. |
| REQUEST_TYPE |
Breaks down reporting data by request type. Can be used for filtering. Corresponds to "Request type" in the Ad Manager UI. Compatible with any of the following report types: Historical, Ad speed. |
| AD_UNIT_STATUS |
Status of the ad unit. Not available as a dimension to report on, but exists as a dimension in order to filter on it using PQL. Valid values correspond to InventoryStatus. Compatible with any of the following report types: Historical, Future sell-through, Ad speed. |
| MASTER_COMPANION_CREATIVE_ID |
Breaks down reporting data by Creative::id. This includes regular creatives, and master and companions in case of creative sets. Compatible with the "Historical" report type. |
| MASTER_COMPANION_CREATIVE_NAME |
Breaks down reporting data by creative. This includes regular creatives, and master and companions in case of creative sets. Corresponds to "Master and Companion creative" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AUDIENCE_SEGMENT_ID |
Breaks down reporting data by billable audience segment ID. Compatible with the "Historical" report type. |
| AUDIENCE_SEGMENT_NAME |
Breaks down reporting data by billable audience segment name. Corresponds to "Audience segment (billable)" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AUDIENCE_SEGMENT_DATA_PROVIDER_NAME |
Breaks down reporting data by audience segment data provider name. Corresponds to "Data partner" in the Ad Manager UI. Compatible with the "Historical" report type. |
| WEB_PROPERTY_CODE |
Breaks down data by web property code. Compatible with the "Historical" report type. |
| BUYING_AGENCY_NAME |
Breaks down reporting data by agency. Corresponds to "Buying agency" in the Ad Manager UI. Compatible with the "Historical" report type. |
| BUYER_NETWORK_ID |
Breaks down reporting data by buyer network Id. Compatible with the "Historical" report type. |
| BUYER_NETWORK_NAME |
Breaks down reporting data by buyer network name. Corresponds to "Buyer network" in the Ad Manager UI. Compatible with the "Historical" report type. |
| BIDDER_ID |
Breaks down reporting data by Bidder ID. Compatible with the "Historical" report type. |
| BIDDER_NAME |
Breaks down reporting data by Bidder name. Corresponds to "Bidder" in the Ad Manager UI. Compatible with the "Historical" report type. |
| ADVERTISER_DOMAIN_NAME |
Breaks down reporting data by advertiser domain. Corresponds to "Advertiser domain" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AD_EXCHANGE_OPTIMIZATION_TYPE |
Breaks down reporting data by optimization type. Corresponds to "Optimization type" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach. |
| ADVERTISER_VERTICAL_NAME |
Breaks down reporting data by advertiser vertical. Corresponds to "Advertiser vertical" in the Ad Manager UI. Compatible with the "Historical" report type. |
| NIELSEN_SEGMENT |
Campaign date segment of Nielsen Digital Ad Ratings reporting. Corresponds to "Nielsen Digital Ad Ratings segment" in the Ad Manager UI. Compatible with the "Reach" report type. |
| NIELSEN_DEMOGRAPHICS |
Breaks down reporting data by gender and age group, i.e., MALE_18_TO_20, MALE_21_TO_24, MALE_25_TO_29, MALE_30_TO_35, MALE_35_TO_39, MALE_40_TO_44, MALE_45_TO_49, MALE_50_TO_54, MALE_55_TO_64, MALE_65_PLUS, FEMALE_18_TO_20, FEMALE_21_TO_24, FEMALE_25_TO_29, FEMALE_30_TO_34, FEMALE_35_TO_39, FEMALE_40_TO_44, FEMALE_45_TO_49, FEMALE_50_TO_54, FEMALE_55_TO_64, FEMALE_65_PLUS, and OTHER. |
| NIELSEN_RESTATEMENT_DATE |
Data restatement date of Nielsen Digital Ad Ratings data. Corresponds to "Nielsen Digital Ad Ratings restatement date" in the Ad Manager UI. Compatible with the "Reach" report type. |
| NIELSEN_DEVICE_ID |
Breaks down reporting data by device type, i.e., Computer, Mobile and other types. This dimension is supported only for Nielsen columns. Compatible with the "Reach" report type. |
| NIELSEN_DEVICE_NAME |
Breaks down reporting data by device type, i.e., Computer, Mobile and other types. This dimension is supported only for Nielsen columns. Corresponds to "Nielsen Digital Ad Ratings device" in the Ad Manager UI. Compatible with the "Reach" report type. |
| PROGRAMMATIC_BUYER_ID |
Breaks down reporting data by ProposalMarketplaceInfo::buyerAccountId. Compatible with any of the following report types: Historical, Reach. |
| PROGRAMMATIC_BUYER_NAME |
Breaks down reporting data by programmatic buyer name. Corresponds to "Programmatic buyer" in the Ad Manager UI. Compatible with the "Historical" report type. |
| REQUESTED_AD_SIZES |
Breaks down reporting data by requested ad size(s). This can be a chain of sizes or a single size. Corresponds to "Requested ad sizes" in the Ad Manager UI. Compatible with the "Historical" report type. |
| CREATIVE_SIZE_DELIVERED |
Breaks down reporting data by the creative size the ad was delivered to. Corresponds to "Creative size (delivered)" in the Ad Manager UI. Compatible with any of the following report types: Historical, Ad speed. |
| PROGRAMMATIC_CHANNEL_ID |
Breaks down reporting data by the type of transaction that occurred in Ad Exchange. Compatible with the "Historical" report type. |
| PROGRAMMATIC_CHANNEL_NAME |
Breaks down reporting data by the type of transaction that occurred in Ad Exchange. Corresponds to "Programmatic channel" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach. |
| CLASSIFIED_YIELD_PARTNER_NAME |
Breaks down data by detected yield partner name. Corresponds to "Yield partner (classified)" in the Ad Manager UI. Compatible with the "Historical" report type. |
| DP_DATE |
Breaks down Demand reporting data by date in the network time zone. Can be used to filter by date using ISO 8601's format 'YYYY-MM-DD'". Corresponds to "Date" in the Ad Manager UI. Compatible with the "Ad Connector" report type. |
| DP_WEEK |
Breaks down Demand reporting data by week of the year in the network time zone. Cannot be used for filtering. Corresponds to "Week" in the Ad Manager UI. Compatible with the "Ad Connector" report type. |
| DP_MONTH_YEAR |
Breaks down Demand reporting data by month and year in the network time zone. Cannot be used to filter. Corresponds to "Month and year" in the Ad Manager UI. Compatible with the "Ad Connector" report type. |
| DP_COUNTRY_CRITERIA_ID |
Breaks down Demand reporting data by country criteria ID. Can be used to filter by country criteria ID. Compatible with the "Ad Connector" report type. |
| DP_COUNTRY_NAME |
Breaks down Demand reporting data by country name. The country name and the country criteria ID are automatically included as columns in the report. Can be used to filter by country name using the US English name. Corresponds to "Country" in the Ad Manager UI. Compatible with the "Ad Connector" report type. |
| DP_INVENTORY_TYPE |
Breaks down Demand reporting data by inventory type. Corresponds to "Inventory type" in the Ad Manager UI. Compatible with the "Ad Connector" report type. |
| DP_CREATIVE_SIZE |
Breaks down Demand reporting data by the creative size the ad was delivered to. Corresponds to "Creative size" in the Ad Manager UI. Compatible with the "Ad Connector" report type. |
| DP_BRAND_NAME |
Breaks down Demand reporting data by the brand name that bids on ads. Corresponds to "Brand" in the Ad Manager UI. Compatible with the "Ad Connector" report type. |
| DP_ADVERTISER_NAME |
Breaks down Demand reporting data by the advertiser name that bid on ads. Corresponds to "Advertiser" in the Ad Manager UI. Compatible with the "Ad Connector" report type. |
| DP_ADX_BUYER_NETWORK_NAME |
Breaks down Demand reporting data by Ad Exchange ad network name. Example: Google Adwords. Corresponds to "Buyer network" in the Ad Manager UI. Compatible with the "Ad Connector" report type. |
| DP_MOBILE_DEVICE_NAME |
Breaks down reporting data by device name. Corresponds to "Device" in the Ad Manager UI. Compatible with the "Ad Connector" report type. |
| DP_DEVICE_CATEGORY_NAME |
Breaks down reporting data by the category of device (smartphone, feature phone, tablet, or desktop). Corresponds to "Device category" in the Ad Manager UI. Compatible with the "Ad Connector" report type. |
| DP_TAG_ID |
Breaks down reporting data by the tag id provided by the publisher in the ad request. Corresponds to "Tag ID" in the Ad Manager UI. Compatible with the "Ad Connector" report type. |
| DP_DEAL_ID |
Breaks down reporting data by the deal id provided by the publisher in the ad request. Corresponds to "Deal IDs" in the Ad Manager UI. Compatible with the "Ad Connector" report type. |
| DP_APP_ID |
Breaks down reporting data by mobile app ID. Corresponds to "App ID" in the Ad Manager UI. Compatible with the "Ad Connector" report type. |
| CUSTOM_DIMENSION |
Breaks down reporting data by the CustomTargetingKeys marked as dimensions in inventory key-values setup. To use this dimension, a list of custom targeting key IDs must be specified in ReportQuery::customDimensionKeyIds. |
| DEMAND_CHANNEL_ID |
Breaks down reporting data by demand channels. Compatible with any of the following report types: Historical, Reach, Ad speed. |
| DEMAND_CHANNEL_NAME |
Breaks down reporting data by demand channel name. Corresponds to "Demand channel" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach, Ad speed. |
| DOMAIN |
Breaks down reporting data by top private domain. Corresponds to "Domain" in the Ad Manager UI. Compatible with the "Historical" report type. |
| SERVING_RESTRICTION_ID |
Breaks down reporting data by serving restriction id. Compatible with the "Historical" report type. |
| SERVING_RESTRICTION_NAME |
Breaks down reporting data by serving restriction name. Corresponds to "Serving restriction" in the Ad Manager UI. Compatible with the "Historical" report type. |
| UNIFIED_PRICING_RULE_ID |
Breaks down reporting data by unified pricing rule id. Compatible with the "Historical" report type. |
| UNIFIED_PRICING_RULE_NAME |
Breaks down reporting data by unified pricing rule name. Corresponds to "Unified pricing rule" in the Ad Manager UI. Compatible with the "Historical" report type. |
| FIRST_LOOK_PRICING_RULE_ID |
Breaks down reporting data by first price pricing rule id. Compatible with the "Historical" report type. |
| FIRST_LOOK_PRICING_RULE_NAME |
Breaks down reporting data by first price pricing rule name. Corresponds to "First look pricing rule" in the Ad Manager UI. Compatible with the "Historical" report type. |
| BID_RANGE |
Breaks down reporting data by the range within which the bid falls, divided into $0.10 buckets. Corresponds to "Bid range" in the Ad Manager UI. Compatible with the "Historical" report type. |
| BID_REJECTION_REASON |
Breaks down reporting data by the ID of the reason the bid lost or did not participate in the auction. Compatible with the "Historical" report type. |
| BID_REJECTION_REASON_NAME |
Breaks down reporting data by the reason the bid lost or did not participate in the auction. Corresponds to "Bid rejection reason" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AD_TECHNOLOGY_PROVIDER_DOMAIN |
Breaks down reporting data by the domain of the ad technology provider (ATP) associated with the bid. Corresponds to "Ad technology provider domain" in the Ad Manager UI. Compatible with the "Historical" report type. |
| PROGRAMMATIC_DEAL_ID |
Breaks down reporting data by programmatic deal ID. Corresponds to "Programmatic deal ID" in the Ad Manager UI. Compatible with the "Historical" report type. |
| PROGRAMMATIC_DEAL_NAME |
Breaks down reporting data by programmatic deal name. Corresponds to "Programmatic deal name" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AD_TECHNOLOGY_PROVIDER_ID |
Breaks down reporting data by the ID of the ad technology provider (ATP) associated with the bid. Corresponds to "Ad technology provider ID" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AD_TECHNOLOGY_PROVIDER_NAME |
Breaks down reporting data by the ad technology provider (ATP) associated with the bid. Corresponds to "Ad technology provider" in the Ad Manager UI. Compatible with the "Historical" report type. |
| TCF_VENDOR_ID |
Breaks down reporting data by the ID of the ad technology provider as it appears on the Global Vendor List (GVL). Corresponds to "TCF vendor ID" in the Ad Manager UI. Compatible with the "Historical" report type. |
| TCF_VENDOR_NAME |
Breaks down reporting data by the name of the ad technology provider as it appears on the Global Vendor List (GVL). Corresponds to "TCF vendor" in the Ad Manager UI. Compatible with the "Historical" report type. |
| SITE_NAME |
Breaks down reporting data by site. Corresponds to "Site" in the Ad Manager UI. Compatible with the "Historical" report type. |
| CHANNEL_NAME |
Breaks down reporting data by channels. Corresponds to "Channel" in the Ad Manager UI. Compatible with the "Historical" report type. |
| URL_ID |
Breaks down reporting data by URL ID. Compatible with the "Historical" report type. |
| URL_NAME |
Breaks down reporting data by URL name. Corresponds to "URL" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_AD_DURATION |
Breaks down reporting data by video ad duration. Corresponds to "Video ad duration" in the Ad Manager UI. Compatible with the "Historical" report type. |
| VIDEO_AD_TYPE_ID |
Breaks down reporting data by video ad type Id. Compatible with the "Historical" report type. |
| VIDEO_AD_TYPE_NAME |
Breaks down reporting data by video ad type. Corresponds to "Video ad type" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AD_EXCHANGE_PRODUCT_CODE |
Breaks down reporting data by Ad Exchange product code. Compatible with the "Historical" report type. |
| AD_EXCHANGE_PRODUCT_NAME |
Breaks down reporting data by Ad Exchange product. Corresponds to "Ad Exchange product" in the Ad Manager UI. Compatible with the "Historical" report type. |
| DYNAMIC_ALLOCATION_ID |
Breaks down reporting data by Dynamic allocation ID. Compatible with the "Historical" report type. |
| DYNAMIC_ALLOCATION_NAME |
Breaks down reporting data by Dynamic allocation. Corresponds to "Dynamic allocation" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AD_TYPE_ID |
Breaks down reporting data by Ad type ID. Compatible with the "Historical" report type. |
| AD_TYPE_NAME |
Breaks down reporting data by Ad type. Corresponds to "Ad type" in the Ad Manager UI. Compatible with the "Historical" report type. |
| AD_LOCATION_ID |
Breaks down reporting data by Ad location ID. Compatible with the "Historical" report type. |
| AD_LOCATION_NAME |
Breaks down reporting data by Ad location. Corresponds to "Ad location" in the Ad Manager UI. Compatible with the "Historical" report type. |
| TARGETING_TYPE_CODE |
Breaks down reporting data by Targeting type code. Compatible with the "Historical" report type. |
| TARGETING_TYPE_NAME |
Breaks down reporting data by Targeting type. Corresponds to "Targeting type" in the Ad Manager UI. Compatible with the "Historical" report type. |
| BRANDING_TYPE_CODE |
Breaks down reporting data by Branding type code. Compatible with the "Historical" report type. |
| BRANDING_TYPE_NAME |
Breaks down reporting data by Branding type. Corresponds to "Branding type" in the Ad Manager UI. Compatible with the "Historical" report type. |
| BANDWIDTH_ID |
Breaks down reporting data by Bandwidth Id. Compatible with the "Historical" report type. |
| BANDWIDTH_NAME |
Breaks down reporting data by Bandwidth name. Corresponds to "Bandwidth" in the Ad Manager UI. Compatible with the "Historical" report type. |
| CARRIER_ID |
Breaks down reporting data by Carrier Id. Compatible with the "Historical" report type. |
| CARRIER_NAME |
Breaks down reporting data by Carrier name. Corresponds to "Carrier" in the Ad Manager UI. Compatible with the "Historical" report type. |
DimensionAttribute provides additional fields associated with a Dimension. It can only be selected with its corresponding Dimension. For example, DimensionAttribute::ORDER_PO_NUMBER can only be used if the ReportQuery::dimensions contains Dimension::ORDER_NAME.
| Enumerator | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| LINE_ITEM_LABELS |
Represents LineItem::effectiveAppliedLabels as a comma separated list of Label::name for Dimension::LINE_ITEM_NAME. Corresponds to "Line item labels" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach. | ||||||||||
| LINE_ITEM_LABEL_IDS |
Represents LineItem::effectiveAppliedLabels as a comma separated list of Label::id for Dimension::LINE_ITEM_NAME. Compatible with any of the following report types: Historical, Reach. | ||||||||||
| LINE_ITEM_OPTIMIZABLE |
Generated as
Corresponds to "Optimizable" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach. | ||||||||||
| LINE_ITEM_DELIVERY_INDICATOR |
Indicates the progress made for the delivery of the Dimension::LINE_ITEM_NAME.
Corresponds to "Delivery Indicator" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach. | ||||||||||
| LINE_ITEM_DELIVERY_PACING |
Represents LineItem::deliveryRateType for Dimension::LINE_ITEM_NAME. Corresponds to "Delivery pacing" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed. | ||||||||||
| LINE_ITEM_FREQUENCY_CAP |
Represents LineItem::frequencyCaps as a comma separated list of " FrequencyCap::maxImpressions impressions per/every FrequencyCap::numTimeUnits FrequencyCap::timeUnit" (e.g. "10 impressions every day,500 impressions per lifetime") for Dimension::LINE_ITEM_NAME. Corresponds to "Frequency cap" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach. | ||||||||||
| LINE_ITEM_RECONCILIATION_STATUS |
Represents the monthly reconciliation status of the line item for Dimension::LINE_ITEM_NAME and Dimension::MONTH_YEAR. Corresponds to "Line item reconciliation status" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach. | ||||||||||
| LINE_ITEM_LAST_RECONCILIATION_DATE_TIME |
Represents the monthly last reconciliation date time of the line item for Dimension::LINE_ITEM_NAME and Dimension::MONTH_YEAR. Corresponds to "Line item last reconciliation time" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach. | ||||||||||
| ADVERTISER_EXTERNAL_ID |
Represents Company::externalId for Dimension::ADVERTISER_NAME. Corresponds to "External advertiser ID" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach. | ||||||||||
| ADVERTISER_TYPE |
Represents Company::type for Dimension::ADVERTISER_NAME. Can be used for filtering. Corresponds to "Advertiser type" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed. | ||||||||||
| ADVERTISER_CREDIT_STATUS |
Represents Company::creditStatus for Dimension::ADVERTISER_NAME. Can be used for filtering. Corresponds to "Advertiser credit status" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed. | ||||||||||
| ADVERTISER_PRIMARY_CONTACT |
Represents name and email address in the form of name(email) of primary contact for Dimension::ADVERTISER_NAME. Corresponds to "Advertiser primary contact" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach. | ||||||||||
| ORDER_START_DATE_TIME |
Represents the start date (in YYYY-MM-DD format) for Dimension::ORDER_NAME. Can be used for filtering. Corresponds to "Order start date" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed. | ||||||||||
| ORDER_END_DATE_TIME |
Represents the end date (in YYYY-MM-DD format) for Dimension::ORDER_NAME. Can be used for filtering. Corresponds to "Order end date" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed. | ||||||||||
| ORDER_EXTERNAL_ID |
Represents Order::externalOrderId for Dimension::ORDER_NAME. Corresponds to "External order ID" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach. | ||||||||||
| ORDER_PO_NUMBER |
Represents Order::poNumber for Dimension::ORDER_NAME. Can be used for filtering. Corresponds to "Order PO number" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed. | ||||||||||
| ORDER_IS_PROGRAMMATIC |
Represents Order::orderIsProgrammatic for Dimension::ORDER_NAME. Can be used for filtering. Corresponds to "Programmatic order" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach. | ||||||||||
| ORDER_AGENCY |
Represents the name of Order::agencyId for Dimension::ORDER_NAME. Corresponds to "Agency" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach. | ||||||||||
| ORDER_AGENCY_ID |
Represents Order::agencyId for Dimension::ORDER_NAME. Can be used for filtering. Corresponds to "Agency ID" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach. | ||||||||||
| ORDER_LABELS |
Represents Order::effectiveAppliedLabels as a comma separated list of Label::name for Dimension::ORDER_NAME. Corresponds to "Order labels" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach. | ||||||||||
| ORDER_LABEL_IDS |
Represents Order::effectiveAppliedLabels as a comma separated list of Label::id for Dimension::ORDER_NAME. Compatible with any of the following report types: Historical, Reach. | ||||||||||
| ORDER_TRAFFICKER |
The name and email address in the form of name(email) of the trafficker for Dimension::ORDER_NAME Corresponds to "Trafficker" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach. | ||||||||||
| ORDER_TRAFFICKER_ID |
Represents Order::traffickerId for Dimension::ORDER_NAME. Can be used for filtering. Compatible with any of the following report types: Historical, Reach. | ||||||||||
| ORDER_SECONDARY_TRAFFICKERS |
The names and email addresses as a comma separated list of name(email) of the Order::secondaryTraffickerIds for Dimension::ORDER_NAME. Corresponds to "Secondary traffickers" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach. | ||||||||||
| ORDER_SALESPERSON |
The name and email address in the form of name(email) of the Order::salespersonId for Dimension::ORDER_NAME. Corresponds to "Salesperson" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach. | ||||||||||
| ORDER_SECONDARY_SALESPEOPLE |
The names and email addresses as a comma separated list of name(email) of the Order::secondarySalespersonIds for Dimension::ORDER_NAME. Corresponds to "Secondary salespeople" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach. | ||||||||||
| ORDER_LIFETIME_IMPRESSIONS |
The total number of impressions delivered over the lifetime of an Dimension::ORDER_NAME. Corresponds to "Order lifetime impressions" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed. | ||||||||||
| ORDER_LIFETIME_CLICKS |
The total number of clicks delivered over the lifetime of an Dimension::ORDER_NAME. Corresponds to "Order lifetime clicks" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed. | ||||||||||
| ORDER_BOOKED_CPM |
The cost of booking all the CPM ads for Dimension::ORDER_NAME. Corresponds to "Booked CPM" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach. | ||||||||||
| ORDER_BOOKED_CPC |
The cost of booking all the CPC ads for Dimension::ORDER_NAME. Corresponds to "Booked CPC" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach. | ||||||||||
| LINE_ITEM_START_DATE_TIME |
Represents the start date (in YYYY-MM-DD format) for Dimension::LINE_ITEM_NAME. Can be used for filtering. Corresponds to "Line item start date" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed. | ||||||||||
| LINE_ITEM_END_DATE_TIME |
Represents the end date (in YYYY-MM-DD format) for Dimension::LINE_ITEM_NAME. Can be used for filtering. Corresponds to "Line item end date" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed. | ||||||||||
| LINE_ITEM_EXTERNAL_ID |
Represents LineItem::externalId for Dimension::LINE_ITEM_NAME. Can be used for filtering. Corresponds to "External Line Item ID" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach. | ||||||||||
| LINE_ITEM_COST_TYPE |
Represents LineItem::costType for Dimension::LINE_ITEM_NAME. Can be used for filtering. Corresponds to "Cost type" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed. | ||||||||||
| LINE_ITEM_COST_PER_UNIT |
Represents LineItem::costPerUnit for Dimension::LINE_ITEM_NAME. Corresponds to "Rate" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed. | ||||||||||
| LINE_ITEM_CURRENCY_CODE |
Represents the 3 letter currency code for Dimension::LINE_ITEM_NAME. Corresponds to "Currency code" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed. | ||||||||||
| LINE_ITEM_GOAL_QUANTITY |
The total number of impressions, clicks or days that is reserved for Dimension::LINE_ITEM_NAME. Corresponds to "Goal quantity" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed. | ||||||||||
| LINE_ITEM_AVERAGE_NUMBER_OF_VIEWERS |
Corresponds to "Nielsen Average Number Of Viewers" in the Ad Manager UI. Compatible with the "Reach" report type. | ||||||||||
| LINE_ITEM_SPONSORSHIP_GOAL_PERCENTAGE |
The ratio between the goal quantity for Dimension::LINE_ITEM_NAME of LineItemType::SPONSORSHIP and the #LINE_ITEM_GOAL_QUANTITY. Represented as a number between 0..100. Corresponds to "Sponsorship goal (%)" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach. | ||||||||||
| LINE_ITEM_LIFETIME_IMPRESSIONS |
The total number of impressions delivered over the lifetime of a Dimension::LINE_ITEM_NAME. Corresponds to "Line item lifetime impressions" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed. | ||||||||||
| LINE_ITEM_LIFETIME_CLICKS |
The total number of clicks delivered over the lifetime of a Dimension::LINE_ITEM_NAME. Corresponds to "Line item lifetime clicks" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed. | ||||||||||
| LINE_ITEM_PRIORITY |
Represents LineItem::priority for Dimension::LINE_ITEM_NAME as a value between 1 and 16. Can be used for filtering. Corresponds to "Line item priority" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed. | ||||||||||
| CREATIVE_OR_CREATIVE_SET |
Indicates if a creative is a regular creative or creative set. Values will be 'Creative' or 'Creative set' Compatible with the "Historical" report type. | ||||||||||
| MASTER_COMPANION_TYPE |
The type of creative in a creative set - master or companion. Corresponds to "Master or Companion" in the Ad Manager UI. Compatible with the "Historical" report type. | ||||||||||
| LINE_ITEM_CONTRACTED_QUANTITY |
Represents the LineItem::contractedUnitsBought quantity for Dimension::LINE_ITEM_NAME. Corresponds to "Contracted quantity" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach. | ||||||||||
| LINE_ITEM_DISCOUNT |
Represents the LineItem::discount for Dimension::LINE_ITEM_NAME. The number is either a percentage or an absolute value depending on LineItem::discountType. Corresponds to "Discount" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach. | ||||||||||
| LINE_ITEM_NON_CPD_BOOKED_REVENUE |
The cost of booking for a non-CPD Dimension::LINE_ITEM_NAME. Corresponds to "Booked revenue (exclude CPD)" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach. | ||||||||||
| ADVERTISER_LABELS |
Represents Company::appliedLabels as a comma separated list of Label::name for Dimension::ADVERTISER_NAME. Corresponds to "Advertiser labels" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach. | ||||||||||
| ADVERTISER_LABEL_IDS |
Represents Company::appliedLabels as a comma separated list of Label::id for Dimension::ADVERTISER_NAME. Compatible with any of the following report types: Historical, Reach. | ||||||||||
| CREATIVE_CLICK_THROUGH_URL |
Represents the click-through URL for Dimension::CREATIVE_NAME. Corresponds to "Click-through URL" in the Ad Manager UI. Compatible with the "Historical" report type. | ||||||||||
| CREATIVE_SSL_SCAN_RESULT |
Represents whether a creative is SSL-compliant. Corresponds to "Creative SSL scan result" in the Ad Manager UI. Compatible with the "Historical" report type. | ||||||||||
| CREATIVE_SSL_COMPLIANCE_OVERRIDE |
Represents whether a creative's SSL status was overridden. Corresponds to "Creative SSL compliance override" in the Ad Manager UI. Compatible with the "Historical" report type. | ||||||||||
| LINE_ITEM_CREATIVE_START_DATE |
Represents a LineItemCreativeAssociation::startDateTime for a Dimension::LINE_ITEM_NAME and a Dimension::CREATIVE_NAME. Includes the date without the time. Corresponds to "Creative start date" in the Ad Manager UI. Compatible with the "Historical" report type. | ||||||||||
| LINE_ITEM_CREATIVE_END_DATE |
Represents a LineItemCreativeAssociation::endDateTime for a Dimension::LINE_ITEM_NAME and a Dimension::CREATIVE_NAME. Includes the date without the time. Corresponds to "Creative end date" in the Ad Manager UI. Compatible with the "Historical" report type. | ||||||||||
| CONTENT_CMS_NAME |
Represents the CmsContent::displayName within the first element of Content::cmsContent for Dimension::CONTENT_NAME. Corresponds to "Content source name" in the Ad Manager UI. Compatible with any of the following report types: Historical, YouTube consolidated. | ||||||||||
| CONTENT_CMS_VIDEO_ID |
Represents the CmsContent::cmsContentId within the first element of Content::cmsContent for Dimension::CONTENT_NAME. Corresponds to "ID of the video in the content source" in the Ad Manager UI. Compatible with any of the following report types: Historical, YouTube consolidated. | ||||||||||
| CHILD_PARTNER_NAME |
Breaks down reporting data by child partner name in MCM "Manage Inventory". By default, this attribute is ordered by Dimension::CHILD_NETWORK_CODE. This dimension only works for MCM "Manage Inventory" parent publishers. Corresponds to "Child partner name" in the Ad Manager UI. Compatible with the "Historical" report type. | ||||||||||
| AD_UNIT_CODE |
Represents AdUnit::adUnitCode for Dimension::AD_UNIT_NAME. Corresponds to "Ad unit code" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Ad speed. | ||||||||||
Describes how the live stream will have ads dynamically inserted into playlists.
| Enumerator | |
|---|---|
| LINEAR |
Content manifest is served by Google DAI. Content and ads are stitched together into a unique video manifest per user. |
| POD_SERVING_REDIRECT |
Content manifest is served by the partner, embedding Google DAI ad segment URLs which redirect to unique Google DAI ad segments per user. |
| POD_SERVING_MANIFEST |
Ads manifest is served by Google DAI, containing unique ad pod segments for the video player to switch to from the content stream, or for the partner to stitch directly into the user content manifest. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
The reasons for the entity children limit reached error.
| Enumerator | |
|---|---|
| LINE_ITEM_LIMIT_FOR_ORDER_REACHED |
The number of line items on the order exceeds the max number of line items allowed per order in the network. |
| CREATIVE_ASSOCIATION_LIMIT_FOR_LINE_ITEM_REACHED |
The number of creatives associated with the line item exceeds the max number of creatives allowed to be associated with a line item in the network. |
| AD_UNIT_LIMIT_FOR_PLACEMENT_REACHED |
The number of ad units on the placement exceeds the max number of ad units allowed per placement in the network. |
| TARGETING_EXPRESSION_LIMIT_FOR_LINE_ITEM_REACHED |
The number of targeting expressions on the line item exceeds the max number of targeting expressions allowed per line item in the network. |
| TARGETING_EXPRESSION_SIZE_LIMIT_REACHED |
The size of a single targeting expression tree exceeds the max size allowed by the network. |
| CUSTOM_TARGETING_VALUES_FOR_KEY_LIMIT_REACHED |
The number of custom targeting values for the free-form or predefined custom targeting key exceeds the max number allowed. |
| TARGETING_EXPRESSION_LIMIT_FOR_CREATIVES_ON_LINE_ITEM_REACHED |
The total number of targeting expressions on the creatives for the line item exceeds the max number allowed per line item in the network. |
| ATTACHMENT_LIMIT_FOR_PROPOSAL_REACHED |
The number of attachments added to the proposal exceeds the max number allowed per proposal in the network. |
| PROPOSAL_LINE_ITEM_LIMIT_FOR_PROPOSAL_REACHED |
The number of proposal line items on the proposal exceeds the max number allowed per proposal in the network. |
| PRODUCT_LIMIT_FOR_PRODUCT_PACKAGE_REACHED |
The number of product package items on the product package exceeds the max number allowed per product package in the network. |
| PRODUCT_TEMPLATE_AND_PRODUCT_BASE_RATE_LIMIT_FOR_RATE_CARD_REACHED |
The number of product template and product base rates on the rate card (including excluded product base rates) exceeds the max number allowed per rate card in the network. |
| PRODUCT_PACKAGE_ITEM_BASE_RATE_LIMIT_FOR_RATE_CARD_REACHED |
The number of product package item base rates on the rate card exceeds the max number allowed per rate card in the network. |
| PREMIUM_LIMIT_FOR_RATE_CARD_REACHED |
The number of premiums of the rate card exceeds the max number allowed per rate card in the network. |
| AD_UNIT_LIMIT_FOR_AD_EXCLUSION_RULE_TARGETING_REACHED |
The number of ad units on AdExclusionRule::inventoryTargeting exceeds the max number of ad units allowed per ad exclusion rule inventory targeting in the network. |
| NATIVE_STYLE_LIMIT_FOR_NATIVE_AD_FORMAT_REACHED |
The number of native styles under the native creative template exceeds the max number of native styles allowed per native creative template in the network. |
| TARGETING_EXPRESSION_LIMIT_FOR_PRESENTATION_ASSIGNMENT_REACHED |
The number of targeting expressions on the native style exceeds the max number of targeting expressions allowed per native style in the network. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
The reasons for the entity limit reached error.
The reasons for the target error.
| Enumerator | |
|---|---|
| INVALID_CURRENCY_CODE |
The currency code is invalid and does not follow ISO 4217. |
| UNSUPPORTED_CURRENCY_CODE |
The currency code is not supported. |
| CURRENCY_CODE_ALREADY_EXISTS |
The currency code already exists. When creating an exchange rate, its currency should not be associated with any existing exchange rate. When creating a list of exchange rates, there should not be two exchange rates associated with same currency. |
| INVALID_EXCHANGE_RATE |
The exchange rate value is invalid. When the ExchangeRate::refreshRate is ExchangeRateRefreshRate::FIXED, the ExchangeRate::exchangeRate should be larger than 0. Otherwise it is invalid. |
| EXCHANGE_RATE_NOT_FOUND |
The exchange rate value is not found. When the ExchangeRate::refreshRate is ExchangeRateRefreshRate::DAILY or ExchangeRateRefreshRate::MONTHLY, the ExchangeRate::exchangeRate should be assigned by Google. It is not found if Google cannot find such an exchange rate. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
Potential reasons for ExchangeSignupService errors
The file formats available for creating the report.
| Enumerator | |
|---|---|
| TSV |
The report file is generated as a list of Tab Separated Values. |
| TSV_EXCEL |
The report file is generated as a list of tab-separated values for Excel. |
| CSV_DUMP |
The report file is generated as a list of Comma Separated Values, to be used with automated machine processing.
|
| XML |
The report file is generated as XML. |
| XLSX |
The report file is generated as an Office Open XML spreadsheet designed for Excel 2007+. |
Error reason types for ForecastAdjustmentError.
The status of a forecast adjustment. Inactive adjustments are not applied during forecasting.
Options for how the volume settings of a ForecastAdjustment are defined.
Reason why a forecast could not be retrieved.
Types of behavior for frequency caps within ad rules.
The reasons for the target error.
The reasons for the target error.
Specifies the type of the goal for a LineItem.
| Enumerator | |
|---|---|
| NONE |
No goal is specified for the number of ads delivered. The LineItem::lineItemType must be one of: |
| LIFETIME |
There is a goal on the number of ads delivered for this line item during its entire lifetime. The LineItem::lineItemType must be one of: |
| DAILY |
There is a daily goal on the number of ads delivered for this line item. The LineItem::lineItemType must be one of: |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
Reason for GRP settings error.
| Enumerator | |
|---|---|
| INVALID_AGE_RANGE |
Age range for GRP audience is not valid. Please see the Ad Manager Help Center for more information. |
| UNDER_18_MIN_AGE_REQUIRES_ALL_AGES |
Age range for GRP audience is not allowed to include ages under 18 unless designating all ages in target(2-65+). |
| LINE_ITEM_ENVIRONMENT_TYPE_NOT_SUPPORTED |
GRP settings are only supported for video line items. |
| NIELSEN_DAR_REQUIRES_INSTREAM_VIDEO |
For deals with Nielsen DAR enabled, there must be an instream video environment. |
| LINE_ITEM_TYPE_NOT_SUPPORTED |
GRP settings are not supported for the given line item type. |
| CANNOT_SPECIFY_GENDER_FOR_GIVEN_AGE_RANGE |
GRP audience gender cannot be specified for the selected age range. |
| INVALID_MIN_AGE |
Minimum age for GRP audience is not valid. |
| INVALID_MAX_AGE |
Maximum age for GRP audience is not valid. |
| CANNOT_DISABLE_GRP_AFTER_ENABLING |
GRP settings cannot be disabled. |
| CANNOT_CHANGE_GRP_PROVIDERS |
GRP provider cannot be updated. |
| CANNOT_CHANGE_GRP_SETTINGS |
GRP settings cannot be updated once the line item has started serving. |
| GRP_AUDIENCE_GOAL_NOT_SUPPORTED |
Impression goal based on GRP audience is not supported. |
| DEMOG_GOAL_EXPECTED |
Impression goal based on GRP audience expected. |
| CANNOT_SET_GRP_AUDIENCE_GOAL |
Impression goal based on GRP audience cannot be set once the line item has started serving. |
| CANNOT_REMOVE_GRP_AUDIENCE_GOAL |
Impression goal based on GRP audience cannot be removed once the line item has started serving. |
| UNSUPPORTED_GEO_TARGETING |
Unsupported geographic location targeted for line item with GRP audience goal. |
| UNSUPPORTED_GRP_SETTING |
GRP Settings specified are unsupported. |
| SHOULD_SET_IN_TARGET_GOAL_THROUGH_GRP_SETTINGS |
In-target line items should be set through the grpSettings target impression goal. |
| SHOULD_SET_IN_TARGET_GOAL_THROUGH_PRIMARY_GOAL |
In-target line items should be set through the primaryReservationUnit's in-target Impressions unit type. |
| NIELSEN_REGISTRATION_FAILED |
Attempt to register with Nielsen failed. |
| LEGACY_NIELSEN_CAMPAIGN_REGISTRATION_ATTEMPT |
Attempted to register a placement on a legacy Nielsen campaign. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
Represents the target gender for a GRP demographic targeted line item.
Error reasons that may arise during HTML5 bundle processing.
| Enumerator | |
|---|---|
| CANNOT_EXTRACT_FILES_FROM_BUNDLE |
Cannot extract files from HTML5 bundle. |
| CLICK_TAG_HARD_CODED |
Bundle cannot have hard-coded click tag url(s). |
| CLICK_TAG_IN_GWD_UNUPPORTED |
Bundles created using GWD (Google Web Designer) cannot have click tags. GWD-published bundles should use exit events instead of defining var
|
| CLICK_TAG_NOT_IN_PRIMARY_HTML |
Click tag detected outside of primary HTML file. |
| CLICK_TAG_INVALID |
Click tag or exit function has invalid name or url. |
| FILE_SIZE_TOO_LARGE |
HTML5 bundle or total size of extracted files cannot be more than 1000 KB. |
| FILES_TOO_MANY |
HTML5 bundle cannot have more than 50 files. |
| FLASH_UNSUPPORTED |
Flash files in HTML5 bundles are not supported. Any file with a .swf or .flv extension causes this error. |
| GWD_COMPONENTS_UNSUPPORTED |
The HTML5 bundle contains unsupported GWD component(s). |
| GWD_ENABLER_METHODS_UNSUPPORTED |
The HTML5 bundle contains Unsupported GWD Enabler method(s). |
| GWD_PROPERTIES_INVALID |
GWD properties are invalid. |
| LINKED_FILES_NOT_FOUND |
The HTML5 bundle contains broken relative file reference(s). |
| PRIMARY_HTML_MISSING |
No primary HTML file detected. |
| PRIMARY_HTML_UNDETERMINED |
Multiple HTML files are detected. One of them should be named as
|
| SVG_BLOCK_INVALID |
An SVG block could not be parsed. |
| CANNOT_DECODE_BUNDLE |
The HTML5 bundle cannot be decoded. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
Image densities.
The reasons for the target error.
| Enumerator | |
|---|---|
| INVALID_IMAGE |
The file's format is invalid. |
| INVALID_SIZE |
Size::width and Size::height cannot be negative. |
| UNEXPECTED_SIZE |
The actual image size does not match the expected image size. |
| OVERLAY_SIZE_TOO_LARGE |
The size of the asset is larger than that of the overlay creative. |
| ANIMATED_NOT_ALLOWED |
Animated images are not allowed. |
| ANIMATION_TOO_LONG |
Animation length exceeded the allowed policy limit. |
| CMYK_JPEG_NOT_ALLOWED |
Images in CMYK color formats are not allowed. |
| FLASH_NOT_ALLOWED |
Flash files are not allowed. |
| FLASH_WITHOUT_CLICKTAG |
If FlashCreative::clickTagRequired is
|
| ANIMATED_VISUAL_EFFECT |
Animated visual effect is not allowed. |
| FLASH_ERROR |
An error was encountered in the flash file. |
| LAYOUT_PROBLEM |
Incorrect image layout. |
| FLASH_HAS_NETWORK_OBJECTS |
Flash files with network objects are not allowed. |
| FLASH_HAS_NETWORK_METHODS |
Flash files with network methods are not allowed. |
| FLASH_HAS_URL |
Flash files with hard-coded click thru URLs are not allowed. |
| FLASH_HAS_MOUSE_TRACKING |
Flash files with mouse tracking are not allowed. |
| FLASH_HAS_RANDOM_NUM |
Flash files that generate or use random numbers are not allowed. |
| FLASH_SELF_TARGETS |
Flash files with self targets are not allowed. |
| FLASH_BAD_GETURL_TARGET |
Flash file contains a bad geturl target. |
| FLASH_VERSION_NOT_SUPPORTED |
Flash or ActionScript version in the submitted file is not supported. |
| FILE_TOO_LARGE |
The uploaded file is too large. |
| SYSTEM_ERROR_IRS |
A system error occurred, please try again. |
| SYSTEM_ERROR_SCS |
A system error occurred, please try again. |
| UNEXPECTED_PRIMARY_ASSET_DENSITY |
The image density for a primary asset was not one of the expected image densities. |
| DUPLICATE_ASSET_DENSITY |
Two or more assets have the same image density. |
| MISSING_DEFAULT_ASSET |
The creative does not contain a primary asset. (For high-density creatives, the primary asset must be a standard image file with 1x density.) |
| PREVERIFIED_MIMETYPE_NOT_ALLOWED |
preverified_mime_type is not in the client spec's allowlist. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
The single reason for the internal API error.
The reasons for the target error.
Possible reasons for the error.
| Enumerator | |
|---|---|
| EXPLICIT_TARGETING_NOT_ALLOWED |
AdUnit::explicitlyTargeted can be set to
|
| TARGET_PLATFORM_NOT_APPLICABLE |
The specified target platform is not applicable for the inventory unit. |
| ADSENSE_CANNOT_BE_ENABLED |
AdSense cannot be enabled on this inventory unit if it is disabled for the network. |
| ROOT_UNIT_CANNOT_BE_DEACTIVATED |
A root unit cannot be deactivated. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
All possible reasons the error can be thrown.
The reasons for the target error.
| Enumerator | |
|---|---|
| DUPLICATE_ASSOCIATION |
The label has already been attached to the entity. |
| INVALID_ASSOCIATION |
A label is being applied to an entity that does not support that entity type. |
| NEGATION_NOT_ALLOWED |
Label negation cannot be applied to the entity type. |
| DUPLICATE_ASSOCIATION_WITH_NEGATION |
The same label is being applied and negated to the same entity. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
The reasons for the target error.
| Enumerator | |
|---|---|
| INVALID_PREFIX |
A user created label cannot begin with the Google internal system label prefix. |
| NAME_INVALID_CHARS |
Label::name contains unsupported or reserved characters. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
Represents the types of labels supported.
| Enumerator | |
|---|---|
| COMPETITIVE_EXCLUSION |
Allows for the creation of labels to exclude competing ads from showing on the same page. |
| AD_UNIT_FREQUENCY_CAP |
Allows for the creation of limits on the frequency that a user sees a particular type of creative over a portion of the inventory. |
| AD_EXCLUSION |
Allows for the creation of labels to exclude ads from showing against a tag that specifies the label as an exclusion. |
| CREATIVE_WRAPPER |
Allows for the creation of labels that can be used to force the wrapping of a delivering creative with header/footer creatives. These labels are paired with a CreativeWrapper. |
| CANONICAL_CATEGORY |
Allows for the creation of labels mapped to a Google canonical ad category, which can be used for competitive exclusions and blocking across Google systems. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
Specifies the license type of a ThirdPartyAudienceSegment.
| Enumerator | |
|---|---|
| DIRECT_LICENSE |
A direct license is the result of a direct contract between the data provider and the publisher. |
| GLOBAL_LICENSE |
A global license is the result of an agreement between Google and the data provider, which agrees to license their audience segments to all the publishers and/or advertisers of the Google ecosystem. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
The reasons for the target error.
| Enumerator | |
|---|---|
| INVALID_ACTIVITY_FOR_ADVERTISER |
When associating an activity to a line item the activity must belong to the same advertiser as the line item. |
| INVALID_COST_TYPE_FOR_ASSOCIATION |
Activities can only be associated with line items of CostType.CPA. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
The reasons for the target error.
| Enumerator | |
|---|---|
| CREATIVE_IN_WRONG_ADVERTISERS_LIBRARY |
Cannot associate a creative to the wrong advertiser |
| INVALID_LINEITEM_CREATIVE_PAIRING |
The creative type being associated is a invalid for the line item type. |
| STARTDATE_BEFORE_LINEITEM_STARTDATE |
Association start date cannot be before line item start date |
| STARTDATE_NOT_BEFORE_LINEITEM_ENDDATE |
Association start date cannot be same as or after line item end date |
| ENDDATE_AFTER_LINEITEM_ENDDATE |
Association end date cannot be after line item end date |
| ENDDATE_NOT_AFTER_LINEITEM_STARTDATE |
Association end date cannot be same as or before line item start date |
| ENDDATE_NOT_AFTER_STARTDATE |
Association end date cannot be same as or before its start date |
| ENDDATE_IN_THE_PAST |
Association end date cannot be in the past. |
| CANNOT_COPY_WITHIN_SAME_LINE_ITEM |
Cannot copy an association to the same line item without creating new creative |
| UNSUPPORTED_CREATIVE_VAST_REDIRECT_TYPE |
Programmatic only supports the "Video" redirect type. |
| UNSUPPORTED_YOUTUBE_HOSTED_CREATIVE |
Programmatic does not support YouTube hosted creatives. |
| PROGRAMMATIC_CREATIVES_CAN_ONLY_BE_ASSIGNED_TO_ONE_LINE_ITEM |
Programmatic creatives can only be assigned to one line item. |
| CANNOT_ACTIVATE_ASSOCIATION_WITH_INACTIVE_CREATIVE |
Cannot activate a line item creative association if the associated creative is inactive. |
| CANNOT_CREATE_PROGRAMMATIC_CREATIVES |
Cannot create programmatic creatives. |
| CANNOT_UPDATE_PROGRAMMATIC_CREATIVES |
Cannot update programmatic creatives. |
| CREATIVE_AND_LINE_ITEM_MUST_BOTH_BE_SET_TOP_BOX_ENABLED |
Cannot associate a creative with a line item if only one of them is set-top box enabled. |
| CANNOT_DELETE_SET_TOP_BOX_ENABLED_ASSOCIATIONS |
Cannot delete associations between set-top box enabled line items and set-top box enabled creatives. |
| SET_TOP_BOX_CREATIVE_ROTATION_WEIGHT_MUST_BE_INTEGER |
Creative rotation weights must be integers. |
| INVALID_CREATIVE_ROTATION_TYPE_FOR_MANUAL_WEIGHT |
Creative rotation weights are only valid when creative rotation type is set to CreativeRotationType::MANUAL. |
| CLICK_MACROS_REQUIRED |
The code snippet of a creative must contain a click macro (%CLICK_URL_ESC%% or %CLICK_URL_UNESC%%). |
| VIEW_MACROS_NOT_ALLOWED |
The code snippet of a creative must not contain a view macro (%VIEW_URL_ESC%% or %VIEW_URL_UNESC%%). |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
The reasons for the target error.
Describes the status of the association.
| Enumerator | |
|---|---|
| ACTIVE |
The association is active and the associated Creative can be served. |
| NOT_SERVING |
The association is active but the associated Creative may not be served, because its size is not targeted by the line item. |
| INACTIVE |
The association is inactive and the associated Creative is ineligible for being served. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
Describes the possible discount types on the cost of booking a LineItem.
| Enumerator | |
|---|---|
| ABSOLUTE_VALUE |
An absolute value will be discounted from the line item's cost. |
| PERCENTAGE |
A percentage of the cost will be applied as discount for booking the line item. |
The reasons for the target error.
| Enumerator | |
|---|---|
| ALREADY_STARTED |
Some changes may not be allowed because a line item has already started. |
| UPDATE_RESERVATION_NOT_ALLOWED |
Update reservation is not allowed because a line item has already started, users must pause the line item first. |
| ALL_ROADBLOCK_NOT_ALLOWED |
Roadblocking to display all creatives is not allowed. |
| ALL_COMPANION_DELIVERY_NOT_ALLOWED |
Companion delivery to display all creatives is not allowed. |
| CREATIVE_SET_ROADBLOCK_NOT_ALLOWED |
Roadblocking to display all master and companion creative set is not allowed. |
| FRACTIONAL_PERCENTAGE_NOT_ALLOWED |
Fractional percentage is not allowed. |
| DISCOUNT_NOT_ALLOWED |
For certain LineItem configurations discounts are not allowed. |
| UPDATE_CANCELED_LINE_ITEM_NOT_ALLOWED |
Updating a canceled line item is not allowed. |
| UPDATE_PENDING_APPROVAL_LINE_ITEM_NOT_ALLOWED |
Updating a pending approval line item is not allowed. |
| UPDATE_ARCHIVED_LINE_ITEM_NOT_ALLOWED |
Updating an archived line item is not allowed. |
| CREATE_OR_UPDATE_LEGACY_DFP_LINE_ITEM_TYPE_NOT_ALLOWED |
Create or update legacy dfp line item type is not allowed. |
| COPY_LINE_ITEM_FROM_DIFFERENT_COMPANY_NOT_ALLOWED |
Copying line item from different company (advertiser) to the same order is not allowed. |
| INVALID_SIZE_FOR_PLATFORM |
The size is invalid for the specified platform. |
| INVALID_LINE_ITEM_TYPE_FOR_PLATFORM |
The line item type is invalid for the specified platform. |
| INVALID_WEB_PROPERTY_FOR_PLATFORM |
The web property cannot be served on the specified platform. |
| INVALID_WEB_PROPERTY_FOR_ENVIRONMENT |
The web property cannot be served on the specified environment. |
| AFMA_BACKFILL_NOT_ALLOWED |
AFMA backfill not supported. |
| UPDATE_ENVIRONMENT_TYPE_NOT_ALLOWED |
Environment type cannot change once saved. |
| COMPANIONS_NOT_ALLOWED |
The placeholders are invalid because they contain companions, but the line item does not support companions. |
| ROADBLOCKS_WITH_NONROADBLOCKS_NOT_ALLOWED |
The placeholders are invalid because some of them are roadblocks, and some are not. Either all roadblock placeholders must contain companions, or no placeholders may contain companions. This does not apply to video creative sets. |
| CANNOT_UPDATE_TO_OR_FROM_CREATIVE_SET_ROADBLOCK |
A line item cannot be updated from having RoadblockingType::CREATIVE_SET to having a different RoadblockingType, or vice versa. |
| UPDATE_FROM_BACKFILL_LINE_ITEM_TYPE_NOT_ALLOWED |
Can not change from a backfill line item type once creatives have been assigned. |
| UPDATE_TO_BACKFILL_LINE_ITEM_TYPE_NOT_ALLOWED |
Can not change to a backfill line item type once creatives have been assigned. |
| UPDATE_BACKFILL_WEB_PROPERTY_NOT_ALLOWED |
Can not change to backfill web property once creatives have been assigned. |
| INVALID_COMPANION_DELIVERY_OPTION_FOR_ENVIRONMENT_TYPE |
The companion delivery option is not valid for your environment type. |
| COMPANION_BACKFILL_REQUIRES_VIDEO |
Companion backfill is enabled but environment type not video. |
| COMPANION_DELIVERY_OPTION_REQUIRE_PREMIUM |
Companion delivery options require Ad Manager 360 networks. |
| DUPLICATE_MASTER_SIZES |
The master size of placeholders have duplicates. |
| INVALID_PRIORITY_FOR_LINE_ITEM_TYPE |
The line item priority is invalid if for dynamic allocation line items it is different than the default for free publishers. When allowed, Ad Manager 360 users can change the priority to any value. |
| INVALID_ENVIRONMENT_TYPE |
The environment type is not valid. |
| INVALID_ENVIRONMENT_TYPE_FOR_PLATFORM |
The environment type is not valid for the target platform. |
| INVALID_TYPE_FOR_AUTO_EXTENSION |
Only LineItemType::STANDARD line items can be auto extended. |
| VIDEO_INVALID_ROADBLOCKING |
Video line items cannot change the roadblocking type. |
| BACKFILL_TYPE_NOT_ALLOWED |
The backfill feature is not enabled according to your features. |
| INVALID_BACKFILL_LINK_TYPE |
The web property is invalid. A line item must have an appropriate web property selected. |
| DIFFERENT_BACKFILL_ACCOUNT |
All line items in a programmatic order must have web property codes from the same account. |
| COMPANION_DELIVERY_OPTIONS_NOT_ALLOWED_WITH_BACKFILL |
Companion delivery options are not allowed with dynamic allocation line items. |
| INVALID_WEB_PROPERTY_FOR_ADX_BACKFILL |
Dynamic allocation using the AdExchange should always use an AFC web property. |
| INVALID_COST_PER_UNIT_FOR_BACKFILL |
CPM for backfill inventory must be 0. |
| INVALID_SIZE_FOR_ENVIRONMENT |
Aspect ratio sizes cannot be used with video line items. |
| TARGET_PLATOFRM_NOT_ALLOWED |
The specified target platform is not allowed. |
| INVALID_LINE_ITEM_CURRENCY |
Currency on a line item must be one of the specified network currencies. |
| LINE_ITEM_CANNOT_HAVE_MULTIPLE_CURRENCIES |
All money fields on a line item must specify the same currency. |
| CANNOT_CHANGE_CURRENCY |
Once a line item has moved into a a delivering state the currency cannot be changed. |
| INVALID_LINE_ITEM_DATE_TIME |
A DateTime associated with the line item is not valid. |
| INVALID_COST_PER_UNIT_FOR_CPA |
CPA line items must specify a zero cost for the LineItem::costPerUnit. |
| UPDATE_CPA_COST_TYPE_NOT_ALLOWED |
Once a LineItem is activated its LineItem::costPerUnit cannot be updated to/from CPA. |
| UPDATE_VCPM_COST_TYPE_NOT_ALLOWED |
Once a LineItem is activated its LineItem::costPerUnit cannot be updated to/from Viewable CPM. |
| MASTER_COMPANION_LINE_ITEM_CANNOT_HAVE_VCPM_COST_TYPE |
A LineItem with master/companion creative placeholders cannot have Viewable CPM as its LineItem::costPerUnit. |
| DUPLICATED_UNIT_TYPE |
There cannot be goals with duplicated unit type among the secondary goals for a line items. |
| MULTIPLE_GOAL_TYPE_NOT_ALLOWED |
The secondary goals of a line items must have the same goal type. |
| INVALID_UNIT_TYPE_COMBINATION_FOR_SECONDARY_GOALS |
For a CPA line item, the possible combinations for secondary goals must be either click-through conversion only, click-through conversion with view-through conversion or total conversion only. For a Viewable CPM line item or a CPM based Sponsorship line item, its secondary goal has to be impression-based. |
| INVALID_CREATIVE_TARGETING_NAME |
One or more of the targeting names specified by a creative placeholder or line item creative association were not found on the line item. |
| INVALID_CREATIVE_CUSTOM_TARGETING_MATCH_TYPE |
Creative targeting expressions on the line item can only have custom criteria targeting with CustomTargetingValue.MatchType::EXACT. |
| INVALID_CREATIVE_ROTATION_TYPE_WITH_CREATIVE_TARGETING |
Line item with creative targeting expressions cannot have creative rotation type set to CreativeRotationType::SEQUENTIAL. |
| CANNOT_OVERBOOK_WITH_CREATIVE_TARGETING |
Line items cannot overbook inventory when applying creative-level targeting if the originating proposal line item did not overbook inventory. Remove creative-level targeting and try again. |
| PLACEHOLDERS_DO_NOT_MATCH_PROPOSAL |
For a managed line item, inventory sizes must match sizes that are set on the originating proposal line item. In the case that a size is broken out by creative-level targeting, the sum of the creative counts for each size must equal the expected creative count that is set for that size on the originating proposal line item. |
| UNSUPPORTED_LINE_ITEM_TYPE_FOR_THIS_API_VERSION |
The line item type is not supported for this API version. |
| NATIVE_CREATIVE_TEMPLATE_REQUIRED |
Placeholders can only have native creative templates. |
| CANNOT_HAVE_CREATIVE_TEMPLATE |
Non-native placeholders cannot have creative templates. |
| CANNOT_INCLUDE_NATIVE_CREATIVE_TEMPLATE |
Cannot include native creative templates in the placeholders for Ad Exchange line items. |
| CANNOT_INCLUDE_NATIVE_PLACEHOLDER_WITHOUT_TEMPLATE_ID |
Cannot include native placeholders without native creative templates for direct-sold line items. |
| NO_SIZE_WITH_DURATION |
For forecasting only, error when line item has duration, but no creative sizes specified. |
| INVALID_VIEWABILITY_PROVIDER_COMPANY |
Used when the company pointed to by the viewabilityProviderCompanyId is not of type VIEWABILITY_PROVIDER. |
| CANNOT_ACCESS_CUSTOM_PACING_CURVE_CLOUD_STORAGE_BUCKET |
An error occurred while accessing the custom pacing curve Google Cloud Storage bucket. |
| CMS_METADATA_LINE_ITEM_ENVIRONMENT_TYPE_NOT_SUPPORTED |
CMS Metadata targeting is only supported for video line items. |
| SKIPPABLE_AD_TYPE_NOT_ALLOWED |
The
|
| CUSTOM_PACING_CURVE_START_TIME_MUST_MATCH_LINE_ITEM_START_TIME |
Custom pacing curve start time must match the line item's start time. |
| CUSTOM_PACING_CURVE_START_TIME_PAST_LINE_ITEM_END_TIME |
Custom pacing curve goal start time must be before line item end time. |
| INVALID_LINE_ITEM_TYPE_FOR_DELIVERY_FORECAST_SOURCE |
The line item type is invalid for the specified delivery forecast source. |
| INVALID_TOTAL_CUSTOM_PACING_GOAL_AMOUNTS |
The sum of the custom pacing goal amounts is invalid. |
| COPY_LINE_ITEM_WITH_CUSTOM_PACING_CURVE_FULLY_IN_PAST_NOT_ALLOWED |
Copying line items with custom pacing curves that are totally in the past is not allowed. |
| LAST_CUSTOM_PACING_GOAL_AMOUNT_CANNOT_BE_ZERO |
The last custom pacing goal cannot be zero. |
| GRP_PACED_LINE_ITEM_CANNOT_HAVE_ABSOLUTE_CUSTOM_PACING_CURVE_GOALS |
GRP paced line items cannot have absolute custom pacing curve goals. |
| INVALID_MAX_VIDEO_CREATIVE_DURATION |
line item has invalid video creative duration. |
| INVALID_NATIVE_SIZE |
Native size types must by 1x1. |
| INVALID_TARGETED_REQUEST_PLATFORM_FOR_WEB_PROPERTY_CODE |
For AdExchange Line Items, the targeted request platform must match the syndication type of the web property code. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
The reasons for the target error.
| Enumerator | |
|---|---|
| NOT_ALLOWED |
The operation is not allowed due to lack of permissions. |
| NOT_APPLICABLE |
The operation is not applicable for the current state of the LineItem. |
| HAS_COMPLETED |
The LineItem is completed. A LineItemAction cannot be applied to a line item that is completed. |
| HAS_NO_ACTIVE_CREATIVES |
The LineItem has no active creatives. A line item cannot be activated with no active creatives. |
| CANNOT_ACTIVATE_LEGACY_DFP_LINE_ITEM |
A LineItem of type LineItemType::LEGACY_DFP cannot be Activated. |
| CANNOT_ACTIVATE_UNCONFIGURED_LINE_ITEM |
A LineItem with publisher creative source cannot be activated if the corresponding deal is not yet configured by the buyer. |
| CANNOT_DELETE_DELIVERED_LINE_ITEM |
Deleting an LineItem that has delivered is not allowed |
| CANNOT_RESERVE_COMPANY_CREDIT_STATUS_NOT_ACTIVE |
Reservation cannot be made for line item because the LineItem::advertiserId it is associated with has Company::creditStatus that is not
|
| CANNOT_ACTIVATE_INVALID_COMPANY_CREDIT_STATUS |
Cannot activate line item because the LineItem::advertiserId it is associated with has Company::creditStatus that is not
|
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
Specifies the reservation status of the LineItem.
| Enumerator | |
|---|---|
| RESERVED |
Indicates that inventory has been reserved for the line item. |
| UNRESERVED |
Indicates that inventory has not been reserved for the line item. |
LineItemType indicates the priority of a LineItem, determined by the way in which impressions are reserved to be served for it.
| Enumerator | |
|---|---|
| SPONSORSHIP |
The type of LineItem for which a percentage of all the impressions that are being sold are reserved. |
| STANDARD |
The type of LineItem for which a fixed quantity of impressions or clicks are reserved. |
| NETWORK |
The type of LineItem most commonly used to fill a site's unsold inventory if not contractually obligated to deliver a requested number of impressions. Users specify the daily percentage of unsold impressions or clicks when creating this line item. |
| BULK |
The type of LineItem for which a fixed quantity of impressions or clicks will be delivered at a priority lower than the LineItemType::STANDARD type. |
| PRICE_PRIORITY |
The type of LineItem most commonly used to fill a site's unsold inventory if not contractually obligated to deliver a requested number of impressions. Users specify the fixed quantity of unsold impressions or clicks when creating this line item. |
| HOUSE |
The type of LineItem typically used for ads that promote products and services chosen by the publisher. These usually do not generate revenue and have the lowest delivery priority. |
| LEGACY_DFP |
Represents a legacy LineItem that has been migrated from the DFP system. Such line items cannot be created any more. Also, these line items cannot be activated or resumed. |
| CLICK_TRACKING |
The type of LineItem used for ads that track ads being served externally of Ad Manager, for example an email newsletter. The click through would reference this ad, and the click would be tracked via this ad. |
| ADSENSE |
A LineItem using dynamic allocation backed by AdSense. |
| AD_EXCHANGE |
A LineItem using dynamic allocation backed by the Google Ad Exchange. |
| BUMPER |
Represents a non-monetizable video LineItem that targets one or more bumper positions, which are short house video messages used by publishers to separate content from ad breaks. |
| ADMOB |
A LineItem using dynamic allocation backed by AdMob. |
| PREFERRED_DEAL |
The type of LineItem for which there are no impressions reserved, and will serve for a second price bid. All LineItems of type LineItemType::PREFERRED_DEAL should be created via a ProposalLineItem with a matching type. When creating a LineItem of type LineItemType::PREFERRED_DEAL, the ProposalLineItem::estimatedMinimumImpressions field is required. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
Describes reasons for
Describes reasons for
LiveStreamEventCdnSettingsError.
| Enumerator | |
|---|---|
| CDN_CONFIGURATIONS_MUST_HAVE_UNIQUE_CDN_URL_PREFIXES |
CDN configurations in a single LiveStreamEvent cannot have duplicate URL prefixes. |
| MUST_BE_LIVE_CDN_CONFIGURATION |
Only CDN configurations of type
|
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
The reasons for the target error.
Describes reasons for
LiveStreamEventCustomAssetKeyError.
| Enumerator | |
|---|---|
| CONTAINS_INVALID_CHARACTERS |
Custom asset key contains invalid characters. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
Describes reasons for
| Enumerator | |
|---|---|
| START_DATE_TIME_IS_IN_PAST |
Cannot create a new live stream event with a start date in the past. |
| END_DATE_TIME_NOT_AFTER_START_DATE_TIME |
End date must be after the start date. |
| END_DATE_TIME_TOO_LATE |
|
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
Describes reasons for
LiveStreamEventDvrWindowError.
Describes reasons for
Describes the status of a LiveStreamEvent object.
| Enumerator | |
|---|---|
| ACTIVE |
Indicates the LiveStreamEvent has been created and is eligible for streaming. |
| ARCHIVED |
Indicates the LiveStreamEvent has been archived. |
| PAUSED |
Indicates the LiveStreamEvent has been paused. This can be made #ACTIVE at later time. |
| ADS_PAUSED |
Indicates that the stream is still being served, but ad insertion should be paused temporarily. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
The reason of the error.
Frequency types for mid-roll ad rule slots.
| Enumerator | |
|---|---|
| NONE |
The ad rule slot is not a mid-roll and hence
|
| EVERY_N_SECONDS |
|
| FIXED_TIME |
|
| EVERY_N_CUEPOINTS |
|
| FIXED_CUE_POINTS |
Same as #FIXED_TIME, except the values represent the ordinal cue points ("1,3,5", for example). |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
Enum of supported mime types
The reasons for the MobileApplication.
| Enumerator | |
|---|---|
| INVALID_APP_ID |
Could not find the ID of the app being claimed in any app stores. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
A platform a MobileApplication can run on.
| Enumerator | |
|---|---|
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
| ANDROID | |
| IOS | |
| ROKU | |
| AMAZON_FIRETV | |
| PLAYSTATION | |
| XBOX | |
| SAMSUNG_TV | |
A store a MobileApplication is available on.
ApiErrorReason enum for user domain targeting error.
The reasons for the target error.
| Enumerator | |
|---|---|
| ACTIVE_CREATIVE_TEMPLATE_REQUIRED |
Native styles can only be created under active creative templates. |
| INVALID_CUSTOM_TARGETING_MATCH_TYPE |
Targeting expressions on the NativeStyle can only have custom criteria targeting with CustomTargetingValue.MatchType::EXACT. |
| INVALID_INVENTORY_TARTGETING_TYPE |
Native styles only allows inclusion of inventory units. |
| INVALID_STATUS |
The status of a native style cannot be null. |
| INVALID_TARGETING_TYPE |
Targeting expressions on the native style can only have inventory targeting and/or custom targeting. |
| NATIVE_CREATIVE_TEMPLATE_REQUIRED |
Native styles can only be created under native creative templates. |
| TOO_MANY_CUSTOM_TARGETING_KEY_VALUES |
Targeting expressions on native styles can have a maximum of 20 key-value pairs. |
| UNIQUE_SNIPPET_REQUIRED |
Native styles must have an HTML snippet. |
| UNRECOGNIZED_MACRO |
The macro referenced in the snippet is not valid. |
| UNRECOGNIZED_PLACEHOLDER |
The snippet of the native style contains a placeholder which is not defined as a variable on the creative template of this native style. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
Describes status of the native style.
Represents the proposal's negotiation status for Marketplace.
| Enumerator | |
|---|---|
| SELLER_INITIATED |
Indicates that a new Proposal has been created by the seller and has not been sent to Marketplace yet. |
| BUYER_INITIATED |
Indicates that a new Proposal has been created by the buyer and is awaiting seller action. |
| AWAITING_SELLER_REVIEW |
Indicates that a Proposal has been updated by the buyer and is awaiting seller approval. |
| AWAITING_BUYER_REVIEW |
Indicates that a Proposal has been updated by the seller and is awaiting buyer approval. |
| ONLY_SELLER_ACCEPTED |
Indicates that the seller has accepted the Proposal and is awaiting the buyer's acceptance. |
| FINALIZED |
Indicates that the Proposal has been accepted by both the buyer and the seller. |
| CANCELLED |
Indicates that negotiations for the Proposal have been cancelled. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
Possible reasons for NetworkError
Represents the pacing computation method for impressions on connected devices for a Nielsen measured line item. This only applies when Nielsen measurement is enabled for connected devices.
Pending onboarding tasks for the child publishers that must completed before Google's policy compliance is verified.
The reasons for the target error.
| Enumerator | |
|---|---|
| PERMISSION_DENIED |
The operation is not allowed due to lack of permissions. |
| NOT_APPLICABLE |
The operation is not applicable for the current state of the Order. |
| IS_ARCHIVED |
The Order is archived, an OrderAction cannot be applied to an archived order. |
| HAS_ENDED |
The Order is past its end date, An OrderAction cannot be applied to a order that has ended. |
| CANNOT_APPROVE_WITH_UNRESERVED_LINE_ITEMS |
A Order cannot be approved if it contains reservable LineItems that are unreserved. |
| CANNOT_DELETE_ORDER_WITH_DELIVERED_LINEITEMS |
Deleting an Order with delivered line items is not allowed |
| CANNOT_APPROVE_COMPANY_CREDIT_STATUS_NOT_ACTIVE |
Cannot approve because company credit status is not active. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
The reasons for the target error.
Describes the order statuses.
| Enumerator | |
|---|---|
| DRAFT |
Indicates that the Order has just been created but no approval has been requested yet. |
| PENDING_APPROVAL |
Indicates that a request for approval for the Order has been made. |
| APPROVED |
Indicates that the Order has been approved and is ready to serve. |
| DISAPPROVED |
Indicates that the Order has been disapproved and is not eligible to serve. |
| PAUSED |
This is a legacy state. Paused status should be checked on LineItemss within the order. |
| CANCELED |
Indicates that the Order has been canceled and cannot serve. |
| DELETED |
Indicates that the Order has been deleted by DSM. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
Indicates the type of origin forwarding used to support Akamai authentication policies for LiveStreamEvent
Represents whose device categorization to use on Nielsen measured line item with auto-pacing enabled.
| Enumerator | |
|---|---|
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
|
Use Google's device categorization in auto-pacing. | |
| NIELSEN |
Use Nielsen device categorization in auto-pacing |
Describes reasons for permission errors.
| Enumerator | |
|---|---|
| PERMISSION_DENIED |
User does not have the required permission for the request. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
Possible reasons for the error.
Describes the type of the playlist associated with this live stream. This is analagous to the EXT-X-PLAYLIST-TYPE HLS tag. Use PlaylistType.EVENT for streams with the value "#EXT-X-PLAYLIST-TYPE:EVENT" and use PlaylistType.LIVE for streams without the tag.
Describes reason for
| Enumerator | |
|---|---|
| INVALID_PODDING_TYPE_NONE |
Invalid podding type NONE, but has podding fields filled in. Podding types are defined in com.google.ads.publisher.domain.entity.adrule.export.PoddingType. |
| INVALID_PODDING_TYPE_STANDARD |
Invalid podding type STANDARD, but doesn't specify the max ads in pod and max ad duration podding fields. |
| INVALID_OPTIMIZED_POD_WITHOUT_DURATION |
Invalid podding type OPTIMIZED, but doesn't specify pod duration. |
| INVALID_OPTIMIZED_POD_WITHOUT_ADS |
Invalid optimized pod that does not specify a valid max ads in pod, which must either be a positive number or -1 to signify that there is no maximum. |
| INVALID_POD_DURATION_RANGE |
Min pod ad duration is greater than max pod ad duration. |
The reasons for the target error.
| Enumerator | |
|---|---|
| INVALID_PRIORITY | |
| INVALID_RATE_TYPE |
Preferred deal proposal line items only support RateType::CPM. |
| INVALID_FREQUENCY_CAPS |
Preferred deal proposal line items do not support frequency caps. |
| INVALID_ROADBLOCKING_TYPE |
Preferred deal proposal line items only support RoadblockingType::ONE_OR_MORE. |
| INVALID_DELIVERY_RATE_TYPE |
Preferred deal proposal line items only support DeliveryRateType::FRONTLOADED. |
| UNKNOWN | |
Types of programmatic creative sources.
Possible error reasons for a programmatic error.
| Enumerator | |
|---|---|
| AUDIENCE_EXTENSION_NOT_SUPPORTED |
Audience extension is not supported by programmatic line items. |
| AUTO_EXTENSION_DAYS_NOT_SUPPORTED |
Auto extension days is not supported by programmatic line items. |
| VIDEO_NOT_SUPPORTED |
Video is currently not supported. |
| ROADBLOCKING_NOT_SUPPORTED |
Roadblocking is not supported by programmatic line items. |
| INVALID_CREATIVE_ROTATION |
Programmatic line items do not support CreativeRotationType::SEQUENTIAL. |
| INVALID_LINE_ITEM_TYPE |
Programmatic line items only support LineItemType::STANDARD and LineItemType::SPONSORSHIP if the relevant feature is on. |
| INVALID_COST_TYPE |
Programmatic line items only support CostType::CPM. |
| SIZE_NOT_SUPPORTED |
Programmatic line items only support a creative size that is supported by AdX. The list of supported sizes is maintained based on the list published in the help docs: https://support.google.com/adxseller/answer/1100453 |
| ZERO_COST_PER_UNIT_NOT_SUPPORTED |
Zero cost per unit is not supported by programmatic line items. |
| CANNOT_UPDATE_FIELD_FOR_APPROVED_LINE_ITEMS |
Some fields cannot be updated on approved line items. |
| CANNOT_CREATE_LINE_ITEM_FOR_APPROVED_ORDER |
Creating a new line item in an approved order is not allowed. |
| CANNOT_UPDATE_BACKFILL_WEB_PROPERTY_FOR_APPROVED_LINE_ITEMS |
Cannot change backfill web property for a programmatic line item whose order has been approved. |
| COST_PER_UNIT_TOO_LOW |
Cost per unit is too low. It has to be at least 0.005 USD. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
Describes the type of a Company associated with a Proposal.
The reasons for the target error.
| Enumerator | |
|---|---|
| AD_SERVER_UNKNOWN_ERROR |
Unknown error from ad-server |
| AD_SERVER_API_ERROR |
Ad-server reports an api error for the operation. |
| UPDATE_ADVERTISER_NOT_ALLOWED |
Advertiser cannot be updated once the proposal has been reserved. |
| UPDATE_PROPOSAL_NOT_ALLOWED |
Proposal cannot be updated when its status is not
|
| CONTACT_UNSUPPORTED_FOR_ADVERTISER |
Contacts are not supported for advertisers in a programmatic Proposal. |
| INVALID_CONTACT |
Contact associated with a proposal does not belong to the specific company. |
| DUPLICATED_CONTACT |
Contact associated with a proposal's advertiser or agency is duplicated. |
| UNACCEPTABLE_COMPANY_CREDIT_STATUS |
A proposal cannot be created or updated because the company it is associated with has Company::creditStatus that is not
|
| COMPANY_CREDIT_STATUS_NOT_ACTIVE |
Advertiser or agency associated with the proposal has Company::creditStatus that is not
|
| PRIMARY_AGENCY_REQUIRED |
Cannot have other agencies without a primary agency. |
| PRIMARY_AGENCY_NOT_UNIQUE |
Cannot have more than one primary agency. |
| UNSUPPORTED_COMPANY_ASSOCIATION_TYPE_FOR_PROGRAMMATIC_PROPOSAL |
The Company association type is not supported for programmatic proposals. |
| DUPLICATED_COMPANY_ASSOCIATION |
Advertiser or agency associated with a proposal is duplicated. |
| DUPLICATED_SALESPERSON |
Found duplicated primary or secondary sales person. |
| DUPLICATED_SALES_PLANNER |
Found duplicated sales planner. |
| DUPLICATED_TRAFFICKER |
Found duplicated primary or secondary trafficker. |
| HAS_NO_UNARCHIVED_PROPOSAL_LINEITEMS |
The proposal has no unarchived proposal line items. |
| DUPLICATE_TERMS_AND_CONDITIONS |
One or more of the terms and conditions being added already exists on the proposal. |
| UNSUPPORTED_PROPOSAL_CURRENCY_CODE |
The currency code of the proposal is not supported by the current network. All supported currencies can be found in the union of Network::currencyCode and Network::secondaryCurrencyCodes. |
| UNSUPPORTED_BUYER_CURRENCY_CODE |
The currency code of the proposal is not supported by the selected buyer. |
| INVALID_POC |
The POC value of the proposal is invalid. |
| UPDATE_CURRENCY_NOT_ALLOWED |
Currency cannot be updated once the proposal has been reserved. |
| UPDATE_TIME_ZONE_NOT_ALLOWED |
Time zone cannot be updated once the proposal has been sold. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
The reasons for the target error.
| Enumerator | |
|---|---|
| NOT_APPLICABLE |
The operation is not applicable to the current state. |
| PROPOSAL_NOT_EDITABLE |
The operation is not applicable because the containing proposal is not editable. |
| CANNOT_SELECTIVELY_ARCHIVE_PROPOSAL_LINE_ITEMS_FROM_MANDATORY_PRODUCTS |
The archive operation is not applicable because it would cause some mandatory products to have no unarchived proposal line items in the package. |
| CANNOT_SELECTIVELY_UNARCHIVE_PROPOSAL_LINE_ITEMS_FROM_MANDATORY_PRODUCTS |
The unarchive operation is not applicable because it would cause some mandatory products to have no unarchived proposal line items in the package. |
| CANNOT_UNARCHIVE_SOLD_PROGRAMMATIC_PROPOSAL_LINE_ITEM |
Sold programmatic ProposalLineItem cannot be unarchived. |
| CANNOT_ARCHIVE_ONGOING_PROPOSAL_LINE_ITEM |
Active ProposalLineItem cannot be archived |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
The reasons for the target error.
| Enumerator | |
|---|---|
| NOT_SAME_RATE_CARD |
The proposal line item's rate card is not the same as other proposal line items in the proposal. |
| LINE_ITEM_TYPE_NOT_ALLOWED |
The proposal line item's type is not yet supported by Sales Manager. |
| END_DATE_TIME_NOT_AFTER_START_TIME |
The proposal line item's end date time is not after its start date time. |
| START_DATE_TIME_TOO_LATE_IN_MONTH |
The proposal line item's start date time is too late in the month. |
| END_DATE_TIME_TOO_LATE |
The proposal line item's end date time is after 1/1/2037. |
| START_DATE_TIME_IS_IN_PAST |
The proposal line item's start date time is in past. |
| END_DATE_TIME_IS_IN_PAST |
The proposal line item's end date time is in past. |
| FRONTLOADED_NOT_ALLOWED |
Frontloaded delivery rate type is not allowed. |
| ALL_ROADBLOCK_NOT_ALLOWED |
Roadblocking to display all creatives is not allowed. |
| ALL_COMPANION_DELIVERY_NOT_ALLOWED |
Display all companions is not allowed. |
| CREATIVE_SET_ROADBLOCK_NOT_ALLOWED |
Roadblocking to display all master and companion creative set is not allowed. |
| ALREADY_STARTED |
Some changes may not be allowed because the related line item has already started. |
| CONFLICT_WITH_PRODUCT |
The setting is conflict with product's restriction. |
| VIOLATE_BUILT_IN_TARGETING_COMPATIBILITY_RESTRICTION |
The proposal line item's setting violates the product's built-in targeting compatibility restriction. |
| VIOLATE_BUILT_IN_TARGETING_LOCKED_RESTRICTION |
The proposal line item's setting violates the product's built-in targeting locked restriction. |
| MOBILE_TECH_CRITERIA_NOT_SUPPORTED |
Cannot target mobile-only targeting criteria. |
| UNSUPPORTED_TARGETING_TYPE |
The targeting criteria type is unsupported. |
| WRONG_COST |
The contracted cost does not match with what calculated from final rate and units bought. |
| NO_WEB_PROPERTY_FOR_TARGETED_REQUEST_PLATFORM |
The proposal line item targets an inventory type for which the network does not have a corresponding web property. |
| CALCULATED_COST_TOO_HIGH |
The cost calculated from cost per unit and units is too high. |
| INVALID_PRIORITY_FOR_LINE_ITEM_TYPE |
The line item priority is invalid if it's different than the default. |
| UPDATE_PROPOSAL_LINE_ITEM_NOT_ALLOWED |
Propsoal line item cannot update when it is archived. |
| CANNOT_UPDATE_TO_OR_FROM_CREATIVE_SET_ROADBLOCK |
A proposal line item cannot be updated from having RoadblockingType::CREATIVE_SET to having a different RoadblockingType, or vice versa. |
| SEQUENTIAL_CREATIVE_ROTATION_NOT_ALLOWED |
Serving creatives exactly in sequential order is not allowed. |
| UPDATE_RESERVATION_NOT_ALLOWED |
Proposal line item cannot update its reservation detail once start delivering. |
| INVALID_COMPANION_DELIVERY_OPTION_FOR_ROADBLOCKING_TYPE |
The companion delivery option is not valid for the roadblocking type. |
| INCONSISTENT_ROADBLOCK_TYPE |
Roadblocking type is inconsistent with creative placeholders. If the roadblocking type is creative set, creative placeholders should contain companions, and vice versa. |
| INVALID_CONTRACTED_QUANTITY_BUFFER |
ContractedQuantityBuffer is only applicable to standard line item with RateType::CPC/RateType::CPM/RateType::VCPM type. |
| INVALID_VALUES_FOR_CLICK_TRACKING_LINE_ITEM_TYPE |
One or more values on the proposal line item are not valid for a LineItemType::CLICK_TRACKING line item type. |
| UPDATE_COST_ADJUSTMENT_NOT_ALLOWED |
Proposal line item cannot update its cost adjustment after first approval. |
| UNSUPPORTED_RATE_CARD_CURRENCY_CODE |
The currency code of the proposal line item's rate card is not supported by the current network. All supported currencies can be found in the union of Network::currencyCode and Network::secondaryCurrencyCodes. |
| END_DATE_TIME_IS_BEFORE_LAST_PAUSED_TIME |
The corresponding line item is paused, but the proposal line item's end date time is before the last paused time. |
| VIDEO_INVALID_ROADBLOCKING |
Video line items cannot have roadblocking options. |
| UPDATE_TIME_ZONE_NOT_ALLOWED |
Time zone cannot be updated once the proposal line item has been sold. |
| INVALID_TIME_ZONE_FOR_RATE_TYPE |
Time zone must be network time zone if the proposal line item is RateType::VCPM. |
| INVALID_TIME_ZONE_FOR_DEALS |
Only the Network::timeZone is allowed for programmatic proposals. |
| INVALID_ENVIRONMENT_TYPE |
The ProposalLineItem::environmentType is invalid. |
| SIZE_REQUIRED |
At least one size must be specified. |
| COMPANION_NOT_ALLOWED |
A placeholder contains companions but the roadblocking type is not RoadblockingType::CREATIVE_SET or the product type is offline. |
| MISSING_COMPANION |
A placeholder does not contain companions but the roadblocking type is RoadblockingType::CREATIVE_SET. |
| DUPLICATED_MASTER_SIZE |
A placeholder's master size is the same as another placeholder's master size. |
| INVALID_EXPECTED_CREATIVE_COUNT |
Only creative placeholders with standard sizes can set an expected creative count. |
| CANNOT_HAVE_CREATIVE_TEMPLATE |
Non-native placeholders cannot have creative templates. |
| NATIVE_CREATIVE_TEMPLATE_REQUIRED |
Placeholders can only have native creative templates. |
| CANNOT_INCLUDE_NATIVE_PLACEHOLDER_WITHOUT_TEMPLATE_ID |
Cannot include native placeholders without native creative templates. |
| INVALID_CLICK_TRACKING_LINE_ITEM_TYPE |
One or more values are not valid for a LineItemType::CLICK_TRACKING line item type. |
| INVALID_TARGETING_FOR_CLICK_TRACKING |
The targeting is not valid for a LineItemType::CLICK_TRACKING line item type. |
| INVALID_CONTRACTED_UNITS_BOUGHT |
The contractedUnitsBought of the proposal line item is invalid. |
| PLACEHOLDER_CANNOT_CONTAIN_LABELS |
Only creative placeholders with standard sizes can contain labels. |
| INVALID_LABEL_TYPE_IN_PLACEHOLDER |
One or more labels on a creative placeholder is invalid. |
| PLACEHOLDER_CANNOT_CONTAIN_NEGATED_LABELS |
A placeholder cannot contain a negated label. |
| CONTRACTED_UNITS_LESS_THAN_DELIVERED |
Contracted impressions of programmatic proposal line item must be greater than already delivered impressions. |
| DISPLAY_ENVIRONMENT_MUST_HAVE_EXCLUDED_MOBILE_APPS_TARGETING |
If AdExchangeEnvironment is DISPLAY, the proposal line item must have mobile apps as excluded device capability targeting. |
| MOBILE_ENVIRONMENT_MUST_HAVE_INCLUDED_MOBILE_APPS_TARGETING |
If AdExchangeEnvironment is MOBILE, the proposal line item must have mobile apps as included device capability targeting. |
| SKIPPABLE_AD_TYPE_NOT_ALLOWED |
The
|
| CROSS_SELL_TARGETING_UNSUPPORTED |
Cross sell targeting is unsupported for this proposal line item. |
| CANNOT_SET_VIDEO_DURATION_ON_NON_VIDEO_DEAL |
Can't set a video duration for non video deals. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
The reasons for the target error.
The reasons for the target error.
| Enumerator | |
|---|---|
| INVALID_PRODUCT_TYPE |
Programmatic proposal line items only support ProductType::DFP. |
| VIDEO_NOT_SUPPORTED |
EnvironmentType::VIDEO_PLAYER is currently not supported. |
| ROADBLOCKING_NOT_SUPPORTED |
Programmatic proposal line items do not support RoadblockingType::CREATIVE_SET. |
| INVALID_CREATIVE_ROTATION |
Programmatic proposal line items do not support CreativeRotationType::SEQUENTIAL. |
| INVALID_PROPOSAL_LINE_ITEM_TYPE |
Programmatic proposal line items only support LineItemType::STANDARD. |
| INVALID_RATE_TYPE |
Programmatic proposal line items only support RateType::CPM. |
| ZERO_COST_PER_UNIT_NOT_SUPPORTED |
Programmatic proposal line items do not support zero for ProposalLineItem::netRate. |
| INVALID_PROGRAMMATIC_CREATIVE_SOURCE |
Only programmatic proposal line items support ProgrammaticCreativeSource. |
| INVALID_MAX_VIDEO_CREATIVE_DURATION |
Programmatic proposal line item has invalid video creative duration. |
| CANNOT_UPDATE_PROGRAMMATIC_CREATIVE_SOURCE |
Cannot update programmatic creative source if the proposal line item has been sent to the buyer. |
| INVALID_NUM_UNITS |
The Goal::units value is invalid. For RateType::CPD proposal line items, only 100% is allowed |
| MIX_GUARANTEED_AND_PREFERRED_DEAL_NOT_ALLOWED |
Cannot mix guaranteed and Preferred Deal proposal line items in a programmatic proposal. |
| MIX_NATIVE_AND_BANNER_SIZE_NOT_ALLOWED |
Cannot mix native and banner size in a programmatic proposal line item. |
| CANNOT_UPDATE_SIZES |
Cannot update sizes when a programmatic proposal line item with publisher creative source is sent to a buyer. |
| INVALID_SPONSORSHIP_CONTRACTED_UNITS_BOUGHT |
The {ProposalLineItem::contractedUnitsBought} cannot be
|
| INVALID_PROGRAMMATIC_PRICING_MODEL |
Only PricingModel::NET is supported for programmatic proposal line items. |
| BUYER_DISABLED_FOR_PG_VIOLATING_SLA |
Buyer is currently disabled for guaranteed deals due to violation of Programmatic Guaranteed service level agreement. |
| BUYER_NOT_FOUND |
Buyer not found. |
| INVALID_ENVIRONMENT_PLATFORM_TYPE_PAIR |
Cannot create/update proposal line items with an invalid environment and request platform pair. |
| CANNOT_MIX_AUDIO_VIDEO_PROGRAMMATIC_LINE_ITEM |
A proposal line item must either be of video, or audio type, but not both. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
Describes the Proposal status.
| Enumerator | |
|---|---|
| DRAFT |
Indicates that the Proposal has just been created or retracted but no approval has been requested yet. |
| PENDING_APPROVAL |
Indicates that a request for approval has been made for the Proposal. |
| APPROVED |
Indicates that the Proposal has been approved and is ready to serve. |
| REJECTED |
Indicates that the Proposal has been rejected in the approval workflow. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
| Enumerator | |
|---|---|
| EXCEEDED_QUOTA |
The number of requests made per second is too high and has exceeded the allowable limit. The recommended approach to handle this error is to wait about 5 seconds and then retry the request. Note that this does not guarantee the request will succeed. If it fails again, try increasing the wait time. Another way to mitigate this error is to limit requests to 8 per second for Ad Manager 360 accounts, or 2 per second for Ad Manager accounts. Once again this does not guarantee that every request will succeed, but may help reduce the number of times you receive this error. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
| REPORT_JOB_LIMIT |
This user has exceeded the allowed number of new report requests per hour (this includes both reports run via the UI and reports run via ReportService::runReportJob). The recommended approach to handle this error is to wait about 10 minutes and then retry the request. Note that this does not guarantee the request will succeed. If it fails again, try increasing the wait time. Another way to mitigate this error is to limit the number of new report requests to 250 per hour per user. Once again, this does not guarantee that every request will succeed, but may help reduce the number of times you receive this error. |
Describes the type of event the advertiser is paying for. The values here correspond to the values for the LineItem::costType field.
Enumerates the different ways an HLS master playlist on a live stream will can be refreshed.
Represents the reportable state of a custom key.
| Enumerator | |
|---|---|
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
| ON |
Available for reporting in the Ad Manager query tool. |
| OFF |
Not available for reporting in the Ad Manager query tool. |
| CUSTOM_DIMENSION |
Custom dimension available for reporting in the AdManager query tool. |
The reasons for report error.
| Enumerator | |
|---|---|
| DEFAULT |
Default
|
| REPORT_ACCESS_NOT_ALLOWED |
User does not have permission to access the report. |
| DIMENSION_VIEW_NOT_ALLOWED |
User does not have permission to view one or more Dimension. |
| ATTRIBUTE_VIEW_NOT_ALLOWED |
User has no permission to view one or more attributes. |
| COLUMN_VIEW_NOT_ALLOWED | |
| TOO_MANY_CONCURRENT_REPORTS |
The user has exceeded the limit on the number of reports that can be run concurrently. The current limit is 30 per user. |
| REPORT_QUERY_TOO_LONG |
The report query exceeds the maximum allowed number of characters. |
| INVALID_OPERATION_FOR_REPORT_STATE |
Invalid report job state for the given operation. |
| INVALID_DIMENSIONS |
Invalid Dimension objects specified. |
| INVALID_ATTRIBUTES |
The attribute ID(s) are not valid. |
| INVALID_CMS_METADATA_DIMENSIONS |
The API error when running the report with CmsMetadataKeyDimension. There are three reasons for this error.
|
| INVALID_COLUMNS |
Invalid Column objects specified. |
| INVALID_DIMENSION_FILTERS |
Invalid DimensionFilter objects specified. |
| INVALID_DATE |
Invalid date. |
| END_DATE_TIME_NOT_AFTER_START_TIME |
The start date for running the report should not be later than the end date. |
| START_DATE_MORE_THAN_THREE_YEARS_AGO |
The start date for running the report should not be more than three years before now. |
| NOT_NULL | |
| ATTRIBUTES_NOT_SUPPORTED_FOR_REQUEST |
Attribute has to be selected in combination with dimensions. |
| COLUMNS_NOT_SUPPORTED_FOR_REQUESTED_DIMENSIONS |
The provided report violates one or more constraints, which govern incompatibilities and requirements between different report properties. Some reasons for constraint violations include:
For versions 201911 and later, this is only returned when some or all of the Column objects are not supported for the requested Dimension objects. |
| DATE_RANGE_NOT_SUPPORTED_FOR_REQUESTED_REPORT |
The report's date range is not compatible with the requested Dimension and Column objects. |
| TIME_ZONE_TYPE_NOT_SUPPORTED_FOR_REQUESTED_REPORT |
The report's TimeZoneType is not compatible with the requested Column and Dimension objects. |
| CURRENCY_CODE_NOT_SUPPORTED_FOR_REQUESTED_REPORT |
The report's currency is not compatible with the requested Column objects. |
| FAILED_TO_STORE_REPORT |
Failed to store/cache a report. |
| REPORT_NOT_FOUND |
The requested report does not exist. |
| SR_CANNOT_RUN_REPORT_IN_ANOTHER_NETWORK |
User has no permission to view in another network. |
| AD_UNIT_VIEW_NOT_SUPPORTED_FOR_REQUESTED_REPORT |
The report's AdUnitView is not compatible with the requested Dimension and Column objects. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
A view for an ad unit report.
| Enumerator | |
|---|---|
| TOP_LEVEL |
Only the top level ad units. Metrics include events for their descendants that are not filtered out. |
| FLAT |
All the ad units. Metrics do not include events for the descendants. |
| HIERARCHICAL |
Use the ad unit hierarchy. There will be as many ad unit columns as levels of ad units in the generated report:
Metrics do not include events for the descendants. |
Represents the platform which requests and renders the ad.
ApiErrorReason enum for the request platform targeting error.
| Enumerator | |
|---|---|
| REQUIRED |
Creative::size or LineItem::creativePlaceholders size is missing. |
| NOT_ALLOWED |
LineItemCreativeAssociation::sizes must be a subset of LineItem::creativePlaceholders sizes. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
The reasons for the target error.
| Enumerator | |
|---|---|
| UNLIMITED_UNITS_BOUGHT_NOT_ALLOWED |
There is no limit on the number of ads delivered for a line item when you set LineItem::duration to be LineItemSummary.Duration::NONE. This can only be set for line items of type LineItemType::PRICE_PRIORITY. |
| UNLIMITED_END_DATE_TIME_NOT_ALLOWED |
LineItem::unlimitedEndDateTime can be set to true for only line items of type LineItemType::SPONSORSHIP, LineItemType::NETWORK, LineItemType::PRICE_PRIORITY and LineItemType::HOUSE. |
| PERCENTAGE_UNITS_BOUGHT_TOO_HIGH |
When LineItem::lineItemType is LineItemType::SPONSORSHIP, then LineItem::unitsBought represents the percentage of available impressions reserved. That value cannot exceed 100. |
| DURATION_NOT_ALLOWED |
The line item type does not support the specified duration. See LineItemSummary.Duration for allowed values. |
| UNIT_TYPE_NOT_ALLOWED |
The LineItem::unitType is not allowed for the given LineItem::lineItemType. See UnitType for allowed values. |
| COST_TYPE_NOT_ALLOWED |
The LineItem::costType is not allowed for the LineItem::lineItemType. See CostType for allowed values. |
| COST_TYPE_UNIT_TYPE_MISMATCH_NOT_ALLOWED |
When LineItem::costType is CostType::CPM, LineItem::unitType must be UnitType::IMPRESSIONS and when LineItem::costType is CostType::CPC, LineItem::unitType must be UnitType::CLICKS. |
| LINE_ITEM_TYPE_NOT_ALLOWED |
Inventory cannot be reserved for line items which are not of type LineItemType::SPONSORSHIP or LineItemType::STANDARD. |
| NETWORK_REMNANT_ORDER_CANNOT_UPDATE_LINEITEM_TYPE |
Network remnant line items cannot be changed to other line item types once delivery begins. This restriction does not apply to any new line items created in Ad Manager. |
| BACKFILL_WEBPROPERTY_CODE_NOT_ALLOWED |
A dynamic allocation web property can only be set on a line item of type AdSense or Ad Exchange. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
Represents the inventory reservation status for ProposalLineItem objects.
| Enumerator | |
|---|---|
| RESERVED |
The inventory is reserved. |
| NOT_RESERVED |
The proposal line item's inventory is never reserved. |
| RELEASED |
The inventory is once reserved and now released. |
| CHECK_LINE_ITEM_RESERVATION_STATUS |
The reservation status of the corresponding LineItem should be used for this ProposalLineItem. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
Type of
RichMediaStudioChildAssetProperty
| Enumerator | |
|---|---|
| FLASH |
SWF files |
| VIDEO |
FLVS and any other video file types |
| IMAGE |
Image files |
| DATA |
The rest of the supported file types .txt, .xml, etc. |
Rich Media Studio creative supported billing attributes.
This is determined by Rich Media Studio based on the content of the creative and is not updateable.
| Enumerator | |
|---|---|
| IN_PAGE |
Applies to any RichMediaStudioCreativeFormat::IN_PAGE, without Video. |
| FLOATING_EXPANDING |
Applies to any of these following RichMediaStudioCreativeFormat, without Video: RichMediaStudioCreativeFormat::EXPANDING, RichMediaStudioCreativeFormat::IM_EXPANDING, RichMediaStudioCreativeFormat::FLOATING, RichMediaStudioCreativeFormat::PEEL_DOWN, RichMediaStudioCreativeFormat::IN_PAGE_WITH_FLOATING |
| VIDEO |
Applies to any creatives that includes a video. |
| FLASH_IN_FLASH |
Applies to any RichMediaStudioCreativeFormat::FLASH_IN_FLASH, without Video. |
The reasons for the target error.
Different creative format supported by Rich Media Studio creative.
Describes the roadblocking types.
| Enumerator | |
|---|---|
| ONLY_ONE |
Only one creative from a line item can serve at a time. |
| ONE_OR_MORE |
Any number of creatives from a line item can serve together at a time. |
| AS_MANY_AS_POSSIBLE |
As many creatives from a line item as can fit on a page will serve. This could mean anywhere from one to all of a line item's creatives given the size constraints of ad slots on a page. |
| ALL_ROADBLOCK |
All or none of the creatives from a line item will serve. This option will only work if served to a GPT tag using SRA (single request architecture mode). |
| CREATIVE_SET |
A master/companion CreativeSet roadblocking type. A LineItem::creativePlaceholders must be set accordingly. |
Represents the status of the role, weather the role is active or inactive.
The different ways a video/flash can scale.
Indicates the type of security policy associated with access to a CDN. Different security policies require different parameters in a SecurityPolicy.
| Enumerator | |
|---|---|
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
| NONE |
Indicates that no authentication is necessary. |
| AKAMAI |
Security policy for accessing content on the Akamai CDN. |
| CLOUD_MEDIA |
Security policy for access content on Google Cloud Media CDN. |
Describes reasons for server errors
Error reasons for set-top box creatives.
Reason for set-top box error.
| Enumerator | |
|---|---|
| NON_SET_TOP_BOX_AD_UNIT_TARGETED |
The set-top box line item cannot target an ad unit that doesn't have an external set-top box channel ID. |
| AT_LEAST_ONE_AD_UNIT_MUST_BE_TARGETED |
The set-top box line item must target at least one ad unit. |
| CANNOT_EXCLUDE_AD_UNITS |
The set-top box line item cannot exclude ad units. |
| POD_POSITION_OUT_OF_RANGE |
The set-top box line item can only target pod positions 1 - 15. |
| MIDROLL_POSITION_OUT_OF_RANGE |
The set-top box line item can only target midroll positions 4 - 100. |
| FEATURE_NOT_ENABLED |
The set-top box feature is not enabled. |
| INVALID_ENVIRONMENT_TYPE |
Only EnvironmentType::VIDEO_PLAYER is supported for set-top box line items. |
| COMPANIONS_NOT_SUPPORTED |
Companions are not supported for set-top box line items. |
| INVALID_CREATIVE_SIZE |
Set-top box line items only support sizes supported by Canoe. |
| INVALID_LINE_ITEM_TYPE |
Set-top box line items only support LineItemType::STANDARD, LineItemType::HOUSE, and LineItemType::SPONSORSHIP line item types. |
| ORDERS_WITH_STANDARD_LINE_ITEMS_CANNOT_CONTAIN_HOUSE_OR_SPONSORSHIP_LINE_ITEMS |
orders containing LineItemType::STANDARD set-top box line items cannot contain set-top box line items of type LineItemType::HOUSE or LineItemType::SPONSORSHIP. |
| INVALID_COST_TYPE |
Set-top box line items only support CostType::CPM. |
| COST_PER_UNIT_NOT_ALLOWED |
Set-top box line items do not support a cost per unit. |
| DISCOUNT_NOT_ALLOWED |
Set-top box line items do not support discounts. |
| FRONTLOADED_DELIVERY_RATE_NOT_SUPPORTED |
Set-top box line items do not support DeliveryRateType::FRONTLOADED. |
| INVALID_LINE_ITEM_STATUS_CHANGE |
Set-top box line items cannot go from a state that is ready to be synced to a state that is not ready to be synced. |
| INVALID_LINE_ITEM_PRIORITY |
Set-top box line items can only have certain priorities for different reservation types:
|
| SYNC_REVISION_NOT_INCREASING |
When a set-top box line item is pushed to Canoe, a revision number is used to keep track of the last version of the line item that Ad Manager synced with Canoe. The only change allowed on revisions within Ad Manager is increasing the revision number. |
| SYNC_REVISION_MUST_BE_GREATER_THAN_ZERO |
When a set-top box line item is pushed to Canoe, a revision number is used to keep track of the last version of the line item that Ad Manager synced with Canoe. Sync revisions begin at one and can only increase in value. |
| CANNOT_UNARCHIVE_SET_TOP_BOX_LINE_ITEMS |
Set Top box line items cannot be unarchived. |
| COPY_SET_TOP_BOX_ENABLED_LINE_ITEM_NOT_ALLOWED |
Set-top box enabled line items cannot be copied for V0 of the video Canoe campaign push. |
| INVALID_LINE_ITEM_TYPE_CHANGE |
Standard set-top box line items cannot be updated to be LineItemType::House or LineItemType::Sponsorship line items and vice versa. |
| CREATIVE_ROTATION_TYPE_MUST_BE_EVENLY_OR_WEIGHTED |
Set-top box line items can only have a creative rotation type of CreativeRotationType.EVEN or CreativeRotationType::MANUAL. |
| INVALID_FREQUENCY_CAP_TIME_UNIT |
Set-top box line items can only have frequency capping with time units of TimeUnit::DAY, TimeUnit::HOUR, TimeUnit::POD, or TimeUnit::STREAM. |
| INVALID_FREQUENCY_CAP_TIME_RANGE |
Set-top box line items can only have specific time ranges for certain time units:
|
| INVALID_PRIMARY_GOAL_UNIT_TYPE |
Set-top box line items can only have a unit type of UnitType::IMPRESSIONS. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
The reasons for the target error.
| Enumerator | |
|---|---|
| INVALID_CHILD_NETWORK_CODE |
The network code must belong to an MCM child network. |
| CANNOT_ARCHIVE_SITE_WITH_SUBSITES |
Archive all subsites before archiving the site. |
| INVALID_URL_FOR_SITE |
The URL is invalid for a top-level site. |
| MULTIPLE_UPDATES_FOR_SAME_SITE |
The batch of sites could not be updated because the same site was updated multiple times in the batch. |
| TOO_MANY_SITES_PER_REVIEW_REQUEST |
Too many sites in the request to submit them for review. |
| TOO_MANY_REVIEW_REQUESTS_FOR_SITE |
The site has been submitted for review too many times. |
| INVALID_APPROVAL_STATUS_FOR_REVIEW |
Only sites with approval status ApprovalStatus::DRAFT, ApprovalStatus::DISAPPROVED and ApprovalStatus::REQUIRES_REVIEW can be submitted for review. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
The different types of skippable ads.
Enum to store the creative SSL compatibility manual override. Its three states are similar to that of SslScanResult.
| Enumerator | |
|---|---|
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
| NO_OVERRIDE | |
| SSL_COMPATIBLE | |
| NOT_SSL_COMPATIBLE | |
Specifies the start type to use for an entity with a start date time field. For example, a LineItem or LineItemCreativeAssociation.
| Enumerator | |
|---|---|
| USE_START_DATE_TIME |
Use the value in #startDateTime. |
| IMMEDIATELY |
The entity will start serving immediately. #startDateTime in the request is ignored and will be set to the current time. Additionally, #startDateTimeType will be set to StartDateTimeType::USE_START_DATE_TIME. |
| ONE_HOUR_FROM_NOW |
The entity will start serving one hour from now. #startDateTime in the request is ignored and will be set to one hour from the current time. Additionally, #startDateTimeType will be set to StartDateTimeType::USE_START_DATE_TIME. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
The LiveStreamEvent streaming format.
Error reason for SwiffyConversionError.
Targeting dimension of targeting breakdowns.
Represents the types of team access supported for orders.
The reasons for the target error.
| Enumerator | |
|---|---|
| ENTITY_NOT_ON_USERS_TEAMS |
User cannot use this entity because it is not on any of the user's teams. |
| AD_UNITS_NOT_ON_ORDER_TEAMS |
The targeted or excluded ad unit must be on the order's teams. |
| PLACEMENTS_NOT_ON_ORDER_TEAMS |
The targeted placement must be on the order's teams. |
| MISSING_USERS_TEAM |
Entity cannot be created because it is not on any of the user's teams. |
| ALL_TEAM_ASSOCIATION_NOT_ALLOWED |
A team that gives access to all entities of a given type cannot be associated with an entity of that type. |
| INVALID_TEAM_ASSIGNMENT |
The assignment of team to entities is invalid. |
| ALL_TEAM_ACCESS_OVERRIDE_NOT_ALLOWED |
The all entities team access type cannot be overridden. |
| CANNOT_UPDATE_INACTIVE_TEAM |
Cannot modify or create a team with an inactive status. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
The reasons for the target error.
Possible options for third-party brand lift integration.
Possible options for third-party reach integration.
Possible options for third-party viewabitility integration.
Represent the possible time units for frequency capping.
| Enumerator | |
|---|---|
| MINUTE | |
| HOUR | |
| DAY | |
| WEEK | |
| MONTH | |
| LIFETIME | |
| POD |
Per pod of ads in a video stream. Only valid for entities in a EnvironmentType::VIDEO_PLAYER environment. |
| STREAM |
Per video stream. Only valid for entities in a EnvironmentType::VIDEO_PLAYER environment. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
Describes reasons for invalid timezone.
Enumerates all allowed time zones that can be used in reports. Note that some time zones are only compatible with specific fields.
Error reason types for TrafficForecastSegmentError.
| Enumerator | |
|---|---|
| CANNOT_UPDATE_TARGETING_AFTER_CREATION |
Segment targeting cannot be changed after segment creation. |
| TARGETING_NOT_UNIQUE |
The targeting expression that defines the segment is not unique within the given network's segments. The ID of the colliding segment will be provided in the ApiError::trigger. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
The type of transcode request rejection.
Indicates the type of unit used for defining a reservation. The CostType can differ from the UnitType
| Enumerator | |
|---|---|
| IMPRESSIONS |
The number of impressions served by creatives associated with the line item. Line items of all LineItemType support this
|
| CLICKS |
The number of clicks reported by creatives associated with the line item. The LineItem::lineItemType must be LineItemType::STANDARD, LineItemType::BULK or LineItemType::PRICE_PRIORITY. |
| CLICK_THROUGH_CPA_CONVERSIONS |
The number of click-through Cost-Per-Action (CPA) conversions from creatives associated with the line item. This is only supported as secondary goal and the LineItem::costType must be CostType::CPA. |
| VIEW_THROUGH_CPA_CONVERSIONS |
The number of view-through Cost-Per-Action (CPA) conversions from creatives associated with the line item. This is only supported as secondary goal and the LineItem::costType must be CostType::CPA. |
| TOTAL_CPA_CONVERSIONS |
The number of total Cost-Per-Action (CPA) conversions from creatives associated with the line item. This is only supported as secondary goal and the LineItem::costType must be CostType::CPA. |
| VIEWABLE_IMPRESSIONS |
The number of viewable impressions reported by creatives associated with the line item. The LineItem::lineItemType must be LineItemType::STANDARD. |
| IN_TARGET_IMPRESSIONS |
The number of in-target impressions reported by third party measurements. The LineItem::lineItemType must be LineItemType::STANDARD. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
Reasons for inventory url errors.
| Enumerator | |
|---|---|
| CANNOT_USE_RESERVED_URL |
The URL has been reserved, and not available for usage. |
| CANNOT_USE_GOOGLE_URL |
The URL belongs to Google, and not available for usage. |
| INVALID_URL |
The URL is invalid. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
ApiErrorReason enum for user domain targeting error.
Describes the variant playlist type that the profile represents.
The types of VAST ads that a VastRedirectCreative can point to.
| Enumerator | |
|---|---|
| LINEAR |
The VAST XML contains only
|
| NON_LINEAR |
The VAST XML contains only
|
| LINEAR_AND_NON_LINEAR |
The VAST XML contains both
|
Describes reasons for
| Enumerator | |
|---|---|
| MISSING_REQUIRED_FIELDS |
One or more required fields are not specified in the ad tag. |
| NO_LIVE_TRAFFIC |
Ad tag URL is not a live traffic URL. Url should start with: https://pubads.g.doubleclick.net/gampad/live/ads, not https://pubads.g.doubleclick.net/gampad/ads |
| NO_VOD_TRAFFIC |
Ad tag URL is not a VOD traffic URL. Url should start with: https://pubads.g.doubleclick.net/gampad/ads , not https://pubads.g.doubleclick.net/gampad/live/ads |
| INVALID_AD_TAG_HOST |
URL hostname is not a valid Google Publisher Tag or Freewheel Tag host name. |
| INVALID_SCHEME |
Only HTTPS is supported. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
Represents the options for targetable bumper positions, surrounding an ad pod, within a video stream. This includes before and after the supported ad pod positions, VideoPositionType::PREROLL, VideoPositionType::MIDROLL, and VideoPositionType::POSTROLL.
| Enumerator | |
|---|---|
| BEFORE |
Represents the bumper position before the ad pod. |
| AFTER |
Represents the bumper position after the ad pod. |
The reasons for the video position targeting error.
| Enumerator | |
|---|---|
| CANNOT_MIX_BUMPER_AND_NON_BUMPER_TARGETING |
Video position targeting cannot contain both bumper and non-bumper targeting values. |
| INVALID_BUMPER_TARGETING |
The bumper video position targeting is invalid. |
| CAN_ONLY_TARGET_CUSTOM_AD_SPOTS |
Only custom spot AdSpot objects can be targeted. |
| UNKNOWN |
The value returned if the actual value is not exposed by the requested API version. |
Represents a targetable position within a video.
1.8.5 
