Marketplace API に移行する

API を有効にする

他の認定バイヤーと同様に使用するには、Cloud Functions の Marketplace API 使用できます。Marketplace API は、次の手順で有効にできます。

  1. Google API Console 対応の API に移動します。 ページをご覧ください。[ 他の認定バイヤー API( Ad Exchange 購入者 II または Real-time Bidding API
  2. [+ API とサービスの有効化] リンクをクリックします。
  3. 検索ボックスに「認定バイヤーのマーケットプレイス API」と入力して Enter キーを押します。
  4. 検索結果で [認定バイヤーのマーケットプレイス API] を選択します。
  5. [有効にする] ボタンをクリックして Marketplace API を有効にします。
  6. 認証情報を使用して Marketplace API にアクセスできるようになりました 作成されます。

OAuth 2.0 認証情報を更新する

Ad Exchange Buyer II API スコープを使用する既存の OAuth 2.0 ワークフローは、 Marketplace API スコープを使用するように変更:

https://www.googleapis.com/auth/authorized-buyers-marketplace

サービス アカウント OAuth 2.0 の使用をおすすめします。 API にアクセスするフローを示しています。サポートされているすべての OAuth 2.0 フローで新しい API を指定する必要があります スコープを使用して、Marketplace API にアクセスできるトークンを Google にリクエストできます。

Ad Exchange Buyer II API リソースと Marketplace API のマッピング

クライアント

Ad Exchange Buyer II API を使用している場合 accounts.clients Marketplace API の buyers.clients リソースです。

リソース メソッド

Ad Exchange 購入者 II API Marketplace API
accounts.clients.create buyers.clients.create
accounts.clients.get buyers.clients.get
accounts.clients.list buyers.clients.list

このメソッドは現在、 リストフィルタ

accounts.clients.update buyers.clients.patch

このメソッドは現在、 updateMask パラメータ。

リソース フィールド

Ad Exchange 購入者 II API Marketplace API
Client.clientAccountId Client.name

clientAccountId は、クライアント リソース ID です。

Client.role Client.role
Client.status Client.state
Client.clientName Client.displayName
Client.visibleToSeller Client.sellerVisible
Client.entityType

このフィールドは廃止されました。

Client.entityId

このフィールドは廃止されました。

Client.entityName

このフィールドは廃止されました。

Client.partnerClientId Client.partnerClientId

招待状とユーザー

Marketplace API は、Ad Exchange Buyer II API の機能を統合 accounts.clients.invitations および accounts.clients.users 1 つのリソースに buyers.clients.users リソースです。

リソース メソッド

Ad Exchange 購入者 II API Marketplace API
accounts.clients.invitations.create buyers.clients.users.create
accounts.clients.invitations.get buyers.clients.users.get
accounts.clients.invitations.list buyers.clients.users.list

stateINVITED に設定されているユーザーのみ このメソッドは、 accounts.clients.invitations.list

accounts.clients.users.get buyers.clients.users.get
accounts.clients.users.list buyers.clients.users.list
accounts.clients.users.update

API を使用してクライアント ユーザーにパッチを適用することはできなくなりました。おすすめの方法 <ph type="x-smartling-placeholder"></ph> buyers.clients.users.delete を実行して、 作成し、必要な変更を加えて再作成します。

リソース フィールド

Ad Exchange 購入者 II API Marketplace API
ClientUserInvitation.invitationId

このフィールドは廃止されました。

ClientUserInvitation.email ClientUser.email
ClientUserInvitation.clientAccountId

クライアント ユーザーのこのフィールドは存在しません。代わりに、 親クライアントの名前の clientAccountId

ClientUser.userId ClientUser.name

userId は、ユーザー リソース ID です。

ClientUser.clientAccountId

クライアント ユーザーのこのフィールドは存在しません。代わりに、 親クライアントの名前の clientAccountId

ClientUser.status ClientUser.state
ClientUser.email ClientUser.email

商品

このリソースとその機能は、Marketplace API では使用できません。

PublisherProfiles

Ad Exchange Buyer II API を使用している場合 accounts.publisherProfiles Marketplace API の buyers.publisherProfiles リソースです。

リソース メソッド

Ad Exchange 購入者 II API Marketplace API
accounts.publisherProfiles.get buyers.publisherProfiles.get
accounts.publisherProfiles.list buyers.publisherProfiles.list

このメソッドは現在、 リストフィルタ

リソース フィールド

Ad Exchange 購入者 II API Marketplace API
PublisherProfile.publisherProfileId PublisherProfile.name

publisherProfileId はパブリッシャー プロフィール リソースです。 あります。

PublisherProfile.seller.accountId PublisherProfile.seller.accountId
PublisherProfile.seller.subAccountId PublisherProfile.seller.subAccountId
PublisherProfile.displayName PublisherProfile.displayName
PublisherProfile.domains PublisherProfile.domains
PublisherProfile.mobileApps PublisherProfile.mobileApps
PublisherProfile.logoUrl PublisherProfile.logoUrl
PublisherProfile.directDealsContact PublisherProfile.directDealsContact
PublisherProfile.programmaticDealsContact PublisherProfile.programmaticDealsContact
PublisherProfile.mediaKitUrl PublisherProfile.mediaKitUrl
PublisherProfile.samplePageUrl PublisherProfile.samplePageUrl
PublisherProfile.rateCardUrl

このフィールドは廃止されました。

PublisherProfile.googlePlusUrl

このフィールドは廃止されました。

PublisherProfile.overview PublisherProfile.overview
PublisherProfile.buyerPitchStatement PublisherProfile.pitchStatement
PublisherProfile.topHeadlines PublisherProfile.topHeadlines
PublisherProfile.audienceDescription PublisherProfile.audienceDescription
PublisherProfile.isParent PublisherProfile.isParent

提案とFinalizedProposals

Ad Exchange Buyer II API を使用している場合 accounts.proposals Marketplace API の buyers.proposals リソースです。ディールは、プロポーザルから buyers.proposals.deals サブリソースです。確定した提案は API で表現されなくなるため、 取引の成立を細かく管理できます buyers.finalizedDeals リソースです。

リソース メソッド

Ad Exchange 購入者 II API Marketplace API
accounts.proposals.accept buyers.proposals.accept

プロポーザルのステータスが BUYER_ACCEPTANCE_REQUESTED の場合にのみ、buyers.proposals.accept を呼び出します。

accounts.proposals.addNote buyers.proposals.addNote
accounts.proposals.cancelNegotiation buyers.proposals.cancelNegotiation
accounts.proposals.completeSetup buyers.finalizedDeals.setReadyToServe
accounts.proposals.create buyers.proposals.sendRfp
accounts.proposals.get buyers.proposals.get

プロポーザルには、今後取引に関する情報が含まれなくなります。

accounts.proposals.list buyers.proposals.list

なお、返される提案には、 いくつか見てみましょうリスト フィルタリングを使用する場合、Marketplace API のみが をサポートしています リスト フィルタ構文をご覧ください。

accounts.proposals.pause buyers.finalizedDeals.pause
accounts.proposals.resume buyers.finalizedDeals.resume
accounts.proposals.update buyers.proposals.patch

このメソッドは現在、 updateMask パラメータ。

accounts.finalizedProposals.list

<ph type="x-smartling-placeholder"></ph>を使用してください buyers.finalizedDeals.list: 確定した取引を確認する 特定の購入アカウントに対する 追加の課金ができます確定した取引を取得できるようになりました (を含むビッダー レベル) bidders.finalizedDeals.list

accounts.finalizedProposals.pause

<ph type="x-smartling-placeholder"></ph>を使用してください buyers.finalizedDeals.pause: 個別に一時停止します 特定の購入者アカウントの取引を確定できます

accounts.finalizedProposals.resume

<ph type="x-smartling-placeholder"></ph>を使用してください buyers.finalizedDeals.resume - 個別に再開します 特定の購入者アカウントの取引を確定できます

リソース フィールド

proposals リソースと finalizedProposals リソースは同じ Proposal を共有します 同様の移行手順があります。

Ad Exchange 購入者 II API Marketplace API
Proposal.proposalId Proposal.name

proposalId は、プロポーザル リソース ID です。

Proposal.updateTime Proposal.updateTime
Proposal.proposalRevision

Proposal.proposalRevisionDeal.proposalRevision

Proposal.deals.dealId Deal.name

dealId は取引のリソース ID です。

Proposal.deals.proposalId Deal.name

proposalId は、親プロポーザル リソース ID です。

Proposal.deals.createTime Deal.createTime
Proposal.deals.updateTime Deal.updateTime
Proposal.deals.createProductId

このフィールドは廃止されました。

Proposal.deals.createProductRevision

このフィールドは廃止されました。

Proposal.deals.displayName Deal.displayName
Proposal.deals.buyerPrivateData.referenceId

このフィールドは廃止されました。現在はそのプロポーザルだけの できます。

Proposal.deals.dealTerms.description Deal.description
Proposal.deals.dealTerms.brandingType

このフィールドは廃止されました。

Proposal.deals.dealTerms.estimatedGrossSpend Deal.estimatedGrossSpend
Proposal.deals.dealTerms.estimatedImpressionsPerDay

このフィールドは廃止されました。

Proposal.deals.dealTerms.sellerTimeZone Deal.sellerTimeZone
Proposal.deals.dealTerms.guaranteedFixedPriceTerms

Deal.programmaticGuaranteedTerms

なお、guaranteedFixedPriceTerms.fixedPrices は 複数のエントリが入力されることはありません。として Marketplace API の programmaticGuaranteedTerms.fixedPrice と同等です。

Proposal.deals.dealTerms.nonGuaranteedFixedPriceTerms

Deal.preferredDealTerms

なお、nonGuaranteedFixedPriceTerms.fixedPrices は 複数のエントリが入力されることはありません。 その結果、Marketplace API の preferredDealTerms.fixedPrice と同等です。

Proposal.deals.dealTerms.NonGuaranteedAuctionTerms

Deal.privateAuctionTerms

なお、 nonGuaranteedAuctionTerms.reservePricesPerBuyer は 複数のエントリが入力されることはありません。として Marketplace API の privateAuctionTerms.floorPrice と同等です。

Proposal.deals.webPropertyCode

このフィールドは廃止されました。

Proposal.deals.sellerContacts Proposal.sellerContacts
Proposal.deals.availableStartTime Proposal.flightStartTime
Proposal.deals.availableEndTime Proposal.flightEndTime
Proposal.deals.description Proposal.description
Proposal.deals.targetingCriterion Deal.targeting

キーを使用してターゲティングを設定することができなくなりました。 ターゲティングカテゴリを特定するカテゴリは ターゲットは Deal.targeting にあります。たとえば、 Ad Exchange 購入者 II の GOOG_CREATIVE_SIZE キーは参照しています Marketplace API Deal.targeting.inventorySizeTargeting

Proposal.deals.targeting Deal.targeting

ターゲティング条件のカテゴリが追加されました。

Proposal.deals.creativeRestrictions.creativeFormat Deal.creativeRequirements.creativeFormat
Proposal.deals.creativeRestrictions.skippableAdType Deal.creativeRequirements.skippableAdType
Proposal.deals.creativeRestrictions.creativeSpecifications.creativeSize Deal.targeting.inventorySizeTargeting
Proposal.deals.externalDealId

このフィールドは廃止されました。

Proposal.deals.syndicationProduct

このフィールドは廃止されました。

Proposal.deals.creativePreApprovalPolicy Deal.creativeRequirements.creativePreApprovalPolicy
Proposal.deals.creativeSafeFrameCompatibility Deal.creativeRequirements.creativeSafeFrameCompatibility
Proposal.deals.dealServingMetadata

詳しくは、 FinalizedDeal.dealPausingInfo フィールド。

Proposal.deals.programmaticCreativeSource Deal.creativeRequirements.programmaticCreativeSource
Proposal.deals.deliveryControl Deal.deliveryControl

セールの実施方法に関する追加情報が追加されました。

Proposal.deals.isSetupComplete FinalizedDeal.readyToServe

取引が配信可能な状態になっている場合のみ、 ファイナライズされます。buyers.finalizedDeals.setReadyToServe を使用する 確定されたプログラマティック保証型取引を 作成できます

Proposal.originatorRole Proposal.originatorRole
Proposal.seller.accountId Proposal.publisherProfile

パブリッシャー プロフィール名を使用して販売者を特定します。詳細を確認するには、 buyers.publisherProfilesを含むパブリッシャー プロフィール リソースです。

Proposal.seller.subAccountId Proposal.publisherProfile

パブリッシャー プロフィール名を使用して販売者を特定します。詳細を確認するには、 buyers.publisherProfilesを含むパブリッシャー プロフィール リソースです。

Proposal.buyer.accountId

Proposal.buyer または Proposal.client

使用される項目は、交渉を行うアカウントのタイプによって異なります。 ありますReal-Time Bidding API または 2 つの API のリソース名で buyers リソース、または Marketplace API buyers.clients リソースを使用します。

Proposal.billedBuyer.accountId Proposal.billedBuyer

これは、購入者アカウントを参照するリソース名です。 Real-time Bidding API の buyers で表されます。 リソースです。

Proposal.displayName Proposal.displayName
Proposal.proposalState Proposal.state
Proposal.isRenegotiating Proposal.isRenegotiating
Proposal.buyerPrivateData Proposal.buyerPrivateData
Proposal.sellerContacts Proposal.sellerContacts
Proposal.buyerContacts Proposal.buyerContacts
Proposal.privateAuctionId

このフィールドは廃止されました。

Proposal.isSetupComplete FinalizedDeal.readyToServe

buyers.finalizedDeals でより細かくアクセスできるようになりました。

Proposal.lastUpdaterOrCommentorRole Proposal.lastUpdaterOrCommentorRole
Proposal.notes.proposalRevision

このフィールドは廃止されました。

Proposal.notes.noteId

このフィールドは廃止されました。

Proposal.notes.createTime Proposal.notes.createTime
Proposal.notes.creatorRole Proposal.notes.creatorRole
Proposal.notes.note Proposal.notes.note
Proposal.termsAndConditions Proposal.termsAndConditions