Fabryki

factories to interfejs wysokiego poziomu do tworzenia operacji i zasobów za pomocą biblioteki klienta.

Metody fabryk są generowane automatycznie w przypadku wszystkich zasobów, typów enumeracji, operacji i typów usług udostępnianych przez interfejs Google Ads API.

Operacje

Biblioteka zawiera metody client.operation.create_resource.<resource_type>, client.operation.update_resource.<resource_type> i client.operation.remove_resource.<resource_type>, które ułatwiają tworzenie operacji do pracy z interfejsem Google Ads API.

Oto przykład tworzenia zasobu:

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]
)

Pamiętaj, że obiekt zwrócony do bloku cb to nowy egzemplarz klasy CampaignBudget, którą możesz zmodyfikować, oraz zwracana jest odpowiednia operacja tworzenia dla klasy CampaignBudgetService.

Podobnie oferujemy wygodne metody aktualizacji:

# 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])

Te wywołania zwracają poprawnie sformułowaną operację aktualizacji z wstępnie wypełnioną maską pól, która służy do aktualizowania zasobu w interfejsie Google Ads API.

Oto przykład usuwania zasobu za pomocą ścieżki zasobu:

remove_operation = client.operation.remove_resource.campaign(campaign_resource_name)
campaign_service.mutate_campaigns(customer_id, [remove_operation])

Jeśli wolisz samodzielnie pracować z operacją, możesz pobrać operację w postaci nieprzetworzonej, a następnie ręcznie wypełnić pola.

operation = client.operation.campaign

Zasoby

Biblioteka udostępnia funkcję client.resource.<resource_type>, która umożliwia wygodne inicjowanie obiektów zasobów:

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

Do przekazanego bloku przekazywany jest nowy egzemplarz żądanego typu zasobu na potrzeby pól ustawień.

Usługi

Biblioteka udostępnia interfejs client.service.<service_name>, który umożliwia wygodne pobieranie obiektów usługi:

campaign_service = client.service.campaign

Wartości w polu enum

Zalecamy używanie składni symboli do statycznych ustawień pól typu enum (np. campaign.status = :PAUSED). Jeśli jednak chcesz wyliczyć wszystkie prawidłowe wartości typu wyliczeniowego, możesz użyć tych metod:

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

Wyraźne ustawianie wersji interfejsu Google Ads API

Możesz też jawnie ustawić wersję:

client.resource.v19.[entity]
client.operation.v19.[operation]
client.service.v19.[service]
client.enum.v19.[enum]