Customchannels.adunits: list

Requiere autorización

Enumera todos los bloques de anuncios del canal personalizado especificado. Pruébalo ahora.

Solicitud

Solicitud HTTP

GET https://www.googleapis.com/adsense/v1.4/adclients/adClientId/customchannels/customChannelId/adunits

Parámetros

Nombre de parámetro Valor Descripción
Parámetros de ruta
adClientId string Cliente publicitario que contiene el canal personalizado.
customChannelId string Canal personalizado para el que se enumerarán los bloques de anuncios.
Parámetros de consulta opcionales
includeInactive boolean Indica si se deben incluir los bloques de anuncios inactivos. Valor predeterminado: true.
maxResults integer Número máximo de bloques de anuncios que se incluirán en la respuesta. Se utiliza para la paginación. Los valores aceptables son de 0 a 10.000, ambos incluidos.
pageToken string Token de continuación, que se utiliza para la separación en páginas de los bloques de anuncios. Para recuperar la página siguiente, configura este parámetro con el valor "nextPageToken" de la respuesta anterior.

Autorización

Esta solicitud requiere autorización con al menos uno de los siguientes alcances (más información sobre la autenticación y la autorización).

Alcance
https://www.googleapis.com/auth/adsense
https://www.googleapis.com/auth/adsense.readonly

Cuerpo de la solicitud

No proporciones un cuerpo de solicitud con este método.

Respuesta

Si este método se realiza correctamente, el cuerpo de respuesta tendrá la siguiente estructura:

{
  "kind": "adsense#adUnits",
  "etag": etag,
  "nextPageToken": string,
  "items": [
    {
      "code": string,
      "id": string,
      "kind": "adsense#adUnit",
      "name": string,
      "status": string,
      "customStyle": {
        "kind": "adsense#adStyle",
        "colors": {
          "border": string,
          "title": string,
          "background": string,
          "text": string,
          "url": string
        },
        "corners": string,
        "font": {
          "family": string,
          "size": string
        }
      },
      "savedStyleId": string,
      "contentAdsSettings": {
        "type": string,
        "size": string,
        "backupOption": {
          "type": string,
          "color": string,
          "url": string
        }
      },
      "mobileContentAdsSettings": {
        "type": string,
        "size": string,
        "markupLanguage": string,
        "scriptingLanguage": string
      },
      "feedAdsSettings": {
        "type": string,
        "minimumWordCount": integer,
        "frequency": integer,
        "adPosition": string
      }
    }
  ]
}
Nombre de propiedad Valor Descripción Notas
kind string Indica el tipo de lista, en este caso adsense#adUnits.
etag etag Elemento etag de esta respuesta para fines de almacenamiento en caché.
nextPageToken string Token de continuación, que se utiliza para la navegación por los bloques de anuncios. Para recuperar la siguiente página de resultados, establece el valor "pageToken" de la siguiente solicitud con este valor.
items[] list Bloques de anuncios devueltos en esta respuesta de lista.
items[].code string Código de identidad de este bloque de anuncios, que no necesariamente tiene que ser único entre los clientes publicitarios.
items[].id string Identificador único de este bloque de anuncios. Se debe considerar un identificador opaco; no se puede confiar en que esté en un determinado formato.
items[].kind string Indica el tipo de recurso, en este caso adsense#adUnit.
items[].name string Nombre de este bloque de anuncios.
items[].status string Estado de este bloque de anuncios. Los valores posibles son:

NEW: Indica que el bloque de anuncios se ha creado en los últimos siete días y todavía no tiene ninguna actividad asociada a él.

ACTIVE: Indica que ha habido actividad en este bloque de anuncios en los últimos siete días.

INACTIVE: Indica que no ha habido actividad en este bloque de anuncios en los últimos siete días.



Los valores posibles son:
  • "ACTIVE":
  • "INACTIVE":
  • "NEW":
items[].customStyle nested object Información de estilo personalizada específica para este bloque de anuncios.
items[].customStyle.kind string Indica el tipo, en este caso adsense#adStyle.
items[].customStyle.colors object Colores que se incluyen en el estilo. Se representan como seis caracteres hexadecimales, similares a los códigos de color HTML, pero sin el símbolo de almohadilla inicial.
items[].customStyle.colors.border string Color del borde del anuncio.
items[].customStyle.colors.title string Color del título del anuncio.
items[].customStyle.colors.background string Color del fondo del anuncio.
items[].customStyle.colors.text string Color del texto del anuncio.
items[].customStyle.colors.url string Color de la URL del anuncio.
items[].customStyle.corners string Estilo de las esquinas del anuncio.

Los valores posibles son:
  • "SLIGHTLY_ROUNDED":
  • "SQUARE":
  • "VERY_ROUNDED":
items[].customStyle.font object Fuente que se incluye en el estilo.
items[].customStyle.font.family string Familia de la fuente.

Los valores posibles son:
  • "ACCOUNT_DEFAULT_FAMILY":
  • "ADSENSE_DEFAULT_FAMILY":
  • "ARIAL":
  • "LORA":
  • "OPEN_SANS":
  • "OPEN_SANS_LIGHT":
  • "ROBOTO_LIGHT":
  • "TIMES":
  • "UBUNTU_LIGHT":
  • "VERDANA":
items[].customStyle.font.size string Tamaño de la fuente.

Los valores posibles son:
  • "ACCOUNT_DEFAULT_SIZE":
  • "ADSENSE_DEFAULT_SIZE":
  • "LARGE":
  • "MEDIUM":
  • "SMALL":
items[].savedStyleId string ID del estilo de anuncio guardado que contiene la información de estilo de este bloque de anuncios.
items[].contentAdsSettings object Configuración específica de los anuncios de contenido (AFC) y anuncios de contenido para dispositivos móviles de gama alta (AFMC).
items[].contentAdsSettings.type string Tipo de este bloque de anuncios.
items[].contentAdsSettings.size string Tamaño de este bloque de anuncios.
items[].contentAdsSettings.backupOption object Opción alternativa que se utilizará en los casos en que no haya anuncios disponibles.
items[].contentAdsSettings.backupOption.type string Tipo de la opción alternativa. Los valores posibles son: BLANK, COLOR y URL.

Los valores posibles son:
  • "BLANK":
  • "COLOR":
  • "URL":
items[].contentAdsSettings.backupOption.color string Color que se usará cuando el tipo se establezca en COLOR.
items[].contentAdsSettings.backupOption.url string URL que se usará cuando el tipo se establezca URL.
items[].mobileContentAdsSettings object Configuración específica de los anuncios de contenido para móviles WAP (AFMC).
items[].mobileContentAdsSettings.type string Tipo de este bloque de anuncios.
items[].mobileContentAdsSettings.size string Tamaño de este bloque de anuncios.
items[].mobileContentAdsSettings.markupLanguage string Lenguaje de marcas que se utilizará para este bloque de anuncios.

Los valores posibles son:
  • "CHTML":
  • "WML":
  • "XHTML":
items[].mobileContentAdsSettings.scriptingLanguage string Lenguaje de secuencias de comandos que se utilizará para este bloque de anuncios.

Los valores posibles son:
  • "ASP":
  • "CGI":
  • "JSP":
  • "PHP":
items[].feedAdsSettings object Configuración específica de los anuncios en feeds (AFF).
items[].feedAdsSettings.type string Tipo de los anuncios que deben aparecer.
items[].feedAdsSettings.minimumWordCount integer Longitud mínima que debe tener una entrada para que se le adjunten anuncios.
items[].feedAdsSettings.frequency integer Frecuencia con la que deben aparecer los anuncios en el feed (es decir, cada N entradas).
items[].feedAdsSettings.adPosition string Posición de los anuncios relativa a las entradas de feed.

Los valores posibles son:
  • "BOTTOM":
  • "TOP":

Pruébalo

Utiliza el siguiente explorador de APIs para llamar a este método con datos en tiempo real y ver la respuesta.