This project hosts the .NET client library for the Google Ad Manager SOAP API.
- Distributed via Nuget
- Stub classes for all the supported API versions and services.
- Helpful utilities
- SOAP messages are logged, for easier debugging purposes
- Automatic handling of SOAP headers
- Easy management of credentials, authentication, and session information
- Docs available in HTML and XML format.
- .NET Framework 4.5.2+
- .NET Standard 2.0 (limited support)
For API and client library updates and news, please follow our Google Ads Developers blog: http://googleadsdeveloper.blogspot.com/.
- Install your library. We recommend using the following Nuget distribution:
- Google.Dfp: Ad Manager API DotNet Client Library
You can learn more about the nuget package manager at http://www.nuget.org. For other distribution options, see the alternative distribution options below.
- Setup your OAuth2 credentials.
The and Ad Manager API uses OAuth2 as the authentication mechanism. Follow the appropriate guide below based on your use case.
If you're accessing an API using your own credentials...
If you're accessing an API on behalf of clients...
The binary distribution of the Ads API .NET library consists of a precompiled version of the library as a .NET assembly, code examples for using the library, and library documentation. If you are interested in just using the library and not in its internals, and you don't use nuget package manager in your development environment, then you should download this distribution.
The contents of this distribution are as follows:
\
\lib
- Precompiled assemblies.
- Documentation xmls for the assemblies.
\examples
Code examples, in C# and VB.NET (when available).
README
ChangeLog
COPYING
Visual Studio solution file
To run the code examples:
- Open Visual Studio solution file in the root folder of the binary distribution in Microsoft Visual Studio
- Open
App.configfor the examples project and follow the instructions in the file to enter required configuration values. - Save and close
App.config. - Open the Properties dialog for the Examples project (Right click the Examples project of your choice in the Solution Explorer and select the Properties option from the context menu.).
- Navigate to the Debug Tab and enter the command line options. The command line options are of
the form
version.examplename. For instance,v202308.GetCurrentNetworkis the command line option to runGetCurrentNetworkexample inv202308version of the Ad Manager API. - Compile and run the Examples project.
Alternatively, each code example has a main() method, so you can set the appropriate code example
as the Startup object (Select the Application tab on the Examples Properties dialog and pick
the desired class from the "Startup object" dropdown.).
To use the library in a new project:
- Create a new Visual Studio project of your choice (for instance, a C# Windows application).
- Copy the lib folder from the binary distribution to your project folder. Add references to all the assemblies in this folder in your project.
- Add a reference to System.Web.Services in your project.
- Copy
examples\App.configto your project directory and add it to your project. - Edit the required keys in
App.config. If your application has its ownApp.config, then you need to merge its contents with the contents ofexamples\App.config. - Make a call to the library, e.g.:
// Create an appropriate AdsUser instance.
AdManagerUser user = new AdManagerUser();
// Create the required service.
using (NetworkService networkService = user.GetService<NetworkService>())
{
// make calls to service class.
}
You can refer to this wiki article for more details.
See https://github.com/googleads/googleads-dotnet-lib/wiki#logging for details.