予算
予算を管理するためのメソッドが含まれています。 詳細については、「 予算」を参照してください。
メソッド
| メソッド名 | 戻り値の型 | 説明 |
|---|---|---|
| キャンペーン | CampaignSelector | この予算を共有するキャンペーンの一覧をフィルター処理するために使用するセレクターを取得します。 |
| getAmount | double | 予算の金額を取得します。 |
| getDeliveryMethod | string | この予算の配信方法 (予算の種類) を取得します。 |
| getEntityType | string | このエンティティの型を取得します。 |
| getId | string | この共有予算を一意に識別する ID を取得します。 |
| Getname | string | この共有予算の名前を取得します。 |
| getStats | 統計 | この予算を共有するキャンペーンのパフォーマンス データを取得します。 |
| Gettype | string | この予算の種類を取得します。 |
| isExplicitlyShared | ブール型 | この予算が共有予算であるかどうかを示すブール値を取得します。 |
| setAmount(double amount) | void | 予算を指定した金額に設定します。 |
| setDeliveryMethod(String メソッド) | void | この予算の配信方法を設定します。 |
キャンペーン
この予算を共有するキャンペーンの一覧をフィルター処理するために使用する セレクター を取得します。
このメソッドは、 BudgetSelector を使用して取得した予算オブジェクトからのみ呼び出します。キャンペーンの getBudget メソッドを使用して予算を取得した場合、それを呼び出さない場合があります。
戻り値
| 型 | 説明 |
|---|---|
| CampaignSelector | この予算を共有するキャンペーンの一覧をフィルター処理するために使用されるセレクター。 |
getAmount
予算の金額を取得します。
戻り値
| 型 | 説明 |
|---|---|
| double | アカウントの通貨での予算。 |
getDeliveryMethod
予算の配信方法 (予算の種類) を取得します。
戻り値
| 型 | 説明 |
|---|---|
| string | 予算の配信方法。 使用可能な値は次のとおりです。
|
getEntityType
このエンティティの型を取得します。
戻り値
| 型 | 説明 |
|---|---|
| string | このエンティティの型は Budget です。 |
getId
この共有予算を一意に識別する ID を取得します。
戻り値
| 型 | 説明 |
|---|---|
| string | この共有予算を一意に識別する ID。 予算が共有予算でない場合は null を返します。 |
Getname
この共有予算の名前を取得します。
戻り値:
| 型 | 説明 |
|---|---|
| string | 共有予算の名前。 予算が共有予算でない場合は null を返します。 |
Gettype
この予算の種類を取得します。
戻り値:
| 型 | 説明 |
|---|---|
| string | 予算の種類。 可能な型を次に示します。
|
getStats
この予算を共有するキャンペーンのパフォーマンス データを取得します。
パフォーマンス データは、共有予算でのみ使用できます。 このメソッドを呼び出すには、予算セレクターのチェーンに forDateRange(String dateRange) または forDateRange(Object dateFrom, Object dateTo) メソッドを含める必要があります。
戻り値:
| 型 | 説明 |
|---|---|
| 統計 | この予算を共有するキャンペーンのパフォーマンス データ。 予算が共有予算でない場合は null を返します。 |
isExplicitlyShared
この予算が共有予算であるかどうかを示すブール値を取得します。
キャンペーンと共有する予算は、同じアカウントに存在する必要があります。 予算を共有すると、予算を完全に活用できます。 たとえば、キャンペーン A に独自の $10 予算があり、キャンペーン B に独自の $10 予算がある場合、キャンペーン A は予算の 8 ドルしか費やさない可能性があります。 しかし、キャンペーン B はパフォーマンスが良いため、すべての予算を費やし、より多くの予算を費やしている可能性があります。 キャンペーンが予算を共有している場合、キャンペーン B は、キャンペーン A が使用しなかった $2 を自動的に使用し、より多くのトラフィックが送信される可能性を高めます。
戻り値:
| 型 | 説明 |
|---|---|
| ブール型 | 予算が複数のキャンペーンで共有されることを意図している場合は true です。それ以外の場合は false。 |
setAmount(double amount)
予算の金額を設定します。
共有予算を更新するには、 BudgetSelector と BudgetIterator を使用して予算を取得する必要があります。
Campaign エンティティのメソッドを使用して予算を取得すると、予算の金額のgetBudget設定が失敗します。
引数
| 名前 | 型 | 説明 |
|---|---|---|
| 量 | double | アカウントの通貨での予算。 |
戻り値
| 型 | 説明 |
|---|---|
| void | Nothing を返します。 |
setDeliveryMethod(string メソッド)
予算の配信方法を設定します。
引数
| 名前 | 型 | 説明 |
|---|---|---|
| メソッド | string | 予算の配信方法。 大文字と小文字を区別する値は次のとおりです。
|
戻り値
| 型 | 説明 |
|---|---|
| void | Nothing を返します。 |