プログラマティック

このガイドでは、API を介してプログラマティック ダイレクト機能を使用する方法の概要を説明します。提案の作成方法と交渉を行う方法について説明します。

Primer

プログラマティック プロポーザルは、Google アド マネージャーのオーダーに似ています。プログラマティック プロポーザルには、お客様と購入者との間で提案された取引に関する広範な情報が含まれています。プロポーザルとその広告申込情報は、バイヤーに対する広告枠の提案を表します。

詳しくは、ヘルプセンターをご覧ください。

API を使用してプロポーザルを作成する

Proposal オブジェクトの作成に必要なのは、名前とプログラマティック購入者のみです。プログラマティック バイヤー ID は、UI または 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);

Python

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

PHP

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

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

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
    }
};

Ruby

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

交渉のために購入者に送信する前に、追加のフィールドを設定する必要があります。プロポーザルには、広告主、営業担当者、広告担当者、販売者の連絡先が含まれている必要があります。

Java

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

Python

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

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);

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
};

Ruby

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

プロポーザルは通常 ProposalLineItem オブジェクトで構成されるため、次のステップでは、新しく作成したプロポーザルの下にプロポーザル広告申込情報を追加します。

プログラマティック プロポーザルのステータス

次の図は、API の観点から、交渉プロセスのさまざまな時点でのプログラマティック プロポーザルを示しています。各状態は、次のフィールドのさまざまな組み合わせで表されます。

詳しくは、アド マネージャー ヘルプセンターをご覧ください。

マーケットプレイスとのやり取り中にプログラマティック プロポーザルが取り得る状態。
図 1: プログラマティック プロポーザルの状態

交渉のチュートリアル

ここでは、API を使用して購入者とのプログラマティック提案の交渉を完了する方法について説明します。上記の図の状態を参照します。

購入者の審査または承認に向けて準備中

まず、購入者に送信するプロポーザル広告申込情報を含むプログラマティック プロポーザルの下書きを作成する必要があります。上の図の state C です。

購入者の審査または承認をリクエストする

プログラマティック プロポーザルを購入者に審査してもらう準備ができたら、ProposalService.performProposalAction メソッドを使用して RequestBuyerReview または RequestBuyerAcceptance を実行できます。交渉フェーズに移行します。

交渉

このフェーズでは、さまざまなことが起こる可能性があります。

  • 購入者は、変更なしでプログラマティック プロポーザルを承認できます。
  • 購入者が変更を提案する場合があります。この場合、プロポーザルは下書き状態（図 1 の state B）に戻ります。その後、プロポーザルを開いて編集し、提案された変更を加えて、購入者の審査のために返送する必要があります。
  • 購入者からの返信を待たずに変更することもできます。これを行うには、図 1 の state D から提案を開いて編集します。

この交渉は、購入者との間で合意に達するまで続きます。販売者と購入者の間のコメントは、getMarketplaceCommentsByStatement を使用して取得できます。state A の間は、購入者にコメントを送信できます。これを行うには、updateProposals を使用して、プロポーザルの marketplaceComment フィールドを更新する必要があります。コメントは、購入者の承認をリクエストしたときに送信されます。

最終処理済み

パブリッシャーと購入者の両方がプログラマティック プロポーザルを承認すると、プロポーザルは確定状態になります（図 1 の state F）。アド マネージャーでは、このプログラマティック プロポーザルから広告申込情報が自動的に作成されます。

ほとんどの場合、これでプログラマティック プロポーザルは完了です。ただし、この状態から実行できるアクションが 2 つあります。

  • プロポーザルの配信関連フィールドを編集することで、プログラマティック プロポーザルを再交渉のために再度開くことができます。これを行うには、プロポーザルを開いて編集（図 1 の state E to A）し、変更を加えてから、購入者に承認をリクエストします。
  • プロポーザルの名前の更新など、配信に関連しない編集を行い、この変更をこの取引から作成されたアド マネージャーのオーダーと広告申込情報に反映させることができます。これを行うには、図 1 の state E を編集してから、UpdateOrderWithSellerData アクションを実行します。