REST Resource: advertisers.adGroups

リソース: AdGroup

広告申込情報に関連付けられている 1 つの広告グループ。

JSON 表現 
{
  "name": string,
  "advertiserId": string,
  "adGroupId": string,
  "lineItemId": string,
  "displayName": string,
  "adGroupFormat": enum (AdGroupFormat),
  "bidStrategy": {
    object (BiddingStrategy)
  },
  "entityStatus": enum (EntityStatus),
  "targetingExpansion": {
    object (TargetingExpansionConfig)
  },
  "productFeedData": {
    object (ProductFeedData)
  },
  "adGroupInventoryControl": {
    object (AdGroupInventoryControl)
  }
}
フィールド
name

string

出力専用。ID。広告グループのリソース名。
advertiserId

string (int64 format)

出力専用。広告グループが属する広告主の一意の ID。
adGroupId

string (int64 format)

出力専用。広告グループの一意の ID。システムによって割り当てられます。
lineItemId

string (int64 format)

必須。変更不可。広告グループが属する広告申込情報の一意の ID。
displayName

string

必須。広告グループの表示名。

最大サイズが 255 バイトの UTF-8 でエンコードする必要があります。
adGroupFormat

enum (AdGroupFormat)

必須。変更不可。広告グループ内の広告のフォーマット。
bidStrategy

object (BiddingStrategy)

省略可。広告グループで使用される入札戦略。入札戦略で使用できるのは、youtubeAndPartnersBid フィールドと demandGenBid フィールドのみです。
entityStatus

enum (EntityStatus)

必須。広告グループが予算を消化して広告枠に入札できるかどうかを制御します。

広告グループの親広告申込情報が有効でない場合、広告グループのステータスが ENTITY_STATUS_ACTIVE であっても、予算を消化することはできません。
targetingExpansion

object (TargetingExpansionConfig)

省略可。広告グループの最適化されたターゲティングの設定。
productFeedData

object (ProductFeedData)

省略可。この広告グループの商品フィードの設定。
adGroupInventoryControl

object (AdGroupInventoryControl)

省略可。デマンド ジェネレーション広告グループに必要です。広告グループの広告枠管理を指定します。

AdGroupFormat

広告グループの形式。

列挙型
AD_GROUP_FORMAT_UNSPECIFIED このバージョンでは、形式の値が指定されていないか、不明です。
AD_GROUP_FORMAT_IN_STREAM インストリーム広告。
AD_GROUP_FORMAT_VIDEO_DISCOVERY インフィード広告。
AD_GROUP_FORMAT_BUMPER バンパー広告。
AD_GROUP_FORMAT_NON_SKIPPABLE_IN_STREAM スキップ不可のインストリーム広告。
AD_GROUP_FORMAT_AUDIO スキップ不可のインストリーム オーディオ広告。
AD_GROUP_FORMAT_RESPONSIVE レスポンシブ広告。
AD_GROUP_FORMAT_REACH 効率的なリーチの広告グループ（インストリーム広告やバンパー広告など）。
AD_GROUP_FORMAT_MASTHEAD YouTube のトップページの最上部に表示されるマストヘッド広告。
AD_GROUP_FORMAT_DEMAND_GEN デマンド ジェネレーション広告。

ProductFeedData

商品フィードの詳細。

JSON 表現 
{
  "productMatchType": enum (ProductMatchType),
  "productMatchDimensions": [
    {
      object (ProductMatchDimension)
    }
  ],
  "isFeedDisabled": boolean
}
フィールド
productMatchType

enum (ProductMatchType)

商品フィードで商品が選択される仕組み。
productMatchDimensions[]

object (ProductMatchDimension)

商品の照合に使用されるディメンションのリスト。
isFeedDisabled

boolean

商品フィードで商品の表示を無効にしているかどうか。

ProductMatchType

商品を照合する方法のタイプ。

列挙型
PRODUCT_MATCH_TYPE_UNSPECIFIED 指定されていないか、不明です。
PRODUCT_MATCH_TYPE_ALL_PRODUCTS すべての商品が一致しています。
PRODUCT_MATCH_TYPE_SPECIFIC_PRODUCTS 特定の商品が選択されています。
PRODUCT_MATCH_TYPE_CUSTOM_LABEL カスタムラベルで商品を照合します。

ProductMatchDimension

商品を照合するために使用されるディメンション。

JSON 表現 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "productOfferId": string,
  "customLabel": {
    object (CustomLabel)
  }
  // End of mutually exclusive fields.
}
フィールド
商品を照合するディメンションと値。以下は、相互に排他的なフィールドのリストです。レスポンスに設定されるフィールドは、最大 1 つです。
productOfferId

string

同じオファー ID の商品と照合する商品オファーの ID。
customLabel

object (CustomLabel)

ラベルの付いたすべての商品と一致するカスタムラベル。
相互に排他的なフィールドの終わり。

CustomLabel

カスタムラベルのキーと値。

JSON 表現 
{
  "key": enum (CustomLabelKey),
  "value": string
}
フィールド
key

enum (CustomLabelKey)

ラベルのキー。
value

string

ラベルの値。

CustomLabelKey

カスタムラベルのキー

列挙型
CUSTOM_LABEL_KEY_UNSPECIFIED 指定されていないか、不明です。
CUSTOM_LABEL_KEY_0 キー インデックス 0。
CUSTOM_LABEL_KEY_1 キー インデックス 1。
CUSTOM_LABEL_KEY_2 キー インデックス 2。
CUSTOM_LABEL_KEY_3 キー インデックス 3。
CUSTOM_LABEL_KEY_4 キー インデックス 4。

AdGroupInventoryControl

広告グループの広告枠管理。

JSON 表現 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "adGroupInventoryStrategy": enum (AdGroupInventoryStrategy),
  "selectedInventories": {
    object (SelectedInventories)
  }
  // End of mutually exclusive fields.
}
フィールド
広告グループの広告枠管理。以下は、相互に排他的なフィールドのリストです。レスポンスに設定されるフィールドは、最大 1 つです。
adGroupInventoryStrategy

enum (AdGroupInventoryStrategy)

インベントリ戦略。
selectedInventories

object (SelectedInventories)

選択した広告枠。
相互に排他的なフィールドの終わり。

AdGroupInventoryStrategy

広告グループの広告枠戦略。

列挙型
AD_GROUP_INVENTORY_STRATEGY_UNSPECIFIED 指定されていないか、不明です。
AD_GROUP_INVENTORY_STRATEGY_ALL_GOOGLE_AND_DISPLAY_NETWORK_INVENTORY 広告グループが Google とディスプレイ ネットワークのすべての広告枠にオプトインしている。
AD_GROUP_INVENTORY_STRATEGY_ALL_GOOGLE_INVENTORY 広告グループがすべての Google 広告枠を対象にしている。

SelectedInventories

広告グループの広告枠管理。

JSON 表現 
{
  "allowYoutubeStream": boolean,
  "allowYoutubeShorts": boolean,
  "allowYoutubeFeed": boolean,
  "allowDiscover": boolean,
  "allowGmail": boolean,
  "allowGoogleDisplayNetwork": boolean
}
フィールド
allowYoutubeStream

boolean

広告グループが YouTube インストリーム広告枠を有効にしているかどうか。
allowYoutubeShorts

boolean

広告グループが YouTube ショート広告枠を有効にしているかどうか。
allowYoutubeFeed

boolean

広告グループで YouTube インフィード広告枠が有効になっているかどうか。
allowDiscover

boolean

広告グループがファインド広告枠にオプトインしているかどうか。
allowGmail

boolean

広告グループで Gmail インベントリが有効になっているかどうか。
allowGoogleDisplayNetwork

boolean

広告グループが Google ディスプレイ ネットワークの広告枠にオプトインしているかどうか。

メソッド

bulkEditAssignedTargetingOptions

 複数の広告グループのターゲット設定オプションを一括編集します。

bulkListAssignedTargetingOptions

 複数の広告グループに割り当てられたターゲティング オプションをターゲティング タイプ別に一覧表示します。

create

 新しい広告グループを作成します。

delete

 AdGroup を削除します。

get

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

list

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

patch

 既存の広告グループを更新します。