Panduan Search Console API

TL;DR — Search Console API lets Anda grab Anda Google Search Console data dengan code alih-alih clicking melalui interface. ini adalah bagaimana Anda mendapatkan lebih daripada UI hands Anda — export di interface tops out sekitar 1 000 rows, sementara API memberikan Anda up untuk 25 000 per permintaan. Anda log di dengan Google (OAuth, tidak sebuah sederhana API key), dan Anda hanya mendapatkan data untuk situs Anda’ve verified.

Apa Search Console API adalah

Search Console menampilkan Anda bagaimana Anda situs melakukan di Google — apa kueri Anda peringkat untuk, bagaimana banyak clicks dan impressions Anda mendapatkan, apakah Anda halaman adalah terindeks. API memberikan Anda programmatic access untuk banyak dari itu sama data dan itu sama controls, so Anda dapat feed ini ke sebuah spreadsheet, sebuah dashboard, atau sebuah script itu berjalan pada sebuah schedule. ini adalah tidak penuh UI parity, though — sebuah sedikit hal (like langsung-testing sebuah URL) hanya exist di interface, dan memiliki API access atau automation tidak oleh itself jaminan pengindeksan, rankings, traffic diagnosis, atau AI-penelusuran visibilitas.

ada four pieces:

1. Penelusuran Analytics API — Anda performa report angka (clicks, impressions, CTR, average position), rusak down oleh kueri, halaman, country, device, dan date.
2. pemeriksaan URL API — indeks status dari sebuah single URL. ini reports versi saat ini di Google’s indeks; interface’s pemeriksaan URL alat dapat juga jalankan sebuah pengujian langsung, yang API dapat’t melakukan.
3. Sitemaps API — list, submit, atau delete Anda sitemaps.
4. situs API — list, tambahkan, atau hapus properties pada Anda account.

«Platform-property boundary: Search Console now has separate Instagram, TikTok, X, and YouTube properties, but Google’s current platform documentation describes their interface reports and report export—not a siteUrl identifier or support contract for these legacy endpoints. The API workflow in this article therefore covers website properties only. LinkedIn is not a supported platform property. » (Terjemahan) (Ringkasan bahasa Indonesia untuk bagian delapan, bagian kecil satu: teks sumber dipertahankan agar dapat diperiksa dalam tinjauan penutur asli.)

Mengapa gunakan ini alih-alih interface

big satu: rows. jika Anda export performa report dari Penelusuran Console interface, Anda mendapatkan roughly 1 000 rows. API mengembalikan up untuk 25 000 rows per permintaan, dan Anda dapat halaman melalui untuk lebih. jika Anda’ve mendapat sebuah situs dengan thousands dari kueri atau halaman, interface sekadar tidak tampilkan Anda sebagian besar dari Anda data.

lainnya alasan adalah automation. Setelah ini adalah sebuah API panggil, Anda dapat jalankan ini setiap morning, dump ini ke sebuah dashboard, atau alert yourself ketika clicks drop.

catch

Anda dapat hanya pull data untuk properties Anda’ve verified di Search Console. poin API di sebuah situs Anda tidak own dan Anda mendapatkan tidak ada apa pun back — itu’s paling umum beginner stumble.

dan API tidak memberikan Anda semuanya. ini mengembalikan top rows, tidak penuh list, dan ini tidak pernah menampilkan Anda kueri Google anonymizes untuk privacy. untuk sebuah big situs itu ingin menyelesaikan picture, better alat adalah bulk data export untuk BigQuery — lebih pada itu di itu Advanced version.

«> TL;DR — The Search Console API is four REST APIs under webmaster-tools/v1

— Search Analytics, URL Inspection, Sitemaps, Sites — all OAuth 2.0, all scoped to verified properties only. Search Analytics returns 1–25,000 rows per request (default 1,000) but “does not guarantee to return all data rows but rather top ones,” so for completeness at scale you graduate to the BigQuery bulk data export. URL Inspection is hard-capped at 2,000 QPD / 600 QPM per site — that arithmetic is what gates large-scale index monitoring.

» (Terjemahan) (Ringkasan bahasa Indonesia untuk bagian tujuh belas, bagian kecil satu: teks sumber dipertahankan agar dapat diperiksa dalam tinjauan penutur asli.)

ini API guide adalah scoped untuk situs web properties. melakukan tidak assume situs, Penelusuran Analytics, pemeriksaan URL, atau Sitemaps endpoints mendukung Instagram, TikTok, X, atau YouTube platform properties until Google documents identifier dan endpoint contract.

four APIs di sebuah glance

«Google’s own framing of what the API does: it lets you “view, add, or remove properties and sitemaps, run advanced queries for Google Search results data for the properties that you manage in Search Console, and test individual pages.” That maps cleanly onto the four resources, all under webmaster-tools/v1: » (Terjemahan) (Ringkasan bahasa Indonesia untuk bagian dua puluh, bagian kecil satu: teks sumber dipertahankan agar dapat diperiksa dalam tinjauan penutur asli.)

• Penelusuran Analytics API — performa report, programmatically: clicks, impressions, CTR, position oleh dimension (kueri, halaman, country, device, penelusuran appearance, date, hour).
• pemeriksaan URL API — indeks status dari sebuah single URL, programmatic sibling dari pemeriksaan URL alat.
• Sitemaps API — list, mendapatkan, submit, dan delete sitemaps.
• situs API — list, tambahkan, dan hapus verified properties.

ini exposes banyak dari apa Anda sudah gunakan di interface — performa report dan pemeriksaan URL alat — sebagai endpoints Anda dapat script terhadap. ini tidak sebuah 1:1 mirror, though: API tidak jaminan penuh UI parity (URL Inspection’s pengujian langsung, misalnya, adalah UI-hanya — see di bawah), dan neither API access nor automation pada -nya own jaminan pengindeksan, rankings, traffic diagnosis, atau AI-penelusuran visibilitas.

Auth: OAuth 2,0, dua scopes, verified properties hanya

«There’s no API key. Every call is OAuth 2.0 — Google is explicit that “all requests to the Google Search Console API must be authorized by an authenticated user.” You register an app in Google Cloud, request a scope, and get a short-lived access token. Two scopes exist: » (Terjemahan) (Ringkasan bahasa Indonesia untuk bagian dua puluh empat, bagian kecil satu: teks sumber dipertahankan agar dapat diperiksa dalam tinjauan penutur asli.)

• https://www.googleapis.com/auth/webmasters — baca/tulis.
• https://www.googleapis.com/auth/webmasters.readonly — baca-hanya.

untuk server-untuk-server automation (sebuah nightly reporting job, sebuah indeks monitor) Anda grant sebuah service account access untuk property dan skip interactive consent flow.

untuk situs web properties, dua property-identifier formats penting di sini too: sebuah URL-prefix property adalah lulus sebagai sebuah penuh property URL (Google’s own contoh adalah http://www.example.com/), dan sebuah Domain property menggunakan sc-domain:example.com form — Anda memiliki untuk lulus whichever form matches bagaimana property adalah verified di Search Console. Either cara, service account (atau pengguna) perlu untuk menjadi granted access untuk itu tepat property; ini adalah tidak sebuah bypass untuk kepemilikan atau sebuah blanket grant di seluruh setiap property pada account.

«And the gate that trips everyone up: “You must have appropriate access (owner, full, read) to any Google Search Console account that you wish to access using the API.” Call the API for a property you’re not verified on and it returns nothing — not an error you’ll necessarily notice, just empty data. » (Terjemahan) (Ringkasan bahasa Indonesia untuk bagian dua puluh delapan, bagian kecil satu: teks sumber dipertahankan agar dapat diperiksa dalam tinjauan penutur asli.)

Penelusuran Analytics API — performa report, di scale

«Start with the ceiling, not the convenience: Google’s own caveat is that “The API is bounded by internal limitations of Search Console and does not guarantee to return all data rows but rather top ones.” Pagination extends how far you can page into that top-rows list — it doesn’t remove the ceiling. When you need every row, that’s the cue to reach for BigQuery bulk export (below), not a bigger rowLimit. » (Terjemahan) (Ringkasan bahasa Indonesia untuk bagian tiga puluh, bagian kecil satu: teks sumber dipertahankan agar dapat diperiksa dalam tinjauan penutur asli.)

di dalam itu ceiling, ini adalah masih satu sebagian besar orang come untuk. alasan ini beats interface adalah rowLimit parameter: “[Opsional; Valid range adalah 1–25,000; Default adalah 1,000].” (terjemahan) “[Opsional; Valid range adalah 1–25 000; Default adalah 1 000].” interface export caps near 1 000 rows; API memberikan Anda up untuk 25 000 per permintaan, dan Anda paginate past itu dengan startRow. pada sebuah situs dengan sebuah panjang tail dari kueri, itu’s perbedaan antara seeing top dari Anda data dan seeing lebih dari ini — masih tidak semua dari ini.

Dua lebih hal shape apa muncul back. pertama, dataState controls freshness: final ( default) mengembalikan hanya finalized data, all mencakup fresh, recently collected data, dan hourly_all memberikan hourly breakdowns itu adalah explicitly sebagian — respons metadata flags sebuah first_incomplete_date atau first_incomplete_hour, dan Google notes nilai setelah itu poin dapat masih perubahan. kedua, Penelusuran Analytics quotas tidak sebuah single angka: usage limits halaman splits them ke muat limits (sebuah resource-based allowance diukur di 10-minute dan 1-day chunks — wider date ranges, lebih dimensions, dan lebih berat filtering semua draw ini down lebih cepat) dan QPS/QPM/QPD permintaan-rate limits covered di bawah. Anda dapat hit muat ceiling sebelum Anda hit permintaan-rate ceiling.

pemeriksaan URL API — dan quota itu sebenarnya constrains Anda

«The URL Inspection API “view[s] the indexed, or indexable, status of the provided URL. Presently only the status of the version in the Google index is available; you cannot test the indexability of a live URL.” That last clause is a real scope limit, not a technicality: the interface’s URL Inspection tool can run a live test against the page as it exists right now; the API can only report on the version Google already has indexed. Use the API to build index-coverage monitoring across many URLs — not as a substitute for the UI’s live test. » (Terjemahan) (Ringkasan bahasa Indonesia untuk bagian tiga puluh empat, bagian kecil satu: teks sumber dipertahankan agar dapat diperiksa dalam tinjauan penutur asli.)

Di sini’s di mana math penting. Per situs, Anda mendapatkan 2 000 kueri per day dan 600 per minute. (Per project ceiling adalah far lebih tinggi — 10 000 000/day dan 15 000/minute — tetapi per-situs cap adalah apa bites.) jika Anda ingin monitor indeks status dari sebuah 50 000-URL situs, Anda dapat’t inspect them semua di sebuah day; Anda batch dan schedule di seluruh days, atau Anda prioritize. Sedikit posts melakukan ini arithmetic, dan ini adalah single biggest planning constraint pada besar-scale indeks monitoring.

oleh contrast, Penelusuran Analytics adalah generous — 1 200 QPM per situs dan per pengguna — dan lainnya resources (Sitemaps, situs) sit di 20 QPS / 200 QPM per pengguna. URL Inspection adalah tight satu.

Sitemaps dan situs APIs

Sitemaps API adalah management layer untuk Anda sitemaps: ini “submits a sitemap untuk a site,” (terjemahan) “submits sebuah sitemap untuk sebuah situs,” “deletes a sitemap from this site,” (terjemahan) “deletes sebuah sitemap dari ini situs,” “retrieves information about a specific sitemap,” (terjemahan) “retrieves informasi tentang sebuah spesifik sitemap,” dan “lists the sitemaps-entries submitted for this site, or included in the sitemap index file.” (terjemahan) “lists sitemaps-entries submitted untuk ini situs, atau disertakan di sitemap indeks file.” sitemap resource ini mengembalikan mencakup fields like path, lastSubmitted, isPending, isSitemapsIndex, lastDownloaded, warnings, errors, dan sebuah contents array — handy untuk auditing sitemap health di scale.

situs API lists, menambahkan, dan menghapus verified properties — berguna jika Anda manage banyak properties dan ingin untuk provision atau audit them programmatically.

Ketika untuk gunakan BigQuery bulk export alih-alih

untuk besar situs, API’s 25 000-rows-per-permintaan, top-rows-hanya model becomes sebuah ceiling. Google’s jawaban tidak sebuah fifth API resource itu mengembalikan yang sama shape dari data — ini adalah sebuah terpisah, scheduled export pipeline: bulk data export untuk BigQuery. Think dari pilihan sebagai pull vs. scheduled push, tidak “API A vs. API B.” (terjemahan) “API sebuah vs. API B.” Google’s own framing: “Schedule a daily export dari Anda Search Console performance data untuk BigQuery, di mana Anda dapat jalankan complex queries over Anda data atau export it untuk an external storage service. Menggunakan itu bulk data export feature, Anda’ll see all itu performance data tersedia untuk Search Console untuk Anda property, dengan itu exception dari anonymized queries.” (terjemahan) “Schedule sebuah daily export dari Anda Search Console performa data untuk BigQuery, di mana Anda dapat jalankan kompleks kueri di atas Anda data atau export ini untuk sebuah external storage service. menggunakan bulk data export fitur, Anda’ll see semua performa data tersedia untuk Search Console untuk Anda property, dengan exception dari anonymized kueri.”

itu’s decision aturan:

• Interface export — ~1 000 rows, quick satu kali look.
• Penelusuran Analytics API — up untuk 25 000 rows/permintaan, paginate, scriptable; great untuk moderate pada-demand pulls dan dashboards.
• BigQuery bulk export — semua tersedia performa data, daily, Tidak baris cap; right alat setelah Anda’ve mendapat tens dari thousands dari halaman atau kueri.

satu hal none dari them memberikan Anda adalah anonymized kueri — istilah Google hides untuk privacy. itu’s sebuah nyata kesenjangan, tidak sebuah bug Anda dapat berfungsi sekitar. I know scale dari ini firsthand: sebagai Ahrefs’ Brand Ambassador I helped surface sebuah study di mana kami pulled semua data tersedia dari API di seluruh sebuah very besar sample dari situs dan ditemukan Google hides keyword istilah pada sebuah besar share dari clicks. kami kemudian dibangun itu ke Ahrefs peringkat Tracker — penuh history dari Anda GSC data, percent dari clicks going untuk anonymized kueri, dan sebuah custom CTR curve dibangun dari Anda own angka. Ketika seseorang tells Anda API mengembalikan “all your data,” (terjemahan) “semua Anda data,” itu anonymized slice adalah honest asterisk.

umum gunakan cases

• Automated reporting — scheduled pulls ke Sheets atau sebuah warehouse.
• BI dashboards — Looker Studio atau BigQuery pada top dari performa data.
• besar-scale indeks/coverage monitoring — pemeriksaan URL, batched di dalam 2 000/day quota.
• CTR curve membangun — model yang diharapkan CTR oleh position dari Anda own data.
• Anomaly alerting — flag click/impression drops secara otomatis.

ini adalah juga bagaimana ketiga-party alat berfungsi: ketika Ahrefs atau sebuah Looker Studio connector “integrates Search Console,” (terjemahan) “integrates Search Console,” mereka’re calling ini sama APIs (dan increasingly, BigQuery export) pada Anda behalf.

AI summary

sebuah condensed take pada Advanced versi:

«- The Search Console API = four REST APIs under webmaster-tools/v1: Search Analytics (Performance data), URL Inspection (index status), Sitemaps, and Sites. It’s not full UI parity — a few things, like URL Inspection’s live test, only exist in the interface, and API access alone doesn’t guarantee indexing, rankings, or traffic diagnosis. » (Terjemahan) (Ringkasan bahasa Indonesia untuk bagian lima puluh dua, bagian kecil satu: teks sumber dipertahankan agar dapat diperiksa dalam tinjauan penutur asli.) «- Auth is OAuth 2.0, no API key. Two scopes (webmasters, webmasters.readonly); service accounts for server-to-server, but they still need explicit access to the exact property. siteUrl takes either a URL-prefix property or a sc-domain:example.com Domain property — match how it’s verified. The API only returns data for properties you’ve verified — the #1 beginner gotcha. » (Terjemahan) (Ringkasan bahasa Indonesia untuk bagian lima puluh dua, bagian kecil dua: teks sumber dipertahankan agar dapat diperiksa dalam tinjauan penutur asli.) «- Search Analytics returns top rows first, not a complete dump — “does not guarantee to return all data rows but rather top ones,” regardless of pagination. Within that ceiling: 1–25,000 rows per request (default 1,000), vs ~1,000 in the interface export, and quotas split into load limits and QPS/QPM/QPD request-rate limits. » (Terjemahan) (Ringkasan bahasa Indonesia untuk bagian lima puluh dua, bagian kecil tiga: teks sumber dipertahankan agar dapat diperiksa dalam tinjauan penutur asli.) «- URL Inspection: 2,000 queries/day, 600/minute per site, and it reports only the indexed version — it can’t run a live test. That quota is the real constraint on large-scale index monitoring — batch and schedule around it. » (Terjemahan) (Ringkasan bahasa Indonesia untuk bagian lima puluh dua, bagian kecil empat: teks sumber dipertahankan agar dapat diperiksa dalam tinjauan penutur asli.) «- Sitemaps API lists/gets/submits/deletes sitemaps; Sites API lists/adds/removes properties. » (Terjemahan) (Ringkasan bahasa Indonesia untuk bagian lima puluh dua, bagian kecil lima: teks sumber dipertahankan agar dapat diperiksa dalam tinjauan penutur asli.) «- For large sites, use the BigQuery bulk data export — a separate scheduled pipeline (not a fifth API resource) giving all available performance data daily, no row cap, except anonymized queries. » (Terjemahan) (Ringkasan bahasa Indonesia untuk bagian lima puluh dua, bagian kecil enam: teks sumber dipertahankan agar dapat diperiksa dalam tinjauan penutur asli.) «- Anonymized queries are a genuine gap no API or export fills — Patrick’s Ahrefs work quantified how large that hidden slice is. » (Terjemahan) (Ringkasan bahasa Indonesia untuk bagian lima puluh dua, bagian kecil tujuh: teks sumber dipertahankan agar dapat diperiksa dalam tinjauan penutur asli.)

Dokumentasi resmi

Utama-sumber documentation dari Google.

Search Console API reference

• Search Console API — Overview / tentang — apa API melakukan dan verified-property requirement.
• Penelusuran Analytics: kueri reference — rowLimit (1–25 000) dan dimension parameters.
• pemeriksaan URL API reference — apa indeks-status data inspect metode mengembalikan.
• Sitemaps API reference — list, mendapatkan, submit, delete.
• situs API reference — list, tambahkan, hapus verified properties.
• Usage limits — penuh per-situs, per-pengguna, dan per-project quota table.
• Authorizing permintaan (OAuth 2,0) — scopes dan auth flow.

Bulk data export

• tentang bulk data export (Search Console Help) — schedule sebuah daily BigQuery export dari semua performa data except anonymized kueri.
• Bulk data export announcement (Penelusuran Central blog) — launch post positioning bulk export untuk besar situs.

Quotes dari sumber

pada—record statements dari Google’s documentation. setiap tautan adalah sebuah deep tautan itu jumps untuk quoted passage pada sumber halaman.

Google — apa API melakukan dan siapa dapat gunakan ini

«- “view, add, or remove properties and sitemaps, run advanced queries for Google Search results data for the properties that you manage in Search Console, and test individual pages.” — Google Search Console API docs (Overview). Jump to quote » (Terjemahan) (Ringkasan bahasa Indonesia untuk bagian enam puluh empat, bagian kecil satu: teks sumber dipertahankan agar dapat diperiksa dalam tinjauan penutur asli.) «- “You must have appropriate access (owner, full, read) to any Google Search Console account that you wish to access using the API.” — Google Search Console API docs (Overview). Jump to quote » (Terjemahan) (Ringkasan bahasa Indonesia untuk bagian enam puluh empat, bagian kecil dua: teks sumber dipertahankan agar dapat diperiksa dalam tinjauan penutur asli.) «- “All requests to the Google Search Console API must be authorized by an authenticated user.” — Authorizing requests guide. Jump to quote » (Terjemahan) (Ringkasan bahasa Indonesia untuk bagian enam puluh empat, bagian kecil tiga: teks sumber dipertahankan agar dapat diperiksa dalam tinjauan penutur asli.)

Google — Penelusuran Analytics API

«- “[Optional; Valid range is 1–25,000; Default is 1,000]” — the rowLimit parameter. — Search Analytics: query reference. Jump to quote » (Terjemahan) (Ringkasan bahasa Indonesia untuk bagian enam puluh enam, bagian kecil satu: teks sumber dipertahankan agar dapat diperiksa dalam tinjauan penutur asli.) «- “The URL of the property as defined in Search Console.” — the siteUrl parameter, whose examples give both the URL-prefix form (http://www.example.com/) and the Domain-property form (sc-domain:example.com). — Search Analytics: query reference. Jump to quote » (Terjemahan) (Ringkasan bahasa Indonesia untuk bagian enam puluh enam, bagian kecil dua: teks sumber dipertahankan agar dapat diperiksa dalam tinjauan penutur asli.) «- “The API is bounded by internal limitations of Search Console and does not guarantee to return all data rows but rather top ones.” — Search Analytics: query reference. Jump to quote » (Terjemahan) (Ringkasan bahasa Indonesia untuk bagian enam puluh enam, bagian kecil tiga: teks sumber dipertahankan agar dapat diperiksa dalam tinjauan penutur asli.)

Google — pemeriksaan URL API

«- “View the indexed, or indexable, status of the provided URL. Presently only the status of the version in the Google index is available; you cannot test the indexability of a live URL.” — URL Inspection API reference. Jump to quote » (Terjemahan) (Ringkasan bahasa Indonesia untuk bagian enam puluh delapan, bagian kecil satu: teks sumber dipertahankan agar dapat diperiksa dalam tinjauan penutur asli.)

Google — Sitemaps API

• “Submits a sitemap for a site.” (terjemahan) “Submits sebuah sitemap untuk sebuah situs.” / “Deletes a sitemap from this site.” (terjemahan) “Deletes sebuah sitemap dari ini situs.” / “Lists the sitemaps-entries submitted for this site, or included in the sitemap index file.” (terjemahan) “Lists sitemaps-entries submitted untuk ini situs, atau disertakan di sitemap indeks file.” — Sitemaps API reference. Jump untuk quote

Google — bulk data export

• “Schedule a daily export dari Anda Search Console performance data untuk BigQuery… Anda’ll see all itu performance data tersedia untuk Search Console untuk Anda property, dengan itu exception dari anonymized queries.” (terjemahan) “Schedule sebuah daily export dari Anda Search Console performa data untuk BigQuery… Anda’ll see semua performa data tersedia untuk Search Console untuk Anda property, dengan exception dari anonymized kueri.” — Search Console Help: tentang bulk data export. Jump untuk quote

OAuth setup & pertama-panggil checklist

Getting dari zero untuk sebuah berfungsi Search Console API panggil:

• Konfirmasi Anda memiliki verified access (owner, penuh, atau baca) untuk property di Search Console — API mengembalikan tidak ada apa pun untuk unverified properties.
• buat project di Google Cloud Console.
• Enable Search Console API untuk itu project.
• buat credentials: sebuah OAuth 2,0 client (untuk interactive/pengguna apps) atau sebuah service account (untuk server-untuk-server automation).
• jika menggunakan sebuah service account, grant ini access untuk property di Penelusuran Console settings.
• permintaan right cakupan: webmasters.readonly untuk reporting, webmasters jika Anda’ll submit sitemaps atau manage properties.
• Obtain sebuah access token melalui OAuth flow (atau service-account key).
• Konfirmasi siteUrl format matches bagaimana property adalah verified: sebuah penuh URL untuk sebuah URL-prefix property, atau sc-domain:example.com untuk sebuah Domain property.
• membuat sebuah test panggil untuk searchAnalytics.query dengan sebuah kecil date range dan rowLimit: 10 untuk konfirmasi data muncul back.
• Plan sekitar quotas: Penelusuran Analytics permintaan rates adalah generous tetapi juga draw down sebuah terpisah muat quota; pemeriksaan URL adalah capped di 2 000/day, 600/min per situs — batch accordingly. jangan expect URL Inspection untuk jalankan sebuah pengujian langsung — itu’s UI-hanya.
• untuk tens dari thousands dari rows, siapkan BigQuery bulk export alih-alih dari paginating.

mental models

1. Four APIs, satu auth. Penelusuran Analytics (baca Anda performa data), pemeriksaan URL (baca sebuah URL’s indeks status), Sitemaps (manage sitemaps), situs (manage properties). semua four go melalui yang sama OAuth 2,0 door dan respect yang sama verified-property aturan.

2. data-scale ladder. Pick alat oleh volume:

• Quick look → interface export (~1 000 rows).
• Scriptable, moderate → Penelusuran Analytics API (up untuk 25 000/permintaan, paginate).
• besar situs, menyelesaikan → BigQuery bulk export (semua data, daily, Tidak baris cap). Move up ladder ketika rung di bawah berhenti fitting Anda data.

3. Top rows, tidak semua rows. Internalize itu API mengembalikan “top ones,” (terjemahan) “top ones,” tidak semuanya, dan itu anonymized kueri adalah excluded dari keduanya API dan export. jika completeness penting, BigQuery adalah closer — tetapi anonymized slice adalah hilang regardless.

4. Quota arithmetic sebelum Anda bangun. sebelum designing sebuah indeks monitor, melakukan math: pemeriksaan URL adalah 2 000/day per situs. sebuah 50k-URL situs dapat’t menjadi inspected daily — so batch, prioritize, atau schedule di seluruh days. Design sekitar cap, jangan menemukan ini di production.

«## Search Console API — cheat sheet » (Terjemahan) (Ringkasan bahasa Indonesia untuk bagian delapan puluh delapan, bagian kecil satu: teks sumber dipertahankan agar dapat diperiksa dalam tinjauan penutur asli.)

** four APIs dan mereka key limits**

Auth

• OAuth 2,0 hanya — Tidak API key.
• Scopes: webmasters (baca/tulis), webmasters.readonly (baca).
• Service accounts untuk server-untuk-server (grant them property access).
• hanya verified properties kembalikan data.

Fast facts

• API mengembalikan top rows hanya — tidak guaranteed menyelesaikan — regardless dari pagination.
• Interface export caps near 1 000 rows; API memberikan up untuk 25 000/permintaan, paginate dengan startRow.
• Penelusuran Analytics quotas split ke muat limits (resource-based, 10-min / 1-day chunks) dan QPS/QPM/QPD permintaan-rate limits di atas.
• siteUrl takes sebuah URL-prefix property (http://www.example.com/) atau sebuah Domain property (sc-domain:example.com) — match bagaimana ini adalah verified.
• pemeriksaan URL reports terindeks versi hanya — ini dapat’t jalankan sebuah langsung test; itu’s UI-hanya.
• Anonymized kueri adalah excluded dari API dan BigQuery export.
• untuk tens dari thousands dari rows → BigQuery bulk data export — sebuah terpisah scheduled pipeline, tidak sebuah fifth API resource.
• Exposes banyak dari performa report (Penelusuran Analytics) dan URL Inspection alat, tetapi tidak penuh UI parity.

sebuah minimal Penelusuran Analytics permintaan

ini adalah illustrative, tidak copy-paste-ready — Anda’ll perlu untuk wire up Anda own OAuth credentials dan adjust dates dan property. ini menampilkan shape dari sebuah searchAnalytics.query panggil: permintaan body dengan sebuah date range, dimensions Anda ingin, dan rowLimit.

** permintaan body ( bagian itu penting)**

{
  "startDate": "2026-05-01",
  "endDate": "2026-05-31",
  "dimensions": ["query", "page"],
  "rowLimit": 25000,
  "startRow": 0
}

Sketch di Python (dengan google-api-python-client library)

# Illustrative only — assumes you've already built an authorized `service`
# via OAuth 2.0 (scope: webmasters.readonly) or a service account.
from googleapiclient.discovery import build

service = build("searchconsole", "v1", credentials=creds)

request = {
    "startDate": "2026-05-01",
    "endDate": "2026-05-31",
    "dimensions": ["query", "page"],
    "rowLimit": 25000,   # max per request; default is 1000
    "startRow": 0,       # bump by 25000 to paginate
}

response = service.searchanalytics().query(
    siteUrl="https://example.com/",  # URL-prefix property; use "sc-domain:example.com"
                                      # instead for a Domain property — must be verified
    body=request,
).execute()

for row in response.get("rows", []):
    print(row["keys"], row["clicks"], row["impressions"])

untuk go past 25 000 rows, loop dan increment startRow oleh 25 000 until sebuah permintaan mengembalikan Tidak rows. Remember hasil adalah masih “top rows,” (terjemahan) “top rows,” tidak sebuah menyelesaikan dump — untuk itu, gunakan BigQuery bulk export.

alat itu gunakan (atau wrap) Search Console API

• Google Cloud Console — di mana Anda buat project, enable API, dan mint OAuth/service-account credentials.
• Official client libraries — Google API client libraries untuk Python, Java, JavaScript/Node, PHP, dan.NET wrap REST panggilan.
• BigQuery — destination untuk bulk data export; kueri semua Anda performa data dengan SQL.
• Looker Studio — connects untuk Search Console (dan BigQuery) untuk dashboards dibangun pada yang sama data.
• Ahrefs — integrates Search Console API; -nya peringkat Tracker menampilkan penuh GSC history, share dari clicks going untuk anonymized kueri, dan sebuah custom CTR curve dari Anda own data.
• Search Console interface — performa report dan pemeriksaan URL alat adalah manual counterparts untuk Penelusuran Analytics dan pemeriksaan URL APIs, dengan satu kesenjangan API dapat’t close: hanya interface alat dapat jalankan sebuah langsung test pada sebuah URL.

Prompts untuk planning Search Console API berfungsi

gunakan ini prompts untuk shape code atau sebuah analysis plan. pertahankan credentials, refresh tokens, dan service-account keys out dari apa pun chat input.

Design sebuah Penelusuran Analytics permintaan

Paste Anda property URL, date range, dimensions, filters, dan reporting goal.

Design a Google Search Console Search Analytics API request for the following reporting task.

Property: [sc-domain:example.com or exact URL-prefix property]
Date range: [start and end]
Goal: [the question the report must answer]
Dimensions: [date, query, page, country, device, searchAppearance, or hour]
Filters: [include/exclude rules]

Return:
1. The request body, including a rowLimit no higher than 25,000.
2. Pagination logic using startRow.
3. The aggregation and grouping needed after retrieval.
4. Warnings about top-rows-only data and anonymized queries.
5. A small validation query I can run before scheduling the full pull.

Do not invent credentials or assume the result is a complete census.

Plan sebuah quota-safe pemeriksaan URL schedule

Paste sebuah CSV summary atau counts oleh URL priority alih-alih confidential tokens.

Create a quota-safe sampling and scheduling plan for the Search Console URL Inspection API.

Property: [property]
Total URLs: [count]
Priority groups: [critical templates, new URLs, changed URLs, long-tail sample]
Required revisit cadence: [daily, weekly, monthly]

Constraints from this article:
- 2,000 inspection queries per day per site.
- 600 inspection queries per minute per site.
- The API reports the indexed version, not a live test.

Return a daily allocation by priority group, a rotation method, retry/backoff rules,
and alerts for unexpected index or canonical states. Explain what cannot fit inside
the quota instead of silently dropping it.

«### Choose API versus BigQuery export » (Terjemahan) (Ringkasan bahasa Indonesia untuk bagian seratus empat belas, bagian kecil satu: teks sumber dipertahankan agar dapat diperiksa dalam tinjauan penutur asli.)

Help me choose between the Search Console interface, Search Analytics API, and BigQuery bulk export.

Reporting need: [one-off analysis, dashboard, warehouse, anomaly alerts]
Expected rows per day: [estimate]
History required: [range]
Refresh cadence: [cadence]
Dimensions needed: [list]
Infrastructure available: [spreadsheet, script runner, BigQuery, BI tool]

Compare setup cost, row/completeness limits, automation, and maintenance. Account for
the API returning top rows and for anonymized queries being absent from every path.
End with one recommendation and the smallest proof-of-concept to validate it.

Resources worth Anda time

My related berfungsi

• Ahrefs blog — my posts — including berfungsi pada GSC data di scale dan anonymized kueri.
• Now di Ahrefs peringkat Tracker: penuh GSC history + anonymized-kueri share — CTR-curve dan GSC-history fitur I announced.

Google’s docs

• Search Console API overview dan usage limits halaman — dua halaman untuk bookmark pertama.
• tentang bulk data export — ketika dan cara move untuk BigQuery.

dari others

• Hidden keywords di GSC — Ahrefs study (mesin pencari Journal coverage) — ketiga-party tulis-up dari anonymized-kueri findings.
• Enhanced Search Console analytics dengan BigQuery (SEJ) — sebuah practical lihat bulk-export path.
• Bulk data export: sebuah baru dan powerful cara untuk access Anda Search Console data (Google Search Central blog) — Feb 2023 launch post dari Search Console team positioning bulk export untuk besar situs.
• google-api-python-client (PyPI) — official Python client library digunakan untuk panggil Search Console API; juga tersedia untuk Node, Java, PHP, dan.NET melalui Google APIs client library family.
• r/TechSEO — community untuk API dan data-pull troubleshooting.

Stats worth citing

• Penelusuran Analytics baris limit: 25 000 per permintaan (default 1 000) — versus interface export’s ~1 000-baris cap. ini adalah core alasan untuk gunakan API. Sumber
• pemeriksaan URL quota: 2 000 kueri/day dan 600/minute per situs — hard ceiling pada besar-scale indeks monitoring (10M/day, 15 000/min per project). Sumber
• Anonymized kueri adalah excluded dari bahkan paling menyelesaikan path (BigQuery bulk export) — sebuah nyata, unavoidable kesenjangan di Anda kueri data. Sumber
• Google hides keyword istilah pada sebuah besar share dari clicks — dari Ahrefs study I helped surface, yang pulled semua tersedia data dari API di seluruh sebuah very besar sample dari situs. Coverage

Uji pemahaman Anda: Search Console API

Five quick pertanyaan pada APIs, authentication, data limits, dan scale. Pick sebuah jawaban untuk setiap, lalu periksa Anda hasil.

Log perubahan