README

This project hosts the PHP client library for the Google Ads API. It adheres to the PHP sunset schedule and updates the composer.json file four to five months after the minimum required PHP version reaches its end-of-life. Based on the existing supported PHP versions, the update occurs about once a year.

IMPORTANT The Google Ads API client library for PHP has been updated to require PHP version 8 as the minimum version, as announced in #880. This means that the final version of the library that supports PHP 7 is v19.2.0, which supports Google Ads API v12 to v14.

Google Ads API v14 is scheduled to be sunset by the end of May 2024. Therefore, PHP 7 users have about 11 months to migrate to PHP 8 in order to continue using the library without disruption.

Features

Distributed via Composer and Packagist.
Easy management of credentials.
Easy creation of Google Ads API service clients.

Requirements

Both 32-bit and 64-bit PHP systems are supported but we highly recommend to use 64-bit if you can. This is because many fields of the Google Ads API are typed as 64-bit integers and casting their values to int instead of float from 32-bit systems can lead to issues. The largest integer value supported in 32-bit PHP systems is usually 2147483647, see the predefined constant PHP_INT_MAX for more details.
This library depends on Composer. If you don't have it installed on your computer yet, follow the installation guide for Linux/Unix/OS X or installation guide for Windows. For the rest of this guide, we're assuming that you're using Linux/Unix/OS X and have Composer installed globally, thus, your installed Composer is available on the command line as composer.
System requirements and dependencies can be found in composer.json of this library.
- PHP: You can find the required minimum PHP version in "php" under the require key of composer.json. We usually set it to the minimum PHP version for which the PHP development team still provide security fixes. Whenever such a version is sunset, we'll update the composer file accordingly. Currently, the update frequency is around once a year based on the official schedule. Visit this page for introduction to PHP.
- gRPC: To install the gRPC PHP extension, make sure to meet any additional requirements listed in the project's documentation. You can learn more about how gRPC is used by this library by reading our Transport guide. It usually take minutes to install using PECL:
  1. Install the extension using the command sudo pecl install grpc.
  2. Add a line extension=grpc.so to the php.ini file.
  3. Run php -i | grep grpc in a terminal: it is well installed and configured if it returns something
- Protobuf: To install the Protobuf PHP extension, make sure to meet any additional requirements listed in the project's documentation. If you encounter any error during the installation, you can skip this step and the PHP implementation will be used instead. You can learn more about how Protobuf is used by this library by reading our Protobuf implementations guide. It usually take minutes to install using PECL:
  1. Install the extension using the command sudo pecl install protobuf.
  2. Add a line extension=protobuf.so to the php.ini file.
  3. Run php -i | grep protobuf in a terminal: it is well installed and configured if it returns something
You need a developer token to connect to the Google Ads API.
One version of the library typically supports multiple versions of the Google Ads API. You can check the CHANGELOG.md file to identify what versions of the library added or removed the support for a specific version of the Google Ads API. For example, the version V7 of the Google Ads API was added in the version v9.0.0 of the library as described here.

Getting started

Running code examples

Follow the below steps if you want to try our code examples.

Clone this project in the directory of your choice via:

git clone https://github.com/googleads/google-ads-php.git

Change into the google-ads-php directory.
```
cd google-ads-php
```
You'll see some files and subdirectories:
- composer.json: the composer file, which holds the requirements of this library.
- src: source code of the library.
- tests: tests of the library code.
- examples: many examples that demonstrate how to use the library to execute common use cases via the Google Ads API.
- metadata: some metadata files used internally by the source code. They're automatically generated files, so you shouldn't modify them.
Run composer install at the command prompt. This will install all dependencies needed for using the library and running examples.
Set up your OAuth2 credentials.

The Google Ads API uses OAuth2 as the authentication mechanism. Choose the appropriate option below based on your use case, and read and follow the instructions that the example prints to the console.
- Copy the sample google_ads_php.ini to your home directory. This library determines the home directory of your computer by using EnvironmentalVariables::getHome().
- Follow the instructions at https://developers.google.com/google-ads/api/docs/oauth/cloud-project to create an OAuth2 client ID and secret for the installed application OAuth2 flow.
- Run the GenerateUserCredentials example, which will prompt you for your OAuth2 client ID and secret.
- Copy the output from the last step of the example into the google_ads_php.ini file in your home directory. Don't forget to fill in your developer token too.
Run the GetCampaigns example to test if your credentials are valid. You also need to pass your Google Ads account's customer ID without dashes as a command-line parameter:
```
php examples/BasicOperations/GetCampaigns.php --customerId <YOUR_CUSTOMER_ID>
```
NOTE: Code examples are meant to be run from command prompt, not via the web browsers.
Explore other examples.

The examples directory contains several useful examples. Most of the examples require parameters. You can see what are required by running code examples with --help as a command-line parameter.

Note: You will find comments with the formats [START...] and [END...] in the source code of these examples. These are only used for technical purposes, you can completely disregard them.

Installing the library as your project's dependency

Change into the root directory of your project.
Run composer require googleads/google-ads-php at the command prompt. This will install this library and all its dependencies in the vendor/ directory of your project's root directory.
Set up your OAuth2 credentials like described in the previous section.
You can now use this library by importing its classes like shown in the code examples.

Basic usage

Instantiate a client

To issue requests via the Google Ads API, you first need to create a GoogleAdsClient.

For more information on how to configure a client when instantiating it, see the configuration guide.

Get a service client

Once you have an instance of GoogleAdsClient, you can obtain a service client for a particular service using one of the get...ServiceClient() methods.

The created service client can be either GAPIC (Generated API Client) v1 or v2 source code, based on the value of the useGapicV2Source configuration. See GAPIC and Configuration fields for details.

Client configuration

See the Configuration guide.

Transport

There are different types of transport that can be used. See the Transport guide for more information.

Protobuf

Protobuf is used regardless of the transport used to request the Google Ads API.

See the Protobuf guide for more information.

Running in a Docker container

See the Running in a Docker container guide.

Logging

See the Logging guide.

Proxy configuration

See the Proxy guide.

Performance

See the Performance guide.

Miscellaneous

googleads / google-ads-php

Maintainers

Details