Migrar para a API Marketplace

Ativar a API

Semelhante a outros Authorized Buyers você precisa ativar a API API Marketplace antes em que você pode usá-lo. Para ativar a API Marketplace, siga estas etapas:

  1. Acesse APIs ativadas do Console de APIs do Google . Selecione o projeto que você usa para acessar outras APIs do Authorized Buyers, como Comprador II do Ad Exchange ou API Real-time Bidding.
  2. Clique no link + ATIVAR APIS E SERVIÇOS.
  3. Na caixa de pesquisa, digite API Marketplace do Authorized Buyers e pressione Enter.
  4. Nos resultados da pesquisa, selecione API Authorized Buyers Marketplace.
  5. Clique no botão ATIVAR para ativar a API Marketplace.
  6. Agora você pode acessar a API Marketplace com credenciais criados neste projeto.

Atualizar suas credenciais do OAuth 2.0

Os fluxos de trabalho existentes do OAuth 2.0 com o escopo da Ad Exchange Buyer II API precisam ser alterado para usar o escopo da API Marketplace:

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

Recomendamos o uso da conta de serviço OAuth 2.0 para acessar a API. Todos os fluxos do OAuth 2.0 compatíveis precisam especificar a nova API para solicitar um token do Google que possa acessar a API Marketplace.

Como mapear recursos da API de comprador II do Ad Exchange para a API do Marketplace

Clientes

Se você usar a API Ad Exchange Buyer II accounts.clients é possível migrar para a API Marketplace buyers.clients recurso.

Métodos de recursos

API de comprador II do Ad Exchange API Marketplace
accounts.clients.create buyers.clients.create
accounts.clients.get buyers.clients.get
accounts.clients.list buyers.clients.list

Agora, esse método oferece suporte filtros de lista.

accounts.clients.update buyers.clients.patch

Esse método agora oferece suporte a atualizações parciais com a parâmetro updateMask.

Campos de recursos

API de comprador II do Ad Exchange API Marketplace
Client.clientAccountId Client.name

O clientAccountId é o ID do recurso do cliente.
Client.role Client.role
Client.status Client.state
Client.clientName Client.displayName
Client.visibleToSeller Client.sellerVisible
Client.entityType

Este campo foi desativado.
Client.entityId

Este campo foi desativado.
Client.entityName

Este campo foi desativado.
Client.partnerClientId Client.partnerClientId

Convites e Usuários

A API Marketplace combina a funcionalidade da API Ad Exchange Buyer II accounts.clients.invitations e accounts.clients.users recursos em um único buyers.clients.users recurso.

Métodos de recursos

API de comprador II do Ad Exchange 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

Apenas usuários com a state definida como INVITED serão equivalentes aos retornados por accounts.clients.invitations.list

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

Não é mais possível aplicar patches a usuários clientes com a API. Recomendamos que você usa buyers.clients.users.delete para excluir o e recriá-la com as mudanças preferenciais.

Campos de recursos

API de comprador II do Ad Exchange API Marketplace
ClientUserInvitation.invitationId

Este campo foi desativado.
ClientUserInvitation.email ClientUser.email
ClientUserInvitation.clientAccountId

Este campo não existe mais para usuários clientes. Em vez disso, veja clientAccountId no nome do cliente pai.
ClientUser.userId ClientUser.name

O userId é o ID do recurso do usuário.
ClientUser.clientAccountId

Este campo não existe mais para usuários clientes. Em vez disso, veja clientAccountId no nome do cliente pai.
ClientUser.status ClientUser.state
ClientUser.email ClientUser.email

Produtos

Este recurso e a funcionalidade dele não estão disponíveis na API Marketplace.

PublisherProfiles

Se você usar a API Ad Exchange Buyer II accounts.publisherProfiles é possível migrar para a API Marketplace buyers.publisherProfiles recurso.

Métodos de recursos

API de comprador II do Ad Exchange API Marketplace
accounts.publisherProfiles.get buyers.publisherProfiles.get
accounts.publisherProfiles.list buyers.publisherProfiles.list

Agora, esse método oferece suporte filtros de lista.

Campos de recursos

API de comprador II do Ad Exchange API Marketplace
PublisherProfile.publisherProfileId PublisherProfile.name

O publisherProfileId é o recurso do perfil do editor. ID.
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

Este campo foi desativado.
PublisherProfile.googlePlusUrl

Este campo foi desativado.
PublisherProfile.overview PublisherProfile.overview
PublisherProfile.buyerPitchStatement PublisherProfile.pitchStatement
PublisherProfile.topHeadlines PublisherProfile.topHeadlines
PublisherProfile.audienceDescription PublisherProfile.audienceDescription
PublisherProfile.isParent PublisherProfile.isParent

Propostas e FinalizedProposals

Se você usar a API Ad Exchange Buyer II accounts.proposals é possível migrar para a API Marketplace buyers.proposals recurso. Os negócios foram separados das propostas no buyers.proposals.deals sub-recurso. As propostas finalizadas não são mais representadas na API, oferecendo um controle mais granular das transações finalizadas com o buyers.finalizedDeals recurso.

Métodos de recursos

API de comprador II do Ad Exchange API Marketplace
accounts.proposals.accept buyers.proposals.accept

Só chame buyers.proposals.accept quando o estado da proposta for 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

A proposta não terá mais informações sobre as transações.

accounts.proposals.list buyers.proposals.list

As propostas retornadas não terão mais informações sobre ofertas. Se você usa a filtragem de listas, observe que apenas a API Marketplace suporta sintaxe de filtro de lista.
accounts.proposals.pause buyers.finalizedDeals.pause
accounts.proposals.resume buyers.finalizedDeals.resume
accounts.proposals.update buyers.proposals.patch

Esse método agora oferece suporte a atualizações parciais com a parâmetro updateMask.
accounts.finalizedProposals.list

Usar buyers.finalizedDeals.list para ver as transações finalizadas para uma determinada conta de comprador. Agora é possível recuperar transações finalizadas no nível do proponente com bidders.finalizedDeals.list.
accounts.finalizedProposals.pause

Usar buyers.finalizedDeals.pause para pausar uma pessoa as transações finalizadas por uma determinada conta de comprador.
accounts.finalizedProposals.resume

Usar buyers.finalizedDeals.resume para retomar as transações finalizadas por uma determinada conta de comprador.

Campos de recursos

Os recursos proposals e finalizedProposals compartilham o mesmo Proposal e têm etapas de migração semelhantes.

API de comprador II do Ad Exchange API Marketplace
Proposal.proposalId Proposal.name

O proposalId é o ID do recurso da proposta.
Proposal.updateTime Proposal.updateTime
Proposal.proposalRevision

Proposal.proposalRevision e Deal.proposalRevision
Proposal.deals.dealId Deal.name

O dealId é o ID do recurso da transação.
Proposal.deals.proposalId Deal.name

O proposalId é o ID do recurso de proposta pai.
Proposal.deals.createTime Deal.createTime
Proposal.deals.updateTime Deal.updateTime
Proposal.deals.createProductId

Este campo foi desativado.
Proposal.deals.createProductRevision

Este campo foi desativado.
Proposal.deals.displayName Deal.displayName
Proposal.deals.buyerPrivateData.referenceId

Este campo foi desativado. agora ele só é exposto na proposta nível
Proposal.deals.dealTerms.description Deal.description
Proposal.deals.dealTerms.brandingType

Este campo foi desativado.
Proposal.deals.dealTerms.estimatedGrossSpend Deal.estimatedGrossSpend
Proposal.deals.dealTerms.estimatedImpressionsPerDay

Este campo foi desativado.
Proposal.deals.dealTerms.sellerTimeZone Deal.sellerTimeZone
Proposal.deals.dealTerms.guaranteedFixedPriceTerms

Deal.programmaticGuaranteedTerms

Embora guaranteedFixedPriceTerms.fixedPrices seja uma repetido, ele nunca foi preenchido com mais de uma entrada. Conforme como resultado, os recursos da API Marketplace programmaticGuaranteedTerms.fixedPrice é equivalente.
Proposal.deals.dealTerms.nonGuaranteedFixedPriceTerms

Deal.preferredDealTerms

Embora nonGuaranteedFixedPriceTerms.fixedPrices seja um campo repetido, ele nunca foi preenchido com mais de uma entrada. Por isso, os recursos da API Marketplace preferredDealTerms.fixedPrice é equivalente.
Proposal.deals.dealTerms.NonGuaranteedAuctionTerms

Deal.privateAuctionTerms

Embora nonGuaranteedAuctionTerms.reservePricesPerBuyer é um repetido, ele nunca foi preenchido com mais de uma entrada. Conforme como resultado, os recursos da API Marketplace privateAuctionTerms.floorPrice é equivalente.
Proposal.deals.webPropertyCode

Este campo foi desativado.
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

Não é mais possível configurar a segmentação usando uma chave para determinar a categoria de segmentação. No entanto, categorias que podem ser segmentado pode ser encontrado em Deal.targeting. Por exemplo, o A chave GOOG_CREATIVE_SIZE do comprador II do Ad Exchange se refere a APIs Marketplace Deal.targeting.inventorySizeTargeting.
Proposal.deals.targeting Deal.targeting

Foram adicionadas mais categorias de critérios de segmentação.
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

Este campo foi desativado.
Proposal.deals.syndicationProduct

Este campo foi desativado.
Proposal.deals.creativePreApprovalPolicy Deal.creativeRequirements.creativePreApprovalPolicy
Proposal.deals.creativeSafeFrameCompatibility Deal.creativeRequirements.creativeSafeFrameCompatibility
Proposal.deals.dealServingMetadata

Informações semelhantes podem ser encontradas FinalizedDeal.dealPausingInfo.
Proposal.deals.programmaticCreativeSource Deal.creativeRequirements.programmaticCreativeSource
Proposal.deals.deliveryControl Deal.deliveryControl

Foram adicionados detalhes adicionais sobre como as transações serão feitas.
Proposal.deals.isSetupComplete FinalizedDeal.readyToServe

Agora só é possível indicar que uma transação está pronta para veiculação finalizada. Usar a buyers.finalizedDeals.setReadyToServe para indicar que a transação programática garantida finalizada prontos para veiculação.
Proposal.originatorRole Proposal.originatorRole
Proposal.seller.accountId Proposal.publisherProfile

Use o nome do perfil do editor para identificar o vendedor. Você pode ver perfis de editor com o buyers.publisherProfiles recurso.
Proposal.seller.subAccountId Proposal.publisherProfile

Use o nome do perfil do editor para identificar o vendedor. Você pode ver perfis de editor com o buyers.publisherProfiles recurso.
Proposal.buyer.accountId

Proposal.buyer ou Proposal.client.

O campo usado depende do tipo de conta do cliente por um comprador. Esses são os nomes de recursos de uma API Real-time Bidding recurso buyers ou API Marketplace recurso buyers.clients, respectivamente.
Proposal.billedBuyer.accountId Proposal.billedBuyer

Agora, esse é um nome de recurso que se refere a uma conta de comprador como representados no buyers da API Real-time Bidding recurso.
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

Este campo foi desativado.
Proposal.isSetupComplete FinalizedDeal.readyToServe

Agora o acesso é mais granular com buyers.finalizedDeals.

Proposal.lastUpdaterOrCommentorRole Proposal.lastUpdaterOrCommentorRole
Proposal.notes.proposalRevision

Este campo foi desativado.
Proposal.notes.noteId

Este campo foi desativado.
Proposal.notes.createTime Proposal.notes.createTime
Proposal.notes.creatorRole Proposal.notes.creatorRole
Proposal.notes.note Proposal.notes.note
Proposal.termsAndConditions Proposal.termsAndConditions