필드 마스크

Ad Manager REST API는 부분 읽기 및 쓰기에 필드 마스크를 사용합니다. 이렇게 하면 전송되는 데이터의 양을 제한하여 성능을 개선할 수 있습니다. 필드 마스크 필드 이름의 쉼표로 구분된 목록으로 표시됩니다. 예를 들면 다음과 같습니다.

startTime,endTime,targeting.geoTargeting

마스크 읽기

읽기 마스크는 API 응답에 있는 필드를 제어합니다. 페이지의 다음과 같은 두 가지 방법으로 요청의 읽기 마스크를 사용하세요.

fields 쿼리 매개변수:

curl https://admanager.googleapis.com/v1/networks/123456/adUnits?fields=adUnits,nextPageToken,totalSize

X-Goog-FieldMask HTTP 헤더:

curl -H "X-Goog-FieldMask: adUnits,nextPageToken,totalSize" \
    https://admanager.googleapis.com/v1/networks/123456/adUnits

를 통해 개인정보처리방침을 정의할 수 있습니다.

기본 읽기 마스크

일부 API 메서드에는 비용이 많이 드는 필드에 대한 기본 필드 마스크가 포함되어 있음 반환합니다. 목록 메서드가 한 가지 예입니다. 기본적으로 totalSize 필드를 확인합니다.

이러한 필드는 이름 또는 * 와일드 카드를 사용합니다.

마스크 업데이트

업데이트 마스크는 업데이트에서 변경될 필드를 제어합니다 (PATCH). 합니다. 업데이트 마스크가 설정되면 마스크의 필드만 업데이트됩니다. 요청 본문에 설정된 필드와 상관없이

업데이트 마스크는 쿼리 매개변수로 설정됩니다. 예를 들면 다음과 같습니다.

curl -X PATCH https://admanager.googleapis.com/v1/networks/1234/order/4567?updateMask=displayName

필드 순회

필드 마스크는 . 문자를 사용하여 항목 내에서 필드를 지정할 수 있습니다. 있습니다. 이것은 필터.

필드 마스크는 항상 응답 객체를 기준으로 합니다. 예를 들어 LineItem 읽기에는 primaryGoal.units가 포함될 수 있습니다. 해당하는 마스크 (비즈니스 정보 관련) LineItems은 lineItems.primaryGoal.units입니다.

전체 필드를 지정하거나 하위 필드 중 하나를 지정할 수 있습니다. 모두 primaryGoal 및 primaryGoal.units는 모두 유효합니다.

이는 반복되는 입력란에도 적용됩니다. LineItem 필드 마스크 creativePlaceholders.size은(는) 유효하며 size 필드만 포함합니다. (각 CreativePlaceholder).

와일드 카드

필드 마스크는 메시지의 모든 필드를 나타내는 * 문자를 지원합니다. 다음 예는 나열 시 와일드 카드를 사용하는 방법을 보여줍니다. Orders입니다. 이 메서드에는 기본 읽기 마스크가 있어 total_size 필드가 포함되지 않습니다.

예	의미
`*`	`total_size`을(를) 포함한 모든 필드 포함
`orders`	`orders` 필드만 포함되고 모든 하위 필드도 포함됩니다.
`orders.*`	`orders` 필드만 포함되고 모든 하위 필드도 포함됩니다.

잘못된 입력란

필드 마스크가 존재하지 않는 값을 참조하는 경우 API는 INVALID_ARGUMENT 오류가 있을 수 있습니다.