README

此项目托管了 Google Ads API 的 PHP 客户端库。

功能

通过 Composer 和 Packagist 分发。
轻松管理凭据。
轻松创建 Google Ads API 服务客户端。

要求

此库依赖于 Composer。如果您还没有在计算机上安装它，请按照 Linux/Unix/OS X 安装指南或 Windows 安装指南进行操作。在此指南的其余部分，我们假设您正在使用 Linux/Unix/OS X 并且已全局安装了 Composer，因此，您的已安装 Composer 可在命令行上作为 composer 使用。
系统要求和依赖项可以在此库的 composer.json 中找到。
- PHP：您可以在 require 键下的 composer.json 中找到所需的最低 PHP 版本。我们通常将其设置为 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作为认证机制。根据您的用例选择下面的适当选项，并阅读并遵循示例打印到控制台上的说明。

如果您已经为AdWords API提供了凭证...
- 如果您有用于AdWords API的adsapi_php.ini文件，将其复制并重命名为google_ads_php.ini。只需将部分名称从[ADWORDS]更改为[GOOGLE_ADS]。
- 如果您没有该文件，将示例google_ads_php.ini复制到您的主目录。此库通过使用EnvironmentalVariables::getHome()来确定您的计算机的主目录。
如果您使用自己的凭证访问Google Ads API...
- 将示例google_ads_php.ini复制到您的主目录。此库通过使用EnvironmentalVariables::getHome()来确定您的计算机的主目录。
- 按照https://developers.google.com/google-ads/api/docs/oauth/cloud-project中的说明创建OAuth2客户端ID和密钥，用于已安装应用程序的OAuth2流程。
- 运行AuthenticateInDesktopApplication示例，它将提示您输入OAuth2客户端ID和密钥。
- 将示例的最后一步的输出复制到您主目录中的google_ads_php.ini文件中。别忘了填写您的开发者令牌。
运行GetCampaigns示例以测试您的凭据是否有效。您还需要将您的Google Ads账户的客户ID（不带连字符）作为命令行参数传递
```
php examples/BasicOperations/GetCampaigns.php --customerId <YOUR_CUSTOMER_ID>
```
注意：代码示例旨在从命令提示符运行，而不是通过网络浏览器。
探索其他示例。

示例目录包含一些有用的示例。大多数示例都需要参数。您可以通过运行带有--help的代码示例来查看所需参数。

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

基本用法

实例化客户端

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

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

获取服务客户端

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

客户端配置

请参阅配置指南。

传输

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

Protobuf

Protobuf在使用传输请求Google Ads API时使用。

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

在Docker容器中运行

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

日志记录

请参阅日志记录指南。

代理配置

请参阅代理指南。

性能

请参阅性能指南。

杂项

triwinvendor / google-ads

维护者

详细信息