Obrigatório. O ID do anunciante ao qual os grupos de anúncios pertencem.
Parâmetros de consulta
Parâmetros
pageSize
integer
Tamanho da página solicitada. O valor precisa estar entre 1 e 200. Se não for especificado, o padrão será 100. Retorna o código de erro INVALID_ARGUMENT caso um valor inválido seja especificado.
pageToken
string
Um token que identifica a página de resultados que o servidor retornará. Normalmente, esse é o valor de nextPageToken retornado da chamada anterior para o método youtubeAdGroups.list. Caso não seja especificado, a primeira página de resultados será retornada.
orderBy
string
Campo que classificará a lista. Os valores aceitos são:
displayName (padrão)
entityStatus
A ordem de classificação padrão é crescente. Para especificar a ordem decrescente em um campo, adicione um sufixo "desc" ao nome dele. Exemplo: displayName desc.
filter
string
Permite filtrar por campos personalizados de grupos de anúncios do YouTube.
Sintaxe compatível:
As expressões de filtro são compostas por uma ou mais restrições.
As restrições podem ser combinadas por AND e OR. Uma sequência de restrições usa AND implicitamente.
Uma restrição tem o formato {field} {operator} {value}.
Todos os campos precisam usar o operador EQUALS (=).
Propriedades compatíveis:
adGroupId
displayName
entityStatus
lineItemId
adGroupFormat
Exemplos:
Todos os grupos de anúncios em um item de linha: lineItemId="1234"
Todos os grupos de anúncios ENTITY_STATUS_ACTIVE ou ENTITY_STATUS_PAUSEDYOUTUBE_AND_PARTNERS_AD_GROUP_FORMAT_IN_STREAM de um anunciante: (entityStatus="ENTITY_STATUS_ACTIVE" OR
entityStatus="ENTITY_STATUS_PAUSED") AND
adGroupFormat="YOUTUBE_AND_PARTNERS_AD_GROUP_FORMAT_IN_STREAM"
O comprimento desse campo não pode ultrapassar 500 caracteres.
Um token para recuperar a próxima página de resultados. Transmita esse valor no campo pageToken na chamada seguinte para o método youtubeAdGroups.list para recuperar a próxima página de resultados.