Method: accounts.adUnits.list

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

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 listar os blocos de anúncios. 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 maiores serão convertidos para 20.000.
pageToken

string

O valor retornado pelo último ListAdUnitsResponse indica que esta é uma continuação de uma chamada adUnits.list anterior e que o sistema deve 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 de 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 da conta solicitada.
nextPageToken

string

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

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte OAuth 2.0 Overview.

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 para integração com o SDK da AdMob. Essa é uma propriedade somente leitura. Exemplo: ca-app-pub-9876543210987654/0123456789
appId

string

O ID visível externamente do app associado a esse bloco de anúncios. 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 fornecido pelo usuário. O comprimento máximo permitido é de 80 caracteres.
adFormat

string

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

"APP_OPEN": formato de anúncio de abertura do app. "BANNER": formato de anúncio banner. "BANNER_INTERSTITIAL": formato legado que pode ser usado como banner ou intersticial. Não é mais possível criar esse formato, mas ele pode ser segmentado por grupos de mediação. "INTERSTITIAL": um anúncio em tela cheia. Os tipos de anúncio aceitos são "RICH_MEDIA" e "VIDEO". "NATIVE": formato de anúncio nativo. "PREMIADO": um anúncio que, depois de visualizado, recebe um callback verificando a visualização para que uma recompensa possa ser dada 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. Aceita apenas 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. Os valores possíveis são:

"RICH_MEDIA": texto, imagem e outras mídias que não são vídeos. "VIDEO": mídia de vídeo.