Операция запуска отчета выполняется асинхронно как длительная операция, представленная объектом Operation . Результатом операции запуска отчета являются результаты отчета, основанные на объекте Report .
В этом руководстве описано, как использовать API Curation Partners для получения информации о статусе выполнения операции создания отчета и получения результатов завершенной операции создания отчета.
Прежде чем начать
Прежде чем продолжить, необходимо выполнить следующие действия:
- Настройте аутентификацию .
- Запустите формирование отчета , чтобы получить имя ресурса, используемого в длительной операции.
Статус опроса запущенного отчета
Чтобы проверить статус выполнения операции запуска отчета, используйте метод curators.reports.operations.get .
В следующем примере выполняется GET запрос для опроса операции:
ОТДЫХ
Запрос
curl \
'https://curationpartners.googleapis.com/v1/curators/ACCOUNT_ID/reports/123456789/operations/10486370264' \
--header 'Authorization: Bearer ACCESS_TOKEN' \
--header 'Accept: application/json' \
--compressed
Замените следующее:
-
ACCOUNT_ID: ваш идентификатор учетной записи. -
ACCESS_TOKEN: ваш токен доступа.
Ответ
В случае успешного завершения в ответе будет отображаться Operation с полем done , установленным в значение true , а полезная нагрузка response будет заполнена именем ресурса reportResult :
{
"name": "curators/ACCOUNT_ID/reports/123456789/operations/10486370264",
"done": true,
"metadata": {
"@type": "type.googleapis.com/google.ads.curationpartners.v1.RunReportMetadata",
"percentComplete": 100
},
"response": {
"@type": "type.googleapis.com/google.ads.curationpartners.v1.RunReportResponse",
"reportResult": "curators/ACCOUNT_ID/reports/123456789/results/10486370264"
}
}
Java
/* * Copyright (c) 2026 Google LLC * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except * in compliance with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software distributed under the License * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express * or implied. See the License for the specific language governing permissions and limitations under * the License. */ package com.google.api.services.samples.curationpartners.v1.curators.reports.operations; import com.google.api.services.curationpartners.v1.CurationPartners; import com.google.api.services.curationpartners.v1.model.Operation; import com.google.api.services.samples.curationpartners.v1.Utils; import java.io.IOException; import java.security.GeneralSecurityException; import net.sourceforge.argparse4j.ArgumentParsers; import net.sourceforge.argparse4j.inf.ArgumentParser; import net.sourceforge.argparse4j.inf.ArgumentParserException; import net.sourceforge.argparse4j.inf.Namespace; public class GetReportOperation { /** * Executes the get operation for a report operation. * * @param curationPartnersClient the initialized Curation Partners API client. * @param accountId the account ID of the curator. * @param reportId the resource ID of the report. * @param operationId the resource ID of the report operation. * @throws IOException if the API returns an error. */ public static void execute( CurationPartners curationPartnersClient, Long accountId, String reportId, String operationId) throws IOException { String name = String.format( "curators/%s/reports/%s/operations/%s", accountId, reportId, operationId); System.out.printf("Getting report operation with name \"%s\".%n", name); // Get the status of the report operation. Operation operation = curationPartnersClient .curators() .reports() .operations() .get(name) .execute(); System.out.println("Successfully retrieved report operation:"); Utils.jsonPrettyPrint(operation); } /** * Creates and configures the ArgumentParser for this sample. * * @return the configured ArgumentParser. */ private static ArgumentParser createArgumentParser() { ArgumentParser parser = ArgumentParsers.newFor("GetReportOperation") .build() .defaultHelp(true) .description("Gets the status of a long-running report operation. If the " + "operation is done, you can view the report contents with the " + "`curators.reports.results.fetchRows` method."); // Required arguments. parser .addArgument("-a", "--account_id") .help("The account ID of the curator.") .required(true) .type(Long.class); parser .addArgument("-r", "--report_id") .help("The resource ID of the report.") .required(true); parser .addArgument("-o", "--operation_id") .help("The resource ID of the report operation to retrieve.") .required(true); return parser; } public static void main(String[] args) { ArgumentParser parser = createArgumentParser(); Namespace parsedArgs = null; try { parsedArgs = parser.parseArgs(args); } catch (ArgumentParserException ex) { parser.handleError(ex); System.exit(1); } CurationPartners client = null; try { client = Utils.getCurationPartnersClient(); } catch (IOException ex) { System.out.printf("Unable to create Curation Partners API service:%n%s", ex); System.out.println("Did you specify a valid path to a service account key file?"); System.exit(1); } catch (GeneralSecurityException ex) { System.out.printf("Unable to establish secure HttpTransport:%n%s", ex); System.exit(1); } try { execute( client, parsedArgs.getLong("account_id"), parsedArgs.getString("report_id"), parsedArgs.getString("operation_id")); } catch (IOException ex) { System.out.printf("Curation Partners API returned error response:%n%s", ex); System.exit(1); } } }
Ниже описано, как использовать поле done для проверки статуса операции:
- Если поле
doneв ответе имеет значениеfalse, операция выполнения отчета все еще выполняется. - Если поле
doneв ответе имеет значениеtrue, операция выполнения отчета завершена. ОбъектOperationв теле ответа также содержит одно из следующих полей:-
response: Указывает на успешное выполнение операции создания отчета. Это поле представляет собой объект, заполненный полем@type, установленным на типtype.googleapis.com/google.ads.curationpartners.v1.RunReportResponse. ТипRunReportResponseзаполняется полемreportResult, содержащим имя соответствующегоresultотчета. -
error: указывает на то, что операция запуска отчета не удалась. Полеerrorзаполняется объектомStatus, описывающим причину сбоя запуска отчета.
-
Извлечение строк из завершенного отчета
Содержимое завершенной операции запуска отчета можно получить с помощью метода curators.reports.results.fetchRows . Необходимо указать параметр пути name для результата отчета, который представляет собой имя ресурса из поля reportResult завершенной операции запуска отчета.
В следующем примере выполняется GET запрос для получения строк результатов:
ОТДЫХ
Запрос
curl \
'https://curationpartners.googleapis.com/v1/curators/ACCOUNT_ID/reports/123456789/results/10486370264:fetchRows?pageSize=1' \
--header 'Authorization: Bearer ACCESS_TOKEN' \
--header 'Accept: application/json' \
--compressed
Ответ
{
"rows": [
{
"dimensionValues": [
{
"stringValue": "2026-08-01"
},
{
"stringValue": "segment-1001"
}
],
"metricValueGroups": [
{
"primaryValues": [
{
"intValue": "150000"
},
{
"intValue": "3200"
},
{
"doubleValue": 450.75
},
{
"doubleValue": 45.08
}
]
}
]
}
],
"runTime": "2026-08-05T12:00:00Z",
"dateRanges": [
{
"startDate": {
"year": 2026,
"month": 7,
"day": 6
},
"endDate": {
"year": 2026,
"month": 8,
"day": 4
}
}
],
"totalRowCount": 2,
"nextPageToken": "QC7nzW91c2VTcGFubmVyQ29udGlubWF0aW6uVG9wZY45NP=="
}
Java
/* * Copyright (c) 2026 Google LLC * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except * in compliance with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software distributed under the License * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express * or implied. See the License for the specific language governing permissions and limitations under * the License. */ package com.google.api.services.samples.curationpartners.v1.curators.reports.results; import com.google.api.services.curationpartners.v1.CurationPartners; import com.google.api.services.curationpartners.v1.model.FetchReportResultRowsResponse; import com.google.api.services.samples.curationpartners.v1.Utils; import java.io.IOException; import java.security.GeneralSecurityException; import net.sourceforge.argparse4j.ArgumentParsers; import net.sourceforge.argparse4j.inf.ArgumentParser; import net.sourceforge.argparse4j.inf.ArgumentParserException; import net.sourceforge.argparse4j.inf.Namespace; public class FetchReportResultRows { /** * Executes the fetchRows operation for report result rows. * * @param curationPartnersClient the initialized Curation Partners API client. * @param accountId the account ID of the curator. * @param reportId the resource ID of the report. * @param resultId the resource ID of the report result. * @param pageSize the maximum number of rows to return per page. * @param pageToken the page token from a previous response, if any. * @throws IOException if the API returns an error. */ public static void execute( CurationPartners curationPartnersClient, Long accountId, String reportId, String resultId, Integer pageSize, String pageToken) throws IOException { String name = String.format("curators/%s/reports/%s/results/%s", accountId, reportId, resultId); System.out.printf("Fetching report result rows for \"%s\".%n", name); CurationPartners.Curators.Reports.Results.FetchRows request = curationPartnersClient.curators().reports().results().fetchRows(name); if (pageSize != null) { request.setPageSize(pageSize); } if (pageToken != null) { request.setPageToken(pageToken); } FetchReportResultRowsResponse response = request.execute(); System.out.println("Successfully fetched report result rows:"); Utils.jsonPrettyPrint(response); } /** * Creates and configures the ArgumentParser for this sample. * * @return the configured ArgumentParser. */ private static ArgumentParser createArgumentParser() { ArgumentParser parser = ArgumentParsers.newFor("FetchReportResultRows") .build() .defaultHelp(true) .description("Fetches rows for a completed report result."); // Required arguments. parser .addArgument("-a", "--account_id") .help("The account ID of the curator.") .required(true) .type(Long.class); parser .addArgument("-r", "--report_id") .help("The resource ID of the report.") .required(true); parser .addArgument("--result_id") .help("The resource ID of the report result. This is identical to the resource ID of " + "the corresponding report run operation.") .required(true); // Optional arguments. parser .addArgument("--page_size") .help("The maximum number of rows to return per page.") .type(Integer.class); parser .addArgument("--page_token") .help("A page token, received from a previous `FetchReportResultRows` call."); return parser; } public static void main(String[] args) { ArgumentParser parser = createArgumentParser(); Namespace parsedArgs = null; try { parsedArgs = parser.parseArgs(args); } catch (ArgumentParserException ex) { parser.handleError(ex); System.exit(1); } CurationPartners client = null; try { client = Utils.getCurationPartnersClient(); } catch (IOException ex) { System.out.printf("Unable to create Curation Partners API service:%n%s", ex); System.out.println("Did you specify a valid path to a service account key file?"); System.exit(1); } catch (GeneralSecurityException ex) { System.out.printf("Unable to establish secure HttpTransport:%n%s", ex); System.exit(1); } try { execute( client, parsedArgs.getLong("account_id"), parsedArgs.getString("report_id"), parsedArgs.getString("result_id"), parsedArgs.getInt("page_size"), parsedArgs.getString("page_token")); } catch (IOException ex) { System.out.printf("Curation Partners API returned error response:%n%s", ex); System.exit(1); } } }
Вы можете указать следующие параметры запроса:
-
pageSize: максимальное количество возвращаемых строк. Значение по умолчанию — 1000 строк, максимальное — 10 000 строк. -
pageToken: токен страницы, возвращенный в предыдущем ответеfetchRows, для получения следующей партии строк.
Ответ содержит следующие поля:
-
rows: Массив объектовRow. Каждая строка содержит:-
dimensionValues: Значения для каждого запрошенного измерения, упорядоченные так же, как и измерения в определении отчета. -
metricValueGroups: Группы значений метрик, соответствующие диапазонам дат. Каждая группа содержит списокprimaryValuesупорядоченный так же, как и метрики в определении отчета.
-
-
dateRanges: Вычисляемые фиксированные диапазоны дат для отчета. ПолеdateRangesвключается только в текст ответа на первой странице. -
totalRowCount: Общее количество строк в результатах отчета. ПолеtotalRowCountвключается только в тело ответа на первой странице. -
nextPageToken: Токен, передаваемый в последующих запросах для получения следующей страницы строк. Если дополнительных строк нет, API партнеров по курированию пропускает это поле из тела ответа.
В примере REST curators.reports.results.fetchRows каждый элемент в rows напрямую соответствует ReportDefinition , настроенному в отчете:
-
dimensionValues: содержит значения, соответствующие каждому измерению в полеreportDefinition.dimensions, в точно указанном вами порядке. В примере первое значение2026-08-01соответствует измерениюDATE, а второе значение,segment-1001, соответствует измерениюCURATION_DATA_SEGMENT_ID. metricValueGroups: содержит значения метрик, сгруппированные по диапазонам дат отчета. В каждой группе полеprimaryValuesсодержит значения, соответствующие каждой метрике в полеreportDefinition.metrics, в точном порядке, указанном вами. В этом примере четыре значения соответствуют следующим значениям перечисленияMetric:-
IMPRESSIONS:150000 -
CLICKS:3200 -
SPEND:450.75 -
CURATION_PARTNER_FEE:45.08
-
dateRanges: содержит фиксированный диапазон дат, вычисленный Google для относительного диапазонаTHIS_MONTH_TO_DATE, заданного в определении отчета.
Следующие шаги
- Узнайте, как создавать и изменять отчеты с помощью API партнеров по кураторству.
- Узнайте, как просматривать существующие отчеты с помощью API партнеров по кураторству.
- Узнайте, как создавать отчеты с помощью API партнеров по кураторству.