Senkronize İstekler

Yeni Search Ads 360 Reporting API kullanıma sunuldu. Yeni API, Özel raporlar oluşturmak ve verileri raporlama uygulamalarınıza entegre etmek için daha fazla esneklik ve süreçler. Yeni Search Ads 360 Reporting'e geçme ve bu hizmeti kullanma hakkında daha fazla bilgi edinin. API.

Küçük ve orta düzeyli reklamveren veya arama motoru hesabı raporları isterseniz tek bir eşzamanlı rapor isteği gönderebilir. İsteğe yanıt olarak, Search Ads 360 API raporun tamamını bir JSON nesnesinde döndürür. Eşzamanlı istekler:

• Yalnızca reklamvereni döndürebilir ve arama motoru hesabı raporları
• Search Ads 360 raporu oluşturana kadar müşterinizi engelleyin

Büyük reklamveren veya arama motoru hesabı raporları istiyorsanız eşzamansız bakın.

Eşzamanlı istekte bulunmak için

Telefon et: Reports.generate() reklamveren veya arama motoru hesabı raporunuzda istediğiniz veri türünü belirtin.

Search Ads 360 isteği doğrular, raporu oluşturur ve yanıt gövdesi.

Örnek eşzamanlı istek

Aşağıda örnek bir Reports.generate() verilmiştir isteğinde bulunabilirsiniz.

JSON

POST  https://www.googleapis.com/doubleclicksearch/v2/reports/generate
Authorization: Bearer your OAuth 2.0 access token
Content-type: application/json

{
  "reportScope": {
    "agencyId": "12300000000000456", // Replace with your ID
    "advertiserId": "21700000000011523", // Replace with your ID
    "engineAccountId": "700000000073991" // Replace with your ID
  },
  "reportType": "account",              // This report covers all revenue and visits in the
                                        // engine account specified in reportScope.
  "columns": [
    { "columnName": "date" },           // The date column segments the report by individual days.

    { "columnName": "dfaRevenue" },     // Here are some metric columns available for keyword
    {                                   // reports.
      "columnName": "visits",
      "startDate": "2013-01-01",        // Each metric column can optionally specify its own start 
      "endDate": "2013-01-31",          // and end date; by default the report timeRange is used.
      "headerText": "January visits"    // Every column can optionally specify a headerText, which
                                        // changes the name of the column in the report.
    }
  ],
  "timeRange" : {
    "startDate" : "2012-05-01",         // Dates are inclusive and specified in YYYY-MM-DD format.
    "endDate" : "2013-05-01"

    // Alternatively, try the "changedMetricsSinceTimestamp" or "changedAttributesSinceTimestamp"
    // options. See Incremental reports.

  },
  "statisticsCurrency": "agency",       // Required. See Currency for statistics.
  "verifySingleTimeZone": false,        // Optional. Defaults to false. See Time zone.
  "includeRemovedEntities": false           // Optional. Defaults to false.
}
        

Bu isteği göndermek için Search Ads 360 yardımcı program komut dosyasını kullanın

Ham JSON POST isteği göndermek için sa360Api.py komut dosyasını aşağıdaki gibi kullanın:

1. Örnek JSON nesnesini (iki nesne arasındaki her şey ve bu ikisi arasındaki her şey) kopyalayın süslü ayraç) request.txt adlı yeni bir metin dosyasına ekleyin.
2. JSON kodundaki ajans kimliğini kendi ajans kimliğinizle değiştirin.
3. Yorumları kaldırın (ör. // The date column segments the report by individual days.)
4. OAuth 2.0 kimlik bilgilerinizi virgülle ayrılmış tek bir dizede birleştirin. takip edin:
   client-ID,client-secret,refresh-token
   . (Bu, Kurulumda açıklandığı gibi, sa360Api.py --login komutunu çalıştırdığınızda sa360Api.py tarafından verilen dizeyle aynıdır. Yetkilendirme.)
5. sa360Api.py komutunu şu şekilde çağırın:
   sa360Api.py --cred CREDENTIALS --server API-method --post < request.txt
   Yukarıdaki komutta, önceki adımda oluşturduğunuz dizeyi CREDENTIALS yerine kullanın.
   API-method için POST yönteminin adını aşağıdaki kutuya girin.

   Örneğin:
   sa360Api.py --cred 123456789123.apps.googleusercontent.com,ABCDEFGHIJKLMNOPQR_abcdef,1/HIJklM01OPQR23NOP456rst890uvw --server https://www.googleapis.com/doubleclicksearch/v2/reports/generate --post < request.txt

Java

  public static void main(String[] args) throws Exception {
    Doubleclicksearch service = getService(); // See Set Up Your Application.
    Report report = generateAccountReport(service);
    outputReport(report, "./");
  }

  /**
   * Creates an account report using the synchronous Report.generate method.
   *
   * @throws IOException
   */
  private static Report generateAccountReport(Doubleclicksearch service) throws IOException {
    try {
      return service.reports().generate(generateAccountRequest()).execute();
    } catch (GoogleJsonResponseException e) {
      System.err.println("Report request was rejected.");
      for (ErrorInfo error : e.getDetails().getErrors()) {
        System.err.println(error.getMessage());
      }
      System.exit(e.getStatusCode());
      return null; // Unreachable code.
    }
  }

  /**
   * Creates a simple static request that lists the clicks and visits for an engine account. Use
   * your own agency ID, advertiser ID, and engine account ID.
   */
  private static ReportRequest generateAccountRequest() {
    return new ReportRequest().setReportScope(
      new ReportScope()
        .setAgencyId(20700000000000451L) // Replace with your ID
        .setAdvertiserId(21700000000010391L) // Replace with your ID
        .setEngineAccountId(700000000042201L)) // Replace with your ID
        .setReportType("account")
        .setColumns(Arrays.asList(new ReportApiColumnSpec[] {
            new ReportApiColumnSpec().setColumnName("date"),
            new ReportApiColumnSpec().setColumnName("dfaRevenue"),
            new ReportApiColumnSpec()
                .setColumnName("visits")
                .setHeaderText("January visits")
                .setStartDate("2013-01-01")
                .setEndDate("2013-01-31"),}))
        .setTimeRange(new TimeRange()
          .setStartDate("2012-05-01")
          .setEndDate("2013-05-01"))
        .setStatisticsCurrency("agency");
  }

  /**
   * Outputs a synchronous report to a file.
   */
  private static void outputReport(Report report, String localPath)
      throws IOException {
    FileOutputStream outputStream = new FileOutputStream(new File(localPath, "Report"));
    final PrintStream printStream = new PrintStream(outputStream);
    printStream.print(report);
    printStream.close();
  }
        

Python

def generate_report(service):
  """Generate and print sample report.

  Args:
    service: An authorized Doubleclicksearch service.  See Set Up Your Application.
  """
  request = service.reports().generate(
      body=
      {
        "reportScope
            "agencyId": "12300000000000456", // Replace with your ID
            "advertiserId": "21700000000011523", // Replace with your ID
            "engineAccountId": "700000000073991" // Replace with your ID
            },
        "reportType": "account",
        "columns": [
            { "columnName": "date" },
            { "columnName": "dfaRevenue" },
            {
              "columnName": "visits",
              "startDate": "2013-01-01",
              "endDate": "2013-01-31",
              "headerText": "January visits"
             }
        ],
        "timeRange" : {
            "startDate" : "2012-05-01",
            "endDate" : "2013-05-01"
        },
        "statisticsCurrency": "agency",
        "verifySingleTimeZone": "false",
        "includeRemovedEntities": "false"
        }
  )

  pprint.pprint(request.execute())

Örnek rapor

Eşzamanlı bir isteğin yanıtı bir report nesnesidir. İstek başarıyla doğrulanırsa nesnedeki ilk birkaç özellikte , gönderdiğiniz isteği açıklar. Rapor, nesnenin rows içindedir

{
  "kind":"doubleclicksearch#report",
  "request":{
    "columns":[
      {"columnName":"date"},
      {"columnName":"dfaRevenue"},
      {"columnName":"visits","endDate":"2013-01-31","headerText":"visits last month","startDate":"2013-01-01"}
    ],
    "includeDeletedEntities":false,
    "reportScope":{
      "agencyId":"12300000000000456",
      "advertiserId":"21700000000011523",
      "engineAccountId":"700000000073991"
     },
    "reportType":"account",
    "rowCount":10000,
    "startRow":0,
    "statisticsCurrency":"agency",
    "timeRange":{
      "endDate":"2013-05-01",
      "startDate":"2012-05-01"
     }
  },
  "rowCount":366,
  "rows":[
    {
      "date":"2012-05-01",
      "dfaRevenue":0.0,
      "visits last month":0.0
    },
    {
      "date":"2012-05-02",
      "dfaRevenue":0.0,
      "visits last month":0.0
    },
    {
      "date":"2012-05-03",
      "dfaRevenue":0.0,
      "visits last month":0.0
    },
    {
      "date":"2012-05-04",
      "dfaRevenue":0.0,
      "visits last month":0.0
     },
     ...
  ]
}
        

Doğrulama başarısız olursa

Rapor doğrulamayı geçemezse Search Ads 360 bir HTTP 400 yanıtı döndürür hata nesnesiyle karşılaşırsınız. Örneğin, yukarıdaki örnek istekte gerçek bir ajans:

{
 "error": {
   "code": 400,
   "message": "statisticsCurrency: the agency in scope does not have a valid currency. Please make sure the agency is properly initialized in Search Ads 360."
 }
}

Eşzamanlı raporları birden çok yanıta bölme

Varsayılan olarak, eşzamanlı bir istek ilk 10.000 satırı döndürür. Bu davranışı değiştirmek için Reports.request.startRow bağlantısını kullanın ve Reports.request.rowCount özelliklerini kullanabilirsiniz.

Eşzamanlı bir raporu bölme örneği

Örneğin, bu istek bir ajans raporunun ilk yüz satırını (0 ile 99 arası) döndürür (güne göre segmentlere ayrılmış)

{
  "reportScope": {
    "agencyId": "12300000000000456", // Replace with your ID
    "advertiserId": "21700000000011523", // Replace with your ID
    "engineAccountId": "700000000073991" // Replace with your ID
  },
  "reportType": "account",
  "columns": [
    { "columnName": "date" },
    { "columnName": "dfaRevenue" }
  ],
  "timeRange" : {
    "startDate" : "2012-05-01",
    "endDate" : "2013-05-01"
  },
  "startRow":"0",
  "rowCount":"100",
  "statisticsCurrency": "agency",
  "verifySingleTimeZone": false,
  "includeRemovedEntities": false
}
    

Bu isteği 100 ile 199 arasındaki satırlar için başka bir istekle takip edebilirsiniz:

{
  "reportScope": {
    "agencyId": "12300000000000456", // Replace with your ID
    "advertiserId": "21700000000011523", // Replace with your ID
    "engineAccountId": "700000000073991" // Replace with your ID
  },
  "reportType": "account",
  "columns": [
    { "columnName": "date" },
    { "columnName": "dfaRevenue" }
  ],
  "timeRange" : {
    "startDate" : "2012-05-01",
    "endDate" : "2013-05-01"
  },
  "startRow":"100",
  "rowCount":"100",
  "statisticsCurrency": "agency",
  "verifySingleTimeZone": false,
  "includeRemovedEntities": false
}