Google アド マネージャーでは、LineItems などの入稿エンティティのレポート作成と操作の両方に使用できる SOAP API を提供しています。
クライアント ライブラリは複数の言語で利用できます。AdX Seller API と同様に、Ad Manager API では OAuth2 を使用して認証を行います。
最初の API リクエストを実行するには、スタートガイドをご覧ください。
Ad Manager API でのレポート作成
Ad Manager API の ReportService では、次の 2 つの方法でレポートを実行およびダウンロードできます。
- UI でクエリを作成し、ID に基づいて実行する。
- アドホックな ReportQuery を作成する。
どちらの方法でも、API ワークフローは 4 つのステップで構成されます。
- runReportJob を呼び出します。
- getReportJobStatus を使用してレポートのステータスをポーリングします。
- getReportDownloadUrlWithOptions を使用して、完成したレポートの URL を取得します。
- 返された URL からレポートをダウンロードします。
詳しくは、レポートガイドをご覧ください。
レポートのタイムゾーン
Ad Exchange Seller REST API とは異なり、Ad Manager API レポートでは、デフォルトでネットワークのタイムゾーンが使用されます。これを変更するには、TimeZoneType フィールドを設定します。
AdX とアド マネージャーの指標およびディメンションの対応関係
Ad Exchange Seller REST API でサポートされているすべての指標とディメンションが、アド マネージャー Reporting API でご利用いただけるようになりました。名前が変更されたり、非推奨になったりします。詳しくは、以下の表をご覧ください。
指標 / 列
以下の表に、AdX の指標とアド マネージャーの列の対応を示します。
| AdX の指標 | アド マネージャーの列 | アド マネージャーのクエリツールの名前 |
|---|---|---|
| ACTIVE_VIEW_ELIGIBLE_COUNT | AD_EXCHANGE_ACTIVE_VIEW_ENABLED_IMPRESSIONS | アクティブ ビューが有効になっているインプレッション数 |
| ACTIVE_VIEW_MEASURABLE_COUNT | AD_EXCHANGE_ACTIVE_VIEW_MEASURED_IMPRESSIONS | アクティブ ビューで測定されたインプレッション数 |
| ACTIVE_VIEW_MEASURABLE_RATIO | （非推奨） | （非推奨） |
| ACTIVE_VIEW_VIEWABLE_COUNT | AD_EXCHANGE_ACTIVE_VIEW_VIEWED_IMPRESSIONS | アクティブ ビューで表示されたインプレッション数 |
| ACTIVE_VIEW_VIEWABLE_RATIO | （非推奨） | （非推奨） |
| ACTIVE_VIEW_VIEWABLE_TIME | AD_EXCHANGE_AVERAGE_VIEWABLE_TIME | 平均視認可能時間（秒） |
| AD_IMPRESSIONS | AD_EXCHANGE_IMPRESSIONS | 広告の表示回数 |
| AD_IMPRESSIONS_RPM | AD_EXCHANGE_AD_ECPM | 広告 eCPM |
| AD_REQUESTS | AD_EXCHANGE_AD_REQUESTS | 広告リクエスト数 |
| AD_REQUESTS_COVERAGE | AD_EXCHANGE_COVERAGE | カバー率 |
| AD_REQUESTS_CTR | AD_EXCHANGE_AD_REQUEST_CTR | 広告リクエストのクリック率 |
| AD_REQUESTS_RPM | AD_EXCHANGE_AD_REQUEST_ECPM | 広告リクエスト eCPM |
| クリック数 | AD_EXCHANGE_CLICKS | クリック数 |
| COST_PER_CLICK | AD_EXCHANGE_CPC | CPC |
| DEALS_AD_REQUESTS | AD_EXCHANGE_DEALS_AD_REQUESTS | 取引の広告リクエスト |
| DEALS_BID_RESPONSES | AD_EXCHANGE_DEALS_BID_RESPONSES | 取引の入札レスポンス |
| DEALS_MATCH_RATE | AD_EXCHANGE_DEALS_MATCH_RATE | 取引のマッチ率 |
| DEALS_MATCHED_REQUESTS | AD_EXCHANGE_DEALS_MATCHED_REQUESTS | 取引の一致リクエスト数 |
| 収益 | AD_EXCHANGE_ESTIMATED_REVENUE | 推定収益 |
| INDIVIDUAL_AD_IMPRESSIONS | （非推奨） | （非推奨） |
| INDIVIDUAL_AD_IMPRESSIONS_CTR | AD_EXCHANGE_AD_CTR | 広告 CTR |
| INDIVIDUAL_AD_IMPRESSIONS_RPM | （新しい最適化案）AD_EXCHANGE_AD_ECPM | （新しい最適化案）広告 eCPM |
| LIFT_RATE | AD_EXCHANGE_LIFT | リフト |
| MATCHED_AD_REQUESTS | AD_EXCHANGE_MATCHED_REQUESTS | 一致したリクエスト数 |
| MATCHED_AD_REQUESTS_CTR | AD_EXCHANGE_CTR | CTR（クリック率） |
| MATCHED_AD_REQUESTS_RPM | AD_EXCHANGE_MATCHED_ECPM | 一致した eCPM |
| VIDEO_AD_ABANDONMENT_RATIO | AD_EXCHANGE_VIDEO_ABANDONMENT_RATE | 動画の放棄率 |
| VIDEO_AD_DROPOFF_RATIO | AD_EXCHANGE_VIDEO_DROPOFF_RATE | 動画の離脱率 |
| VIDEO_AD_QUARTILE_ONE | AD_EXCHANGE_VIDEO_QUARTILE_1 | 動画四分位 1 |
| VIDEO_AD_QUARTILE_THREE | AD_EXCHANGE_VIDEO_QUARTILE_3 | 動画四分位 3 |
| VIDEO_AD_SKIPPABLE_SKIP_RATIO | AD_EXCHANGE_VIDEO_TRUEVIEW_SKIP_RATE | TrueView スキップ率 |
| VIDEO_AD_SKIPPABLE_VIEWS | AD_EXCHANGE_VIDEO_TRUEVIEW_VIEWS | TrueView 視聴回数 |
| VIDEO_AD_SKIPPABLE_VTR | AD_EXCHANGE_VIDEO_TRUEVIEW_VTR | TrueView の視聴完了率 |
ディメンション
Ad Exchange のディメンションとアド マネージャーのディメンションの対応表を以下に示します。
| AdX ディメンション | アド マネージャー ディメンション | アド マネージャーのクエリツールの名前 |
|---|---|---|
| AD_CLIENT_ID | AD_EXCHANGE_WEB_PROPERTY_CODE | ウェブ プロパティ |
| AD_LOCATION | AD_EXCHANGE_AD_LOCATION | 広告の配置 |
| AD_TAG_NAME | AD_EXCHANGE_TAG_NAME | タグ |
| AD_UNIT_SIZE_CODE | AD_EXCHANGE_INVENTORY_SIZE_CODE | （利用不可） |
| AD_UNIT_SIZE_NAME | AD_EXCHANGE_INVENTORY_SIZE | 広告枠のサイズ |
| ADVERTISER_DOMAIN | AD_EXCHANGE_ADVERTISER_DOMAIN | 広告主のドメイン |
| ADVERTISER_NAME | AD_EXCHANGE_ADVERTISER_NAME | 広告主 |
| ADVERTISER_VERTICAL | AD_EXCHANGE_ADVERTISER_VERTICAL | 広告主様の業種 |
| AGENCY_NAME | AD_EXCHANGE_AGENCY | 代理店 |
| BID_TYPE_CODE | AD_EXCHANGE_BID_TYPE_CODE | （利用不可） |
| BRAND_NAME | AD_EXCHANGE_BRAND_NAME | ブランド |
| BRANDING_TYPE_CODE | AD_EXCHANGE_BRANDING_TYPE_CODE | （利用不可） |
| BRANDING_TYPE_NAME | AD_EXCHANGE_BRANDING_TYPE | ブランディングのタイプ |
| BUYER_NETWORK_ID | AD_EXCHANGE_BUYER_NETWORK_ID | （利用不可） |
| BUYER_NETWORK_NAME | AD_EXCHANGE_BUYER_NETWORK_NAME | 購入者ネットワーク |
| COUNTRY_CODE | AD_EXCHANGE_COUNTRY_CODE | （利用不可） |
| COUNTRY_NAME | AD_EXCHANGE_COUNTRY_NAME | 国 |
| CREATIVE_SIZE | AD_EXCHANGE_CREATIVE_SIZES | クリエイティブ サイズ |
| CUSTOM_CHANNEL_CODE | AD_EXCHANGE_CUSTOM_CHANNEL_CODE | （利用不可） |
| CUSTOM_CHANNEL_ID | AD_EXCHANGE_CUSTOM_CHANNEL_ID | （利用不可） |
| CUSTOM_CHANNEL_NAME | AD_EXCHANGE_CHANNEL_NAME | チャンネル |
| DATE | AD_EXCHANGE_DATE | 日数 |
| DEAL_ID | AD_EXCHANGE_DEAL_ID | 取引 ID |
| DEAL_NAME | AD_EXCHANGE_DEAL_NAME | 取引名 |
| DFP_AD_UNIT_ID | AD_EXCHANGE_DFP_AD_UNIT_ID | （利用不可） |
| DFP_AD_UNITS | AD_EXCHANGE_DFP_AD_UNIT | Google の広告ユニット |
| DFP_REQUEST_SOURCE | AD_EXCHANGE_REQUEST_SOURCES | リクエスト元 |
| DOMAIN_NAME | AD_EXCHANGE_SITE_NAME | Google サイト |
| DSP_NAME | AD_EXCHANGE_DSP_BUYER_NETWORK_NAME | DSP |
| EXPANSION_TYPE_NAME | AD_EXCHANGE_EXPANSION_TYPE | エキスパンド タイプ |
| INVENTORY_OWNERSHIP | AD_EXCHANGE_INVENTORY_OWNERSHIP | 広告枠の所有権 |
| INVENTORY_PARTNER_NAME | AD_EXCHANGE_NETWORK_PARTNER_NAME | ネットワーク パートナー名 |
| MOBILE_APP_NAME | AD_EXCHANGE_MOBILE_APP_NAME | アプリ名 |
| MOBILE_CARRIER_NAME | AD_EXCHANGE_MOBILE_CARRIER_NAME | 携帯通信会社名 |
| MOBILE_DEVICE_NAME | AD_EXCHANGE_MOBILE_DEVICE_NAME | デバイス |
| MOBILE_INVENTORY_TYPE | AD_EXCHANGE_MOBILE_INVENTORY_TYPE | 広告枠のタイプ |
| MOBILE_OS_VERSION | AD_EXCHANGE_OPERATING_SYSTEM | オペレーティング システム |
| MOBILE_USER_BANDWIDTH | AD_EXCHANGE_USER_BANDWIDTH_NAME | 帯域幅 |
| MONTH | AD_EXCHANGE_MONTH | 月 |
| PLATFORM_TYPE_NAME | AD_EXCHANGE_DEVICE_CATEGORY | デバイス カテゴリ |
| PRODUCT_CODE | AD_EXCHANGE_PRODUCT_CODE | （利用不可） |
| PRODUCT_NAME | AD_EXCHANGE_PRODUCT_NAME | 商品 |
| TARGETING_TYPE_CODE | AD_EXCHANGE_TARGETING_TYPE_CODE | （利用不可） |
| TARGETING_TYPE_NAME | AD_EXCHANGE_TARGETING_TYPE | ターゲット タイプ |
| TRANSACTION_TYPE_CODE | AD_EXCHANGE_TRANSACTION_TYPE_CODE | （利用不可） |
| TRANSACTION_TYPE_NAME | AD_EXCHANGE_TRANSACTION_TYPE | トランザクション タイプ |
| URL_CHANNEL_ID | AD_EXCHANGE_URL_ID | （利用不可） |
| URL_CHANNEL_NAME | AD_EXCHANGE_URL | URL |
| VIDEO_AD_DURATION | AD_EXCHANGE_VIDEO_AD_DURATION | （利用不可） |
| VIDEO_AD_DURATION_RAW | AD_EXCHANGE_VIDEO_AD_DURATION_RAW | 動画広告の再生時間 |
| VIDEO_AD_FORMAT | AD_EXCHANGE_VIDEO_AD_TYPE | 動画広告の種類 |
| WEEK | AD_EXCHANGE_WEEK | 週 |
| WINNING_BID_RULE_ID | AD_EXCHANGE_PRICING_RULE_ID | （利用不可） |
| WINNING_BID_RULE_NAME | AD_EXCHANGE_PRICING_RULE_NAME | 価格設定ルール |