Advertiser Examples

1. bid を更新する

Query
Result
mutation {
  updateAdSet(input: {
    id: "00000000-0000-0000-0000-000000000000",
    bidding: {amount: 1000000}
  }) {
    adSet {
      id
    }
  }
}

注: この例では bid の値がマイクロ値(1/1,000,000)で表現されている事に留意して下さい。詳細は Money スカラー値のドキュメントをご参照ください。

2. Ad Set を参照する

No filtering

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

注: レスポンスに含まれる endCursor を次のページをリクエストする際に利用します。例:

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

フィルター

Query
Result
query {
  advertiser {
    adSets(first: 50, configuredStatus: ACTIVE) {
      edges {
        node {
          id
        }
      }
    }
  }
}

3. インサイト情報を参照する

ブレークダウンなし

Query
Result
query {
  adSet(id: "00000000-0000-0000-0000-000000000000") {
    insights(timeRange: {from: "2018-03-06T00:00:00Z", until: "2018-03-07T00:00:00Z"}) {
      timestamps
      reports {
        impressions
        conversions
        spend
      }
    }
  }
}

国別ブレークダウン

Query
Result
query {
  adSet(id: "00000000-0000-0000-0000-000000000000") {
    insights(timePreset: TODAY) {
      reports {
        country
        impressions
        conversions
        spend
      }
    }
  }
}

広告アプリおよびパブリッシャーアプリ別のブレークダウン

注: 2018年10月15日より前のデータには関連するアプリ情報がありません。この場合、"app"はResultタブの例にあるように"null"となります。

注: bundleId および storeId を得るにはTapjoyに連絡し許可を得る必要があります。hashedId はアプリ毎に一意な暗号化した識別子となります。

Query
Result
query {
  adSet(id: "00000000-0000-0000-0000-000000000000") {
    ads {
      id
      insights(timePreset: TODAY) {
        reports {
          app {
            bundleId
            hashedId
          }
          impressions
          conversions
          spend
        }
      }
    }
  }
}

すべてのAd Sets のデータを取得

Query
Result
query {
  advertiser {
    adSets(first: 50, configuredStatus: ACTIVE) {
      edges {
        node {
          id

          insights(timeRange: {from: "2018-03-06T00:00:00Z", until: "2018-03-07T00:00:00Z"}) {
            timestamps
            reports {
              conversions
              spend
            }
          }
        }
      }
    }
  }
}

4. ユーザのタイムゾーンを参照する

utcOffcet は UTC からのタイムゾーンの時差を時分の +/- で表したものです。タイムゾーンが UTC の場合、+00:00 として返されます。

また、これらの情報はタイムゾーンが現時点で夏時間にあるかで変わります。例えば、東部時間のabbreviationはEDTやESTとなります。

Query
Result
query {
  user {
    firstName
    lastName

    timeZone {
      utcOffset
      name
      abbreviation
    }
  }
}

5. 設定されたイベントを参照する

AdSetの multiRewardEngagementEvents をbid量、ステータス、コンバージョン数などにかかわらずすべて列挙します。

Query
Result
{
  adSet(id: "ace4b134-c5ab-4e97-bc81-95406682682c") {
    multiRewardEngagementSettings {
      events {
        eventName
        eventValue
        amount
      }
    }
  }
}

6. イベントを作成・削除する

MultiRewardEngagementEvents の作成・削除は一回の更新で可能です。 AdSet id および少なくとも二つの MultiRewardEngagementEvents のリストを指定する必要があります。

イベントを無効にするには、disable: true 属性値を追加します。意図せぬ削除を避けるため、イベントを無効化する場合にも eventName および eventValue が必須です。

下記の例では、AdSetTUTORIAL_COMPLETELEVEL_ONE の二つのイベントを持つように設定します。同時に LEVEL_TWO イベントを無効にします。

Query
Result
mutation {
  updateAdSetBidding(
    input:{
      id: "<your adset id>"
      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
      }
    }
  }
}

7. アプリ別イベントの設定を参照する

このクエリではパブリッシャーのアプリ別のbid設定を含む adSet のすべての multiRewardEngagementEvents を列挙します。パブリッシャーのアプリ別のイベント設定ではないものは null アプリの下に表示されます。

Query
Result
{
  adSet(id: "ace4b134-c5ab-4e97-bc81-95406682682c") {
    multiRewardEngagementSettings {
      app {
        bundleId
      }
      events {
        eventName
        eventValue
        amount
      }
    }
  }
}

8. アプリ別イベントの設定を作成・削除する

MultiRewardEngagementEvents と同様に、 AppBiddingGroups の作成や削除は一回の更新で可能です。少なくとも一つのパブリッシャの AppReference id と、少なくとも二つの MultiRewardEngagementEvents を指定する必要があります。AppReference で指定したパブリッシャーのアプリ内でコンバージョンが発生した場合、これらのイベントの "amount" が全体で設定している値の代わりに使用されます。

イベントやアプリ別のbidグループを無効化するには disable: true を対象に追加します。 アプリ別のbidグループを無効にすると、自動的にそのグループ配下のイベントも無効化されます。 意図せぬ削除を避けるため、イベントを無効化する場合にもeventNameeventValue が必要です。

下記の例では、AdSetTUTORIAL_COMPLETELEVEL_ONE の二つのイベントを持つように設定します。 各イベントの bid を $2.2 と $12.2 にそれぞれ設定します。この値はすべてのアプリでデフォルト値として使われるようになります。また、 LEVEL_TWO というイベントを無効化します。

次に、Example Publisher App 1 に対して、最初のイベントへの bid 値を $5.5 にし、二つ目のイベントに対するカスタムbidを無効化します。

最後に、Example Publisher App 2 のグループすべてを無効化します。これによりすべてのイベントも無効化されます。

Query
Result
mutation {
  updateAdSetBidding(
    input:{
      id: "<your adset id>"
      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
      }
    }
  }
}