googleads / shopping-content-samples
购物内容API的示例
Requires
- php: >=5.4
- google/apiclient: ^2.0
- guzzlehttp/guzzle: ~6.0
- guzzlehttp/psr7: ^1.2
- monolog/monolog: ^1.17
This package is not auto-updated.
Last update: 2024-09-15 00:49:34 UTC
README
这些代码示例按平台或语言组织。每个语言目录都包含一个README
,其中包含有关如何运行该特定语言示例的更多信息。在此,我们介绍了设置身份验证和所有示例使用的通用配置文件。
有关API的更多信息,请参阅购物内容API和制造商中心API的文档。
选择您的身份验证方法
在开始之前,请查看购物内容API文档中的“入门”部分。您可能希望使用服务帐户来简化身份验证流程。这些示例还支持使用Google应用程序默认凭证。
设置制造商中心API的身份验证与设置购物内容API的身份验证类似。只需确保在API控制台中选择了制造商中心API。如果您想尝试两个API的示例,可以同时选择这两个API。
设置身份验证和示例配置
-
创建存储配置的目录
$(HOME)/shopping-samples
。如果您不确定在您的特定设置中此目录将位于何处,则运行示例(遵循特定语言的
README
)。与该目录或必要文件不存在的示例相关错误将提供预期目录/文件的完整路径。在此目录中,根据您想要尝试的API,创建以下子目录:
content
用于购物内容APImanufacturers
用于制造商中心API
将以下文件放置在您想要尝试的API的相应子目录中。
-
设置您想要的身份验证方法。
如果您正在使用Google应用程序默认凭证
- 遵循Google应用程序默认凭证页面上的说明。
如果您正在使用服务帐户
- 将创建服务帐户时下载的JSON文件放在相应的API配置子目录中的
service-account.json
文件中。
如果您正在使用OAuth2客户端ID
-
将您的OAuth2客户端凭证下载到相应的API配置子目录中的
client-secrets.json
文件中。注意:这些示例假定您正在使用一个可以使用回环IP地址检索令牌的OAuth2客户端ID。如果您不是或不确定是否是,请访问[OAuth2.0 for Mobile & Desktop Apps] (https://developers.google.com/identity/protocols/OAuth2InstalledApp)页面,并按照那里的说明创建一个新的OAuth2客户端ID,以与示例一起使用。
您可以为尝试不同的流程设置多种身份验证方法,但请注意,示例将始终使用可加载的第一个凭据,按照以下顺序
-
每套示例都使用不同的配置文件。对于购物内容 API,从存储库根目录中获取示例
merchant-info.json
,并将其复制到$(HOME)/shopping-samples/content
。接下来,适当地更改其内容。它包含一个具有以下字段的 JSON 对象对于制造商中心 API,从存储库根目录中获取示例
manufacturer-info.json
,并将其复制到$(HOME)/shopping-samples/manufacturers
。接下来,适当地更改其内容。它包含一个具有以下字段的 JSON 对象如果您使用 OAuth2 客户端凭据,一旦您已授权访问,您的令牌详细信息将存储在配置目录中的
stored-token.json
文件中。如果您在身份验证方面遇到任何问题,请删除此文件,您将被要求重新授权访问。
尝试示例
现在您已经配置了公共示例配置文件并设置了您的身份验证凭据,是时候构建和运行任何包含的示例了。如前所述,每个语言子目录中都有特定于语言的说明 README
。祝您玩得开心!
可能的问题
- 当使用购物内容 API 时,如果您尚未在您的帐户中设置税务设置,运行某些示例时可能会出现错误。如果您收到“缺少税务设置”错误,请在尝试这些示例之前在商家中心中设置您的税务设置。选择“在美国不收取税费”设置就足够了。