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

広告の 1 行目。
description2

string

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

object (YoutubeVideoDetails)

広告で宣伝される YouTube 動画。
thumbnail

enum (Thumbnail)

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

サムネイル

動画ファインド広告で選択可能なサムネイル オプション。

列挙型
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 クリエイティブのインプレッションが配信されたときに ping に使用される 1×1 トラッキング ピクセル。
AD_URL_TYPE_BEACON_EXPANDABLE_DCM_IMPRESSION エキスパンド DCM インプレッション ビーコン。配信時には複数のビーコンに展開されます。
AD_URL_TYPE_BEACON_CLICK クリック イベントがトリガーされたときに ping を実行するトラッキング URL。
AD_URL_TYPE_BEACON_SKIP スキップ イベントがトリガーされたときに ping するトラッキング URL。

Methods

get

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

list

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