PublisherQueryLanguageService (v202511)

    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.

    An example query text might be "select CountryCode, Name from Geo_Target" , where CountryCode and Name are columns of interest and Geo_Target is the table.

    The following tables are supported:

    Geo_Target

    Column Name
    Description
    Id
    Unique identifier for the Geo target
    Name
    The name of the Geo target
    CanonicalParentId
    The criteria ID of the direct parent that defines the canonical name of the geo target. For example, if the current geo target is "San Francisco", its canonical name would be "San Francisco, California, United States" thus the canonicalParentId would be the criteria ID of California and the canonicalParentId of California would be the criteria ID of United states
    ParentIds
    A comma separated list of criteria IDs of all parents of the geo target ordered by ascending size
    CountryCode
    Country code as defined by ISO 3166-1 alpha-2
    Type
    Allowable values:
    • Airport
    • Autonomous_Community
    • Canton
    • City
    • Congressional_District
    • Country
    • County
    • Department
    • DMA_Region
    • Governorate
    • Municipality
    • Neighborhood
    • Postal_Code
    • Prefecture
    • Province
    • Region
    • State
    • Territory
    • Tv_Region
    • Union_Territory
    Targetable
    Indicates whether geographical targeting is allowed

    Bandwidth_Group

    Column Name Description
    Id Unique identifier for the bandwidth group
    BandwidthName Name of the bandwidth group

    Browser

    Note: this table only contains browsers that are available in the Ad Manager UI targeting picker.

    Column Name Description
    Id Unique identifier for the browser
    BrowserName Name of the browser
    MajorVersion Major version of the browser
    MinorVersion Minor version of the browser

    Browser_Language

    Column Name Description
    Id Unique identifier for the browser language
    BrowserLanguageName Browser's language

    Device_Capability

    Column Name Description
    Id Unique identifier for the device capability
    DeviceCapabilityName Name of the device capability

    Device_Category

    Column Name Description
    Id Unique identifier for the device category
    DeviceCategoryName Name of the device category

    Device_Manufacturer

    Column Name Description
    Id Unique identifier for the device manufacturer
    MobileDeviceManufacturerName Name of the device manufacturer

    Mobile_Carrier

    Column Name Description
    Id Unique identifier for the mobile carrier
    CountryCode The country code of the mobile carrier
    MobileCarrierName Name of the mobile carrier

    Mobile_Device

    Column Name Description
    Id Unique identifier for the mobile device
    MobileDeviceManufacturerId Id of the device manufacturer
    MobileDeviceName Name of the mobile device

    Mobile_Device_Submodel

    Column Name Description
    Id Unique identifier for the mobile device submodel
    MobileDeviceId Id of the mobile device
    MobileDeviceSubmodelName Name of the mobile device submodel

    Operating_System

    Column Name Description
    Id Unique identifier for the operating system
    OperatingSystemName Name of the operating system

    Operating_System_Version

    Column Name Description
    Id Unique identifier for the operating system version
    OperatingSystemId Id of the operating system
    MajorVersion The operating system major version
    MinorVersion The operating system minor version
    MicroVersion The operating system micro version

    Third_Party_Company

    Column Name Description
    Id Unique identifier for the third party company
    Name The third party company name
    Type The third party company type
    Status The status of the third party company

    Line_Item

    Column name Type Description
    CostType
    		 Text The method used for billing this LineItem .
    CreationDateTime
    		 Datetime The date and time this LineItem was last created. This attribute may be null for LineItem s created before this feature was introduced.
    DeliveryRateType
    		 Text The strategy for delivering ads over the course of the LineItem 's duration. This attribute is optional and defaults to DeliveryRateType.EVENLY . Starting in v201306, it may default to DeliveryRateType.FRONTLOADED if specifically configured to on the network.
    ExternalId
    		 Text An identifier for the LineItem that is meaningful to the publisher.
    Id
    		 Number Uniquely identifies the LineItem . This attribute is read-only and is assigned by Google when a line item is created.
    IsMissingCreatives
    		 Boolean Indicates if a LineItem is missing any creatives for the creativePlaceholders specified.
    IsSetTopBoxEnabled
    		 Boolean Whether or not this line item is set-top box enabled.
    LastModifiedDateTime
    		 Datetime The date and time this LineItem was last modified.
    LatestNielsenInTargetRatioMilliPercent
    		 Number The most recently computed in-target ratio measured from Nielsen reporting data and the LineItem 's settings. It's provided in milli percent, or null if not applicable.
    LineItemType
    		 Text Indicates the line item type of a LineItem .
    Name
    		 Text The name of the LineItem .
    OrderId
    		 Number The ID of the Order to which the LineItem belongs.
    ServingEndTime
    		 Datetime The date and time on which the LineItem stops serving, inclusive of any grace period.
    StartDateTime
    		 Datetime The date and time on which the LineItem is enabled to begin serving.
    Status
    		 Text The status of the LineItem .
    Targeting
    		 Targeting The targeting criteria for the ad campaign.
    UnitsBought
    		 Number The total number of impressions or clicks that will be reserved for the LineItem . If the line item is of type LineItemType.SPONSORSHIP , then it represents the percentage of available impressions reserved.

    Ad_Unit

    Column name Type Description
    AdUnitCode
    		 Text A string used to uniquely identify the ad unit for the purposes of serving the ad. This attribute is read-only and is assigned by Google when an ad unit is created.
    ExternalSetTopBoxChannelId
    		 Text The channel ID for set-top box enabled ad units .
    Id
    		 Number Uniquely identifies the ad unit. This value is read-only and is assigned by Google when an ad unit is created.
    LastModifiedDateTime
    		 Datetime The date and time this ad unit was last modified.
    Name
    		 Text The name of the ad unit.
    ParentId
    		 Number The ID of the ad unit's parent. Every ad unit has a parent except for the root ad unit, which is created by Google.

    User

    Column name Type Description
    Email
    		 Text The email or login of the user.
    ExternalId
    		 Text An identifier for the user that is meaningful to the publisher.
    Id
    		 Number The unique ID of the user.
    IsServiceAccount
    		 Boolean True if this user is an OAuth2 service account user, false otherwise.
    Name
    		 Text The name of the user.
    RoleId
    		 Number The unique role ID of the user. Role objects that are created by Google will have negative IDs.
    RoleName
    		 Text The name of the Role assigned to the user.

    Programmatic_Buyer

    Column name Type Description
    BuyerAccountId
    		 Number The ID used by Authorized Buyers to bill the appropriate buyer network for a programmatic order.
    EnabledForPreferredDeals
    		 Boolean Whether the buyer is allowed to negotiate Preferred Deals.
    EnabledForProgrammaticGuaranteed
    		 Boolean Whether the buyer is enabled for Programmatic Guaranteed deals.
    IsAgency
    		 Boolean Whether the buyer is an advertising agency.
    Name
    		 Text Display name that references the buyer.
    ParentId
    		 Number The ID of the programmatic buyer's sponsor. If the programmatic buyer has no sponsor, this field will be -1.
    PartnerClientId
    		 Text ID used to represent Display & Video 360 client buyer partner ID (if Display & Video 360) or Authorized Buyers client buyer account ID.

    Audience_Segment_Category

    Column name Type Description
    Id
    		 Number The unique identifier for the audience segment category.
    Name
    		 Text The name of the audience segment category.
    ParentId
    		 Number The unique identifier of the audience segment category's parent.

    Audience_Segment

    Column name Type Description
    AdIdSize
    		 Number The number of AdID users in the segment.
    CategoryIds
    		 Set of number The ids of the categories that this audience segment belongs to.
    Id
    		 Number The unique identifier for the audience segment.
    IdfaSize
    		 Number The number of IDFA users in the segment.
    MobileWebSize
    		 Number The number of mobile web users in the segment.
    Name
    		 Text The name of the audience segment.
    OwnerAccountId
    		 Number The owner account id of the audience segment.
    OwnerName
    		 Text The owner name of the audience segment.
    PpidSize
    		 Number The number of PPID users in the segment.
    SegmentType
    		 Text The type of the audience segment.

    Time_Zone

    Column name Type Description
    Id
    		 Text The id of time zone in the form of America/New_York .
    StandardGmtOffset
    		 Text The standard GMT offset in current time in the form of GMT-05:00 for America/New_York , excluding the Daylight Saving Time.

    Proposal_Terms_And_Conditions

    Column name Type Description

    Change_History

    Restrictions: Only ordering by ChangeDateTime descending is supported. The IN operator is only supported on the entityType column. OFFSET is not supported. To page through results, filter on the earliest change Id as a continuation token. For example "WHERE Id < :id" . On each query, both an upper bound and a lower bound for the ChangeDateTime are required.
    Column name Type Description
    ChangeDateTime
    		 Datetime The date and time this change happened.
    EntityId
    		 Number The ID of the entity that was changed.
    EntityType
    		 Text The type of the entity that was changed.
    Id
    		 Text The ID of this change. IDs may only be used with "<" operator for paging and are subject to change. Do not store IDs. Note that the "<" here does not compare the value of the ID but the row in the change history table it represents.
    Operation
    		 Text The operation that was performed on this entity.
    UserId
    		 Number The ID of the user that made this change.

    ad_category

    Column name Type Description
    ChildIds
    		 Set of number Child IDs of an Ad category. Only general categories have children
    Id
    		 Number ID of an Ad category
    Name
    		 Text Localized name of an Ad category
    ParentId
    		 Number Parent ID of an Ad category. Only general categories have parents
    Type
    		 Text Type of an Ad category. Only general categories have children

    rich_media_ad_company

    The global set of rich media ad companies that are known to Google.
    Column name Type Description
    CompanyGvlId
    		 Number IAB Global Vendor List ID of a Rich Media Ad Company
    GdprStatus
    		 Text GDPR compliance status of a Rich Media Ad Company. Indicates whether the company has been registered with Google as a compliant company for GDPR.
    Id
    		 Number ID of a Rich Media Ad Company
    Name
    		 Text Name of a Rich Media Ad Company
    PolicyUrl
    		 Text Policy URL of a Rich Media Ad Company

    mcm_earnings

    Restriction: On each query, an expression scoping the MCM earnings to a single month is required (e.x. "WHERE month = '2020-01'" or "WHERE month IN ('2020-01')"). Bydefault, child publishers are ordered by their network code.
    Column name Type Description
    ChildName
    		 Text The name of the child publisher.
    ChildNetworkCode
    		 Text The network code of the child publisher.
    ChildPaymentCurrencyCode
    		 Text The child payment currency code as defined by ISO 4217.
    ChildPaymentMicros
    		 Number The portion of the total earnings paid to the child publisher in micro units of the ChildPaymentCurrencyCode
    DeductionsCurrencyCode
    		 Text The deductions currency code as defined by ISO 4217. Null for earnings prior to August 2020.
    DeductionsMicros
    		 Number The deductions for the month due to spam in micro units of the DeductionsCurrencyCode . Null for earnings prior to August 2020.
    DelegationType
    		 Text The current type of MCM delegation between the parent and child publisher.
    Month
    		 Date The year and month that the MCM earnings data applies to. The date will be specified as the first of the month.
    ParentName
    		 Text The name of the parent publisher.
    ParentNetworkCode
    		 Text The network code of the parent publisher.
    ParentPaymentCurrencyCode
    		 Text The parent payment currency code as defined by ISO 4217.
    ParentPaymentMicros
    		 Number The portion of the total earnings paid to the parent publisher in micro units of the ParentPaymentCurrencyCode .
    TotalEarningsCurrencyCode
    		 Text The total earnings currency code as defined by ISO 4217.
    TotalEarningsMicros
    		 Number The total earnings for the month in micro units of the TotalEarningsCurrencyCode .

    Linked_Device

    Column name Type Description
    Id
    		 Number The ID of the LinkedDevice
    Name
    		 Text The name of the LinkedDevice
    UserId
    		 Number The ID of the user that this device belongs to.
    Visibility
    		 Text The visibility of the LinkedDevice.

    child_publisher

    By default, child publishers are ordered by their ID.
    Column name Type Description
    AddressVerificationExpirationTime
    		 Datetime Date when the child publisher's address verification (mail PIN) will expire.
    AddressVerificationLastModifiedTime
    		 Datetime The time of the last change in the child publisher's address verification (mail PIN) process.
    AddressVerificationStatus
    		 Text The address verification (mail PIN) status of the child publisher's Ad Manager network. Possible values are {$code EXEMPT}, {$code EXPIRED}, {$code FAILED}, {$code PENDING}, {$code NOT_ELIGIBLE}, and {$code VERIFIED}.
    ApprovalStatus
    		 Text The approval status of the child publisher's Ad Manager network. Possible values are {$code APPROVED}, {$code CLOSED_BY_PUBLISHER}, {$code CLOSED_INVALID_ACTIVITY}, {$code CLOSED_POLICY_VIOLATION}, {$code DEACTIVATED_BY_AD_MANAGER}, {$code DISAPPROVED_DUPLICATE_ACCOUNT}, {$code DISAPPROVED_INELIGIBLE}, and {$code PENDING_GOOGLE_APPROVAL}.
    ApprovedManageAccountRevshareMillipercent
    		 Number The approved revshare with the MCM child publisher
    ChildNetworkAdExchangeEnabled
    		 Boolean Whether the child publisher's Ad Manager network has Ad Exchange enabled
    ChildNetworkCode
    		 Text The network code of the MCM child publisher
    DelegationType
    		 Text The delegation type of the MCM child publisher. This will be the approved type if the child has accepted the relationship, and the proposed type otherwise.
    Email
    		 Text The email of the MCM child publisher
    Id
    		 Number The ID of the MCM child publisher.
    IdentityVerificationLastModifiedTime
    		 Datetime The time of the last change in the child publisher's identity verification process.
    IdentityVerificationStatus
    		 Text Status of the child publisher's identity verification process. Possible values are {$code EXEMPT}, {$code EXPIRED}, {$code FAILED}, {$code PENDING}, {$code NOT_ELIGIBLE}, and {$code VERIFIED}.
    InvitationStatus
    		 Text Status of the parent's invitation request to a child publisher. Possible values are {$code ACCEPTED}, {$code EXPIRED}, {$code PENDING}, {$code REJECTED}, and {$code WITHDRAWN}.
    Name
    		 Text The name of the MCM child publisher
    OnboardingTasks
    		 Set of text The child publisher's pending onboarding tasks. This will only be populated if the child publisher's AccountStatus is PENDING_GOOGLE_APPROVAL .
    ReadinessStatus
    		 Text Overall onboarding readiness of the child publisher. Correlates with serving behavior, but does not include site-level approval information. Possible values are {$code READY}, {$code NOT_READY}, and {$code INACTIVE}.
    SellerId
    		 Text The child publisher's seller ID, as specified in the parent publisher's sellers.json file. This field is only relevant for Manage Inventory child publishers.

    content_label

    Column name Type Description
    Id
    		 Number The ID of the Content Label
    Label
    		 Text The name of the Content Label

    taxonomy_category

    Column name Type Description
    Production WSDL
    https://ads.google.com/apis/ads/publisher/v202511/PublisherQueryLanguageService?wsdl
    Namespace
    https://www.google.com/apis/ads/publisher/v202511
    Operations
    Errors

    select

    Retrieves rows of data that satisfy the given Statement.query from the system.

    Parameters

    Field Type Description
    selectStatement
    		Statement

    Response

    Field Type Description
    rval
    		ResultSet

    Errors

    Error
    Reasons
    AdUnitCodeError
    Lists the generic errors associated with AdUnit.adUnitCode .
    Enumerations
    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.
    AdUnitHierarchyError
    Caused by creating an AdUnit object with an invalid hierarchy.
    Enumerations
    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.
    ApiVersionError
    Errors related to the usage of API versions.
    Enumerations
    UPDATE_TO_NEWER_VERSION
    Indicates that the operation is not allowed in the version the request was made in.
    UNKNOWN
    The value returned if the actual value is not exposed by the requested API version.
    AudienceSegmentError
    Errors that could occur on audience segment related requests.
    Enumerations
    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.
    AuthenticationError
    An error for an exception that occurred when authenticating.
    Enumerations
    AMBIGUOUS_SOAP_REQUEST_HEADER
    The SOAP message contains a request header with an ambiguous definition of the authentication header fields. This means either the authToken and oAuthToken fields were both null or both were specified. Exactly one value should be specified with each request.
    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 authToken and optional networkCode .
    MISSING_AUTHENTICATION_HTTP_HEADER
    The HTTP request is missing a request header with an authToken
    MISSING_AUTHENTICATION
    The request is missing an authToken
    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 networkCode was found.
    NETWORK_CODE_REQUIRED
    The user has access to more than one network, but did not provide a networkCode .
    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.
    CollectionSizeError
    Error for the size of the collection being too large
    Enumerations
    TOO_LARGE
    UNKNOWN
    The value returned if the actual value is not exposed by the requested API version.
    CommonError
    A place for common errors that can be used across services.
    Enumerations
    NOT_FOUND
    Indicates that an attempt was made to retrieve an entity that does not exist.
    ALREADY_EXISTS
    Indicates that an attempt was made to create an entity that already exists.
    NOT_APPLICABLE
    Indicates that a value is not applicable for given use case.
    DUPLICATE_OBJECT
    Indicates that two elements in the collection were identical.
    CANNOT_UPDATE
    Indicates that an attempt was made to change an immutable field.
    UNSUPPORTED_OPERATION
    Indicates that the requested operation is not supported.
    CONCURRENT_MODIFICATION
    Indicates that another request attempted to update the same data in the same network at about the same time. Please wait and try the request again.
    REQUEST_TOO_LARGE
    Indicates that the request is too large to be processed.

    This error is thrown when internal system limits are exceeded due to the number of affected entities implied by the input parameters. Clients should reduce the number of affected entities and try again.

    UNKNOWN
    The value returned if the actual value is not exposed by the requested API version.
    CreativeError
    Lists all errors associated with creatives.
    Enumerations
    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.
    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.
    INVALID_COMPANY_TYPE
    Company type should be one of Advertisers, House Advertisers and Ad Networks.
    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_REMOVE_PLACEMENT_IDS
    Cannot remove placement IDs from a creative that is associated with a direct supply path line item.
    UNKNOWN
    The value returned if the actual value is not exposed by the requested API version.
    DealError
    Errors associated with creating or updating programmatic proposals .
    Enumerations
    CANNOT_ADD_LINE_ITEM_WHEN_SOLD
    Cannot add new proposal line items to a Proposal when Proposal.isSold is true .
    CANNOT_ARCHIVE_LINE_ITEM_WHEN_SOLD
    Cannot archive proposal line items from a Proposal when Proposal.isSold is true .
    CANNOT_ARCHIVE_PROPOSAL_WHEN_SOLD
    Cannot archive a Proposal when Proposal.isSold is true .
    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.
    ExchangeRateError
    Lists all errors associated with ExchangeRate objects.
    Enumerations
    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.
    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.
    Enumerations
    MISSING_FEATURE
    A feature is being used that is not enabled on the current network.
    UNKNOWN
    The value returned if the actual value is not exposed by the requested API version.
    FileError
    A list of all errors to be used for problems related to files.
    Enumerations
    MISSING_CONTENTS
    The provided byte array is empty.
    SIZE_TOO_LARGE
    The provided file is larger than the maximum size defined for the network.
    UNKNOWN
    The value returned if the actual value is not exposed by the requested API version.
    InternalApiError
    Indicates that a server-side error has occured. InternalApiError s are generally not the result of an invalid request or message sent by the client.
    Enumerations
    UNEXPECTED_INTERNAL_API_ERROR
    API encountered an unexpected internal error.
    TRANSIENT_ERROR
    A temporary error occurred during the request. Please retry.
    UNKNOWN
    The cause of the error is not known or only defined in newer versions.
    DOWNTIME
    The API is currently unavailable for a planned downtime.
    ERROR_GENERATING_RESPONSE
    Mutate succeeded but server was unable to build response. Client should not retry mutate.
    InvalidEmailError
    Caused by supplying a value for an email attribute that is not a valid email address.
    Enumerations
    INVALID_FORMAT
    The value is not a valid email address.
    UNKNOWN
    The value returned if the actual value is not exposed by the requested API version.
    InvalidUrlError
    Lists all errors associated with URLs.
    Enumerations
    ILLEGAL_CHARACTERS
    The URL contains invalid characters.
    INVALID_FORMAT
    The format of the URL is not allowed. This could occur for a number of reasons. For example, if an invalid scheme is specified (like "ftp://") or if a port is specified when not required, or if a query was specified when not required.
    INSECURE_SCHEME
    URL contains insecure scheme.
    NO_SCHEME
    The URL does not contain a scheme.
    UNKNOWN
    The value returned if the actual value is not exposed by the requested API version.
    InventoryTargetingError
    Lists all inventory errors caused by associating a line item with a targeting expression.
    Enumerations
    AT_LEAST_ONE_PLACEMENT_OR_INVENTORY_UNIT_REQUIRED
    At least one placement or inventory unit is required
    INVENTORY_CANNOT_BE_TARGETED_AND_EXCLUDED
    The same inventory unit or placement cannot be targeted and excluded at the same time
    INVENTORY_UNIT_CANNOT_BE_TARGETED_IF_ANCESTOR_IS_TARGETED
    A child inventory unit cannot be targeted if its ancestor inventory unit is also targeted.
    INVENTORY_UNIT_CANNOT_BE_TARGETED_IF_ANCESTOR_IS_EXCLUDED
    A child inventory unit cannot be targeted if its ancestor inventory unit is excluded.
    INVENTORY_UNIT_CANNOT_BE_EXCLUDED_IF_ANCESTOR_IS_EXCLUDED
    A child inventory unit cannot be excluded if its ancestor inventory unit is also excluded.
    EXPLICITLY_TARGETED_INVENTORY_UNIT_CANNOT_BE_TARGETED
    An explicitly targeted inventory unit cannot be targeted.
    EXPLICITLY_TARGETED_INVENTORY_UNIT_CANNOT_BE_EXCLUDED
    An explicitly targeted inventory unit cannot be excluded.
    SELF_ONLY_INVENTORY_UNIT_NOT_ALLOWED
    A landing page-only ad unit cannot be targeted.
    SELF_ONLY_INVENTORY_UNIT_WITHOUT_DESCENDANTS
    A landing page-only ad unit cannot be targeted if it doesn't have any children.
    YOUTUBE_AUDIENCE_SEGMENTS_CAN_ONLY_BE_TARGETED_WITH_YOUTUBE_SHARED_INVENTORY
    Audience segments shared from YouTube can only be targeted with inventory shared from YouTube for cross selling.
    UNKNOWN
    The value returned if the actual value is not exposed by the requested API version.
    InventoryUnitError
    Lists the generic errors associated with AdUnit objects.
    Enumerations
    EXPLICIT_TARGETING_NOT_ALLOWED
    AdUnit.explicitlyTargeted can be set to true only in an Ad Manager 360 account.
    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.
    LineItemFlightDateError
    Lists all errors associated with LineItem start and end dates.
    Enumerations
    START_DATE_TIME_IS_IN_PAST
    END_DATE_TIME_IS_IN_PAST
    END_DATE_TIME_NOT_AFTER_START_TIME
    END_DATE_TIME_TOO_LATE
    UNKNOWN
    The value returned if the actual value is not exposed by the requested API version.
    LineItemOperationError
    Lists all errors for executing operations on line items
    Enumerations
    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 ACTIVE or ON_HOLD .
    CANNOT_ACTIVATE_INVALID_COMPANY_CREDIT_STATUS
    Cannot activate line item because the LineItem.advertiserId it is associated with has Company.creditStatus that is not ACTIVE , INACTIVE , or ON_HOLD .
    UNKNOWN
    The value returned if the actual value is not exposed by the requested API version.
    NotNullError
    Caused by supplying a null value for an attribute that cannot be null.
    Enumerations
    ARG1_NULL
    Assuming that a method will not have more than 3 arguments, if it does, return NULL
    ARG2_NULL
    ARG3_NULL
    NULL
    UNKNOWN
    The value returned if the actual value is not exposed by the requested API version.
    NullError
    Caused by supplying a non-null value for an attribute that should be null.
    Enumerations
    NOT_NULL
    UNKNOWN
    The value returned if the actual value is not exposed by the requested API version.
    OrderActionError
    Lists all errors associated with performing actions on Order objects.
    Enumerations
    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 LineItem s 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.
    CANNOT_UPDATE_ORDER_OVER_LINE_ITEM_LIMIT
    Cannot update an Order because it has more than the allowed number of LineItem s.
    UNKNOWN
    The value returned if the actual value is not exposed by the requested API version.
    OrderError
    Lists all errors associated with orders.
    Enumerations
    UPDATE_CANCELED_ORDER_NOT_ALLOWED
    Updating a canceled order is not allowed.
    UPDATE_PENDING_APPROVAL_ORDER_NOT_ALLOWED
    Updating an order that has its approval pending is not allowed.
    UPDATE_ARCHIVED_ORDER_NOT_ALLOWED
    Updating an archived order is not allowed.
    CANNOT_MODIFY_PROPOSAL_ID
    DSM can set the proposal ID only at the time of creation of order. Setting or changing proposal ID at the time of order update is not allowed.
    PRIMARY_USER_REQUIRED
    Cannot have secondary user without a primary user.
    PRIMARY_USER_CANNOT_BE_SECONDARY
    Primary user cannot be added as a secondary user too.
    ORDER_TEAM_NOT_ASSOCIATED_WITH_ADVERTISER
    A team associated with the order must also be associated with the advertiser.
    USER_NOT_ON_ORDERS_TEAMS
    The user assigned to the order, like salesperson or trafficker, must be on one of the order's teams.
    AGENCY_NOT_ON_ORDERS_TEAMS
    The agency assigned to the order must belong to one of the order's teams.
    INVALID_FIELDS_SET_FOR_NON_PROGRAMMATIC_ORDER
    Programmatic info fields should not be set for a non-programmatic order.
    UNKNOWN
    The value returned if the actual value is not exposed by the requested API version.
    ParseError
    Lists errors related to parsing.
    Enumerations
    UNPARSABLE
    Indicates an error in parsing an attribute.
    UNKNOWN
    The value returned if the actual value is not exposed by the requested API version.
    PermissionError
    Errors related to incorrect permission.
    Enumerations
    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.
    PublisherQueryLanguageContextError
    An error that occurs while executing a PQL query contained in a Statement object.
    Enumerations
    UNEXECUTABLE
    Indicates that there was an error executing the PQL.
    UNKNOWN
    The value returned if the actual value is not exposed by the requested API version.
    PublisherQueryLanguageSyntaxError
    An error that occurs while parsing a PQL query contained in a Statement object.
    Enumerations
    UNPARSABLE
    Indicates that there was a PQL syntax error.
    UNKNOWN
    The value returned if the actual value is not exposed by the requested API version.
    QuotaError
    Describes a client-side error on which a user is attempting to perform an action to which they have no quota remaining.
    Enumerations
    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.

    SEGMENT_POPULATION_LIMIT
    This network has exceeded the allowed number of identifiers uploaded within a 24 hour period. The recommended approach to handle this error is to wait 30 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.
    RangeError
    A list of all errors associated with the Range constraint.
    Enumerations
    TOO_HIGH
    TOO_LOW
    UNKNOWN
    The value returned if the actual value is not exposed by the requested API version.
    RegExError
    Caused by supplying a value for an object attribute that does not conform to a documented valid regular expression.
    Enumerations
    INVALID
    Invalid value found.
    NULL
    Null value found.
    UNKNOWN
    The value returned if the actual value is not exposed by the requested API version.
    RequiredCollectionError
    A list of all errors to be used for validating sizes of collections.
    Enumerations
    REQUIRED
    A required collection is missing.
    TOO_LARGE
    Collection size is too large.
    TOO_SMALL
    Collection size is too small.
    UNKNOWN
    The value returned if the actual value is not exposed by the requested API version.
    RequiredError
    Errors due to missing required field.
    Enumerations
    REQUIRED
    Missing required field.
    RequiredNumberError
    A list of all errors to be used in conjunction with required number validators.
    Enumerations
    REQUIRED
    TOO_LARGE
    TOO_SMALL
    TOO_LARGE_WITH_DETAILS
    TOO_SMALL_WITH_DETAILS
    UNKNOWN
    The value returned if the actual value is not exposed by the requested API version.
    RequiredSizeError
    A list of all errors to be used for validating Size .
    Enumerations
    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.
    ReservationDetailsError
    Lists all errors associated with LineItem's reservation details.
    Enumerations
    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.
    CPA_DEPRECATED
    CPA LineItem s can't have end dates older than February 22, 2024.
    UNKNOWN
    The value returned if the actual value is not exposed by the requested API version.
    ServerError
    Errors related to the server.
    Enumerations
    SERVER_ERROR
    Indicates that an unexpected error occured.
    SERVER_BUSY
    Indicates that the server is currently experiencing a high load. Please wait and try your request again.
    UNKNOWN
    The value returned if the actual value is not exposed by the requested API version.
    StatementError
    An error that occurs while parsing Statement objects.
    Enumerations
    VARIABLE_NOT_BOUND_TO_VALUE
    A bind variable has not been bound to a value.
    UNKNOWN
    The value returned if the actual value is not exposed by the requested API version.
    StringFormatError
    A list of error code for reporting invalid content of input strings.
    Enumerations
    UNKNOWN
    ILLEGAL_CHARS
    The input string value contains disallowed characters.
    INVALID_FORMAT
    The input string value is invalid for the associated field.
    StringLengthError
    Errors for Strings which do not meet given length constraints.
    Enumerations
    TOO_LONG
    TOO_SHORT
    UNKNOWN
    The value returned if the actual value is not exposed by the requested API version.
    TypeError
    An error for a field which is an invalid type.
    UniqueError
    An error for a field which must satisfy a uniqueness constraint
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: