Migrar da AdX Seller REST API

O Google Ad Manager oferece uma API DAO para gerar relatórios e manipular entidades de programação, como LineItems. As bibliotecas de cliente estão disponíveis em várias linguagens. Assim como a API AdX Seller, a Ad Manager API usa OAuth2 para autenticação.

Para começar sua primeira solicitação de API, consulte Primeiros passos.

Relatórios na API Ad Manager

O ReportService da API Ad Manager oferece duas maneiras de gerar e fazer o download de relatórios:

  1. Criar uma consulta na IU e executá-la com base no ID dela.
  2. Construir uma ReportQuery ad hoc.

Com qualquer uma das opções, o fluxo de trabalho da API consiste em quatro etapas:

  1. Chame runReportJob.
  2. Procure o status do relatório usando getReportJobStatus.
  3. Encontre o URL do relatório concluído usando getReportDownloadUrlWithOptions.
  4. Faça o download do relatório no URL retornado.

Para mais detalhes, consulte o guia de relatórios.

Fusos horários dos relatórios

Ao contrário da API REST do vendedor do Ad Exchange, nos relatórios da API Ad Manager o padrão é o fuso horário da sua rede. Para mudar isso, defina o campo TimeZoneType.

Mapeamento de métricas e dimensões do AdX para o Ad Manager

Todas as métricas e dimensões compatíveis da API REST do vendedor do Ad Exchange agora estão presentes na API de relatórios do Ad Manager. Alguns nomes foram alterados e outros foram descontinuados. Consulte as tabelas abaixo para mais detalhes.

Métricas / colunas

Esta tabela faz a correspondência entre as métricas do AdX e as colunas do Ad Manager.

Métrica do AdXColuna do Ad ManagerNome da Ferramenta de consulta do Ad Manager
ACTIVE_VIEW_ELIGIBLE_COUNT AD_EXCHANGE_ACTIVE_VIEW_ENABLED_IMPRESSIONS Impressões ativadas do Active View
ACTIVE_VIEW_MEASURABLE_COUNT AD_EXCHANGE_ACTIVE_VIEW_MEASURED_IMPRESSIONS Impressões medidas do Active View
ACTIVE_VIEW_MEASURABLE_RATIO (descontinuado) (descontinuado)
ACTIVE_VIEW_VIEWABLE_COUNT AD_EXCHANGE_ACTIVE_VIEW_VIEWED_IMPRESSIONS Impressões visualizadas do Active View
ACTIVE_VIEW_VIEWABLE_RATIO (descontinuado) (descontinuado)
ACTIVE_VIEW_VIEWABLE_TIME AD_EXCHANGE_AVERAGE_VIEWABLE_TIME Tempo médio visível (s)
AD_IMPRESSIONS AD_EXCHANGE_IMPRESSIONS Impressões do anúncio
AD_IMPRESSIONS_RPM AD_EXCHANGE_AD_ECPM eCPM de anúncio
AD_REQUESTS AD_EXCHANGE_AD_REQUESTS Solicitações de anúncios
AD_REQUESTS_COVERAGE AD_EXCHANGE_COVERAGE Cobertura
AD_REQUESTS_CTR AD_EXCHANGE_AD_REQUEST_CTR CTR de solicitação de anúncio
AD_REQUESTS_RPM AD_EXCHANGE_AD_REQUEST_ECPM eCPM da solicitação de anúncio
CLIQUES AD_EXCHANGE_CLICKS Cliques
COST_PER_CLICK AD_EXCHANGE_CPC CPC
DEALS_AD_REQUESTS AD_EXCHANGE_DEALS_AD_REQUESTS Solicitações de anúncios das transações
DEALS_BID_RESPONSES AD_EXCHANGE_DEALS_BID_RESPONSES Reações dos lances das transações
DEALS_MATCH_RATE AD_EXCHANGE_DEALS_MATCH_RATE Taxa de correspondência das transações
DEALS_MATCHED_REQUESTS AD_EXCHANGE_DEALS_MATCHED_REQUESTS Solicitações correspondentes das transações
GANHOS AD_EXCHANGE_ESTIMATED_REVENUE Receita estimada
INDIVIDUAL_AD_IMPRESSIONS (descontinuado) (descontinuado)
INDIVIDUAL_AD_IMPRESSIONS_CTR AD_EXCHANGE_AD_CTR CTR do anúncio
INDIVIDUAL_AD_IMPRESSIONS_RPM (nova recomendação) AD_EXCHANGE_AD_ECPM (nova recomendação) eCPM de anúncio
LIFT_RATE AD_EXCHANGE_LIFT Aumento
MATCHED_AD_REQUESTS AD_EXCHANGE_MATCHED_REQUESTS Solicitações atendidas
MATCHED_AD_REQUESTS_CTR AD_EXCHANGE_CTR CTR
MATCHED_AD_REQUESTS_RPM AD_EXCHANGE_MATCHED_ECPM eCPM correspondente
VIDEO_AD_ABANDONMENT_RATIO AD_EXCHANGE_VIDEO_ABANDONMENT_RATE Taxa de abandono de vídeo
VIDEO_AD_DROPOFF_RATIO AD_EXCHANGE_VIDEO_DROPOFF_RATE Taxa de desistência do vídeo
VIDEO_AD_QUARTILE_ONE AD_EXCHANGE_VIDEO_QUARTILE_1 Quartil 1 do vídeo
VIDEO_AD_QUARTILE_THREE AD_EXCHANGE_VIDEO_QUARTILE_3 Quartil 3 do vídeo
VIDEO_AD_SKIPPABLE_SKIP_RATIO AD_EXCHANGE_VIDEO_TRUEVIEW_SKIP_RATE Taxa de pulados de TrueView
VIDEO_AD_SKIPPABLE_VIEWS AD_EXCHANGE_VIDEO_TRUEVIEW_VIEWS Visualizações do TrueView
VIDEO_AD_SKIPPABLE_VTR AD_EXCHANGE_VIDEO_TRUEVIEW_VTR VTR de TrueView

Dimensões

Esta tabela faz a correspondência entre as dimensões do AdX e as dimensões do Ad Manager.

Dimensão do AdXDimensão do Ad ManagerNome da Ferramenta de consulta do Ad Manager
AD_CLIENT_ID AD_EXCHANGE_WEB_PROPERTY_CODE Propriedade da web
AD_LOCATION AD_EXCHANGE_AD_LOCATION Locais do anúncio
AD_TAG_NAME AD_EXCHANGE_TAG_NAME Tags
AD_UNIT_SIZE_CODE AD_EXCHANGE_INVENTORY_SIZE_CODE (Indisponível)
AD_UNIT_SIZE_NAME AD_EXCHANGE_INVENTORY_SIZE Tamanhos de inventário
ADVERTISER_DOMAIN AD_EXCHANGE_ADVERTISER_DOMAIN Domínios de anunciantes
ADVERTISER_NAME AD_EXCHANGE_ADVERTISER_NAME Anunciantes
ADVERTISER_VERTICAL AD_EXCHANGE_ADVERTISER_VERTICAL Indústrias do anunciante
AGENCY_NAME AD_EXCHANGE_AGENCY Agências
BID_TYPE_CODE AD_EXCHANGE_BID_TYPE_CODE (Indisponível)
BRAND_NAME AD_EXCHANGE_BRAND_NAME Marcas
BRANDING_TYPE_CODE AD_EXCHANGE_BRANDING_TYPE_CODE (Indisponível)
BRANDING_TYPE_NAME AD_EXCHANGE_BRANDING_TYPE Tipos de branding
BUYER_NETWORK_ID AD_EXCHANGE_BUYER_NETWORK_ID (Indisponível)
BUYER_NETWORK_NAME AD_EXCHANGE_BUYER_NETWORK_NAME Redes de compradores
COUNTRY_CODE AD_EXCHANGE_COUNTRY_CODE (Indisponível)
COUNTRY_NAME AD_EXCHANGE_COUNTRY_NAME Países
CREATIVE_SIZE AD_EXCHANGE_CREATIVE_SIZES Tamanhos de criativo
CUSTOM_CHANNEL_CODE AD_EXCHANGE_CUSTOM_CHANNEL_CODE (Indisponível)
CUSTOM_CHANNEL_ID AD_EXCHANGE_CUSTOM_CHANNEL_ID (Indisponível)
CUSTOM_CHANNEL_NAME AD_EXCHANGE_CHANNEL_NAME Canais
DATA AD_EXCHANGE_DATE Dias
DEAL_ID AD_EXCHANGE_DEAL_ID IDs da oferta
DEAL_NAME AD_EXCHANGE_DEAL_NAME Nomes de transações
DFP_AD_UNIT_ID AD_EXCHANGE_DFP_AD_UNIT_ID (Indisponível)
DFP_AD_UNITS AD_EXCHANGE_DFP_AD_UNIT Blocos de anúncios do DFP
DFP_REQUEST_SOURCE AD_EXCHANGE_REQUEST_SOURCES Origens das solicitações
DOMAIN_NAME AD_EXCHANGE_SITE_NAME Sites
DSP_NAME AD_EXCHANGE_DSP_BUYER_NETWORK_NAME DSPs
EXPANSION_TYPE_NAME AD_EXCHANGE_EXPANSION_TYPE Tipos de expansíveis
INVENTORY_OWNERSHIP AD_EXCHANGE_INVENTORY_OWNERSHIP Propriedade do inventário
INVENTORY_PARTNER_NAME AD_EXCHANGE_NETWORK_PARTNER_NAME Nomes dos parceiros de rede
MOBILE_APP_NAME AD_EXCHANGE_MOBILE_APP_NAME Nomes de aplicativos
MOBILE_CARRIER_NAME AD_EXCHANGE_MOBILE_CARRIER_NAME Nomes das operadoras
MOBILE_DEVICE_NAME AD_EXCHANGE_MOBILE_DEVICE_NAME Dispositivo
MOBILE_INVENTORY_TYPE AD_EXCHANGE_MOBILE_INVENTORY_TYPE Tipos de inventário
MOBILE_OS_VERSION AD_EXCHANGE_OPERATING_SYSTEM Sistemas operacionais
MOBILE_USER_BANDWIDTH AD_EXCHANGE_USER_BANDWIDTH_NAME Largura de banda
MONTH AD_EXCHANGE_MONTH Meses
PLATFORM_TYPE_NAME AD_EXCHANGE_DEVICE_CATEGORY Categorias de dispositivo
PRODUCT_CODE AD_EXCHANGE_PRODUCT_CODE (Indisponível)
PRODUCT_NAME AD_EXCHANGE_PRODUCT_NAME Produtos
TARGETING_TYPE_CODE AD_EXCHANGE_TARGETING_TYPE_CODE (Indisponível)
TARGETING_TYPE_NAME AD_EXCHANGE_TARGETING_TYPE Tipos de segmentação
TRANSACTION_TYPE_CODE AD_EXCHANGE_TRANSACTION_TYPE_CODE (Indisponível)
TRANSACTION_TYPE_NAME AD_EXCHANGE_TRANSACTION_TYPE Tipos de transação
URL_CHANNEL_ID AD_EXCHANGE_URL_ID (Indisponível)
URL_CHANNEL_NAME AD_EXCHANGE_URL URLs
VIDEO_AD_DURATION AD_EXCHANGE_VIDEO_AD_DURATION (Indisponível)
VIDEO_AD_DURATION_RAW AD_EXCHANGE_VIDEO_AD_DURATION_RAW Durações dos anúncios em vídeo
VIDEO_AD_FORMAT AD_EXCHANGE_VIDEO_AD_TYPE Tipos de anúncio em vídeo
WEEK AD_EXCHANGE_WEEK Semanas
WINNING_BID_RULE_ID AD_EXCHANGE_PRICING_RULE_ID (Indisponível)
WINNING_BID_RULE_NAME AD_EXCHANGE_PRICING_RULE_NAME Regras de precificação