程序化

本指南简要概述了如何通过 API 使用程序化直接交易功能。其中介绍了如何创建提案以及如何执行协商。

Primer

程序化提案类似于 Google Ad Manager 中的订单。程序化提案包含您与买方之间拟议交易的广泛信息。提案及其订单项代表向买方提供的广告资源。

如需了解详情，请访问帮助中心。

通过 API 创建提案

如需创建 Proposal 对象，只需提供名称和程序化买方。程序化买方 ID 可通过界面或 Programmatic_Buyer PQL 表获取。

Java

Proposal proposal = new Proposal();

// Setting required Marketplace information.
ProposalMarketplaceInfo proposalMarketplaceInfo = new ProposalMarketplaceInfo();
proposalMarketplaceInfo.setBuyerAccountId(programmaticBuyerId);

// Set common required fields for a proposal.
proposal.setName("Proposal #" + new Random().nextInt(Integer.MAX_VALUE));
proposal.setPrimaryTraffickerId(primaryTraffickerId);
proposal.setMarketplaceInfo(proposalMarketplaceInfo);
    

在 GitHub 上查看

Python

proposal = {
    # Setting required Marketplace information.
    'isProgrammatic': 'true',
    'marketplaceInfo': {
        'buyerAccountId': programmatic_buyer_id,
    },
    # Set common required fields for proposals.
    'name': 'Proposal #%s' % uuid.uuid4(),
    # ...
}
    

在 GitHub 上查看

PHP

$proposal = new Proposal();
$proposal->setName('Proposal #' . uniqid());

// Set the required Marketplace information.
$proposalMarketplaceInfo = new ProposalMarketplaceInfo();
$proposalMarketplaceInfo->setBuyerAccountId($buyerId);
$proposal->setMarketplaceInfo($proposalMarketplaceInfo);
    

在 GitHub 上查看

C#

// Create a proposal with the minimum required fields.
Proposal proposal = new Proposal()
{
    name = "Programmatic proposal #" + new Random().Next(int.MaxValue),
    // Set required Marketplace information
    marketplaceInfo = new ProposalMarketplaceInfo()
    {
        buyerAccountId = programmaticBuyerId
    }
};
    

在 GitHub 上查看

Ruby

# Create proposal configuration object.
proposal = {
  :marketplace_info => {
    :buyer_account_id => buyer_id
  },
  :name => 'Proposal %s' % SecureRandom.uuid(),
  # ...
}
    

在 GitHub 上查看

在发送给买方进行协商之前，您需要设置其他字段。 提案必须包含广告客户、销售人员、广告投放人员和卖方联系人。

Java

SalespersonSplit primarySalesperson = new SalespersonSplit();
primarySalesperson.setUserId(primarySalespersonId);
proposal.setPrimarySalesperson(primarySalesperson);
    

在 GitHub 上查看

Python

'primarySalesperson': {
    'userId': primary_salesperson_id,
},
'primaryTraffickerId': primary_trafficker_id,
'probabilityOfClose': '100000',
    

在 GitHub 上查看

PHP

// Create salesperson splits for the primary salesperson.
$primarySalesperson = new SalespersonSplit();
$primarySalesperson->setUserId($primarySalespersonId);
$proposal->setPrimarySalesperson($primarySalesperson);

// Set the primary trafficker on the proposal for when it becomes an
// order.
$proposal->setPrimaryTraffickerId($primaryTraffickerId);

$advertiser = new ProposalCompanyAssociation();
$advertiser->setType(
    ProposalCompanyAssociationType::ADVERTISER
);
$advertiser->setCompanyId($advertiserId);
$proposal->setAdvertiser($advertiser);
    

在 GitHub 上查看

C#

// Set fields that are required before sending the proposal to the buyer.
proposal.primaryTraffickerId = primaryTraffickerId;
proposal.sellerContactIds = new long[] { primarySalespersonId };
proposal.primarySalesperson = new SalespersonSplit()
{
    userId = primarySalespersonId,
};
proposal.advertiser = new ProposalCompanyAssociation()
{
    type = ProposalCompanyAssociationType.ADVERTISER,
    companyId = advertiserId
};
    

在 GitHub 上查看

Ruby

:primary_salesperson => {
  :user_id => primary_salesperson_id
},
:primary_trafficker_id => primary_trafficker_id
    

在 GitHub 上查看

由于提案通常由 ProposalLineItem 对象组成，因此下一步是在新创建的提案下添加提案订单项。

程序化提案的状态

下图从 API 的角度描绘了程序化提案在协商过程中的各个时间点。每个状态都由以下字段的各种组合表示：

• ProposalMarketplaceInfo.hasLocalVersionEdits
• ProposalMarketplaceInfo.negotiationStatus
• Proposal.status

如需了解详情，请访问 Ad Manager 帮助中心。

图 1：程序化提案的状态

协商演示

在这里，我们将引导您使用该 API 与买方完成程序化提案协商。我们将参考上图中的状态。

正在准备供买方审核或接受

首先，您需要起草一份程序化提案，其中包含您要发送给买方的提案订单项。这是上图中的 state C。

请求买方审核或接受

当您准备好让买方审核程序化提案时，可以使用 ProposalService.performProposalAction 方法RequestBuyerReview或RequestBuyerAcceptance。这样，您就会进入协商阶段。

协商

在此阶段，可能会发生多种情况。

• 买方可能会不加修改地接受您的程序化提案。
• 买方可能会提议更改。在这种情况下，提案将恢复为草稿状态（图 1 中的 state B）。然后，您需要打开提案进行修改，做出提议的更改，并将其发回给买方审核。
• 您也可以在买方回复之前就决定进行更改。为此，您可以从图 1 中的 state D 打开提案进行修改。

注意：当程序化提案处于可修改状态（图 1 中的 state A）时，它不会自动接收来自 Marketplace 的更新。这意味着，如果买方在您请求买方接受之前进行了更改，那么当您尝试请求买方接受时，您会收到出错提示 NEW_VERSION_FROM_BUYER。如需解决此问题，请执行 DiscardProposalDrafts 操作，这会使用来自市场的最新买方更改覆盖您的本地修改。然后，您需要重新应用本地修改。

此协商过程会一直持续，直到您与买方达成协议。您可以使用 getMarketplaceCommentsByStatement 检索您与买方之间的评论。在state A中，您可以向买方发送评论。为此，您需要使用 updateProposals 更新提案中的 marketplaceComment 字段。当您请求买方接受提案时，系统会发送该评论。

已完成

当您和买方都接受程序化提案后，该提案便会进入已敲定状态（图 1 中的 state F）。然后，Ad Manager 会根据此程序化提案自动创建订单项。

在大多数情况下，您现在已完成程序化提案；不过，您可以在此状态下执行两项操作：

• 您可以通过修改提案中与投放相关的字段，重新打开程序化提案以进行重新协商。为此，您可以打开提案进行修改（图 1 中的 state E to A），做出更改，然后请求买方接受。
• 您可以进行与投放无关的修改，例如更新提案名称，并在根据此交易创建的 Ad Manager 订单和订单项中反映这些更改。为此，您需要修改图 1 中的 state E，然后执行 UpdateOrderWithSellerData 操作。