ProductGroup

製品グループの管理に使用されるメソッドを含む基本の製品グループ オブジェクト。

使用例:

    var shoppingCampaign = AdsApp.shoppingCampaigns().withIds(["123456789"]).get().next();

    var productGroups = shoppingCampaign.productGroups().get();

    while (productGroups.hasNext()) {
        var group = productGroups.next();
    }

メソッド

メソッド名 戻り値の型 説明
asBrand ProductBrand 商品グループをブランド商品グループにキャストします。
asCategory ProductCategory 製品グループをカテゴリ製品グループにキャストします。
asChannel ProductChannel 製品グループをチャネル製品グループにキャストします。
asChannelExclusivity ProductChannelExclusivity 製品グループをチャネル専用の製品グループにキャストします。
asCondition ProductCondition 製品グループを条件製品グループにキャストします。
asCustomLabel ProductCustomLabel 製品グループをカスタム ラベルの製品グループにキャストします。
asItemId ProductItemId 商品グループをアイテム ID の商品グループにキャストします。
asProductType ProductType 製品グループを製品タイプの製品グループにキャストします。
子供 ProductGroupSelector この商品グループの子商品グループのリストをフィルター処理するために使用するセレクターを取得します。
getAdGroup AdGroup この製品グループが属する広告グループを取得します。
getCampaign Campaign この商品グループが属するキャンペーンを取得します。
getDimension string この商品グループのディメンションを取得します。
getEntityType string このエンティティの型を取得します。
getId string この製品グループを一意に識別する ID を取得します。
getMaxCpc double この商品グループの最大クリック単価の金額を取得します。
getStats 統計情報 この製品グループのパフォーマンス データを取得します。
getValue 文字列 この商品グループの値を取得します。
isExcluded ブール型 この製品グループを除外するかどうかを決定するブール値を取得します。
isOtherCase ブール型 この製品グループが兄弟製品グループでは表されない他のすべてのケースを表すかどうかを判断するブール値を取得します。
parent ProductGroup この製品グループの親製品グループを取得します。
setMaxCpc(double cpc) void この商品グループに使用する最大クリック単価額を設定します。

asBrand

この製品グループをブランド製品グループにキャストします。

注:

ブランドの価値にアクセスするために、商品グループをブランド商品グループにキャストする必要はありません。 getValue メソッドを呼び出すことで、ブランドの価値にアクセスできます。

戻り値

説明
ProductBrand 製品グループのプロパティにアクセスするために使用されるメソッドが含まれます。

asCategory

この製品グループをカテゴリ製品グループにキャストします。

注:

カテゴリの値にアクセスするために、商品グループをカテゴリ商品グループにキャストする必要はありません。 カテゴリの値にアクセスするには、 getValue メソッドを呼び出します。

戻り値

説明
ProductCategory 製品グループのプロパティにアクセスするために使用されるメソッドが含まれます。

asChannel

この製品グループをチャネル製品グループにキャストします。

注:

チャネルの値にアクセスするために、製品グループをチャネル製品グループにキャストする必要はありません。 チャネルの値にアクセスするには、 getValue メソッドを呼び出します。

戻り値

説明
ProductChannel 製品グループのプロパティにアクセスするために使用されるメソッドが含まれます。

asChannelExclusivity

この製品グループをチャネル専用製品グループにキャストします。

注:

チャネルの値にアクセスするために、製品グループをチャネル タイプ製品グループにキャストする必要はありません。 チャネルの値にアクセスするには、 getValue メソッドを呼び出します。

戻り値

説明
ProductChannelExclusivity 製品グループのプロパティにアクセスするために使用されるメソッドが含まれます。

asCondition

この製品グループを条件製品グループにキャストします。

注:

条件の値にアクセスするために、製品グループを条件製品グループにキャストする必要はありません。 条件の値にアクセスするには、 getValue メソッドを呼び出します。

戻り値

説明
ProductCondition 製品グループのプロパティにアクセスするために使用されるメソッドが含まれます。

asCustomLabel

この製品グループをカスタム ラベルの製品グループにキャストします。

注:

ラベルの値にアクセスするために、製品グループを CustomLabel 製品グループにキャストする必要はありません。 ラベルの値にアクセスするには、 getValue メソッドを呼び出します。 値の対象であるラベルの種類を知る必要がある場合にのみ、製品グループを CustomLabel にキャストする必要があります。 たとえば、カスタム ラベル 0 から 4 などです。

戻り値

説明
ProductCustomLabel 製品グループのプロパティにアクセスするために使用されるメソッドが含まれます。

asItemId

この製品グループをアイテム ID の製品グループにキャストします。

注:

ID の値にアクセスするために、商品グループを ItemId 商品グループにキャストする必要はありません。 ID の値にアクセスするには、 getValue メソッドを呼び出します。

戻り値

説明
ProductItemId 製品グループのプロパティにアクセスするために使用されるメソッドが含まれます。

asProductType

この製品グループを製品タイプの製品グループにキャストします。

注:

種類の値にアクセスするために、製品グループを ProductType 製品グループにキャストする必要はありません。 getValue メソッドを呼び出すことによって、型の値にアクセスできます。 値の対象である種類を知る必要がある場合にのみ、製品グループを ProductType にキャストする必要があります。 たとえば、PRODUCT_TYPE_L1 などです。

戻り値

説明
ProductType 製品グループのプロパティにアクセスするために使用されるメソッドが含まれます。

children

この商品グループの子商品グループ一覧をフィルター処理するために使用する セレクター を取得します

戻り値

説明
ProductGroupSelector この製品グループ内の子のリストをフィルター処理するために使用されるセレクター。

getAdGroup

この製品グループが属する広告グループを取得します。

戻り値

説明
AdGroup この製品グループが属する広告グループ。

getCampaign

この商品グループが属するキャンペーンを取得します。

戻り値

説明
Campaign この商品グループが属するキャンペーン。

getDimension

この商品グループのディメンションを取得します。

戻り値

説明
文字列 この商品グループのディメンション。 使用可能な値は次のとおりです。
  • ROOT — ツリーの上部
  • ブランド
  • カテゴリ
  • 条件
  • CUSTOM_LABEL
  • ITEM_ID
  • PRODUCT_TYPE

getEntityType

このエンティティの型を取得します。

戻り値

説明
string このエンティティの種類。 ProductGroup です。

getId

この製品グループを一意に識別する ID を取得します。

戻り値

説明
string この商品グループを一意に識別する ID。

getMaxCpc

この商品グループの最大クリック単価の金額を取得します。

戻り値

説明
double 入札金額。 設定されていない場合、または負の製品グループ (isExludedtrue の場合) を返します。

getStats

この製品グループのパフォーマンス データを取得します。

このメソッドを呼び出すには、商品グループ セレクターのチェーンにいずれかのforDateRangeメソッドを含める必要があります。

戻り値:

説明
統計情報 この製品グループのパフォーマンス データ。

getValue

この商品グループの値を取得します。

戻り値:

説明
文字列 この商品グループの値。 これがルート グループの場合は null を返します。

isExcluded

この商品グループが負の商品グループかどうかを判断するブール値を取得します。

戻り値:

説明
ブール型 この製品グループが負のグループの場合は true 。それ以外の場合は false。 たとえば、すべての滑降スキーを含めるのではなく、除外します。

isOtherCase

この製品グループが、兄弟製品グループでは表されない他のすべてを表すかどうか (他のケース) を決定するブール値を取得します。

戻り値:

説明
ブール型 この製品グループが "other" ケースを表す場合は true 。それ以外の場合は false。 たとえば、[すべての商品] (ルート ノード) を [Sporting Goods] で除算すると、[Sporting Goods] に含まれない商品を表す兄弟商品グループが作成され、このフィールドが true に設定されます。 この商品グループの親 ID と Sporting Goods 商品グループはルート ノードを指します。

この製品グループの親を取得します。

戻り値:

説明
ProductGroup この製品グループの親。 これがルート グループの場合は null を返します。

setMaxCpc(double cpc)

この商品グループの最大クリック単価金額を設定します。

引数

名前 説明
cpc double 入札金額。 入札額はアカウントの通貨で定められ、この通貨によって指定できる下限と最高入札額が決まります。 商品グループが細分化されている (子がある)、または負の商品グループ (isExcludedが True) の場合は、入札単価を設定しないでください。

戻り値

説明
void Nothing を返します。