NetworkService (v202508)

    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.

    Production WSDL
    https://ads.google.com/apis/ads/publisher/v202508/NetworkService?wsdl
    Namespace
    https://www.google.com/apis/ads/publisher/v202508
    Operations
    Errors

    getAllNetworks

    Returns the list of Network objects to which the current login has access.

    Intended to be used without a network code in the SOAP header when the login may have more than one network associated with it.

    Parameters

    Field Type Description

    Response

    Field Type Description
    rval
    		Network []

    getCurrentNetwork

    Returns the current network for which requests are being made.

    Parameters

    Field Type Description

    Response

    Field Type Description
    rval
    		Network

    getDefaultThirdPartyDataDeclaration

    Returns the default ThirdPartyDataDeclaration for this network. If this setting has never been updated on your network, then this API response will be empty.

    Parameters

    Field Type Description

    Response

    Field Type Description
    rval
    		ThirdPartyDataDeclaration

    makeTestNetwork

    Creates a new blank network for testing purposes using the current login.

    Each login(i.e. email address) can only have one test network. Data from any of your existing networks will not be transferred to the new test network. Once the test network is created, the test network can be used in the API by supplying the Network.networkCode in the SOAP header or by logging into the Ad Manager UI.

    Test networks are limited in the following ways:

    • Test networks cannot serve ads.
    • Because test networks cannot serve ads, reports will always come back without data.
    • Since forecasting requires serving history, forecast service results will be faked. See ForecastService for more info.
    • Test networks are, by default, Ad Manager networks and don't have any features from Ad Manager 360. To have additional features turned on, please contact your account manager.
    • Test networks are limited to 10,000 objects per entity type.

    Parameters

    Field Type Description

    Response

    Field Type Description
    rval
    		Network

    updateNetwork

    Updates the specified network. Currently, only the network display name can be updated.

    Parameters

    Field Type Description
    network
    		Network

    Response

    Field Type Description
    rval
    		Network

    Errors

    Error
    Reasons
    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.
    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.
    UNKNOWN
    The value returned if the actual value is not exposed by the requested API version.
    ExchangeSignupApiError
    ApiError for exceptions thrown by ExchangeSignupService.
    Enumerations
    ADSENSE_ACCOUNT_CREATION_ERROR
    ADSENSE_ACCOUNT_ALREADY_HAS_EXCHANGE
    FAILED_TO_ADD_WEBSITE_TO_PROPERTY
    FAILED_TO_CREATE_LINK_FOR_NEW_ACCOUNT
    CANNOT_CREATE_NEW_ACCOUNT_FOR_MAPPED_CUSTOMER
    FAILED_TO_CREATE_EXCHANGE_SETTINGS
    DUPLICATE_PRODUCT_TYPE
    INVALID_SIGNUP_PRODUCT
    UNKNOWN_PRODUCT
    BAD_SITE_VERIFICATION_UPDATE_REQUEST
    NO_EXCHANGE_ACCOUNT
    SINGLE_SYNDICATION_PRODUCT
    ACCOUNT_NOT_YET_READY
    MULTIPLE_ADSENSE_ACCOUNTS_NOT_ALLOWED
    MISSING_LEGAL_ENTITY_NAME
    MISSING_ACTIVE_BILLING_PROFILE
    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.
    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.
    InventoryClientApiError
    ApiError for common exceptions thrown when accessing AdSense InventoryClient.
    Enumerations
    ACCESS_DENIED
    ADSENSE_AUTH_ERROR
    ADSENSE_RPC_ERROR
    DOMAIN_NO_SCHEME
    DOMAIN_INVALID_HOST
    DOMAIN_INVALID_TLD
    DOMAIN_ONE_STRING_AND_PUBLIC_SUFFIX
    DOMAIN_INVALID_INPUT
    DOMAIN_NO_PUBLIC_SUFFIX
    UNKNOWN_ERROR
    LiveStreamEventSlateError
    Lists all errors associated with LiveStreamEvent slate creative id.
    Enumerations
    INVALID_SLATE_CREATIVE_ID
    The slate creative ID does not correspond to a slate creative.
    LIVE_STREAM_EVENT_SLATE_CREATIVE_ID_REQUIRED
    The required field live stream event slate is not set.

    There must either be a slate creative ID assigned to the live stream event or a valid network level slate selected.

    MISSING_SOURCE_FOR_SLATE
    The slate does not have a videoSourceUrl or assetSourcePath.
    INVALID_SLATE_TYPE
    The slate is of an invalid type.
    CANNOT_CHANGE_SLATE_VIDEO_SOURCE_URL
    The slate video source url cannot change.
    UNKNOWN
    The value returned if the actual value is not exposed by the requested API version.
    McmError
    An error for multiple customer management.
    Enumerations
    UNKNOWN
    The value returned if the actual value is not exposed by the requested API version.
    REVENUE_SHARE_PERCENT_OUTSIDE_RANGE
    An MCM parent revenue share must be between 0 to 100_000L in millis.
    RESELLER_PARENT_REVENUE_SHARE_IS_NOT_100_PERCENT
    An MCM reseller parent revenue share must be 100_000L in millis.
    MI_PARENT_REVENUE_SHARE_IS_NOT_100_PERCENT
    An MCM Manage Inventory parent revenue share must be 100_000L in millis.
    DUPLICATE_CHILD_PUBLISHER_NETWORK_CODE
    The network code is used by another child publisher.
    DUPLICATE_CHILD_PUBLISHER_ACTIVE_EMAIL
    The email is used by another active child publisher.
    CHILD_NETWORK_DISAPPROVED
    The MCM child network has been disapproved by Google.
    MANAGE_INVENTORY_UNSUPPORTED_IN_RESELLER_NETWORK
    Manage inventory is not supported in reseller network.
    CANNOT_SEND_INVITATION_TO_MCM_PARENT
    Cannot send MCM invitation to a MCM parent.
    CANNOT_SEND_INVITATION_TO_NETWORK_WITH_RESELLER_PARENT
    A non-reseller MCM parent cannot send invitation to child which has another reseller parent.
    CANNOT_SEND_INVITATION_TO_SELF
    Cannot send MCM invitation to self.
    CANNOT_CLOSE_MCM_WITH_ACTIVE_CHILDREN
    An MCM parent network cannot be disabled as parent with active children.
    CANNOT_TURN_CHILD_INTO_PARENT_WITH_ACTIVE_INVITATION
    Cannot turn on MCM feature flag on a MCM Child network with active invitations.
    MISSING_NETWORK_EXCHANGE_ACCOUNT
    An Ad Exchange account is required for an MCM parent network.
    OPERATION_UNSUPPORTED_INITIAL_STATUS
    MCM operation is not allowed for initial status.
    NetworkError
    An error for a network.
    Enumerations
    UNKNOWN
    The value returned if the actual value is not exposed by the requested API version.
    MULTI_CURRENCY_NOT_SUPPORTED
    Multi-currency support is not enabled for this network. This is an Ad Manager 360 feature.
    UNSUPPORTED_CURRENCY
    Currency provided is not supported.
    NETWORK_CURRENCY_CANNOT_BE_SAME_AS_SECONDARY
    The network currency cannot also be specified as a secondary currency.
    DEPRECATED_DATA_TRANSFER_CONFIG_EVENT_TYPE
    The data transfer config cannot have a deprecated event type.
    DELEGATION_CHILD_NETWORK_CANNOT_BECOME_A_PARENT
    An MCM child network cannot become a parent network.
    DELEGATION_PARENT_NETWORK_CANNOT_BECOME_A_CHILD
    An MCM parent network cannot become a child of another network.
    CANNOT_ADD_SAME_NETWORK_AS_DELEGATION_CHILD
    In MCM, a network cannot become a parent of itself.
    MAX_APPROVED_DELEGATION_CHILD_NETWORKS_EXCEEDED
    The MCM parent network has exceeded the system limit of child networks.
    MAX_PENDING_DELEGATION_CHILD_NETWORKS_EXCEEDED
    The MCM parent network has exceeded the system limit of child networks pending approval.
    CHILD_NETWORK_ALREADY_EXISTS
    The network is already being managed by the parent network for MCM.
    CHILD_NETWORK_CANNOT_BE_DISAPPROVED
    A child network must not be disapproved.
    IN_PARENT_DELEGATION_UNSUPPORTED_FOR_NETWORK
    Only Ad Manager 360 networks are allowed to manage the inventory of other networks.
    ERROR_REENABLING_AD_EXCHANGE_ON_MCM_CHILD
    When an MCM child network self-signsup for ad exchange but disconnects from the parent, then tries to re-enable again, this indicates that there was an error in re-enabling ad exchange.
    ERROR_SETTING_SITE_SERVING_MODE_ON_MCM_CHILD
    The error shown when there is an issue setting the approved site serving field when re-enabling or disabling ad exchange on an MCM child.
    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.
    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.
    PrecisionError
    List all errors associated with number precisions.
    Enumerations
    WRONG_PRECISION
    The lowest N digits of the number must be zero.
    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.
    RequestError
    Encapsulates the generic errors thrown when there's an error with user request.
    Enumerations
    UNKNOWN
    Error reason is unknown.
    INVALID_INPUT
    Invalid input.
    UNSUPPORTED_VERSION
    The api version in the request has been discontinued. Please update to the new AdWords 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.
    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.
    SetTopBoxCreativeError
    Errors associated with set-top box creatives .
    Enumerations
    EXTERNAL_ASSET_ID_IMMUTABLE
    Set-top box creative external asset IDs are immutable after creation.
    EXTERNAL_ASSET_ID_REQUIRED
    Set-top box creatives require an external asset ID.
    PROVIDER_ID_IMMUTABLE
    Set-top box creative provider IDs are immutable after creation.
    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
    UrlError
    Common errors for URLs.
    Enumerations
    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.
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: