レポートの作成と更新

DCM/DFA Reporting and Trafficking API の Reports サービスでは、レポート リソース オブジェクトを使用して、レポート ビルダーのレポートを作成および更新することができます。レポート リソースは実行するレポートの基本情報のほか、レポート出力の構成について外形を示します。

このガイドでは、プログラムから Reports サービスを使用してレポート ビルダーのレポートを作成、更新する方法について詳しく説明します。

レポート リソースを設定する

レポート ビルダーのレポートを作成または更新する最初の手順は、レポート リソース オブジェクトを設定することです。新しいレポートを作成する場合、空のリソースを用意して、必須のフィールドを設定します。既存のレポートを更新する場合は、以下の選択肢があります。

  1. 推奨: 部分更新を行います。この方法を使用する場合、最初に空のリソースを用意し、変更するフィールドに設定します。部分更新では、指定するフィールドの変更のみ保存されます。
  2. 全体の更新を行います。この方法を使用する場合、既存のレポート リソースを読み込み、フィールドを直接変更します。全体の更新ではそのレポートのすべてのフィールドが常に保存されます。

レポート リソースの内容の詳細は、設定するレポートのタイプによって異なります。ただし、以下のフィールドはすべてのレポートタイプに共通です。

フィールド説明
必須のフィールド
nameレポートの名前
typeレポートのタイプ
省略可能なフィールド
deliveryレポートのメール配信設定
fileNameこのレポートのファイルを生成するときに使用するファイル名
formatレポートの出力形式で、CSV と Excel のどちらか
schedule定期的に実行するレポートのスケジュール

上記の共通のフィールドにより、レポートの骨格が構成されます。新しい標準レポート リソースの作成方法について、下記の例で示します。

C#

Report report = new Report();

// Set the required fields "name" and "type".
report.Name = "Example standard report";
report.Type = "STANDARD";

// Set optional fields.
report.FileName = "example_report";
report.Format = "CSV";

Java

Report report = new Report();

// Set the required fields "name" and "type".
report.setName("Example standard report");
report.setType("STANDARD");

// Set optional fields
report.setFileName("example_report");
report.setFormat("CSV");

PHP

$report = new Google_Service_Dfareporting_Report();

// Set the required fields "name" and "type".
$report->setName('Example standard report');
$report->setType('STANDARD');

// Set optional fields.
$report->setFileName('example_report');
$report->setFormat('CSV');

Python

report = {
    # Set the required fields "name" and "type".
    'name': 'Example Standard Report',
    'type': 'STANDARD',
    # Set optional fields.
    'fileName': 'example_report',
    'format': 'CSV'
}

Ruby

report = DfareportingUtils::API_NAMESPACE::Report.new(
  # Set the required fields "name" and "type".
  name: 'Example Standard Report',
  type: 'STANDARD',
  # Set optional fields.
  file_name: 'example_report',
  format: 'CSV'
)

レポートの条件を定義する

レポートタイプと設定する共通フィールドを選択したら、次の手順として、レポートの条件を定義します。レポート条件を指定してレポートの対象範囲を限定し、関係のある情報だけが返されるようにします。これにより、レポート出力の構造も定義されます。

指定する条件はレポートタイプによって異なります。レポートタイプと条件の関係を次の表で説明します。

レポートタイプ 条件のフィールド
STANDARD criteria
REACH reachCriteria
PATH_TO_CONVERSION pathToConversionCriteria
FLOODLIGHT floodlightCriteria
CROSS_DIMENSION_REACH crossDimensionReachCriteria

上記のタイプ別の条件はそれぞれ、少しずつ異なるフィールド セットをエクスポーズします。一方、以下のように共通の条件フィールド セットもあり、レポートの出力を管理するのに通常役に立ちます。

フィールド 説明
dateRange このレポートを実行する日付。カスタマイズした開始日と終了日または相対的な期間を指定できます。
dimensionFilters 返される結果を制限するフィルタのリスト。フィルタの設定について詳しくは、フィルタ値を検索するセクションをご覧ください。
ディメンション レポートの出力に含める キャンペーン マネージャー 要素のリスト。
metricNames レポートの出力に含める指標の標準単位。

レポートのディメンション、指標、フィルタの選択について詳しくは、フィールドの整合性を判断するセクションをご覧ください。その他のタイプ別の条件フィールドについては、リファレンス ドキュメントヘルプセンターをご覧ください。

下記の例では、標準レポート リソースに基本的な条件を追加しています。

C#

// Define a date range to report on. This example uses explicit start and
// end dates to mimic the "LAST_30_DAYS" relative date range.
DateRange dateRange = new DateRange();
dateRange.EndDate = DateTime.Now.ToString("yyyy-MM-dd");
dateRange.StartDate = DateTime.Now.AddDays(-30).ToString("yyyy-MM-dd");

// Create a report criteria.
SortedDimension dimension = new SortedDimension();
dimension.Name = "dfa:advertiser";

Report.CriteriaData criteria = new Report.CriteriaData();
criteria.DateRange = dateRange;
criteria.Dimensions = new List<SortedDimension>() { dimension };
criteria.MetricNames = new List<string>() {
  "dfa:clicks",
  "dfa:impressions"
};

// Add the criteria to the report resource.
report.Criteria = criteria;

Java

// Define a date range to report on. This example uses explicit start and end dates to mimic
// the "LAST_MONTH" relative date range.
DateRange dateRange = new DateRange();
dateRange.setEndDate(new DateTime(true, System.currentTimeMillis(), null));

Calendar lastMonth = Calendar.getInstance();
lastMonth.add(Calendar.MONTH, -1);
dateRange.setStartDate(new DateTime(true, lastMonth.getTimeInMillis(), null));

// Create a report criteria.
Report.Criteria criteria = new Report.Criteria();
criteria.setDateRange(dateRange);
criteria.setDimensions(Lists.newArrayList(new SortedDimension().setName("dfa:advertiser")));
criteria.setMetricNames(Lists.newArrayList("dfa:clicks", "dfa:impressions"));

// Add the criteria to the report resource.
report.setCriteria(criteria);

PHP

// Define a date range to report on. This example uses explicit start and
// end dates to mimic the "LAST_30_DAYS" relative date range.
$dateRange = new Google_Service_Dfareporting_DateRange();
$dateRange->setStartDate(
    date('Y-m-d', mktime(0, 0, 0, date('m'), date('d') - 30, date('Y')))
);
$dateRange->setEndDate(date('Y-m-d'));

// Create a report criteria.
$dimension = new Google_Service_Dfareporting_SortedDimension();
$dimension->setName('dfa:advertiser');

$criteria = new Google_Service_Dfareporting_ReportCriteria();
$criteria->setDateRange($dateRange);
$criteria->setDimensions([$dimension]);
$criteria->setMetricNames(['dfa:clicks', 'dfa:impressions']);

// Add the criteria to the report resource.
$report->setCriteria($criteria);

Python

# Define a date range to report on. This example uses explicit start and end
# dates to mimic the "LAST_30_DAYS" relative date range.
end_date = date.today()
start_date = end_date - timedelta(days=30)

# Create a report criteria.
criteria = {
    'dateRange': {
        'startDate': start_date.strftime('%Y-%m-%d'),
        'endDate': end_date.strftime('%Y-%m-%d')
    },
    'dimensions': [{
        'name': 'dfa:advertiser'
    }],
    'metricNames': ['dfa:clicks', 'dfa:impressions']
}

# Add the criteria to the report resource.
report['criteria'] = criteria

Ruby

# Define a date range to report on. This example uses explicit start and end
# dates to mimic the "LAST_30_DAYS" relative date range.
start_date = DateTime.now.prev_day(30).strftime('%Y-%m-%d')
end_date = DateTime.now.strftime('%Y-%m-%d')

# Create a report criteria
criteria = DfareportingUtils::API_NAMESPACE::Report::Criteria.new(
  date_range: DfareportingUtils::API_NAMESPACE::DateRange.new(
    start_date: start_date,
    end_date: end_date
  ),
  dimensions: [
    DfareportingUtils::API_NAMESPACE::SortedDimension.new(
      name: 'dfa:advertiser'
    )
  ],
  metric_names: ['dfa:clicks', 'dfa:impressions']
)

# Add the criteria to the report resource.
report.criteria = criteria

フィルタ値を検索する

レポートのフィルタを設定する際、レポートの出力を制限するためにフィルタが使用する値を正確に指定する必要があります。特定のフィルタに対して指定可能な値が不明な場合は、DimensionValues サービスを使用して検索します。

基本的なディメンション値のクエリには、ディメンション名だけでなく、開始日終了日も指定します。開始日と終了日は、その期間内で有効な値にレスポンスを制限します。クエリの結果をさらに限定する必要がある場合は、その他のフィルタも指定できます。

下記の例では、レポートの対象となる期間中に有効な広告主のフィルタ値を検索し、その値をレポート条件に追加します。

C#

// Query advertiser dimension values for report run dates.
DimensionValueRequest request = new DimensionValueRequest();
request.StartDate = report.Criteria.DateRange.StartDate;
request.EndDate = report.Criteria.DateRange.EndDate;
request.DimensionName = "dfa:advertiser";

DimensionValueList values =
    service.DimensionValues.Query(request, profileId).Execute();

if (values.Items.Any()) {
  // Add a value as a filter to the report criteria.
  report.Criteria.DimensionFilters = new List<DimensionValue>() {
    values.Items[0]
  };
}

Java

// Query advertiser dimension values for report run dates.
DimensionValueRequest request = new DimensionValueRequest();
request.setStartDate(report.getCriteria().getDateRange().getStartDate());
request.setEndDate(report.getCriteria().getDateRange().getEndDate());
request.setDimensionName("dfa:advertiser");

DimensionValueList values = reporting.dimensionValues().query(profileId, request).execute();

if (!values.getItems().isEmpty()) {
  // Add a value as a filter to the report criteria.
  List<DimensionValue> filters = Lists.newArrayList(values.getItems().get(0));
  report.getCriteria().setDimensionFilters(filters);
}

PHP

// Query advertiser dimension values for report run dates.
$request = new Google_Service_Dfareporting_DimensionValueRequest();
$request->setStartDate(
    $report->getCriteria()->getDateRange()->getStartDate()
);
$request->setEndDate(
    $report->getCriteria()->getDateRange()->getEndDate()
);
$request->setDimensionName('dfa:advertiser');

$values =
    $this->service->dimensionValues->query($userProfileId, $request);

if (!empty($values->getItems())) {
    // Add a value as a filter to the report criteria.
    $report->getCriteria()->setDimensionFilters([$values->getItems()[0]]);
}

Python

# Query advertiser dimension values for report run dates.
request = {
    'dimensionName': 'dfa:advertiser',
    'endDate': report['criteria']['dateRange']['endDate'],
    'startDate': report['criteria']['dateRange']['startDate']
}

values = service.dimensionValues().query(
    profileId=profile_id, body=request).execute()

if values['items']:
  # Add a value as a filter to the report criteria.
  report['criteria']['dimensionFilters'] = [values['items'][0]]

Ruby

# Query advertiser dimension values for report run dates.
dimension = DfareportingUtils::API_NAMESPACE::DimensionValueRequest.new(
  dimension_name: 'dfa:advertiser',
  start_date: report.criteria.date_range.start_date,
  end_date: report.criteria.date_range.end_date
)

values = service.query_dimension_value(profile_id, dimension)

unless values.items.empty?
  # Add a value as a filter to the report criteria.
  report.criteria.dimension_filters = [values.items.first]
end

フィールドの整合性を判断する

レポート条件を設定する際、指標、ディメンション、フィルタの組み合わせのすべてが有効とは限らないことを忘れないでください。無効な組み合わせを含むレポートは保存できないので、使用する予定のフィールド間の整合性を保つことが重要です。

レポート リソースの作成中に、そのリソースを Reports.compatibleFields サービスに渡して、すでに選択したフィールドに対して、有効なフィールドを確認することができます。レポートの設定が解析され、整合性のあるディメンション、指標、フィルタが返されます。このレスポンスに含まれるフィールド間では、整合性がすべて保証されているわけではありません。場合によってリクエストを複数回行い、選択するフィールドをすべて組み合わせても問題ないかを確認する必要があります。

下記の例では、作成したレポート リソースを入力として、整合性のあるサンプル フィールドをリクエストする方法を示します。

C#

CompatibleFields fields =
    service.Reports.CompatibleFields.Query(report, profileId).Execute();

ReportCompatibleFields reportFields = fields.ReportCompatibleFields;

if(reportFields.Dimensions.Any()) {
  // Add a compatible dimension to the report.
  Dimension dimension = reportFields.Dimensions[0];
  SortedDimension sortedDimension = new SortedDimension();
  sortedDimension.Name = dimension.Name;
  report.Criteria.Dimensions.Add(sortedDimension);
} else if (reportFields.Metrics.Any()) {
  // Add a compatible metric to the report.
  Metric metric = reportFields.Metrics[0];
  report.Criteria.MetricNames.Add(metric.Name);
}

Java

CompatibleFields fields = reporting.reports().compatibleFields()
    .query(profileId, report).execute();

ReportCompatibleFields reportFields = fields.getReportCompatibleFields();

if (!reportFields.getDimensions().isEmpty()) {
  // Add a compatible dimension to the report.
  Dimension dimension = reportFields.getDimensions().get(0);
  SortedDimension sortedDimension = new SortedDimension().setName(dimension.getName());
  report.getCriteria().getDimensions().add(sortedDimension);
} else if (!reportFields.getMetrics().isEmpty()) {
  // Add a compatible metric to the report.
  Metric metric = reportFields.getMetrics().get(0);
  report.getCriteria().getMetricNames().add(metric.getName());
}

PHP

$fields = $this->service->reports_compatibleFields->query(
    $userProfileId,
    $report
);

$reportFields = $fields->getReportCompatibleFields();

if (!empty($reportFields->getDimensions())) {
    // Add a compatible dimension to the report.
    $dimension = $reportFields->getDimensions()[0];
    $sortedDimension = new Google_Service_Dfareporting_SortedDimension();
    $sortedDimension->setName($dimension->getName());
    $report->getCriteria()->setDimensions(
        array_merge(
            $report->getCriteria()->getDimensions(),
            [$sortedDimension]
        )
    );
} elseif (!empty($reportFields->getMetrics())) {
    // Add a compatible metric to the report.
    $metric = $reportFields->getMetrics()[0];
    $report->getCriteria()->setMetricNames(
        array_merge(
            $report->getCriteria()->getMetricNames(),
            [$metric->getName()]
        )
    );
}

Python

fields = service.reports().compatibleFields().query(
    profileId=profile_id, body=report).execute()

report_fields = fields['reportCompatibleFields']

if report_fields['dimensions']:
  # Add a compatible dimension to the report.
  report['criteria']['dimensions'].append({
      'name': report_fields['dimensions'][0]['name']
  })
elif report_fields['metrics']:
  # Add a compatible metric to the report.
  report['criteria']['metricNames'].append(
      report_fields['metrics'][0]['name'])

Ruby

fields = service.query_report_compatible_field(profile_id, report)

report_fields = fields.report_compatible_fields

if report_fields.dimensions.any?
  # Add a compatible dimension to the report.
  report.criteria.dimensions <<
    DfareportingUtils::API_NAMESPACE::SortedDimension.new(
      name: report_fields.dimensions.first.name
    )
elsif report_fields.metrics.any?
  # Add a compatible metric to the report.
  report.criteria.metric_names << report_fields.metrics.first.name
end

レポートを保存する

このプロセスの最後の手順は、レポート リソースを保存することです。新しいレポートを作成している場合、Reports.insert を呼び出してそのレポートを挿入することができます。

C#

Report insertedReport =
    service.Reports.Insert(report, profileId).Execute();

Java

Report insertedReport = reporting.reports().insert(profileId, report).execute();

PHP

$insertedReport =
    $this->service->reports->insert($userProfileId, $report);

Python

inserted_report = service.reports().insert(
    profileId=profile_id, body=report).execute()

Ruby

report = service.insert_report(profile_id, report)

部分更新を行う場合は、Reports.patch を呼び出して変更を保存することができます。

C#

// Patch an existing report.
Report patchedReport =
    service.Reports.Patch(report, profileId, reportId).Execute();

Java

// Patch an existing report.
Report patchedReport = reporting.reports().patch(profileId, reportId, report).execute();

PHP

# Patch an existing report.
$patchedReport =
    $this->service->reports->patch($userProfileId, $reportId, $report)

Python

# Patch an existing report.
patched_report = service.reports().patch(
    profileId=profile_id, reportId=report_id, body=report).execute();

Ruby

# Patch an existing report.
patched_report = service.patch_report(profile_id, report_id, report)

または、全体の更新を選択した場合は、Reports.update を呼び出して変更を保存することができます。

C#

// Update an existing report.
Report updatedReport =
    service.Reports.Update(report, profileId, report.Id).Execute();

Java

// Update an existing report.
Report updatedReport = reporting.reports().update(profileId, report.getId(), report).execute();

PHP

# Update an existing report.
$updatedReport =
    $this->service->reports->update($userProfileId, $report->getId(), $report)

Python

# Update an existing report.
updated_report = service.reports().update(
    profileId=profile_id, reportId=report['id'], body=report).execute();

Ruby

# Update an existing report.
updated_report = service.update_report(profile_id, report.id, report);

リクエストが正常に保存されると、そのレポート リソースのコピーがレスポンスの本文内に返されます。このリソースの複数のフィールドに値が新たに入力されていますが、最も重要なのは id フィールドです。この id は、ワークフローのその後の部分でこのレポートを参照するために使用します。