Web Service: NetworkService

Port type NetworkServiceInterfaceSource code

1. getAllNetworks
   Source code
   Description:
   Returns the list of {@link 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.

   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   getAllNetworksRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type getAllNetworks

   Returns the list of {@link 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.
   Output:
   getAllNetworksResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type getAllNetworksResponse

   • rval - optional, unbounded; type Network
     {@code Network} represents a network.
     • id - optional; type long
       The unique ID of the {@code Network}. This value is readonly and is assigned by Google.
     • displayName - optional; type string
       The display name of the network.
     • networkCode - optional; type string
       The network code. If the current login has access to multiple networks, then the network code must be provided in the SOAP request headers for all requests. Otherwise, it is optional to provide the network code in the SOAP headers. This field is read-only.
     • propertyCode - optional; type string
       The property code. This field is read-only.
     • timeZone - optional; type string
       The time zone associated with the delivery of orders and reporting. This field is read-only.
     • currencyCode - optional; type string
       The primary currency code. This field is read-only.
     • secondaryCurrencyCodes - optional, unbounded; type string
       Currencies that can be used as an alternative to the {@link Network#currencyCode} for trafficking {@link LineItem line items}.
     • effectiveRootAdUnitId - optional; type string
       The {@link AdUnit#id} of the top most ad unit to which descendant ad units can be added. Should be used for the {@link AdUnit#parentId} when first building inventory hierarchy. This field is read-only.
     • isTest - optional; type boolean
       Whether this is a test network. This field is read-only.
   Fault:
   ApiException (wsdlsoap:fault, use = literal)Source code
   ApiException type ApiExceptionFault

   Exception class for holding a list of service errors.

   Base class for exceptions.

   • message - optional; type string
     Error message.

   • errors - optional, unbounded; type ApiError
     The API error base class that provides details about an error that occurred while processing a service request.

     The OGNL field path is provided for parsers to identify the request data element that may have caused the error.

     • fieldPath - optional; type string
       The OGNL field path to identify cause of error.
     • fieldPathElements - optional, unbounded; type FieldPathElement
       A parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.
       A segment of a field path. Each dot in a field path defines a new segment.
       • field - optional; type string
         The name of a field in lower camelcase. (e.g. "biddingStrategy")
       • index - optional; type int
         For list fields, this is a 0-indexed position in the list. Null for non-list fields.
     • trigger - optional; type string
       The data that caused the error.
     • errorString - optional; type string
       A simple string representation of the error and reason.
     List of errors.

   A fault element of type ApiException.
2. getCurrentNetwork
   Source code
   Description:
   Returns the current network for which requests are being made.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   getCurrentNetworkRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type getCurrentNetwork

   Returns the current network for which requests are being made.
   Output:
   getCurrentNetworkResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type getCurrentNetworkResponse

   • rval - optional; type Network
     {@code Network} represents a network.
     • id - optional; type long
       The unique ID of the {@code Network}. This value is readonly and is assigned by Google.
     • displayName - optional; type string
       The display name of the network.
     • networkCode - optional; type string
       The network code. If the current login has access to multiple networks, then the network code must be provided in the SOAP request headers for all requests. Otherwise, it is optional to provide the network code in the SOAP headers. This field is read-only.
     • propertyCode - optional; type string
       The property code. This field is read-only.
     • timeZone - optional; type string
       The time zone associated with the delivery of orders and reporting. This field is read-only.
     • currencyCode - optional; type string
       The primary currency code. This field is read-only.
     • secondaryCurrencyCodes - optional, unbounded; type string
       Currencies that can be used as an alternative to the {@link Network#currencyCode} for trafficking {@link LineItem line items}.
     • effectiveRootAdUnitId - optional; type string
       The {@link AdUnit#id} of the top most ad unit to which descendant ad units can be added. Should be used for the {@link AdUnit#parentId} when first building inventory hierarchy. This field is read-only.
     • isTest - optional; type boolean
       Whether this is a test network. This field is read-only.
   Fault:
   ApiException (wsdlsoap:fault, use = literal)Source code
   ApiException type ApiExceptionFault

   Exception class for holding a list of service errors.

   Base class for exceptions.

   • message - optional; type string
     Error message.

   • errors - optional, unbounded; type ApiError
     The API error base class that provides details about an error that occurred while processing a service request.

     The OGNL field path is provided for parsers to identify the request data element that may have caused the error.

     • fieldPath - optional; type string
       The OGNL field path to identify cause of error.
     • fieldPathElements - optional, unbounded; type FieldPathElement
       A parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.
       A segment of a field path. Each dot in a field path defines a new segment.
       • field - optional; type string
         The name of a field in lower camelcase. (e.g. "biddingStrategy")
       • index - optional; type int
         For list fields, this is a 0-indexed position in the list. Null for non-list fields.
     • trigger - optional; type string
       The data that caused the error.
     • errorString - optional; type string
       A simple string representation of the error and reason.
     List of errors.

   A fault element of type ApiException.
3. getDefaultThirdPartyDataDeclaration
   Source code
   Description:
   Returns the default {@link ThirdPartyDataDeclaration} for this network. If this setting has never been updated on your network, then this API response will be empty.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   getDefaultThirdPartyDataDeclarationRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type getDefaultThirdPartyDataDeclaration

   Returns the default {@link ThirdPartyDataDeclaration} for this network. If this setting has never been updated on your network, then this API response will be empty.
   Output:
   getDefaultThirdPartyDataDeclarationResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type getDefaultThirdPartyDataDeclarationResponse

   • rval - optional; type ThirdPartyDataDeclaration
     Represents a set of declarations about what (if any) third party companies are associated with a given creative.

     This can be set at the network level, as a default for all creatives, or overridden for a particular creative.

     • declarationType - optional; type DeclarationType - type string with restriction - enum { 'NONE', 'DECLARED', 'UNKNOWN' }
     • thirdPartyCompanyIds - optional, unbounded; type long
   Fault:
   ApiException (wsdlsoap:fault, use = literal)Source code
   ApiException type ApiExceptionFault

   Exception class for holding a list of service errors.

   Base class for exceptions.

   • message - optional; type string
     Error message.

   • errors - optional, unbounded; type ApiError
     The API error base class that provides details about an error that occurred while processing a service request.

     The OGNL field path is provided for parsers to identify the request data element that may have caused the error.

     • fieldPath - optional; type string
       The OGNL field path to identify cause of error.
     • fieldPathElements - optional, unbounded; type FieldPathElement
       A parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.
       A segment of a field path. Each dot in a field path defines a new segment.
       • field - optional; type string
         The name of a field in lower camelcase. (e.g. "biddingStrategy")
       • index - optional; type int
         For list fields, this is a 0-indexed position in the list. Null for non-list fields.
     • trigger - optional; type string
       The data that caused the error.
     • errorString - optional; type string
       A simple string representation of the error and reason.
     List of errors.

   A fault element of type ApiException.
4. makeTestNetwork
   Source code
   Description:
   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 {@link 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 {@link 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.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   makeTestNetworkRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type 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 {@link 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 {@link 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.
   Output:
   makeTestNetworkResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type makeTestNetworkResponse

   • rval - optional; type Network
     {@code Network} represents a network.
     • id - optional; type long
       The unique ID of the {@code Network}. This value is readonly and is assigned by Google.
     • displayName - optional; type string
       The display name of the network.
     • networkCode - optional; type string
       The network code. If the current login has access to multiple networks, then the network code must be provided in the SOAP request headers for all requests. Otherwise, it is optional to provide the network code in the SOAP headers. This field is read-only.
     • propertyCode - optional; type string
       The property code. This field is read-only.
     • timeZone - optional; type string
       The time zone associated with the delivery of orders and reporting. This field is read-only.
     • currencyCode - optional; type string
       The primary currency code. This field is read-only.
     • secondaryCurrencyCodes - optional, unbounded; type string
       Currencies that can be used as an alternative to the {@link Network#currencyCode} for trafficking {@link LineItem line items}.
     • effectiveRootAdUnitId - optional; type string
       The {@link AdUnit#id} of the top most ad unit to which descendant ad units can be added. Should be used for the {@link AdUnit#parentId} when first building inventory hierarchy. This field is read-only.
     • isTest - optional; type boolean
       Whether this is a test network. This field is read-only.
   Fault:
   ApiException (wsdlsoap:fault, use = literal)Source code
   ApiException type ApiExceptionFault

   Exception class for holding a list of service errors.

   Base class for exceptions.

   • message - optional; type string
     Error message.

   • errors - optional, unbounded; type ApiError
     The API error base class that provides details about an error that occurred while processing a service request.

     The OGNL field path is provided for parsers to identify the request data element that may have caused the error.

     • fieldPath - optional; type string
       The OGNL field path to identify cause of error.
     • fieldPathElements - optional, unbounded; type FieldPathElement
       A parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.
       A segment of a field path. Each dot in a field path defines a new segment.
       • field - optional; type string
         The name of a field in lower camelcase. (e.g. "biddingStrategy")
       • index - optional; type int
         For list fields, this is a 0-indexed position in the list. Null for non-list fields.
     • trigger - optional; type string
       The data that caused the error.
     • errorString - optional; type string
       A simple string representation of the error and reason.
     List of errors.

   A fault element of type ApiException.
5. updateNetwork
   Source code
   Description:
   Updates the specified network. Currently, only the network display name can be updated.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   updateNetworkRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type updateNetwork

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

   • network - optional; type Network
     {@code Network} represents a network.
     • id - optional; type long
       The unique ID of the {@code Network}. This value is readonly and is assigned by Google.
     • displayName - optional; type string
       The display name of the network.
     • networkCode - optional; type string
       The network code. If the current login has access to multiple networks, then the network code must be provided in the SOAP request headers for all requests. Otherwise, it is optional to provide the network code in the SOAP headers. This field is read-only.
     • propertyCode - optional; type string
       The property code. This field is read-only.
     • timeZone - optional; type string
       The time zone associated with the delivery of orders and reporting. This field is read-only.
     • currencyCode - optional; type string
       The primary currency code. This field is read-only.
     • secondaryCurrencyCodes - optional, unbounded; type string
       Currencies that can be used as an alternative to the {@link Network#currencyCode} for trafficking {@link LineItem line items}.
     • effectiveRootAdUnitId - optional; type string
       The {@link AdUnit#id} of the top most ad unit to which descendant ad units can be added. Should be used for the {@link AdUnit#parentId} when first building inventory hierarchy. This field is read-only.
     • isTest - optional; type boolean
       Whether this is a test network. This field is read-only.
   Output:
   updateNetworkResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type updateNetworkResponse

   • rval - optional; type Network
     {@code Network} represents a network.
     • id - optional; type long
       The unique ID of the {@code Network}. This value is readonly and is assigned by Google.
     • displayName - optional; type string
       The display name of the network.
     • networkCode - optional; type string
       The network code. If the current login has access to multiple networks, then the network code must be provided in the SOAP request headers for all requests. Otherwise, it is optional to provide the network code in the SOAP headers. This field is read-only.
     • propertyCode - optional; type string
       The property code. This field is read-only.
     • timeZone - optional; type string
       The time zone associated with the delivery of orders and reporting. This field is read-only.
     • currencyCode - optional; type string
       The primary currency code. This field is read-only.
     • secondaryCurrencyCodes - optional, unbounded; type string
       Currencies that can be used as an alternative to the {@link Network#currencyCode} for trafficking {@link LineItem line items}.
     • effectiveRootAdUnitId - optional; type string
       The {@link AdUnit#id} of the top most ad unit to which descendant ad units can be added. Should be used for the {@link AdUnit#parentId} when first building inventory hierarchy. This field is read-only.
     • isTest - optional; type boolean
       Whether this is a test network. This field is read-only.
   Fault:
   ApiException (wsdlsoap:fault, use = literal)Source code
   ApiException type ApiExceptionFault

   Exception class for holding a list of service errors.

   Base class for exceptions.

   • message - optional; type string
     Error message.

   • errors - optional, unbounded; type ApiError
     The API error base class that provides details about an error that occurred while processing a service request.

     The OGNL field path is provided for parsers to identify the request data element that may have caused the error.

     • fieldPath - optional; type string
       The OGNL field path to identify cause of error.
     • fieldPathElements - optional, unbounded; type FieldPathElement
       A parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.
       A segment of a field path. Each dot in a field path defines a new segment.
       • field - optional; type string
         The name of a field in lower camelcase. (e.g. "biddingStrategy")
       • index - optional; type int
         For list fields, this is a 0-indexed position in the list. Null for non-list fields.
     • trigger - optional; type string
       The data that caused the error.
     • errorString - optional; type string
       A simple string representation of the error and reason.
     List of errors.

   A fault element of type ApiException.