このページは Cloud Translation API によって翻訳されました。

レポートを作成および更新する

キャンペーンマネージャー 360 API のレポートサービスでは、レポートリソースオブジェクトを使用して、レポートビルダーのレポートを作成および更新できます。レポートリソースには、実行するレポートに関する基本情報と、レポート出力の構造が表示されます。

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

レポートリソースを構成する

レポートビルダーのレポートを作成または更新するには、まずレポートリソースオブジェクトを設定します。新しいレポートを作成するときは、空のリソースから始めて必要なフィールドを設定します。既存のレポートを更新する場合は、次のどちらかを選択できます。

推奨: 部分更新を行います。この方法では、空のリソースから始めて、変更するフィールドを設定します。部分更新では、指定したフィールドに対する変更のみが保存されます。
フルアップデートの実行。この方法では、既存のレポートリソースを読み込み、フィールドを直接変更します。完全更新を行うと、レポートのフィールドが常に保存されます。

レポートリソースの具体的な内容は、レポートの種類によって異なります。その場合も、すべてのレポートタイプに共通するフィールドがいくつかあります。

Field	説明
必須フィールド
name	レポートの名前。
type	レポートのタイプ。
省略可能項目
デリバリー	レポートのメール配信設定。
ファイル名	このレポートのレポートファイルを生成する際に使用されるファイル名。
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'
)

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

レポートタイプを選択して共通フィールドを設定したら、次にレポート条件を定義します。レポートの条件はレポートの範囲を制限し、関連情報のみが含まれるようにするために使用されます。また、レポート出力の構造も定義します。

使用される基準はレポートの種類によって異なります。レポートの種類と条件の関係を次の表に示します。

レポートタイプ	条件フィールド
標準	基準
REACH	reachCriteria
PATH_TO_CONVERSION	pathToConversionCriteria
Floodlight	Floodlight 条件
CROSS_DIMENSION_REACH（英語）	crossDimensionReachCriteria

これらのタイプ固有の基準のそれぞれが若干異なるフィールドセットを公開しますが、一般的にレポート出力の制御に役立つ一般的な条件フィールドのセットがあります。

Field	説明
dateRange	このレポートを実行する日付。カスタム開始日と終了日、または相対的な期間を指定できます。注: API を使用してレポートを作成すると、`YESTERDAY` のような相対的な期間は米国/ロサンゼルスのタイムゾーンで解決されます。これにより、タイムゾーンが異なるユーザーに対して予期しない結果が生じる可能性があります。
ディメンションフィルタ	返される結果を制限するフィルタのリスト。フィルタの設定の詳細については、クエリフィルタの値をご覧ください。
ディメンション	レポート出力に含めるキャンペーンマネージャー 360 要素のリスト。
指標名	レポート出力に含める標準の測定単位。

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

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

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 = "advertiser";

Report.CriteriaData criteria = new Report.CriteriaData();
criteria.DateRange = dateRange;
criteria.Dimensions = new List<SortedDimension>() { dimension };
criteria.MetricNames = new List<string>() {
  "clicks",
  "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("advertiser")));
criteria.setMetricNames(Lists.newArrayList("clicks", "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('advertiser');

$criteria = new Google_Service_Dfareporting_ReportCriteria();
$criteria->setDateRange($dateRange);
$criteria->setDimensions([$dimension]);
$criteria->setMetricNames(['clicks', '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': 'advertiser'
    }],
    'metricNames': ['clicks', '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: 'advertiser'
    )
  ],
  metric_names: ['clicks', '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 = "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("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('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': '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: '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 は、ワークフローの残りでこのレポートを参照する際に使用されます。

レポートを作成および更新する

レポート リソースを構成する

C#

Java

PHP

Python

Ruby

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

C#

Java

PHP

Python

Ruby

フィルタの値をクエリ

C#

Java

PHP

Python

Ruby

フィールドの互換性を確認する

C#

Java

PHP

Python

Ruby

レポートを保存する

C#

Java

PHP

Python

Ruby

C#

Java

PHP

Python

Ruby

C#

Java

PHP

Python

Ruby

レポートリソースを構成する