Accounts.customchannels.adunits: list

Требуется авторизация

Создает список всех рекламных блоков для указанного клиентского канала. Попробовать...

Запрос

HTTP-запрос

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

Параметры

Имя параметра Значение Описание
Параметры пути
accountId string Аккаунт, с которым связан рекламный клиент.
adClientId string Рекламный клиент, к которому относится выбранный клиентский канал.
customChannelId string Клиентский канал, для которого создается список рекламных блоков.
Необязательные параметры запроса
includeInactive boolean Указывает, нужно ли учитывать неактивные рекламные блоки. Значение по умолчанию: true.
maxResults integer Максимальное число рекламных блоков в ответе. Используется для разбивки на страницы. Возможные значения: от 0 до 10000 включительно.
pageToken string Токен продолжения. Используется для постраничного просмотра рекламных блоков. Чтобы получить следующую страницу результатов, задайте для этого параметра значение nextPageToken из предыдущего ответа.

Авторизация

Этот запрос требует авторизации с использованием хотя бы одного из указанных ниже диапазонов. Подробнее об аутентификации и авторизации...

Диапазон
https://www.googleapis.com/auth/adsense
https://www.googleapis.com/auth/adsense.readonly

Тело запроса

При работе с данным методом тело запроса не используется.

Ответ

В случае успеха этот метод возвращает тело ответа со следующей структурой:

  "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
      }
    }
  ]
}
Имя свойства Значение Описание Примечания
kind string Тип списка, в данном случае adsense#adUnits.
etag etag ETag данного ответа (для кеширования).
nextPageToken string Токен продолжения. Используется для постраничного просмотра рекламных блоков. Чтобы получить следующую страницу результатов, необходимо присвоить это значение параметру pageToken в следующем запросе.
items[] list Рекламные блоки, возвращаемые в данном ответе.
items[].code string Индивидуальный код рекламного блока, не обязательно уникальный в данном рекламном клиенте.
items[].id string Уникальный идентификатор данного рекламного блока. Это непрозрачный идентификатор без какого-либо определенного формата.
items[].kind string Тип ресурса, в данном случае adsense#adUnit.
items[].name string Название рекламного блока.
items[].status string Статус этого рекламного блока. Возможные значения:

NEW означает, что рекламный блок создан не более 7 дней назад и с ним ещё не производились никакие действия.

ACTIVE означает, что за последние 7 дней с рекламным блоком производились действия.

INACTIVE означает, что за последние 7 дней с рекламным блоком не производилось никаких действий.



Возможные значения:
  • "ACTIVE":
  • "INACTIVE":
  • "NEW":
items[].customStyle nested object Информация о собственном стиле объявлений, выбранном для данного рекламного блока.
items[].customStyle.kind string Тип, в данном случае adsense#adStyle.
items[].customStyle.colors object Цвета, входящие в стиль. Представляются шестью десятичными числами, аналогично цветовым кодам HTML, но без знака решетки в начале.
items[].customStyle.colors.border string Цвет рамки объявления.
items[].customStyle.colors.title string Цвет заголовка объявления.
items[].customStyle.colors.background string Цвет фона объявления.
items[].customStyle.colors.text string Цвет текста объявления.
items[].customStyle.colors.url string Цвет URL объявления.
items[].customStyle.corners string Стиль углов объявления.

Возможные значения:
  • "SLIGHTLY_ROUNDED":
  • "SQUARE":
  • "VERY_ROUNDED":
items[].customStyle.font object Шрифт, входящий в стиль.
items[].customStyle.font.family string Семейство шрифтов.

Возможные значения:
  • "ACCOUNT_DEFAULT_FAMILY":
  • "ADSENSE_DEFAULT_FAMILY":
  • "ARIAL":
  • "LORA":
  • "OPEN_SANS":
  • "OPEN_SANS_LIGHT":
  • "ROBOTO_LIGHT":
  • "TIMES":
  • "UBUNTU_LIGHT":
  • "VERDANA":
items[].customStyle.font.size string Размер шрифта.

Возможные значения:
  • "ACCOUNT_DEFAULT_SIZE":
  • "ADSENSE_DEFAULT_SIZE":
  • "LARGE":
  • "MEDIUM":
  • "SMALL":
items[].savedStyleId string Идентификатор сохраненного стиля объявлений, содержащего информацию о стиле данного рекламного блока.
items[].contentAdsSettings object Настройки, относящиеся к объявлениям AdSense для контента и объявлениям для показа на мобильных устройствах высокого класса (AdSense для мобильного контента).
items[].contentAdsSettings.type string Тип рекламного блока.
items[].contentAdsSettings.size string Размер рекламного блока.
items[].contentAdsSettings.backupOption object Резервный вариант на случай, если нет ни одного доступного объявления.
items[].contentAdsSettings.backupOption.type string Тип резервного варианта. Возможные значения: BLANK, COLOR и URL.

Возможные значения:
  • "BLANK":
  • "COLOR":
  • "URL":
items[].contentAdsSettings.backupOption.color string Если выбран тип COLOR – цвет, который будет использоваться в случае отсутствия объявлений.
items[].contentAdsSettings.backupOption.url string Если выбран тип URL – URL-адрес.
items[].mobileContentAdsSettings object Настройки, относящиеся к мобильным WAP-объявлениям (AdSense для мобильного контента).
items[].mobileContentAdsSettings.type string Тип рекламного блока.
items[].mobileContentAdsSettings.size string Размер рекламного блока.
items[].mobileContentAdsSettings.markupLanguage string Язык разметки, который следует использовать для этого рекламного блока.

Возможные значения:
  • "CHTML":
  • "WML":
  • "XHTML":
items[].mobileContentAdsSettings.scriptingLanguage string Скриптовый язык, который следует использовать для этого рекламного блока.

Возможные значения:
  • "ASP":
  • "CGI":
  • "JSP":
  • "PHP":
items[].feedAdsSettings object Настройки объявлений в фидах (AdSense для фидов).
items[].feedAdsSettings.type string Тип принимаемых объявлений.
items[].feedAdsSettings.minimumWordCount integer Минимальная длина записи для размещения объявлений.
items[].feedAdsSettings.frequency integer Частота показа объявлений в фиде (например, через каждые N записей).
items[].feedAdsSettings.adPosition string Положение объявлений относительно записей в фиде.

Возможные значения:
  • "BOTTOM":
  • "TOP":

Попробуйте!

Воспользуйтесь сервисом API Explorer, чтобы вызвать этот метод и оценить результаты.

Оставить отзыв о...

Текущей странице
AdSense Management API
AdSense Management API