REST Resource: advertisers.adGroupAds

リソース: AdGroupAd

1 つの広告グループに関連付けられた 1 つの広告。

JSON 表現 
{
  "name": string,
  "advertiserId": string,
  "adGroupAdId": string,
  "adGroupId": string,
  "displayName": string,
  "entityStatus": enum (EntityStatus),
  "adUrls": [
    {
      object (AdUrl)
    }
  ],

  // Union field ad_details can be only one of the following:
  "displayVideoSourceAd": {
    object (DisplayVideoSourceAd)
  },
  "mastheadAd": {
    object (MastheadAd)
  },
  "inStreamAd": {
    object (InStreamAd)
  },
  "nonSkippableAd": {
    object (NonSkippableAd)
  },
  "bumperAd": {
    object (BumperAd)
  },
  "audioAd": {
    object (AudioAd)
  },
  "videoDiscoverAd": {
    object (VideoDiscoveryAd)
  },
  "videoPerformanceAd": {
    object (VideoPerformanceAd)
  }
  // End of list of possible types for union field ad_details.
}
フィールド
name

string

広告のリソース名。
advertiserId

string (int64 format)

広告が属する広告主の一意の ID。
adGroupAdId

string (int64 format)

広告の一意の ID。システムによって割り当てられます。
adGroupId

string (int64 format)

広告が属する広告グループの一意の ID。
displayName

string

広告の表示名。

UTF-8 でエンコードし、最大サイズを 255 バイトにする必要があります。
entityStatus

enum (EntityStatus)

広告のエンティティ ステータス。
adUrls[]

object (AdUrl)

広告で使用される URL のリスト。
共用体フィールド ad_details。広告の詳細。ad_details は次のいずれかになります。
displayVideoSourceAd

object (DisplayVideoSourceAd)

ディスプレイ＆ビデオ 360 のクリエイティブから取得された広告の詳細。
mastheadAd

object (MastheadAd)

YouTube ホームフィードで配信される広告の詳細。
inStreamAd

object (InStreamAd)

ブランド認知度やリーチのマーケティング目標達成に使用される、5 秒経過後にスキップ可能なインストリーム広告の詳細。
nonSkippableAd

object (NonSkippableAd)

リーチ マーケティング目標に使用される、6～15 秒のスキップ不可の短いインストリーム動画広告の詳細。
bumperAd

object (BumperAd)

6 秒以下のスキップ不可の短い動画広告の詳細で、リーチに使用されます。
audioAd

object (AudioAd)

リーチのマーケティング目標に使用されるオーディオ広告の詳細。
videoDiscoverAd

object (VideoDiscoveryAd)

ユーザーが発見した場所に表示される動画を宣伝する広告の詳細。
videoPerformanceAd

object (VideoPerformanceAd)

ビジネス、サービス、商品のコンバージョンを促進するために動画アクション キャンペーンで使用される広告の詳細。

DisplayVideoSourceAd

ディスプレイ＆ビデオ 360 のクリエイティブから取得された広告。

JSON 表現 
{
  "creativeId": string
}
フィールド
creativeId

string (int64 format)

ソース クリエイティブの ID。

MastheadAd

マストヘッド広告の詳細。

JSON 表現 
{
  "video": {
    object (YoutubeVideoDetails)
  },
  "headline": string,
  "description": string,
  "videoAspectRatio": enum (VideoAspectRatio),
  "autoplayVideoStartMillisecond": string,
  "autoplayVideoDuration": string,
  "callToActionButtonLabel": string,
  "callToActionFinalUrl": string,
  "callToActionTrackingUrl": string,
  "showChannelArt": boolean,
  "companionYoutubeVideos": [
    {
      object (YoutubeVideoDetails)
    }
  ]
}
フィールド
video

object (YoutubeVideoDetails)

広告で使用される YouTube 動画。
headline

string

広告の見出しです。
description

string

広告の説明です。
videoAspectRatio

enum (VideoAspectRatio)

マストヘッドで自動再生される YouTube 動画のアスペクト比。
autoplayVideoStartMillisecond

string (int64 format)

動画の再生を開始するまでの時間（ミリ秒単位）。
autoplayVideoDuration

string (Duration format)

動画が自動再生される時間。

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"。
callToActionButtonLabel

string

行動を促すフレーズのボタンのテキスト。
callToActionFinalUrl

string

行動を促すフレーズのボタンのリンク先 URL です。
callToActionTrackingUrl

string

行動を促すフレーズのボタンのトラッキング URL。
showChannelArt

boolean

YouTube ページの上部に表示される背景またはバナーを表示するかどうか。
companionYoutubeVideos[]

object (YoutubeVideoDetails)

パソコンでマストヘッド広告の横に表示される動画。2 つまで指定できます。

YoutubeVideoDetails

YouTube 動画の詳細。

JSON 表現 
{
  "id": string,
  "unavailableReason": enum (VideoUnavailableReason)
}
フィールド
id

string

YouTube ウェブページで検索できる YouTube 動画 ID。
unavailableReason

enum (VideoUnavailableReason)

動画データが利用できない理由。

VideoUnavailableReason

動画が利用できない理由として考えられるもの。

列挙型
VIDEO_UNAVAILABLE_REASON_UNSPECIFIED 不明または未指定。
VIDEO_UNAVAILABLE_REASON_PRIVATE この動画は非公開です。
VIDEO_UNAVAILABLE_REASON_DELETED 動画が削除されます。

VideoAspectRatio

YouTube 動画で使用できるアスペクト比。

列挙型
VIDEO_ASPECT_RATIO_UNSPECIFIED 指定なしまたは不明。
VIDEO_ASPECT_RATIO_WIDESCREEN 動画が引き伸ばされ、上部と下部が切り取られている。
VIDEO_ASPECT_RATIO_FIXED_16_9 動画のアスペクト比は固定 16:9 です。

InStreamAd

インストリーム広告の詳細。

JSON 表現 
{
  "commonInStreamAttribute": {
    object (CommonInStreamAttribute)
  },
  "customParameters": {
    string: string,
    ...
  }
}
フィールド
commonInStreamAttribute

object (CommonInStreamAttribute)

一般的な広告属性。
customParameters

map (key: string, value: string)

トラッキング URL テンプレートにカスタム値を渡すカスタム パラメータ。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

CommonInStreamAttribute

インストリーム広告、スキップ不可の広告、バンパー広告の共通属性。

JSON 表現 
{
  "displayUrl": string,
  "finalUrl": string,
  "trackingUrl": string,
  "actionButtonLabel": string,
  "actionHeadline": string,
  "video": {
    object (YoutubeVideoDetails)
  },
  "companionBanner": {
    object (ImageAsset)
  }
}
フィールド
displayUrl

string

広告に表示されるウェブページのアドレスです。
finalUrl

string

広告をクリックしたユーザーに表示されるウェブページの URL アドレス。
trackingUrl

string

トラッキング目的でバックグラウンドで読み込まれた URL アドレス。
actionButtonLabel

string

行動を促すフレーズのボタンに表示されるテキストです。
actionHeadline

string

行動を促すフレーズのバナーの広告見出し。
video

object (YoutubeVideoDetails)

広告の YouTube 動画。
companionBanner

object (ImageAsset)

動画広告の横に表示される画像。

ImageAsset

画像アセットのメタデータ。

JSON 表現 
{
  "mimeType": string,
  "fullSize": {
    object (Dimensions)
  },
  "fileSize": string
}
フィールド
mimeType

string

画像アセットの MIME タイプ。
fullSize

object (Dimensions)

この画像のメタデータ（元のサイズ）。
fileSize

string (int64 format)

画像アセットのファイルサイズ（バイト単位）。

NonSkippableAd

スキップ不可の広告の詳細。

JSON 表現 
{
  "commonInStreamAttribute": {
    object (CommonInStreamAttribute)
  },
  "customParameters": {
    string: string,
    ...
  }
}
フィールド
commonInStreamAttribute

object (CommonInStreamAttribute)

一般的な広告属性。
customParameters

map (key: string, value: string)

トラッキング URL テンプレートにカスタム値を渡すカスタム パラメータ。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

BumperAd

バンパー広告の詳細。

JSON 表現 
{
  "commonInStreamAttribute": {
    object (CommonInStreamAttribute)
  }
}
フィールド
commonInStreamAttribute

object (CommonInStreamAttribute)

一般的な広告属性。

AudioAd

オーディオ広告の詳細。

JSON 表現 
{
  "displayUrl": string,
  "finalUrl": string,
  "trackingUrl": string,
  "video": {
    object (YoutubeVideoDetails)
  }
}
フィールド
displayUrl

string

広告に表示されるウェブページのアドレスです。
finalUrl

string

広告をクリックしたユーザーに表示されるウェブページの URL アドレス。
trackingUrl

string

トラッキング目的でバックグラウンドで読み込まれた URL アドレス。
video

object (YoutubeVideoDetails)

広告の YouTube 動画。

VideoDiscoveryAd

TrueView ディスカバリー広告の詳細です。

JSON 表現 
{
  "headline": string,
  "description1": string,
  "description2": string,
  "video": {
    object (YoutubeVideoDetails)
  },
  "thumbnail": enum (Thumbnail)
}
フィールド
headline

string

広告の見出し。
description1

string

広告の最初のテキスト行。
description2

string

広告の 2 行目のテキストです。
video

object (YoutubeVideoDetails)

広告が宣伝する YouTube 動画。
thumbnail

enum (Thumbnail)

広告で使用されているサムネイル画像。

サムネイル

TrueView ディスカバリー広告で使用できるサムネイル オプション。

列挙型
THUMBNAIL_UNSPECIFIED 不明または未指定。
THUMBNAIL_DEFAULT デフォルトのサムネイルは、自動生成またはユーザーがアップロードできます。
THUMBNAIL_1 サムネイル 1、動画から生成されたもの。
THUMBNAIL_2 動画から生成されたサムネイル 2。
THUMBNAIL_3 動画から生成されたサムネイル 3。

VideoPerformanceAd

動画パフォーマンス広告の詳細。

JSON 表現 
{
  "finalUrl": string,
  "trackingUrl": string,
  "actionButtonLabels": [
    string
  ],
  "headlines": [
    string
  ],
  "longHeadlines": [
    string
  ],
  "descriptions": [
    string
  ],
  "displayUrlBreadcrumb1": string,
  "displayUrlBreadcrumb2": string,
  "domain": string,
  "videos": [
    {
      object (YoutubeVideoDetails)
    }
  ],
  "customParameters": {
    string: string,
    ...
  },
  "companionBanners": [
    {
      object (ImageAsset)
    }
  ]
}
フィールド
finalUrl

string

広告をクリックしたユーザーに表示されるウェブページの URL アドレス。
trackingUrl

string

トラッキングのためにバックグラウンドで読み込まれる URL アドレス。
actionButtonLabels[]

string

行動を促すフレーズのボタンに表示されるテキスト アセットのリスト。
headlines[]

string

行動を促すフレーズのバナーに表示される広告見出しのリスト。
longHeadlines[]

string

行動を促すフレーズ バナーに表示される単独の広告見出しのリスト。
descriptions[]

string

行動を促すフレーズ バナーに表示される説明のリスト。
displayUrlBreadcrumb1

string

表示 URL のドメインの後の最初の部分。
displayUrlBreadcrumb2

string

表示 URL のドメインの後の 2 番目の部分。
domain

string

表示 URL のドメイン。
videos[]

object (YoutubeVideoDetails)

この広告で使用されている YouTube 動画アセットのリスト。
customParameters

map (key: string, value: string)

トラッキング URL テンプレートにカスタム値を渡すカスタム パラメータ。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }
companionBanners[]

object (ImageAsset)

この広告で使用されるコンパニオン バナーのリスト。

AdUrl

広告に関連する追加の URL（ビーコンなど）。

JSON 表現 
{
  "type": enum (AdUrlType),
  "url": string
}
フィールド
type

enum (AdUrlType)

広告 URL のタイプ。
url

string

URL 文字列の値。

AdUrlType

使用できる広告 URL の種類。

列挙型
AD_URL_TYPE_UNSPECIFIED 不明または未指定。
AD_URL_TYPE_BEACON_IMPRESSION クリエイティブのインプレッションが配信されたときにピニングする 1x1 トラッキング ピクセル。
AD_URL_TYPE_BEACON_EXPANDABLE_DCM_IMPRESSION 拡張可能な DCM インプレッション ビーコン。配信時に、複数のビーコンに拡張されます。
AD_URL_TYPE_BEACON_CLICK クリック イベントがトリガーされたときに ping するトラッキング URL。
AD_URL_TYPE_BEACON_SKIP スキップ イベントがトリガーされたときに ping するトラッキング URL。

メソッド

get

 広告グループの広告を取得します。

list

 広告グループの広告を一覧表示します。