方法指南

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

创建用户

通过 UserService,拥有管理员权限的用户可以直接在其广告资源网中创建用户。任何开发者都可以做到这一点,而无需先注册新用户。例如,如果您是首次试用该 API,而不是以管理员(电子邮件地址的默认)身份执行每个 API 调用,则可能需要创建一些具有销售人员、广告投放人员或广告客户等角色的用户来测试实际工作流程。

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

获取根 AdMob

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

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

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

查询对象

您可以使用许多服务公开的 getObjectsByStatement() 方法,根据搜索条件来搜索对象,其中“Object”即为特定的对象类型。此方法需要使用 PQL 查询。该查询与 SQL 查询类似,都允许指定要搜索的字段(字段名称映射到对象属性),并对搜索结果进行排序、限制和偏移。请参阅 PQL 指南,详细了解 PQL 以及您可以按哪些对象字段进行过滤。

创建订单

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

示例

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

创建订单项

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

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

示例

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

创建广告素材

不同类型的广告素材支持不同的组件:例如,图片广告素材支持图片使用一个源文件;Flash 广告素材支持两个基础素材资源文件:一个 Flash 文件和一个备用图片文件,以防 Flash 文件无法投放。对于在第三方网站上托管的广告素材,您只需上传引用第三方服务器上文件的 HTML 代码段即可。请查看您的具体 Creative 子类,了解创建广告素材需要上传哪些素材资源。

示例

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

修改现有对象

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

注意:更新后的对象将完全替换现有对象,因此,如果您忘记在发送的对象中设置某个属性值,则已保存的对象将采用该属性的默认值,而不是先前的值。

更改对象状态

可通过调用服务公开的 performObjectAction() 方法来更改对象状态。此方法采用两个参数:

  • 操作对象实例,用于描述您要执行的操作。例如,订单服务公开了多个操作,包括 ApproveOrdersPauseOrdersArchiveOrders。操作对象都派生自适用于您的服务的基础操作类。
  • 对要更改的对象进行描述的 PQL 查询。通过指定相应的 PQL 语句,您可以一次更改一个或多个对象的状态。

生成广告代码

您无法使用 API 生成广告代码;而是必须使用 Google Ad Manager 网站。有关详情,请参阅帮助中心的代码植入 部分。

更多示例

您可以在我们的客户端库示例代码中找到更多使用几种不同编程语言编写的示例。请参阅客户端库和示例代码 页面,获取使用您的编程语言编写的示例链接。