Reminder: v201702 will be sunset on February 28, 2018.

操作方法指南

本页面提供关于如何使用该 API 执行常规任务的详情。

创建用户

通过 UserService,拥有系统管理员权限的用户可以直接在其广告联盟中创建用户。所有开发者都可以这样做,无需先注册新用户。例如,如果您是首次尝试使用该 API,不妨创建一些具有销售人员、广告投放人员或广告客户等角色的用户来测试实际工作流程,而不用以管理员(为您的电子邮件地址分配的默认角色)身份执行每次 API 调用。

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

获取根 AdUni

您可以将子节点添加到的顶级 AdUnit 以及所允许的层次结构深度均取决于您的帐号类型,即帐号是 DFP 广告管理系统(以下简称 DFP)标准版还是专业版。支持修改自己子节点的顶级 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. 在新建的 Targeting 对象中封装 InventoryTargeting 对象,并将其分配到 LineItem 的定位属性。
  5. 使用新对象调用订单项服务方法 createLineItems(),并检查结果以确认对象是否已创建。

示例

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

创建广告素材

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

示例

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

修改现有对象

要修改现有对象,请通过调用 getObjectsByStatement() 查询您的对象,更新所返回对象中的值,然后调用 updateObjects()

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

更改对象状态

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

  • 描述您要完成的操作的操作对象实例。 例如,订单服务会提供多种操作,包括 ApproveOrdersPauseOrdersArchiveOrders。操作对象全都源自与服务对应的基本操作类。
  • 对要更改的对象进行了描述的 PQL 查询。 通过指定相应的 PQL 语句,您可以一次更改一个或多个对象的状态。

生成广告代码

您无法使用 API 生成广告代码,而必须是通过 DFP 网站。有关详情,请参见帮助中心内的代码部分。

更多示例

您可以在我们的客户端库示例代码中找到更多示例(采用多种不同的编程语言编写),并且还可在客户端库和示例代码页上看到与您使用的编程语言对应的示例链接。

 

发送以下问题的反馈:

此网页
DoubleClick for Publishers
DoubleClick for Publishers
需要帮助?请访问我们的支持页面