factories
는 클라이언트 라이브러리로 작업과 리소스를 만드는 고급 인터페이스를 제공합니다.
Google Ads API에서 제공하는 모든 리소스, enum, 작업, 서비스 유형에 대해 팩토리 메서드가 자동으로 생성됩니다.
운영
이 라이브러리는 Google Ads API와 함께 작동하는 작업을 쉽게 만들 수 있는 client.operation.create_resource.<resource_type>
, client.operation.update_resource.<resource_type>
, client.operation.remove_resource.<resource_type>
편의 메서드를 제공합니다.
다음은 리소스를 만드는 예입니다.
campaign_budget_operation = client.operation.create_resource.campaign_budget do |cb|
cb.name = "Interplanetary Budget #{(Time.new.to_f * 1000).to_i}"
cb.delivery_method = :STANDARD
cb.amount_micros = 500000
end
return_budget = client.service.campaign_budget.mutate_campaign_budgets(
customer_id,
[campaign_budget_operation]
)
cb
블록에 생성된 객체는 변형할 수 있는 CampaignBudget
의 새 인스턴스이며 CampaignBudgetService
에 적절한 생성 작업이 반환됩니다.
마찬가지로 업데이트를 위한 편의 메서드도 제공합니다.
# if you only have a resource name
update_operation = client.operation.update_resource.campaign(campaign_resource_name) do |camp|
camp.status = :PAUSED
end
campaign_service.mutate_campaigns(customer_id, [update_operation])
# if you have a full resource proto
update_operation = client.operation.update_resource.campaign(campaign) do
campaign.name = "A different interplanetary Cruise #{(Time.new.to_f * 1000).to_i}"
end
campaign_service.mutate_campaigns(customer_id, [update_operation])
이러한 호출은 Google Ads API의 리소스를 업데이트하기 위한 사전 채워진 필드 마스크가 포함된 올바른 형식의 업데이트 작업을 반환합니다.
다음은 리소스 경로를 사용하여 리소스를 삭제하는 예입니다.
remove_operation = client.operation.remove_resource.campaign(campaign_resource_name)
campaign_service.mutate_campaigns(customer_id, [remove_operation])
작업을 직접 처리하려면 원시 작업을 가져온 다음 필드를 수동으로 채울 수 있습니다.
operation = client.operation.campaign
리소스
라이브러리는 리소스 객체를 초기화하는 편리한 방법으로 client.resource.<resource_type>
를 제공합니다.
campaign.network_settings = client.resource.network_settings do |ns|
ns.target_google_search = true
ns.target_search_network = true
ns.target_content_network = false
ns.target_partner_search_network = false
end
요청된 리소스 유형의 새 인스턴스가 필드를 설정하기 위해 전달된 블록에 제공됩니다.
서비스
이 라이브러리는 서비스 객체를 가져오는 편리한 방법으로 client.service.<service_name>
를 제공합니다.
campaign_service = client.service.campaign
열거형
enum 필드를 정적으로 설정하는 경우 기호 문법을 사용하는 것이 좋습니다(예: campaign.status = :PAUSED
). 그러나 열거형의 유효한 값을 모두 열거하려면 다음과 같은 메서드도 제공됩니다.
client.enum.ad_type.each { |x| p x }
:SHOPPING_PRODUCT_AD
:GMAIL_AD
:UNKNOWN
:UNSPECIFIED
:CALL_ONLY_AD
:VIDEO_AD
:IMAGE_AD
:EXPANDED_DYNAMIC_SEARCH_AD
:RESPONSIVE_DISPLAY_AD
:TEXT_AD
:LEGACY_RESPONSIVE_DISPLAY_AD
:LEGACY_APP_INSTALL_AD
:APP_AD
:SHOPPING_SMART_AD
:EXPANDED_TEXT_AD
:HOTEL_AD
:RESPONSIVE_SEARCH_AD
Google Ads API 버전 명시적으로 설정
버전을 명시적으로 설정할 수도 있습니다.
client.resource.v19.[entity]
client.operation.v19.[operation]
client.service.v19.[service]
client.enum.v19.[enum]