Placements: list

Recupera uma lista de posições, possivelmente filtrada. Esse método é compatível com paginação. Faça um teste agora.

Solicitação

Solicitação HTTP

GET https://www.googleapis.com/dfareporting/v3.4/userprofiles/profileId/placements

Parâmetros

Nome do parâmetro Valor Descrição
Parâmetros de caminho
profileId long ID do perfil de usuário associado a esta solicitação.
Parâmetros de consulta opcionais
advertiserIds long Seleciona somente posições que pertençam a estes anunciantes.
archived boolean Seleciona somente posições arquivadas. Para selecionar posições tanto arquivadas quanto não arquivadas, não defina este campo.
campaignIds long Seleciona somente posições que pertençam a estas campanhas.
compatibilities string Seleciona somente posições associadas a estas compatibilidades. DISPLAY e DISPLAY_INTERSTITIAL se referem à renderização em computadores ou dispositivos móveis para anúncios normais ou intersticiais, respectivamente. APP e APP_INTERSTITIAL são usados para renderização em apps para dispositivos móveis. IN_STREAM_VIDEO se refere à renderização em anúncios em vídeo in-stream desenvolvidos com o padrão VAST.

Os valores aceitáveis são os seguintes:
  • "APP"
  • "APP_INTERSTITIAL"
  • "DISPLAY"
  • "DISPLAY_INTERSTITIAL"
  • "IN_STREAM_AUDIO"
  • "IN_STREAM_VIDEO"
contentCategoryIds long Seleciona somente posições associadas a estas categorias de conteúdo.
directorySiteIds long Seleciona somente posições associadas a estes sites do diretório.
groupIds long Seleciona somente posições que pertençam a estes grupos.
ids long Seleciona somente posições com estes IDs.
maxEndDate string Seleciona somente posições ou grupos que tenham data de término igual ou anterior ao maxEndDate especificado. A data precisa estar no formato "aaaa-MM-dd".
maxResults integer É o número máximo de resultados para retornar. Os valores aceitos vão de 0 a 1000. Padrão: 1000
maxStartDate string Seleciona somente posições ou grupos que tenham data de início igual ou anterior ao maxStartDate especificado. A data precisa estar no formato "aaaa-MM-dd".
minEndDate string Seleciona somente posições ou grupos que tenham data de término igual ou posterior ao minEndDate especificado. A data precisa estar no formato "aaaa-MM-dd".
minStartDate string Seleciona somente posições ou grupos que tenham data de início igual ou posterior ao minStartDate especificado. A data precisa estar no formato "aaaa-MM-dd".
pageToken string É o valor de nextPageToken da página de resultados anterior.
paymentSource string Seleciona somente posições com esta origem de pagamento.

Os valores aceitáveis são os seguintes:
  • "PLACEMENT_AGENCY_PAID"
  • "PLACEMENT_PUBLISHER_PAID"
placementStrategyIds long Seleciona somente posições associadas a estas estratégias de posicionamento.
pricingTypes string Seleciona somente posições com estes tipos de preço.

Os valores aceitáveis são os seguintes:
  • "PRICING_TYPE_CPA"
  • "PRICING_TYPE_CPC"
  • "PRICING_TYPE_CPM"
  • "PRICING_TYPE_CPM_ACTIVEVIEW"
  • "PRICING_TYPE_FLAT_RATE_CLICKS"
  • "PRICING_TYPE_FLAT_RATE_IMPRESSIONS"
searchString string Permite a pesquisa de posições por nome ou ID. Caracteres curinga (*) são permitidos. Por exemplo, "placement*2015" retornará posições com nomes como "placement June 2015", "placement May 2015" ou simplesmente "placements 2015". A maioria das pesquisas também adiciona caracteres curinga implicitamente no começo e no fim da string de pesquisa. Por exemplo, uma string de pesquisa de "placement" corresponderá a posições com o nome "my placement", "placement 2015" ou simplesmente "placement".
siteIds long Seleciona somente posições associadas a estes sites.
sizeIds long Seleciona somente posições associadas a estes tamanhos.
sortField string É o campo que classificará a lista.

Os valores aceitáveis são:
  • "ID" (padrão)
  • "NAME"
sortOrder string Ordem dos resultados classificados.

Os valores aceitáveis são:
  • "ASCENDING" (padrão)
  • "DESCENDING"

Autorização

Esta solicitação requer autorização com o seguinte escopo:

Escopo
https://www.googleapis.com/auth/dfatrafficking

Para mais informações, consulte a página de autenticação e autorização.

Corpo da solicitação

Não forneça um corpo de solicitação com este método.

Resposta

Se for bem-sucedido, esse método retornará um corpo de resposta com esta estrutura:

{
  "kind": "dfareporting#placementsListResponse",
  "nextPageToken": string,
  "placements": [
    placements Resource
  ]
}
Nome da propriedade Valor Descrição Notas
kind string Identifica o tipo de recurso. Valor: a string fixa "dfareporting#placementsListResponse".
placements[] list É uma coleção de posições.
nextPageToken string É o token de paginação a ser usado para a próxima operação da lista.

Faça um teste

Use o APIs Explorer abaixo para chamar esse método em dados ativos e ver a resposta.