キャンペーン管理

最終更新日: 2024年12月11日

概要

Reporting APIを使用して、キャンペーンを管理したり、イベントや Ad Set の設定詳細を確認したりすることができます。

はじめる前に: こちらの手順に従ってAPIで認証する必要があります。

1. Ad Set の管理

入札額(bid)、ターゲティングデータ、キャンペーンのステータスなど、Ad Set の設定詳細を確認します。

参照: Advertiser#adSets フィールド、 AdSet

Query
Result
query {
  advertiser {
    adSets(first: 50) {
      edges {
        node {
          id
          bidding {
            amount
          }
          campaign {
            objective
          }
        }
      }
      pageInfo {
        endCursor
        hasNextPage
      }
    }
  }
}

Ad Set のbidを変更する

注**:返されるbidはマイクロ単位(米ドルの1/1,000,000)で表現されます。詳細はMoneyスカラー型のドキュメントを参照してください。

参照: AdSetBiddingUpdateInput

Mutation
Result
mutation {
  updateAdSetBidding(input: {
    id: "00000000-0000-0000-0000-000000000000",
    bidding: {amount: 1000000}
  }) {
    bidding {
      amount
    }
  }
}

2. Multi-Reward Event の管理

Multi-Reward オファーに関するイベントレベルの情報(bid、イベント名、イベントの linearity など)を確認します。

:Ad Set 内のすべてのイベントが、bid、ステータス、コンバージョン数に関係なく返されます。

参照: MultiRewardEngagementEvent

Query
Result
{
  adSet(id: "00000000-0000-0000-0000-000000000000") {
    multiRewardEngagementSettings {
      events {
        eventName
        eventValue
        amount
      }
    }
  }
}

Multi-Reward Event の作成および削除

MultiRewardEngagementEvents の作成および削除は、単一のミューテーションで実行されます。AdSet IDと2つ以上の MultiRewardEngagementEvents のリストを指定する必要があります。イベントを無効にするには、disable: true 属性を追加してください。誤削除を防ぐため、イベントを無効にする際にも eventNameeventValue は必須です。

参照: AdSetBiddingUpdateInput 型、 MultiRewardEngagementEventInput

Mutation
Result
mutation {
  updateAdSetBidding(
    input:{
      id: "00000000-0000-0000-0000-000000000000"
      bidding: {
        multiRewardEngagementEvents: [
          {
            eventName:"TUTORIAL_COMPLETE",
            eventValue: "",
            amount: 2200000
          },
          {
            eventName:"LEVEL_ONE",
            eventValue: "",
            amount: 12200000
          },
          {
            eventName:"LEVEL_TWO",
            eventValue: "",
            disable: true
          }
        ]
      }
    }
  ) {
    bidding {
      multiRewardEngagementEvents {
        eventName
        eventValue
        amount
      }
    }
  }
}

3. アプリ固有の設定の管理

パブリッシャーアプリごとに入札が有効になっているMulti-Reward オファーについて、イベントレベルの情報を確認します。結果は bid、イベント名、イベントの linearity などのイベントの情報が、パブリッシャーのアプリ別に返ります。

:アプリ固有でないイベント設定は、null アプリの下にリストされます。

参照: MultiRewardEngagementEvent 型、 AppReference

Query
Result
{
  adSet(id: "00000000-0000-0000-0000-000000000000") {
    multiRewardEngagementSettings {
      app {
        bundleId
      }
      events {
        eventName
        eventValue
        amount
      }
    }
  }
}

アプリ別イベント設定の作成および削除

MultiRewardEngagementEvents と同様に、AppBiddingGroups の作成および削除は、単一のミューテーションで実行されます。少なくとも1つのパブリッシャー AppReference IDおよび2つ以上の MultiRewardEngagementEvents を提供する必要があります。これらのイベントのbidは、該当するパブリッシャー AppReference 内でコンバージョンが発生した場合に、トップレベルで設定された値の代わりに使用されます。

イベントまたはアプリごとの入札グループを無効にするには、オブジェクトに disable: true を追加してください。アプリごとの入札グループを無効にすると、子イベントも自動的に無効になります。誤削除を防ぐため、イベントを無効にする際には eventNameeventValue は必須です。

参照: AdSetBiddingUpdateInput 型、 AppBiddingGroupInput 型、 MultiRewardEngagementEventInput 型、 AppReference

Mutation
Result
mutation {
  updateAdSetBidding(
    input:{
      id: "00000000-0000-0000-0000-000000000000"
      bidding: {
        perAppBidGroups: [{
          pubAppId:"<example_publisher_app_id>"
          multiRewardEngagementEvents: [
            {
              eventName:"TUTORIAL_COMPLETE",
              eventValue: "",
              amount: 5500000
            },
            {
              eventName:"LEVEL_ONE",
              eventValue: "",
              disable: true,
            }  
          ]
        },
        {
          pubAppId:"<example_publisher_app_id_2>",
          disable: true
        }],
        multiRewardEngagementEvents: [
          {
            eventName:"TUTORIAL_COMPLETE",
            eventValue: "",
            amount: 2200000
          },
          {
            eventName:"LEVEL_ONE",
            eventValue: "",
            amount: 12200000
          },
          {
            eventName:"LEVEL_TWO",
            eventValue: "",
            disable: true
          }
        ]
      }
    }
  ) {
    bidding {
      multiRewardEngagementEvents {
        eventName
        eventValue
        amount
      }
      perAppBidGroups {
          pubApp {
            id
            name
          }
        }
        multiRewardEngagementEvents {
          eventName
          eventValue
          amount
      }
    }
  }
}