The primary components of the Search Ads 360 Reporting API are resources and services. A resource represents a Search Ads 360 entity and you use a service to retrieve Search Ads 360 entities.
A Search Ads 360 account is a hierarchy of objects.
The top-level resource of an account is the customer.
Each account contains one or more active campaigns.
Campaigncontains one or more ad groups that group your ads into logical collections.
AdGroupcontains one or more ad group ads.
You can attach one or more
CampaignCriterionto an ad group or campaign. Criteria define how ads are triggered.
- 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.
Resources represent the entities in your Search Ads 360 account. Example
Every object in Search Ads 360 is identified by its own ID. Some IDs are globally unique, that is, across all Search Ads 360 accounts, while others are unique only within a confined scope.
|Object ID uniqueness scope|
|Ad ID||Ad GroupEach
|AdGroupCriterion ID||Ad GroupEach
|Feed Item ID||Global|
|Feed Attribute ID||Feed|
|Feed Mapping ID||Global|
These ID rules can be useful when designing local storage for your Search Ads 360 objects.
Some objects can be used for multiple entity types. If this is the case, the
object contains a
type field that describes its contents. For example,
AdGroupAd can refer to a text ad, hotel ad, or local ad.
You can access the type value through the
AdGroupAd.ad.type field. Its
value is returned in the
Each resource is uniquely identified by a
resource_name string that
concatenates the resource and its parents into a path.
Campaign resource names, for example, have the form:
A campaign with ID
987654 in the Search Ads 360 account with customer ID
1234567, has the
Services let you retrieve your Search Ads 360 entities and metadata. There a three service types:
- Search service
SearchAds360Serviceis the single, unified service for retrieving all resource objects and performance statistics. It provides two methods:
SearchStream. Both methods require require a query that specifies the resource to query, the resource attributes and performance metrics to retrieve, the predicates to use for filtering the request, and the segments to use to further break down performance statistics. See Create search reports and Search Ads 360 Query Language for more information.
- Field service
SearchAds360FieldServiceretrieves metadata about resources, such as, the available attributes for a resource and its data type. You can request the catalog for resources, resource fields, segmentation keys, and metrics available in the
SearchAds360Servicesearch methods. See Retrieve resource metadata to learn more.
- Entity-specific services
These services provide a
GETrequest method that retrieves a single resource instance. This is useful for examining the structure of a resource.
Examples of entity-specific services include:
- CustomColumnService that returns the requested custom column in full detail.