Release for v5.1.0.

Author: saturnism

ChangeLog.md

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

LICENSE

@@ -0,0 +1,177 @@
+## The Google Ads APIs PHP Client Library
+
+This project hosts the PHP client library for the various SOAP-based Ads APIs
+(AdWords, AdExchange Buyer, and DFP) at Google.
+
+
+### Features
+
+* Provides easy SOAP logging of API calls.
+* Automatic handling of SOAP headers.
+* Easy management of credentials, authentication, and session information.
+* Examples to that show how to access API services.
+
+
+### Requirements
+
+PHP
+  - [PHP 5.2.x - 5.4.x](http://php.net)
+  - Required PHP extensions:
+    - [SoapClient](http://us3.php.net/manual/en/book.soap.php) (--enable-soap)
+    - [OpenSSL](http://php.net/manual/en/book.openssl.php) (--with-ssl)
+    - [cURL](http://php.net/manual/en/book.curl.php) (--with-curl)
+
+Build environment
+  - [PHPUnit](http://www.phpunit.de)
+  - [Phing](http://phing.info)
+  - Modified wsdl2php-interpreter (included in this project)
+    - Original: http://code.google.com/p/wsdl2php-interpreter
+  - Required PHP extensions:
+    - [XSLTProcessor](http://php.net/manual/en/class.xsltprocessor.php)
+        (--with-xsl)
+
+
+### Announcements and updates
+
+For API and client library updates and news, please follow our [Google+ Ads
+Developers page](https://plus.google.com/+GoogleAdsDevelopers/posts) and our
+[Google Ads Developers blog](http://googleadsdeveloper.blogspot.com).
+
+
+### Getting started
+
+1\. Register an OAuth 2 application.
+
+You will need to register an OAuth2 application to get a valid client ID and
+secret. See the [Using OAuth 2 wiki page]
+(https://github.com/googleads/googleads-php-lib/wiki/Using-OAuth-2.0) for more information.
+
+2\. Download the client library.
+
+The client library source can be found with the example distributions in the
+[releases section](https://github.com/googleads/googleads-php-lib/releases) of
+this GitHub project. Download the examples for the product you are working with
+and untar it.
+
+3\. Enter your OAuth 2 and account credentials.
+
+In the distribution you will find a lib folder. Under
+lib/Google/Api/Ads/[PRODUCT]/ you will find an auth.ini file. Open the auth.ini
+file and enter your OAuth 2 client ID and secret that you generated in step 1.
+Also enter the required product specific credentials, such as network code for
+DFP and developer token for AdWords.
+
+> It is recommended that during development of your library, you use a test
+> network/account. For DFP, you can follow instructions for how to obtain a
+> test network here:
+> https://developers.google.com/doubleclick-publishers/docs/start
+> For AdWords, you can follow instructions here:
+> https://developers.google.com/adwords/api/docs/test-accounts
+
+Now in your distribution, navigate to examples/[PRODUCT]/Auth and run the
+GetRefreshToken.php example. Copy the refresh token the example produces into
+the auth.ini file mentioned above.
+
+4\. Run an example.
+
+To ensure you have setup credentials properly, run the GetAllCompanies.php
+example located in examples/Dfp/v201311/CompanyService/ if you're using DFP.
+
+If you're using AdWords, run the GetCampaigns.php example located in
+examples/AdWords/v201309/BasicOperations/.
+
+5\. Install the client library.
+
+To install the client library, either copy the lib/ folder into where you store
+your PHP source files that is on your PHP include path, or add the current
+directory path of the lib/ folder to your PHP include path.
+
+
+### Basic usage
+
+The following example is for AdWords, but the general code applies to all
+products.
+
+
+```php
+
+// Set the include path and the require the folowing PHP file.
+//
+// You can set the include path to src directory or reference
+// AdWordsUser.php directly via require_once.
+// $path = '/path/to/pda_api_php_lib/src';
+$path = dirname(__FILE__) . '/../../../src';
+set_include_path(get_include_path() . PATH_SEPARATOR . $path);
+require_once 'Google/Api/Ads/AdWordsUser/Lib/AdWordsUser.php';
+
+// Create an AdWordsUser instance using the default constructor, which will load
+// information from the auth.ini file as described above.
+$user = new AdWordsUser();
+
+// Optionally, enable logging to capture the content of SOAP requests and
+// responses.
+$user->LogDefaults();
+
+// Instantiate the desired service class by calling the get***Service method on
+// the AdWordsUser instance.
+$campaignService = $user->GetService('CampaignService', 'v201309')
+
+// Create data objects and invoke methods on the service class instance. The
+// data objects and methods map directly to the data objects and requests for
+// the corresponding web service.
+
+// Create new campaign structure.
+$campaign = new Campaign();
+$campaign->name = 'Campaign #' . time();
+$campaign->status = 'ACTIVE';
+$campaign->biddingStrategyConfiguration = new BiddingStrategyConfiguration();
+$campaign->biddingStrategyConfiguration->biddingStrategyType = 'MANUAL_CPC';
+$campaign->budget = new Budget('DAILY', new Money(50000000), 'STANDARD');
+
+$operation = new CampaignOperation();
+$operation->operand = $campaign;
+$operation->operator = 'ADD';
+$operations[] = $operation;
+
+// Add campaign.
+$campaignReturnValue = $campaignService->mutate($operations);
+```
+
+
+### How do I enable logging?
+
+The client library uses a custom class for all logging purposes and is exposed
+through the Logger.php file. There are two loggers within this class described
+below.
+
+  - REQUEST_INFO_LOG: Logs all requests from the client library along
+    with information such as the timestamp, email, service, method,
+    request Id, response time and which server was used. The default
+    behavior is to log this information to "logs/request_info.log" relative to
+    your project's home directory.
+
+  - SOAP_XML_LOG: Logs all incoming and outgoing SOAP requests/responses. The
+    default behavior is to log this information to "logs/soap_xml.log" relative
+    to your project's home directory. Sensitive information, such as
+    authentication tokens, will be stripped.
+
+Logging can be enabled using the following methods.
+
+  - $user->LogDefaults(): Logs request information for all requests, but only
+    logs SOAP XML for requests that resulted in an error.
+
+  - $user->LogErrors(): Only logs request information and SOAP XML for requests
+    that resulted in an error.
+
+  - $user->LogAll(): Logs request information and SOAP XML for all requests.
+
+You can use the methods of the Logger class directly for even more control over
+how requests are logged.
+
+
+### Where do I submit client library bug reports, feature requests, and patches?
+
+All of these can be submitted through the
+[issue tracker](https://github.com/googleads/googleads-php-lib/issues) in this
+GitHub project.
+