README

此项目托管了Google Ads API的PHP客户端库。它遵循PHP日落时间表，并在最低要求的PHP版本达到其生命周期的4到5个月后更新composer.json文件。基于现有的支持PHP版本，更新大约每年发生一次。

重要如#880中宣布，PHP版本的Google Ads API客户端库已更新为需要PHP 8作为最低版本。这意味着支持PHP 7的库的最终版本是v19.2.0，支持Google Ads API v12到v14。

Google Ads API v14计划于2024年5月底停用。因此，PHP 7用户大约有11个月的时间迁移到PHP 8，以便无缝继续使用此库。

功能

通过Composer和Packagist分发。
易于管理凭证。
易于创建Google Ads API服务客户端。

要求

支持32位和64位PHP系统，但我们强烈建议如果可能的话使用64位。这是因为Google Ads API的许多字段被指定为64位整数，并且将32位系统中的值从float强制转换为int可能会导致问题。32位PHP系统支持的整数最大值通常是2147483647，有关更多详细信息，请参阅PHP_INT_MAX。
此库依赖于Composer。如果您尚未在计算机上安装它，请遵循Linux/Unix/OS X的安装指南或Windows的安装指南。在本指南的其余部分中，我们假设您正在使用Linux/Unix/OS X并且已全局安装Composer，因此您的安装Composer可以在命令行上作为composer使用。
系统要求和依赖关系可以在该库的composer.json中找到。
- PHP：您可以在require键下的"php"中找到所需的最低PHP版本，该键位于composer.json文件中。我们通常将其设置为PHP开发团队仍提供安全补丁的最小PHP版本。当此类版本停止支持时，我们将相应地更新composer文件。目前，更新频率大约为一年一次，根据官方时间表。访问此页面了解PHP的介绍。
- gRPC：要安装gRPC PHP扩展，请确保满足项目文档中列出的任何附加要求。您可以通过阅读我们的传输指南了解更多关于如何使用此库的gRPC信息。使用PECL安装通常需要几分钟。
  1. 使用命令sudo pecl install grpc安装扩展。
  2. 将extension=grpc.so行添加到php.ini文件中。
  3. 在终端中运行php -i | grep grpc：如果返回一些内容，则表示它已正确安装和配置。
- Protobuf：要安装Protobuf PHP扩展，请确保满足项目文档中列出的任何附加要求。如果在安装过程中遇到任何错误，您可以跳过此步骤，将使用PHP实现。您可以通过阅读我们的Protobuf实现指南了解更多关于如何使用此库的Protobuf信息。使用PECL安装通常需要几分钟。
  1. 使用命令sudo pecl install protobuf安装扩展。
  2. 将extension=protobuf.so行添加到php.ini文件中。
  3. 在终端中运行php -i | grep protobuf：如果返回一些内容，则表示它已正确安装和配置。
您需要一个开发人员令牌才能连接到Google Ads API。
库的一个版本通常支持Google Ads API的多个版本。您可以通过查看CHANGELOG.md文件来识别哪些版本的库添加或删除了对特定版本Google Ads API的支持。例如，Google Ads API的V7版本在库的v9.0.0版本中添加，如此处所述。

入门指南

运行代码示例

如果您想尝试我们的代码示例，请按照以下步骤操作。

通过以下方式在您选择的目录中克隆此项目：
```
git clone https://github.com/googleads/google-ads-php.git
```
切换到google-ads-php目录。
```
cd google-ads-php
```
您将看到一些文件和子目录
- composer.json：此库的要求的composer文件。
- src：库的源代码。
- tests：库代码的测试。
- examples：许多示例，演示如何使用Google Ads API通过库执行常见用例。
- metadata：一些源代码内部使用的元数据文件。它们是自动生成的文件，因此您不应该修改它们。
在命令提示符中运行composer install。这将安装使用库和运行示例所需的所有依赖项。
设置您的OAuth2凭据。

Google Ads API使用OAuth2作为认证机制。根据您的用例选择合适的选项，并阅读并遵循示例打印到控制台中的说明。
- 将示例中的google_ads_php.ini（点击此处访问）复制到您的家目录。此库通过使用EnvironmentalVariables::getHome()来确定您的计算机的家目录。
- 按照https://developers.google.com/google-ads/api/docs/oauth/cloud-project中的说明创建OAuth2客户端ID和密钥，用于已安装的应用程序OAuth2流程。
- 运行GenerateUserCredentials示例，该示例将提示您输入OAuth2客户端ID和密钥。
- 将示例最后一步的输出复制到您家目录中的google_ads_php.ini文件中。别忘了填写您的开发者令牌。
运行GetCampaigns示例以测试您的凭据是否有效。您还需要将不带连字符的您的Google Ads账户的客户ID作为命令行参数传递
```
php examples/BasicOperations/GetCampaigns.php --customerId <YOUR_CUSTOMER_ID>
```
注意：代码示例旨在从命令提示符运行，而不是通过网络浏览器。
探索其他示例。

示例目录中包含几个有用的示例。大多数示例都需要参数。您可以通过将--help作为命令行参数运行代码示例来查看所需参数。

注意：您将在这些示例的源代码中找到格式为[START...]和[END...]的注释。这些仅用于技术目的，您可以完全忽略它们。

将库安装为项目的依赖项

切换到您的项目的根目录。
在命令提示符中运行composer require googleads/google-ads-php。这将在此项目的根目录的vendor/目录中安装此库及其所有依赖项。
设置您的OAuth2凭据，如前文所述。
您现在可以通过导入其类来使用此库，如代码示例中所示。

基本用法

实例化客户端

要使用Google Ads API发出请求，您首先需要创建一个GoogleAdsClient。

有关在实例化时如何配置客户端的更多信息，请参阅配置指南。

获取服务客户端

一旦您有了GoogleAdsClient的一个实例，您就可以使用其中一个get...ServiceClient()方法获取特定服务的服务客户端。

创建的服务客户端可以是基于useGapicV2Source配置值的GAPIC（生成API客户端）v1或v2源代码。有关详细信息，请参阅GAPIC和配置字段。

客户端配置

查看配置指南。

传输

可以使用不同类型的传输。有关更多信息，请参阅传输指南。

Protobuf

无论使用哪种传输方式请求Google Ads API，都会使用Protobuf。

有关更多信息，请参阅Protobuf指南。

在Docker容器中运行

请参阅在Docker容器中运行指南。

日志记录

请参阅日志记录指南。

代理配置

请参阅代理指南。

性能

请参阅性能指南。

杂项

googleads / google-ads-php

维护者

详细信息