Search Ads 360 Reporting API versi baru kini tersedia. Bergabunglah dengan grup Google
searchads-api-announcements untuk terus mendapatkan informasi terbaru tentang peningkatan dan rilis mendatang.
Struktur Reporting API Search Ads 360
Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
Komponen utama Search Ads 360 Reporting API adalah resource dan
layanan. Resource mewakili entitas Search Ads 360 dan Anda menggunakan layanan
untuk mengambil entitas Search Ads 360.
Hierarki objek
Akun Search Ads 360 adalah hierarki objek.
Resource tingkat teratas akun adalah pelanggan.
Setiap akun berisi satu atau beberapa kampanye aktif.
Setiap Campaign berisi satu atau beberapa grup iklan yang mengelompokkan iklan Anda ke dalam
koleksi logis.
Setiap AdGroup berisi satu atau beberapa iklan grup iklan.
Anda dapat melampirkan satu atau beberapa AdGroupCriterion atau CampaignCriterion
ke grup iklan atau kampanye. Kriteria menentukan cara iklan dipicu.
- Ada banyak jenis kriteria, seperti kata kunci, rentang usia, dan lokasi. Kriteria yang ditentukan di tingkat kampanye memengaruhi semua resource lain dalam kampanye. Anda juga dapat menentukan anggaran dan tanggal seluruh kampanye.
Resource
Resource mewakili entitas di akun Search Ads 360 Anda. Contoh
resource mencakup Customer, Campaign, dan AdGroup.
ID Objek
Setiap objek di Search Ads 360 diidentifikasi dengan ID-nya sendiri. Beberapa ID bersifat unik secara global, yaitu di semua akun Search Ads 360, sementara ID lainnya hanya bersifat unik dalam cakupan terbatas.
| Cakupan keunikan ID objek |
| ID Anggaran |
Global |
| ID kampanye |
Global |
| Nomor Grup Iklan |
Global |
| ID iklan |
Grup IklanSetiap pasangan AdGroupId / AdId bersifat unik secara global. |
| ID AdGroupCriterion |
Grup IklanSetiap pasangan AdGroupId / CriterionId bersifat unik secara global. |
| ID CampaignCriterion |
KampanyeSetiap pasangan CampaignId / CriterionId unik secara global. |
| Ekstensi Iklan |
KampanyeSetiap pasangan CampaignId / AdExtensionId bersifat unik secara global. |
| ID Feed |
Global |
| ID Item Feed |
Global |
| ID Atribut Feed |
Feed |
| ID Pemetaan Feed |
Global |
| ID Label |
Global |
| ID Daftar Pengguna |
Global |
Aturan ID ini dapat berguna saat mendesain penyimpanan lokal untuk objek Search Ads 360 Anda.
Jenis objek
Beberapa objek dapat digunakan untuk beberapa jenis entity. Jika demikian, objek berisi kolom type yang menjelaskan kontennya. Misalnya,
AdGroupAd dapat merujuk ke iklan teks, iklan hotel, atau iklan lokal.
Anda dapat mengakses nilai jenis melalui kolom AdGroupAd.ad.type. Nilainya
ditampilkan dalam enum AdType.
Nama resource
Setiap resource diidentifikasi secara unik oleh string resource_name yang
menggabungkan resource dan induknya ke dalam sebuah jalur.
Misalnya, nama resource kampanye memiliki bentuk:
customers/CUSTOMER_ID/campaigns/CAMPAIGN_ID
Kampanye dengan ID 987654 di akun Search Ads 360 dengan ID pelanggan
1234567, memiliki resource_name:
customers/1234567/campaigns/987654
Layanan
Layanan memungkinkan Anda mengambil entitas dan metadata Search Ads 360. Ada
tiga jenis layanan:
- Layanan penelusuran
SearchAds360Service adalah layanan terpadu tunggal untuk mengambil semua
objek resource dan statistik performa. Class ini menyediakan dua metode: Search
dan SearchStream. Kedua metode ini memerlukan kueri yang menentukan
resource yang akan dikueri, atribut resource dan metrik performa yang akan diambil,
predikat yang akan digunakan untuk memfilter permintaan, serta segmen yang akan digunakan untuk
memperinci statistik performa lebih lanjut. Lihat Membuat laporan penelusuran dan Bahasa
Kueri Search Ads 360 untuk mengetahui informasi
selengkapnya.- Layanan lapangan
SearchAds360FieldService mengambil metadata
tentang resource, seperti atribut yang tersedia untuk resource dan jenis
datanya. Anda dapat meminta katalog untuk resource, kolom resource, kunci
segmentasi, dan metrik yang tersedia dalam metode penelusuran SearchAds360Service. Lihat
Mengambil metadata resource
untuk mempelajari lebih lanjut.- Layanan khusus entitas
Layanan ini menyediakan metode permintaan GET yang mengambil satu instance resource. Hal ini berguna untuk memeriksa struktur resource.
Contoh layanan khusus entitas meliputi:
Kecuali dinyatakan lain, konten di halaman ini dilisensikan berdasarkan Lisensi Creative Commons Attribution 4.0, sedangkan contoh kode dilisensikan berdasarkan Lisensi Apache 2.0. Untuk mengetahui informasi selengkapnya, lihat Kebijakan Situs Google Developers. Java adalah merek dagang terdaftar dari Oracle dan/atau afiliasinya.
Terakhir diperbarui pada 2025-08-29 UTC.
[null,null,["Terakhir diperbarui pada 2025-08-29 UTC."],[[["\u003cp\u003eThe Search Ads 360 Reporting API uses resources to represent Search Ads 360 entities and services to retrieve them, with the core being the SearchAds360Service for comprehensive data retrieval.\u003c/p\u003e\n"],["\u003cp\u003eSearch Ads 360 accounts are structured hierarchically, starting with the customer resource at the top, followed by campaigns, ad groups, ads, and criteria for targeting.\u003c/p\u003e\n"],["\u003cp\u003eEvery Search Ads 360 object has a unique ID, some globally and others within a specific scope like an ad group or campaign, which is important for data management.\u003c/p\u003e\n"],["\u003cp\u003eResources are identified by resource names, which are strings that combine the resource and its parent resources in a path format, such as customers/CUSTOMER_ID/campaigns/CAMPAIGN_ID.\u003c/p\u003e\n"],["\u003cp\u003eThe Search Ads 360 Reporting API provides services like SearchAds360Service for data retrieval, SearchAds360FieldService for resource metadata, and entity-specific services for detailed information on individual resources like custom columns.\u003c/p\u003e\n"]]],["The Search Ads 360 Reporting API uses resources (entities) and services (retrieval methods). Resources, like `Customer`, `Campaign`, and `AdGroup`, are organized hierarchically. Each object has a unique ID with varying scopes and a `resource_name` for identification. Services include `SearchAds360Service` to retrieve resources and statistics, `SearchAds360FieldService` for metadata, and entity-specific services for individual resource instances. `SearchAds360Service` uses queries with attributes, metrics, predicates, and segments to filter data.\n"],null,["# Search Ads 360 Reporting API structure\n\nThe primary components of the Search Ads 360 Reporting API are *resources* and\n*services*. A resource represents a Search Ads 360 entity and you use a service\nto retrieve Search Ads 360 entities.\n\nObject hierarchy\n----------------\n\nA Search Ads 360 account is a hierarchy of objects.\n\n- The top-level resource of an account is the [customer](/search-ads/reporting/api/reference/fields/v0/customer).\n\n- Each account contains one or more active [campaigns](/search-ads/reporting/api/reference/fields/v0/campaign).\n\n- Each `Campaign` contains one or more [ad groups](/search-ads/reporting/api/reference/fields/v0/ad_group) that group your ads into\n logical collections.\n\n- Each `AdGroup` contains one or more [ad group ads](/search-ads/reporting/api/reference/rpc/ad_group_ad).\n\n- You can attach one or more [`AdGroupCriterion`](/search-ads/reporting/api/reference/fields/v0/ad_group_criterion) or [`CampaignCriterion`](/search-ads/reporting/api/reference/fields/v0/campaign_criterion)\n to an ad group or campaign. Criteria define how ads are triggered.\n\n - There are many [criterion types](), such as, keywords, age ranges, and locations. Criteria defined at the campaign level affect all other resources within the campaign. You can also specify campaign-wide budgets and dates.\n\nResources\n---------\n\nResources represent the entities in your Search Ads 360 account. Example\nresources include [`Customer`](/search-ads/reporting/api/reference/fields/v0/customer), [`Campaign`](/search-ads/reporting/api/reference/fields/v0/campaign) and [`AdGroup`](/search-ads/reporting/api/reference/fields/v0/ad_group).\n\n### Object IDs\n\nEvery object in Search Ads 360 is identified by its own ID. Some IDs are\nglobally unique, that is, across all Search Ads 360 accounts, while others\nare unique only within a confined scope.\n\n| Object ID uniqueness scope ||\n|----------------------|------------------------------------------------------------------------------|\n| Budget ID | Global |\n| Campaign ID | Global |\n| AdGroup ID | Global |\n| Ad ID | Ad Group \u003cbr /\u003e Each `AdGroupId` / `AdId` pair is globally unique. |\n| AdGroupCriterion ID | Ad Group \u003cbr /\u003e Each `AdGroupId` / `CriterionId` pair is globally unique. |\n| CampaignCriterion ID | Campaign \u003cbr /\u003e Each `CampaignId` / `CriterionId` pair is globally unique. |\n| Ad Extensions | Campaign \u003cbr /\u003e Each `CampaignId` / `AdExtensionId` pair is globally unique. |\n| Feed ID | Global |\n| Feed Item ID | Global |\n| Feed Attribute ID | Feed |\n| Feed Mapping ID | Global |\n| Label ID | Global |\n| UserList ID | Global |\n\nThese ID rules can be useful when designing local storage for your Search Ads\n360 objects.\n\n### Object types\n\nSome objects can be used for multiple entity types. If this is the case, the\nobject contains a `type` field that describes its contents. For example,\n[`AdGroupAd`](/search-ads/reporting/api/reference/rpc/ad_group_ad) can refer to a text ad, hotel ad, or local ad.\nYou can access the type value through the [`AdGroupAd.ad.type`](/search-ads/reporting/api/reference/rpc/add_group_ad) field. Its\nvalue is returned in the [`AdType`](/search-ads/reporting/api/reference/rpc/google.ads.searchads360.v0.enums#adtypeenum) enum.\n\n### Resource names\n\nEach resource is uniquely identified by a `resource_name` string that\nconcatenates the resource and its parents into a path.\n\nCampaign resource names, for example, have the form: \n\n```scdoc\ncustomers/CUSTOMER_ID/campaigns/CAMPAIGN_ID\n```\n\nA campaign with ID `987654` in the Search Ads 360 account with customer ID\n`1234567`, has the `resource_name`: \n\n```text\ncustomers/1234567/campaigns/987654\n```\n\nServices\n--------\n\nServices let you retrieve your Search Ads 360 entities and metadata. There a\nthree service types:\n\nSearch service\n: [`SearchAds360Service`](/search-ads/reporting/api/reference/rpc/google.ads.searchads360.v0.services#searchads360service) is the single, unified service for retrieving all\n resource objects and performance statistics. It provides two methods: *`Search`*\n and *`SearchStream`* . Both methods require require a query that specifies the\n resource to query, the resource attributes and performance metrics to retrieve,\n the predicates to use for filtering the request, and the segments to use to\n further break down performance statistics. See [Create search reports](/search-ads/reporting/concepts/search-reports) and [Search\n Ads 360 Query Language](/search-ads/reporting/concepts/query-language) for more\n information.\n\nField service\n: [`SearchAds360FieldService`](/search-ads/reporting/api/reference/rpc/google.ads.searchads360.v0.services#searchads360fieldservice) retrieves metadata\n about resources, such as, the available attributes for a resource and its data\n type. You can request the catalog for resources, resource fields, segmentation\n keys, and metrics available in the `SearchAds360Service` search methods. See\n [Retrieve resource metadata](/search-ads/reporting/concepts/field-service)\n to learn more.\n\nEntity-specific services\n\n: These services provide a `GET` request method that retrieves a single resource\n instance. This is useful for examining the structure of a resource.\n\n Examples of entity-specific services include:\n\n - [CustomColumnService](/search-ads/reporting/api/reference/rpc/google.ads.searchads360.v0.services#customcolumnservice) that returns the requested custom column in full detail."]]
