Method: accounts.adUnits.list

Liste os blocos de anúncios na conta especificada da AdMob.

Solicitação HTTP

GET https://admob.googleapis.com/v1/{parent=accounts/*}/adUnits

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. Nome do recurso da conta para a qual os blocos de anúncios serão listados. Exemplo: accounts/pub-9876543210987654

Parâmetros de consulta

Parâmetros
pageSize

integer

O número máximo de blocos de anúncios a serem retornados. Se não for especificado ou for 0, no máximo 10.000 blocos de anúncios serão retornados. O valor máximo é 20.000; valores acima de 20.000 serão convertidos para 20.000.
pageToken

string

o valor retornado pelo último ListAdUnitsResponse; indica que essa é uma continuação de uma chamada adUnits.list anterior e que o sistema precisa retornar a próxima página de dados.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Resposta para a solicitação da lista de blocos de anúncios.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "adUnits": [
    {
      object (AdUnit)
    }
  ],
  "nextPageToken": string
}
Campos
adUnits[]

object (AdUnit)

Os blocos de anúncios resultantes para a conta solicitada.
nextPageToken

string

Se não estiver vazio, indica que pode haver mais blocos de anúncios para a solicitação. Esse valor precisa ser transmitido em uma nova ListAdUnitsRequest.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/admob.readonly

Para mais informações, consulte a Visão geral do OAuth 2.0.

AdUnit

Descreve um bloco de anúncios da AdMob.

Representação JSON 
{
  "name": string,
  "adUnitId": string,
  "appId": string,
  "displayName": string,
  "adFormat": string,
  "adTypes": [
    string
  ]
}
Campos
name

string

Nome do recurso para este bloco de anúncios. O formato é accounts/{publisherId}/adUnits/{ad_unit_id_fragment} Exemplo: accounts/pub-9876543210987654/adUnits/0123456789
adUnitId

string

O ID visível externamente do bloco de anúncios que pode ser usado na integração com o SDK da AdMob. Esta é uma propriedade somente leitura. Exemplo: ca-app-pub-9876543210987654/0123456789
appId

string

O ID visível externamente do app ao qual este bloco de anúncios está associado. Exemplo: ca-app-pub-9876543210987654~0123456789
displayName

string

O nome de exibição do bloco de anúncios, conforme mostrado na interface da AdMob e fornecida pelo usuário. O tamanho máximo permitido é de 80 caracteres.
adFormat

string

Formato do anúncio do bloco de anúncios. Os possíveis valores são os seguintes:

"APP_OPEN" - Formato do anúncio de abertura do app. "BANNER" - Formato de anúncio de banner. "BANNER_INTERSTITIAL" - Formato legado que pode ser usado como banner ou intersticial. Esse formato não pode mais ser criado, mas pode ser segmentado por grupos de mediação. "INTERSTITIAL" - Um anúncio de tela cheia. Os tipos de anúncios compatíveis são "RICH_MEDIA" e "VIDEO". "NATIVO" - Formato de anúncio nativo. "PREMIADO" - Um anúncio que, depois de visualizado, recebe uma chamada de retorno verificando a visualização para que um prêmio possa ser concedido ao usuário. Os tipos de anúncios compatíveis são "RICH_MEDIA" (interativo) e vídeo em que o vídeo não pode ser excluído. "REWARDED_INTERSTITIAL" - Formato de anúncio intersticial premiado. Compatível apenas com o tipo de anúncio em vídeo. Consulte https://support.google.com/admob/answer/9884467.
adTypes[]

string

Tipo de mídia do anúncio compatível com este bloco de anúncios. Valores possíveis:

"RICH_MEDIA" - Texto, imagem e outras mídias que não sejam vídeos. "VÍDEO" - Mídia em vídeo.