本頁面由 Cloud Translation API 翻譯而成。

建立及更新報表

Campaign Manager 360 API 的報表服務可讓您使用報表資源物件建立及更新「報表製作工具」報表。報表資源概述了執行報表的基本資訊，以及報表輸出的結構。

本指南詳細說明如何透過報表服務，透過程式建立及更新「報表製作工具」的報表。

設定報表資源

建立或更新「報表製作工具」報表的第一步是設定報表資源物件。新建報表時，一開始您可以先使用空的資源，並設定必要的欄位。如果您要更新現有報表，可以選擇：

建議使用：執行部分更新。採用這個方法時，您會先從空資源著手，然後設定要變更的欄位。部分更新只會儲存所選欄位的變更。
正在執行完整更新。這樣就會載入現有的報表資源，並直接修改其欄位。完整更新則會儲存報表的所有欄位。

報表資源的確切內容取決於您設定的報表類型。即使如此，以下幾個報表類型也通用的欄位：

欄位	說明
必填欄位
名稱	報表的名稱。
類型	報表類型。
選填欄位
delivery	報表的電子郵件傳送設定。
fileName	產生這份報表報表檔案時使用的檔案名稱。
format	報表的輸出格式 (CSV 或 Excel)。
時間表	定期執行報表的時間表。

這些常見欄位構成報表的基本資料，以下範例說明如何建立新的標準報表資源：

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'
}

小茹

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	floodlightCriteria
CROSS_DIMENSION_REACH	crossDimensionReachCriteria

儘管每個類型專屬的條件都會顯示一組略為不同的欄位，但還有一組常見條件欄位，對於控制報表輸出作業來說很有用：

欄位	說明
dateRange	此報表的執行日期。可用來指定自訂開始和結束日期，或是相對日期範圍。注意：透過 API 執行報表時，系統會以美國/洛杉磯時區解析相對日期範圍 (例如 `YESTERDAY`)。時區不同，可能會導致使用者遇到非預期的結果。
dimensionFilters	限制傳回結果的篩選器清單。想進一步瞭解如何設定篩選器，請參閱查詢篩選器值一節。
尺寸	要加入報表輸出結果的 Campaign Manager 360 元素清單。
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 = "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

小茹

# 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]]

小茹

# 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'])

小茹

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()

小茹

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();

小茹

# 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();

小茹

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

成功儲存要求後，回應主體中會傳回報表資源的副本。這項資源會填寫數個新欄位，其中最重要的是 id 欄位。這個 ID 就是您在其他工作流程中，用來參照這份報表的名稱。

建立及更新報表 透過集合功能整理內容 你可以依據偏好儲存及分類內容。

設定報表資源

C#

Java

PHP

Python

小茹

定義報表條件

C#

Java

PHP

Python

小茹

查詢篩選器值

C#

Java

PHP

Python

小茹

判斷欄位相容性

C#

Java

PHP

Python

小茹

儲存報表

C#

Java

PHP

Python

小茹

C#

Java

PHP

Python

小茹

C#

Java

PHP

Python

小茹

建立及更新報表