GoogleAdsFieldService
를 사용하여 GoogleAdsService
Search 및 SearchStream 메서드에서 사용할 수 있는 리소스, 리소스 필드, 세분화 키, 측정항목의 카탈로그를 동적으로 요청할 수 있습니다. 카탈로그는 Google Ads API 클라이언트가 Google Ads 쿼리 언어 문을 검증하고 생성하는 데 사용할 수 있는 메타데이터를 제공합니다.
샘플 HTTP 요청 및 응답
요청은 다음 URL의 Google Ads API 서버에 대한 HTTP GET
로 구성됩니다.
https://googleads.googleapis.com/v19/googleAdsFields/{resource_or_field}
다음은 요청의 예와 ad_group 리소스에 대해 GoogleAdsFieldService
에서 반환된 응답입니다.
요청
https://googleads.googleapis.com/v19/googleAdsFields/ad_group
응답
{
"resourceName": "googleAdsFields/ad_group",
"name": "ad_group",
"category": "RESOURCE",
"selectable": false,
"filterable": false,
"sortable": false,
"selectableWith": [
"campaign",
"customer",
"metrics.average_cpc",
"segments.device",
...
],
"attributeResources": [
"customer",
"campaign"
],
"metrics": [
"metrics.conversions",
"metrics.search_budget_lost_impression_share",
"metrics.average_cost",
"metrics.clicks",
...
],
"segments": [
"segments.date",
"segments.ad_network_type",
"segments.device",
...
]
}
이 예시에서 중요한 배열은 다음과 같습니다.
attributeResources
FROM
절의 리소스에 암시적으로 조인할 수 있는 리소스입니다.metrics
FROM
절에서 리소스와 함께 선택할 수 있는 측정항목입니다.category
가RESOURCE
인 필드에만 채워집니다.segments
FROM
절의 리소스와 함께 선택할 수 있는 세그먼트 키입니다. 이러한 측정항목은 쿼리에 지정된 측정항목을 분류합니다.category
가RESOURCE
인 필드에만 채워집니다.selectableWith
-
FROM
절에 있지 않을 때 지정된 필드와 함께 선택할 수 있는 필드입니다. 이 속성은FROM
절의 리소스에 포함되지 않은 쿼리에서 선택할 수 있는 리소스 또는 세그먼트를 식별할 때만 관련이 있습니다. 예를 들어ad_group
에서ad_group.id
및segments.date
를 선택하고campaign
의 속성을 포함하려는 경우 기존segments.date
필드와 함께 선택되므로segments.date
가 캠페인의selectableWith
속성에 있는지 확인해야 합니다.
메타데이터 세부정보
다음 수준에서 GoogleAdsFieldService
를 사용하여 카탈로그를 요청할 수 있습니다.
- 리소스
- 예를 들어
googleAdsFields/campaign
입니다. - 리소스의 필드
- 예를 들어
googleAdsFields/campaign.name
입니다. - 분류 필드
- 예를 들어
googleAdsFields/segments.ad_network_type
입니다. - 측정항목
- 예를 들어
googleAdsFields/metrics.clicks
입니다.