From 54f65ac9589e2402bfc360f7d77efd120bdca594 Mon Sep 17 00:00:00 2001 From: "Anash P. Oommen" Date: Mon, 7 Jul 2014 09:32:54 -0400 Subject: [PATCH] Update README.md --- README.md | 61 ++++++++++++++++++++++++++----------------------------- 1 file changed, 29 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index 6dea73837aa..8a01e545305 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ #Google Ads API .NET Client Library This project hosts the .NET client library for the various SOAP-Based Ads APIs - AdWords API, DoubleClick Ad Exchange Buyer SOAP (AdxBuyer) API, DoubleClick for Advertisers (DFA) API, and Google's DoubleClick for Publishers (DFP) API at Google. + ##Features - Distributed via Nuget - Stub classes for all the supported API versions and services. @@ -8,7 +9,7 @@ This project hosts the .NET client library for the various SOAP-Based Ads APIs - - 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 CHM formats. +- Docs available in HTML and XML format. ##Requirements @@ -30,23 +31,23 @@ We provide source, binary and nuget distributions for the client library. You ma This is the recommended way to get the client library. The nuget distributions of the client library are listed below: ###AdWords and AdxBuyer API -- Google.AdWords: AdWords and DoubleClick Ad Exchange Buyer API DotNet Client Library -- Google.AdWords.Examples.CSharp: C# Code examples for AdWords API -- Google.AdWords.Examples.VB: VB.NET Code examples for AdWords API -- Google.AdXBuyer.Examples.CSharp: C# Code examples for AdxBuyer API -- Google.AdXBuyer.Examples.VB: VB.NET Code examples for AdxBuyer API +- [Google.AdWords](https://www.nuget.org/packages/Google.AdWords/): AdWords and DoubleClick Ad Exchange Buyer API DotNet Client Library +- [Google.AdWords.Examples.CSharp](https://www.nuget.org/packages/Google.AdWords.Examples.CSharp/): C# Code examples for AdWords API +- [Google.AdWords.Examples.VB](https://www.nuget.org/packages/Google.AdWords.Examples.VB/): VB.NET Code examples for AdWords API +- [Google.AdXBuyer.Examples.CSharp](https://www.nuget.org/packages/Google.AdXBuyer.Examples.CSharp/): C# Code examples for AdxBuyer API +- [Google.AdXBuyer.Examples.VB](https://www.nuget.org/packages/Google.AdXBuyer.Examples.VB/): VB.NET Code examples for AdxBuyer API ###DFP API -- Google.Dfp: DFP API DotNet Client Library -- Google.Dfp.Examples.CSharp: C# Code examples for DFP API +- [Google.Dfp](https://www.nuget.org/packages/Google.Dfp/): DFP API DotNet Client Library +- [Google.Dfp.Examples.CSharp](https://www.nuget.org/packages/Google.Dfp.Examples.CSharp/): C# Code examples for DFP API ###DFA API -- Google.Dfa: DFA API DotNet Client Library -- Google.Dfa.Examples.CSharp: C# Code examples for DFA API +- [Google.Dfa](https://www.nuget.org/packages/Google.Dfa/): DFA API DotNet Client Library +- [Google.Dfa.Examples.CSharp](https://www.nuget.org/packages/Google.Dfa.Examples.CSharp/): C# Code examples for DFA API -To use the library, you can install the appropriate nuget packages and add reference to your Visual Studio project. You can learn more about the nuget package manager at http://www.nuget.org +To use the library, you can install the appropriate nuget packages and add reference to your Visual Studio project. You can learn more about the nuget package manager at http://www.nuget.org. ##Binary distribution 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. There are separate downloads for AdWords, AdxBuyer, DFA and DFP APIs. @@ -54,11 +55,9 @@ The binary distribution of the Ads API .NET library consists of a precompiled ve The contents of this distribution are as follows: ``` \ - \docs - - Documentation xmls for the assemblies. - - Prebuilt help files for the client library in chm format. \lib - Precompiled assemblies. + - Documentation xmls for the assemblies. \examples Code examples, in C# and VB.NET (when available). README @@ -69,21 +68,21 @@ The contents of this distribution are as follows: To run the code examples: - Open Visual Studio solution file in the root folder of the binary distribution in Microsoft Visual Studio -- Open App.config for the examples project and follow the instructions in the file to enter required configuration values. -- Save and close App.config. +- Open `App.config` for 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, v201402.AddCampaign is the command line option to run AddCampaign example in v201402 version of the AdWords API. +- Navigate to the Debug Tab and enter the command line options. The command line options are of the form `version.examplename`. For instance, `v201402.AddCampaign` is the command line option to run `AddCampaign` example in `v201402` version of the AdWords 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.). +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.config to your project directory and add it to your project. -- Edit the required keys in App.config. If your application has its own App.config, then you need to merge its contents with the contents of examples\App.config +- Copy `examples\App.config` to your project directory and add it to your project. +- Edit the required keys in `App.config`. If your application has its own `App.config`, then you need to merge its contents with the contents of `examples\App.config`. - Make a call to the library, e.g.: ``` @@ -96,7 +95,7 @@ CampaignService service = (CampaignService) user.GetService( // make more calls to service class. ``` -You can refer to this wiki article for more details. +You can refer to [this wiki article](/googleads/googleads-dotnet-lib/wiki/Getting-Started) for more details. ##Source distribution @@ -106,8 +105,6 @@ The source distribution of the Ads API .NET Client Library consists of individua The contents of this distribution are as follows: \ - \docs - - Prebuilt help files for the client library in .CHM format. \examples \adwords - Adwords API code examples, in C# and VB.NET. @@ -129,22 +126,22 @@ The contents of this distribution are as follows: To compile and run the project: - Open the Visual Studio solution in Microsoft Visual Studio. -- Open App.config for the examples project of your choice and follow the instructions in the file to enter required configuration values. -- Save and close App.config. +- Open `App.config` for the examples project of your choice 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 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, v201402.AddCampaign is the command line option to run the AddCampaign example for the v201402 version of the AdWords API. +- Navigate to the Debug tab and enter the command line options. The command line options are of the form `version.examplename`. For instance, `v201402.AddCampaign` is the command line option to run the `AddCampaign` example for the `v201402` version of the AdWords API. - Set the Examples project as the Startup project. - 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.). +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 run the test cases, you need to download and install the latest version of NUnit from http://www.nunit.org/. Once you have installed NUnit, you can compile and run the test cases as follows: - Right click the appropriate Tests project and choose References from the context menu. -- From the references dialog, add a reference to the nunit.framework assembly. -- Right click theTests project and choose Properties. Navigate to the Debug tab and choose "Start external program". Browse to the path for nunit.exe and pick it as the Startup application. -- Open App.config for the test project and follow the instructions in the file to enter required configuration values. -- Set the AdWords.Tests project as the startup project and run the project. +- From the references dialog, add a reference to the `nunit.framework` assembly. +- Right click theTests project and choose Properties. Navigate to the Debug tab and choose "Start external program". Browse to the path for `nunit.exe` and pick it as the Startup application. +- Open `App.config` for the test project and follow the instructions in the file to enter required configuration values. +- Set the `AdWords.Tests` project as the startup project and run the project. It is recommended that you run the test cases against a test environment. Refer to the appropriate API documentation for details on how this may be done. @@ -167,5 +164,5 @@ It is recommended that you run the test cases against a test environment. Refer - DFP API: https://developers.google.com/doubleclick-publishers/community - DFA API: https://developers.google.com/doubleclick-advertisers/community -###Authors: +###Authors List all github profiles here