מעבר ל-Marketplace API

הפעלת ה-API

בדומה לממשקי API אחרים של Authorized Buyers, צריך להפעיל את Marketplace API כדי להשתמש בו. כדי להפעיל את Marketplace API:

  1. נכנסים לדף Google API Enabled APIs. בוחרים את הפרויקט שבו אתם משתמשים כדי לגשת לממשקי API אחרים של שותפים מורשים, כמו Ad Exchange Buyer II או Real-time Bidding API.
  2. לוחצים על הקישור + ENABLE APIS AND SERVICES.
  3. בתיבת החיפוש, מקלידים Authorized Buyers Marketplace API ומקישים על Enter.
  4. בתוצאות החיפוש, בוחרים באפשרות Authorized Buyers Marketplace API.
  5. לוחצים על הלחצן הפעלה כדי להפעיל את Marketplace API.
  6. עכשיו אמורה להיות לכם גישה ל-Marketplace API באמצעות פרטי הכניסה שנוצרו בפרויקט הזה.

עדכון פרטי הכניסה אל OAuth 2.0

תהליכי עבודה קיימים של OAuth 2.0 עם היקף ה-API של Ad Exchange Buyer II צריכים להשתנות כך שישתמשו בהיקף ה-API של Marketplace:

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

מומלץ להשתמש בתהליך Service Account OAuth 2.0 כדי לגשת ל-API. בכל תהליכי התמיכה שנתמכים ב-OAuth 2.0, צריך לציין את היקף ה-API החדש כדי לבקש מ-Google אסימון שיכול לגשת ל-Marketplace API.

מיפוי משאבי API של Ad Exchange Buyer II ל-Marketplace API

לקוחות

אם אתם משתמשים במשאב accounts.clients של Ad Exchange Buyer II API, תוכלו לעבור למשאב buyers.clients של Marketplace API.

שיטות של משאבים

ממשק API של Ad Exchange Buyer II 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 Buyer II API Marketplace API
Client.clientAccountId Client.name

clientAccountId הוא מזהה המשאב של הלקוח.
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 משלב את הפונקציונליות של המשאבים accounts.clients.invitations ו-accounts.clients.users של Ad Exchange Buyer II API במשאב יחיד buyers.clients.users.

שיטות משאבים

ממשק API של Ad Exchange Buyer II 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

רק משתמשים שהערך של state שלהם מוגדר כ-INVITED יתאימו למשתמשים שמוחזרים על ידי 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. מומלץ להשתמש ב- buyers.clients.users.delete כדי למחוק את משתמש הלקוח וליצור אותו מחדש עם השינויים המועדפים.

שדות משאבים

Ad Exchange Buyer II API Marketplace API
ClientUserInvitation.invitationId

השדה הזה נסגר.
ClientUserInvitation.email ClientUser.email
ClientUserInvitation.clientAccountId

השדה הזה לא קיים יותר אצל משתמשי לקוח. במקום זאת, בודקים את הערך של clientAccountId בשם של לקוח ההורה.
ClientUser.userId ClientUser.name

userId הוא מזהה המשאב של המשתמש.
ClientUser.clientAccountId

השדה הזה לא קיים יותר אצל משתמשי לקוח. במקום זאת, בודקים את הערך של clientAccountId בשם של לקוח ההורה.
ClientUser.status ClientUser.state
ClientUser.email ClientUser.email

מוצרים

המשאב הזה והפונקציונליות שלו לא זמינים ב-Marketplace API.

PublisherProfiles

אם אתם משתמשים במשאב accounts.publisherProfiles של Ad Exchange Buyer II API, תוכלו לעבור למשאב buyers.publisherProfiles של Marketplace API.

שיטות של משאבים

ממשק API של Ad Exchange Buyer II Marketplace API
accounts.publisherProfiles.get buyers.publisherProfiles.get
accounts.publisherProfiles.list buyers.publisherProfiles.list

השיטה הזו תומכת עכשיו במסנני רשימות.

שדות משאבים

Ad Exchange Buyer II API API של Marketplace
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

הצעות והצעות סופיות

אם אתם משתמשים במשאב accounts.proposals של Ad Exchange Buyer II API, תוכלו לעבור למשאב buyers.proposals של Marketplace API. מבצעים הופרדו מהצעות למשאב המשנה buyers.proposals.deals. הצעות שהושלמו כבר לא מיוצגות ב-API, כך שתוכלו לשלוט בצורה מפורטת יותר בעסקאות שהושלמו באמצעות המשאב buyers.finalizedDeals.

שיטות של משאבים

ממשק API של Ad Exchange Buyer II Marketplace API
accounts.proposals.accept buyers.proposals.accept

צריך לבצע קריאה אל buyers.proposals.accept רק כשמצב ההצעה הוא BUYER_ACCEPTANCE_REQUESTED.
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

כדי לראות את המבצעים הסופיים בחשבון קונה נתון, צריך להשתמש ב- buyers.finalizedDeals.list. עכשיו אפשר לאחזר עסקאות שהושלמו ברמת המגיש באמצעות bidders.finalizedDeals.list.
accounts.finalizedProposals.pause

אפשר להשתמש ב- buyers.finalizedDeals.pause כדי להשהות עסקאות ספציפיות שהושלמו בחשבון של קונה נתון.
accounts.finalizedProposals.resume

אפשר להשתמש ב- buyers.finalizedDeals.resume כדי להמשיך עסקאות אישיות שהושלמו בחשבון קונה נתון.

שדות משאבים

המשאבים proposals ו-finalizedProposals חולקים את אותה ייצוג של Proposal, עם שלבי העברה דומים.

Ad Exchange Buyer II API API של Marketplace
Proposal.proposalId Proposal.name

השדה proposalId הוא מזהה המשאב של ההצעה.
Proposal.updateTime Proposal.updateTime
Proposal.proposalRevision

Proposal.proposalRevision וגם Deal.proposalRevision
Proposal.deals.dealId Deal.name

dealId הוא מזהה המשאב של העסקה.
Proposal.deals.proposalId Deal.name

proposalId הוא מזהה המשאב של הצעת ההורה.
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 הוא שדה חוזר, אבל הוא אף פעם לא מאוכלס ביותר מרשומות אחת. כתוצאה מכך, הערך programmaticGuaranteedTerms.fixedPrice של Marketplace API מקביל.
Proposal.deals.dealTerms.nonGuaranteedFixedPriceTerms

Deal.preferredDealTerms

שימו לב ש-nonGuaranteedFixedPriceTerms.fixedPrices הוא שדה חוזר, אבל הוא אף פעם לא מאוכלס ביותר מרשומות אחת. כתוצאה מכך, הערך preferredDealTerms.fixedPrice של Marketplace API מקביל.
Proposal.deals.dealTerms.NonGuaranteedAuctionTerms

Deal.privateAuctionTerms

חשוב לשים לב ש-nonGuaranteedAuctionTerms.reservePricesPerBuyer הוא שדה חוזר, אבל הוא אף פעם לא מאוכלס ביותר מרשומה אחת. כתוצאה מכך, הערך של privateAuctionTerms.floorPrice ב-Marketplace API זהה.
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. לדוגמה, המפתח GOOG_CREATIVE_SIZE מ-Ad Exchange Buyer II מתייחס ל-Deal.targeting.inventorySizeTargeting של Marketplace API.
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.

השדה שבו נעשה שימוש תלוי בסוג החשבון של הקונה שמנהל את המשא ומתן. אלה שמות המשאבים של משאב buyers ב-Real-time Bidding API או משאב buyers.clients ב-Marketplace API, בהתאמה.
Proposal.billedBuyer.accountId Proposal.billedBuyer

זהו עכשיו שם משאב שמתייחס לחשבון של קונה, כפי שהוא מיוצג במשאב buyers של Real-time Bidding API.
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