GoogleAdsFieldService를 사용하여 GoogleAdsServiceSearch 및 SearchStream 메서드에서 사용할 수 있는 리소스, 리소스의 필드, 세분화 키, 측정항목의 카탈로그를 동적으로 요청할 수 있습니다. 카탈로그는 Google Ads API 클라이언트가 Google Ads 쿼리 언어 문의 유효성 검사 및 구성에 사용할 수 있는 메타데이터를 제공합니다.
샘플 HTTP 요청 및 응답
요청은 다음 URL의 Google Ads API 서버에 대한 HTTP GET로 구성됩니다.
세그먼트 키입니다.
이러한 세그먼트는 쿼리에 지정된 측정항목을 분류합니다. 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입니다.
[null,null,["최종 업데이트: 2025-09-05(UTC)"],[[["\u003cp\u003eUse \u003ccode\u003eGoogleAdsFieldService\u003c/code\u003e to retrieve metadata for resources, fields, segments, and metrics available in Google Ads API Search methods.\u003c/p\u003e\n"],["\u003cp\u003eThe catalog provides data for validation and Google Ads Query Language statement construction, useful for Google Ads API clients.\u003c/p\u003e\n"],["\u003cp\u003eRequest metadata details using resource, resource's field, segmentation field, or metric levels through \u003ccode\u003eGoogleAdsFieldService\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eImportant arrays include: \u003ccode\u003eattributeResources\u003c/code\u003e for implicit joins, \u003ccode\u003emetrics\u003c/code\u003e and \u003ccode\u003esegments\u003c/code\u003e available for selection, and \u003ccode\u003eselectableWith\u003c/code\u003e for fields selectable alongside others.\u003c/p\u003e\n"],["\u003cp\u003eWhile the example uses HTTP/JSON, using client libraries based on gRPC is recommended for submitting requests.\u003c/p\u003e\n"]]],[],null,["# Resource Metadata\n\nYou can use [`GoogleAdsFieldService`](/google-ads/api/reference/rpc/v21/GoogleAdsFieldService)\nto dynamically request the catalog for resources, resource's fields,\nsegmentation keys and metrics available in the\n[`GoogleAdsService`](/google-ads/api/reference/rpc/v21/GoogleAdsService) *Search* and\n*SearchStream* methods. The catalog provides metadata that can be used by\nGoogle Ads API clients for validation and construction of Google Ads Query Language statements.\n\nSample HTTP request and response\n--------------------------------\n\n| **Note:** The example shows the underlying HTTP/JSON request as a guide, but you are strongly encouraged to use one of the [client libraries](/google-ads/api/docs/client-libs) based on [gRPC](//grpc.io) to submit your requests.\n\nThe request consists of an `HTTP GET` to the Google Ads API server at the following\nURL: \n\n https://googleads.googleapis.com/v21/googleAdsFields/{resource_or_field}\n\nThe following example shows a request followed by the response returned from\n`GoogleAdsFieldService` for the **ad_group** resource:\n\n### Request\n\n https://googleads.googleapis.com/v21/googleAdsFields/ad_group\n\n### Response\n\n {\n \"resourceName\": \"googleAdsFields/ad_group\",\n \"name\": \"ad_group\",\n \"category\": \"RESOURCE\",\n \"selectable\": false,\n \"filterable\": false,\n \"sortable\": false,\n \"selectableWith\": [\n \"campaign\",\n \"customer\",\n \"metrics.average_cpc\",\n \"segments.device\",\n ...\n ],\n \"attributeResources\": [\n \"customer\",\n \"campaign\"\n ],\n\n \"metrics\": [\n \"metrics.conversions\",\n \"metrics.search_budget_lost_impression_share\",\n \"metrics.average_cost\",\n \"metrics.clicks\",\n ...\n ],\n \"segments\": [\n \"segments.date\",\n \"segments.ad_network_type\",\n \"segments.device\",\n ...\n ]\n }\n\nFor this example, the important arrays are:\n\n`attributeResources`\n: Resources that can be implicitly joined to the resource in the `FROM`\n clause.\n\n`metrics`\n: Metrics that are available to be selected with the resource in the `FROM`\n clause. Only populated for fields where the `category` is `RESOURCE`.\n\n`segments`\n: Segment keys that can be selected with the resource in the `FROM` clause.\n These segment the metrics specified in the query. Only populated for fields\n where the `category` is `RESOURCE`.\n\n`selectableWith`\n\n: Fields that can be selected alongside a given field, when not in the `FROM`\n clause. This attribute is only relevant when identifying resources or segments\n that are able to be selected in a query where they are not included by the\n resource in the `FROM` clause. As an example, if we are selecting `ad_group.id`\n and `segments.date` from `ad_group`, and we want to include attributes from\n `campaign`, we would need to check that `segments.date` is in the\n `selectableWith` attribute for campaign, since it's being selected alongside\n the existing `segments.date` field.\n\nMetadata details\n----------------\n\nYou can request the catalog using the `GoogleAdsFieldService` at these levels:\n\nResource\n: For example, `googleAdsFields/campaign`.\n\nResource's field\n: For example, `googleAdsFields/campaign.name`.\n\nSegmentation field\n: For example, `googleAdsFields/segments.ad_network_type`.\n\nMetric\n: For example, `googleAdsFields/metrics.clicks`."]]