대부분의 리소스는 Mutate 메서드를 사용하여 수정 (생성, 업데이트 또는 삭제)됩니다. Mutate 메서드는 후행 리소스 ID 없이 리소스 이름 패턴과 일치하는 리소스별 URL에 HTTP POST로 호출됩니다.
변경할 리소스의 ID는 대신 JSON 요청 본문으로 전송됩니다. 이를 통해 서로 다른 리소스에 대한 여러 작업이 포함된 단일 API 호출을 보낼 수 있습니다.
예를 들어 캠페인의 리소스 이름에는 다음 형식이 사용됩니다.
customers/CUSTOMER_ID/campaigns/CAMPAIGN_ID
캠페인 변형에 사용되는 URL을 파생하려면 뒤에 나오는 리소스 ID를 생략하고 :mutate를 추가합니다.
https://googleads.googleapis.com/v17/customers/CUSTOMER_ID/campaigns:mutate
Mutate 메시지에는 여러 operation 객체가 포함될 수 있는 operations 배열과 함께 최상위 JSON 객체가 포함됩니다. 결과적으로 각 작업은 create, update, remove 중 하나일 수 있습니다. 다음은 가능한 유일한 변경 작업입니다.
POST /v17/customers/CUSTOMER_ID/campaigns:mutate HTTP/1.1
Host: googleads.googleapis.com
Content-Type: application/json
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN
{
"operations": [
...
]
}
대부분의 서비스는 단일 API 호출로 수천 개의 작업을 지원합니다. 시스템 한도 가이드에는 요청 크기의 제한사항이 설명되어 있습니다.
단일 API 요청 내의 작업은 기본적으로 하나의 작업 집합으로 실행됩니다. 즉, 모두 함께 성공하거나 단일 작업이 실패하면 전체 일괄 작업이 실패합니다. 일부 서비스는 partialFailure 속성을 지원하여 이 동작을 변경합니다. 변형 작업 의미 체계에 관한 자세한 내용은 리소스 변형을 참고하세요.
생성
만들기 작업은 새 항목을 생성하며 만들려는 리소스의 전체 JSON 표현을 포함해야 합니다.
POST /v17/customers/CUSTOMER_ID/campaigns:mutate HTTP/1.1
Host: googleads.googleapis.com
Content-Type: application/json
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN
{
"operations": [
{
"create": {
"name": "An example campaign",
"status": "PAUSED",
"campaignBudget": "customers/CUSTOMER_ID/campaignBudgets/CAMPAIGN_BUDGET_ID",
"advertisingChannelType": "SEARCH",
"networkSettings": {
"targetGoogleSearch": true,
"targetSearchNetwork": true,
"targetContentNetwork": true,
"targetPartnerSearchNetwork": false
},
"target_spend": {}
}
}
]
}
업데이트
업데이트 작업은 기존 리소스에 대한 희소 업데이트를 수행합니다. 수정할 필드만 지정하면 됩니다.
업데이트할 필드를 지정하려면 updateMask 속성을 쉼표로 구분된 필드 이름 목록으로 설정합니다. 객체의 완전한 형식의 JSON 표현이 이미 있지만 (예: 이전 API 호출에서 반환됨) 특정 필드만 변경하려는 경우에 특히 유용합니다.
JSON 객체를 프루닝하는 대신 수정할 필드 이름을 updateMask에 나열하고 전체 JSON 객체를 전송하면 됩니다.
아래 예에서는 지정된 resourceName가 있는 기존 캠페인의 name 및 status를 변경합니다.
POST /v17/customers/CUSTOMER_ID/campaigns:mutate HTTP/1.1
Host: googleads.googleapis.com
Content-Type: application/json
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN
{
"operations": [
{
"updateMask": "name,status",
"update": {
"resourceName": "customers/CUSTOMER_ID/campaigns/CAMPAIGN_ID",
"name": "My renamed campaign",
"status": "PAUSED",
}
}
]
}
삭제
삭제 작업은 객체를 효과적으로 삭제하여 Google Ads 상태를 REMOVED로 설정합니다. 삭제할 resourceName만 있으면 됩니다.
POST /v17/customers/CUSTOMER_ID/campaigns:mutate HTTP/1.1
Host: googleads.googleapis.com
Content-Type: application/json
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN
{
"operations": [
{
"remove": "customers/CUSTOMER_ID/campaigns/CAMPAIGN_ID"
}
]
}