方法指南

本页详细介绍了如何使用 API 执行常见任务。

创建用户

UserService 允许 拥有管理员权限的用户可以创建 用户任何开发者都可以做到这一点 让新用户先注册例如，如果您正在试用 API 而不是以管理员（默认 电子邮件地址），您可能需要创建几个具有如下角色的用户： 销售人员、广告投放人员或广告客户，以测试实际的工作流程。

  1. 新建一些 Gmail 地址，如 my.name.salesperson@gmail.com。或者 将一个现有的非 Gmail 地址注册为新的 Google 账号。
  2. 使用以下新地址和所选的 Role 调用 createUsers。
  3. 您可以使用 OAuth 2.0 生成访问令牌，从而以此新用户的身份进行身份验证。

获取根 AdUni

可以添加子节点的最高 AdUnit 以及允许的层次结构深度都取决于您的账号类型（标准版还是专业版）。支持修改其子节点的最顶层 AdUnit 称为有效根 AdUnit。

如需检索有效根，请调用 NetworkService.getCurrentNetwork()，并检查返回的 Network 对象的 effectiveRootAdUnitId 字段。

注意：不同的账号类型支持不同的层次结构模式。

查询对象

您可以使用 getObjectsByStatement() 方法按搜索条件搜索对象 其中 Object 即为特定的对象类型。本次 方法接受 PQL 查询，此查询与 SQL 查询类似，因为它允许您指定 要搜索的字段（字段名称映射到对象属性）、排序、 并限制搜索结果的范围。请参阅 PQL 此指南详细介绍了 PQL，并了解您可以使用 过滤条件。

创建订单

要创建订单，只需创建一个Order对象并设置广告客户 销售人员和广告投放人员 ID 分配给相应的用户，请为他们指定一个唯一的名称， 然后调用 createOrders()。结果将包含新创建的 Order， 或错误。

示例

请参阅用于创建订单的 Java 代码示例。

创建订单项

创建新订单项的步骤如下：

  1. 创建一个新的 Order 对象，或使用现有对象。
  2. 创建一个新的LineItem对象，并设置轮播类型、广告素材尺寸数组 开始日期和结束日期以及其他属性。
  3. 创建一个新的 InventoryTargeting 对象，并指定要定位或排除的 Placement 或 AdUnit 对象。
  4. 将 InventoryTargeting 对象封装在新的 Targeting 对象中，并将其分配给 并将其设为LineItem的定位属性
  5. 使用新对象调用订单项服务方法 createLineItems()，并检查结果以确认对象是否已创建。

示例

请参阅用于创建订单项的 Java 代码示例。

创建广告素材

不同类型的广告素材支持不同的组件：例如，图片 广告素材支持图片的单一源文件；Flash 广告素材支持 两个基础资源文件：一个 Flash 文件和一个备份图片文件 文件无法投放。对于在第三方网站上托管的广告素材，您需要上传 引用第三方服务器上的文件的 HTML 代码段。查看您的 特定的 Creative 子类，以了解要上传哪些素材资源 创建广告素材。

示例

请参阅用于创建图片广告素材的 Java 代码示例。

修改现有对象

如需修改现有对象，请调用 getObjectsByStatement() 来查询对象， 更新返回对象中的值，然后调用 updateObjects()。

注意：更新后的对象会完全替换现有对象，因此如果您 发送的对象中忘记设置属性值，保存的对象将 则会获取该属性的默认值，而不是之前的值。

更改对象状态

可调用 performObjectAction() 方法来更改对象状态 由服务公开此方法采用两个参数：

  • 描述您要执行的操作的操作对象实例。对于 实例时，订单服务会公开几种操作，包括 ApproveOrders、PauseOrders、 和 ArchiveOrders。操作对象都派生于基本操作 类。
  • 对要更改的对象进行描述的 PQL 查询。您可以更改 通过指定相应的 PQL 来同时了解一个或多个对象的状态 声明。

生成广告代码

您无法使用 API 生成广告代码；您必须使用 Google Ad Manager 网站。请参阅代码 帮助中心部分， 。

更多示例

我们的客户端库示例代码中提供更多使用多种不同语言编写的 不同的编程语言请参阅客户端库和示例代码 页面，获取使用您的编程语言编写的示例链接。