מעבר ל-Marketplace API

מפעילים את ה-API

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

  1. נכנסים לדף ממשקי API שמופעלים על ידי Google API Console. בוחרים את הפרויקט שבו אתם משתמשים כדי לגשת לממשקי API אחרים של Authorized Buyers, כמו 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 עם היקף Ad Exchange Buyer II API כדי להשתמש בהיקף Marketplace API:

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

כדי לגשת ל-API מומלץ להשתמש בתהליך של Service Account OAuth 2.0. בכל התהליכים הנתמכים ב-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 ממשק API של Marketplace
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.

שדות משאבים

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

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

ממשק API של Ad Exchange Buyer II ממשק API של Marketplace
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 כדי למחוק את משתמש הלקוח וליצור אותו מחדש עם השינויים המועדפים.

שדות משאבים

ממשק API של Ad Exchange Buyer II ממשק API של Marketplace
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 ממשק API של Marketplace
accounts.publisherProfiles.get buyers.publisherProfiles.get
accounts.publisherProfiles.list buyers.publisherProfiles.list

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

שדות משאבים

ממשק API של Ad Exchange Buyer II ממשק 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 ממשק API של Marketplace
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, ושלבי ההעברה שלהם דומים.

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