Migrar para a API Marketplace

Ativar a API

Assim como as APIs de outros Authorized Buyers, você precisa ativar a API Marketplace antes de usá-la. Para ativar a API Marketplace, siga estas etapas:

  1. Acesse a página de APIs ativadas pelo Console de APIs do Google. Selecione o projeto que você usa para acessar outras APIs do Authorized Buyers, como a API Ad Exchange Buyer II ou a API Real-time Bidding.
  2. Clique no link + ATIVAR APIS E SERVIÇOS.
  3. Na caixa de pesquisa, digite API Authorized Buyers Marketplace 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 criadas neste projeto.

Atualizar suas credenciais do OAuth 2.0

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

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

Recomendamos o uso do fluxo do OAuth 2.0 da conta de serviço para acessar a API. Todos os fluxos do OAuth 2.0 aceitos precisam especificar o novo escopo da API para solicitar um token do Google que possa acessar a API Marketplace.

Mapeamento de recursos da API Ad Exchange Buyer II para a API Marketplace

Clientes

Se você usar o recurso accounts.clients da API Ad Exchange Buyer II, poderá migrar para o recurso buyers.clients da API Marketplace.

Métodos de recursos

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

Esse método agora é compatível com filtros de lista.

accounts.clients.update buyers.clients.patch

Esse método agora é compatível com atualizações parciais com o parâmetro updateMask.

Campos de recursos

API Ad Exchange Buyer II 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 dos recursos accounts.clients.invitations e accounts.clients.users da API Ad Exchange Buyer II em um único recurso buyers.clients.users.

Métodos de recursos

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

Apenas os usuários com o state definido 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 corrigir usuários clientes com a API. Recomendamos que você use buyers.clients.users.delete para excluir o usuário cliente e recriá-lo com as mudanças preferidas.

Campos de recursos

API Ad Exchange Buyer II 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, visualize o 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, visualize o 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 o recurso accounts.publisherProfiles da API Ad Exchange Buyer II, poderá migrar para o recurso buyers.publisherProfiles da API Marketplace.

Métodos de recursos

API Ad Exchange Buyer II API Marketplace
accounts.publisherProfiles.get buyers.publisherProfiles.get
accounts.publisherProfiles.list buyers.publisherProfiles.list

Esse método agora é compatível com filtros de lista.

Campos de recursos

API Ad Exchange Buyer II API Marketplace
PublisherProfile.publisherProfileId PublisherProfile.name

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

Se você usar o recurso accounts.proposals da API Ad Exchange Buyer II, poderá migrar para o recurso buyers.proposals da API Marketplace. As transações foram separadas das propostas no subrecurso buyers.proposals.deals. As propostas finalizadas não são mais representadas na API, proporcionando um controle mais granular das transações finalizadas com o recurso buyers.finalizedDeals.

Métodos de recursos

API Ad Exchange Buyer II API Marketplace
accounts.proposals.accept buyers.proposals.accept

Chame buyers.proposals.accept somente 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 as transações. Se você usar a filtragem de lista, a API Marketplace será compatível apenas com a 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 é compatível com atualizações parciais com o parâmetro updateMask.
accounts.finalizedProposals.list

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

Use buyers.finalizedDeals.pause para pausar transações finalizadas individuais em uma determinada conta de comprador.
accounts.finalizedProposals.resume

Use buyers.finalizedDeals.resume para retomar transações finalizadas individuais para uma determinada conta de comprador.

Campos de recursos

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

API Ad Exchange Buyer II 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 de transação.
Proposal.deals.proposalId Deal.name

O proposalId é o ID do recurso da 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 e agora está exposto apenas no nível da proposta.
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

Observe que, embora guaranteedFixedPriceTerms.fixedPrices seja um campo repetido, ele nunca foi preenchido com mais de uma única entrada. Como resultado, o programmaticGuaranteedTerms.fixedPrice da API Marketplace é equivalente.
Proposal.deals.dealTerms.nonGuaranteedFixedPriceTerms

Deal.preferredDealTerms

Observe que, embora nonGuaranteedFixedPriceTerms.fixedPrices seja um campo repetido, ele nunca foi preenchido com mais de uma única entrada. O preferredDealTerms.fixedPrice da API Marketplace é equivalente.
Proposal.deals.dealTerms.NonGuaranteedAuctionTerms

Deal.privateAuctionTerms

Observe que, embora nonGuaranteedAuctionTerms.reservePricesPerBuyer seja um campo repetido, ele nunca foi preenchido com mais de uma única entrada. Como resultado, o privateAuctionTerms.floorPrice da API Marketplace é 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 da segmentação. No entanto, as categorias que podem ser segmentadas podem ser encontradas em Deal.targeting. Por exemplo, a chave GOOG_CREATIVE_SIZE do comprador II do Ad Exchange se refere ao Deal.targeting.inventorySizeTargeting da API Marketplace.
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 no campo FinalizedDeal.dealPausingInfo.
Proposal.deals.programmaticCreativeSource Deal.creativeRequirements.programmaticCreativeSource
Proposal.deals.deliveryControl Deal.deliveryControl

Adicionamos mais detalhes sobre como as transações serão colocadas.
Proposal.deals.isSetupComplete FinalizedDeal.readyToServe

Agora só é possível sinalizar que uma transação está pronta para veiculação se ela estiver finalizada. Use o método buyers.finalizedDeals.setReadyToServe para indicar que sua transação programática garantida finalizada está pronta para veiculação.
Proposal.originatorRole Proposal.originatorRole
Proposal.seller.accountId Proposal.publisherProfile

Use o nome do perfil do editor para identificar o vendedor. É possível ver os perfis dos editores com o recurso buyers.publisherProfiles.
Proposal.seller.subAccountId Proposal.publisherProfile

Use o nome do perfil do editor para identificar o vendedor. É possível ver os perfis dos editores com o recurso buyers.publisherProfiles.
Proposal.buyer.accountId

Proposal.buyer ou Proposal.client.

O campo usado depende do tipo de conta do comprador da negociação. Estes são os nomes de recurso de um recurso buyers da API Real-time Bidding ou da API Marketplace buyers.clients, respectivamente.
Proposal.billedBuyer.accountId Proposal.billedBuyer

Agora, esse é o nome de um recurso que se refere a uma conta de comprador, conforme representado no recurso buyers da API de lances em tempo real.
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